EZezypay

Create A Checkout Session

Changed on
post/billing/checkout

Request

  • Base URL
    https://api-sandbox.ezypay.com/v2
  • URL
    https://api-sandbox.ezypay.com/v2/billing/checkout
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://identity-sandbox.ezypay.com/token

Headers

Merchantstring required

Your merchant id

Request body

descriptionstring required

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

accountingCodestring

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

successUrlstring

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

cancelUrlstring

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

customerIdstring

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

paymentMethodTokenstring

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

Response

200

checkoutUrlstring
idstring

Example response

{
  "checkoutUrl": "https://checkout-sandbox.ezypay.com/bf42feec",
  "id": "51c12344-6648-4391-935d-8bc83f7e2c0d"
}

Changes