Create A Checkout Session

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Create a checkout session which will generate a unique checkout link for you that can be sent to customers to make a payment.

The checkout session will be disabled as soon as the payment has been collected. Payments that failed will have a decisive number of attempts before the session is disabled.

Guide to use Ezypay's Checkout Page: https://developer.ezypay.com/docs/checkout

❗️

Before the checkout link is shared out to customers, integrators/merchants has the responsibility to ensure that any of their customers who use the checkout page, is a valid customer.

📘

Only accept credit card transactions. Important to always have the "successURL" and the "cancelURL" setup for each checkout page created.

Existing Ezypay customer id and Ezypay payment method token can be provided to reduce new customer id and payment method token to be created for an existing Ezypay customer.

Body Params
amount
object
required

The amount (actual amount and currency) that you want to charge.

string
required

The description of the payment. This description will be the main line item in the generated invoice.

string

The accounting code that you'll want this invoice to be associated with.

string

The URL that the Checkout Page will redirect to once a payment outcome is reached, regardless of status.

string

The URL that the Checkout Page will redirect to if the user cancels the payment.

string

The unique UUID of the customer that you want to be the payee of this invoice.

string

The unique payment method token that you want used for this payment.

Headers
string
required

Your merchant id

Responses

Language
LoadingLoading…
Response
Choose an example:
application/json