Create checkout session

post

https://api.synapto.construction/v1/accounts/{account}/checkout-sessions

Required capability: payments

Path Params

account

string

required

Body Params

client_reference_id

string

Client supplied identifier to cross-reference the checkout to internal systems (like an order id for example).

amount

string

required

Amount to be captured in minor unit of the currency (ex: euro-cents for euros).

Example: 300 (as in 300 pence for £3.00)

currency

string

required

ISO 4217 three letter currency code. Must be supported by at least one payment rail associated with the device.

Example: "GBP"

success_url

string

The URL to return to when the customer successfully completed the checkout. If empty, a Synapto hosted success page is displayed.

cancel_url

string

When set, a "Back" link becomes visible on the checkout page and the user is redirected to this link. It is recommended to set this field.

metadata

object

Client supplied metadata. At most 50 keys with a max length of 40 characters are permitted. Values may be strings up to 500 characters each.

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A successful response.