Create a checkout session

post

https://api.smartpay.co/v1/checkout-sessions

A Checkout Session represents your customer's session as they use Smartpay Checkout to pay for orders or create a token.
The Checkout Session will contain a reference to the Order or Token once created. If your user completes their Smartpay checkout successfully, the Order or Token will be successful.

A Checkout Session needs to be created on your server using a private API key. To begin Smartpay checkout redirect the user to the url returned by the call

Errors

For possible error responses see Errors.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Create a checkout session for a standard order

amount

number

required

≥ 0

The amount intended to be collected through this order. A positive integer in the smallest currency unit.

cancelUrl

string

required

The URL the customer will be redirected to if the Checkout Session hasn't completed successfully. This means the Checkout failed, or the customer decided to cancel it.

captureMethod

string

enum

Allowed:

currency

string

required

Three-letter ISO currency code, in uppercase. Must be a supported currency.

customerInfo

object

required

Customer Information, the details provided here are used to pre-populate forms for your customer's checkout experiences. The more information you send, the better experience the customer will have.

description

string

length between 1 and 80

An arbitrary - ideally descriptive - long form explanation of the Order, meant to be displayed to the customer.

items

array of objects

required

length between 1 and 50

The line items the customer wishes to order. At least one product and at most 50 items.

items*

locale

string

enum

Locale

Allowed:

metadata

object

Set of up to 20 key-value pairs that you can attach to the object.

reference

string

length between 1 and 40

A - ideally unique - string to reference the Order in your system (e.g. an order ID, etc.).

shippingInfo

object

required

Shipping Information

successUrl

string

required

The URL the customer will be redirected to if the Checkout Session completed successfully. This means the Checkout succeeded, i.e. the customer authorized the order.

Responses

200Expanded Checkout Session

400Invalid Request

401Unauthorized