Sezzle

The Sezzle API is intended for merchants interested in accepting Sezzle Pay as a payment option.

Installation & Usage

Requirements

PHP 7.3 and later. Should also work with PHP 8.0 but has not been tested.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/Sezzle/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');




$apiInstance = new OpenAPI\Client\Api\BearerAuthenticationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$inline_object = new \OpenAPI\Client\Sezzle\InlineObject(); // \OpenAPI\Client\Sezzle\InlineObject

try {
    $result = $apiInstance->postV1Authentication($inline_object);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BearerAuthenticationApi->postV1Authentication: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to http://localhost/sandbox.gateway.sezzle.com/v2

Class	Method	HTTP request	Description
BearerAuthenticationApi	postV1Authentication	POST /authentication	Get bearer authentication token
CustomerApi	deleteV2Token	DELETE /customer/{customer_uuid}	Delete customer
CustomerApi	getV2Customer	GET /customer/{customer_uuid}	Get customer
CustomerApi	getV2CustomerList	GET /customer	Get list of customers
CustomerApi	postV2CustomerOrder	POST /customer/{customer_uuid}/order	Create order by customer
CustomerApi	preapproveV2Token	POST /customer/{customer_uuid}/preapprove	Preapprove amount by customer
OrderApi	deleteV2DeleteCheckoutByOrder	DELETE /order/{order_uuid}/checkout	Delete checkout by order
OrderApi	getV2Order	GET /order/{order_uuid}	Get order details
OrderApi	patchV2Checkout	PATCH /order/{order_uuid}	Update order
OrderApi	postV2CaptureByOrder	POST /order/{order_uuid}/capture	Capture amount by order
OrderApi	postV2ReauthorizeByOrder	POST /order/{order_uuid}/reauthorize	Reauthorize amount by order
OrderApi	postV2RefundByOrder	POST /order/{order_uuid}/refund	Refund amount by order
OrderApi	postV2ReleaseByOrder	POST /order/{order_uuid}/release	Release amount by order
OrderApi	postV2UpchargeByOrder	POST /order/{order_uuid}/upcharge	Upcharge amount by order
ReportsApi	getInterestAccountActivity	GET /interest/activity	Interest Account Activity
ReportsApi	getInterestAccountBalance	GET /interest/balance	Interest Account Balance
ReportsApi	getSettlementDetails	GET /settlements/details/{payout_uuid}	Settlement Details
ReportsApi	getSettlementSummaries	GET /settlements/summaries	Settlement Summaries
SessionApi	getV2Session	GET /session/{session_uuid}	Get session status
SessionApi	postV2Session	POST /session	Create a new session
TokenApi	getV2CustomerToken	GET /token/{token}/customer	Get customer token
TokenApi	getV2SessionToken	GET /token/{token}/session	Get session token
WebhooksApi	deleteV2Webhooks	DELETE /webhooks/{webhooks_uuid}	Delete webhooks
WebhooksApi	getV2Webhook	GET /webhooks/{webhooks_uuid}	get webhook
WebhooksApi	getV2Webhooks	GET /webhooks	List webhooks
WebhooksApi	postV2WebhookTest	POST /webhooks/test	Trigger a test webhook
WebhooksApi	postV2Webhooks	POST /webhooks	Create webhooks

Models

• Address
• Authorization
• Capture
• Customer
• Discount
• InlineObject
• InlineObject1
• InlineObject2
• InlineObject3
• InlineResponse200
• InlineResponse2001
• InlineResponse2002
• InlineResponse2003
• InlineResponse2004
• InlineResponse201
• InlineResponse2011
• InlineResponse2011Order
• InlineResponse2011Tokenize
• InstallmentPlan
• Intent
• LineItem
• Link
• Notification
• Order
• OrderAuthorization
• Price
• Refund
• Session
• SessionCancelUrl
• SessionStatus
• Token
• Webhook
• WebhookTest

Authorization

Bearer

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

• API version: 2.0.0
• Build package: org.openapitools.codegen.languages.PhpClientCodegen