Creates a new Checkout

Creates a new Checkout.

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

Used to create a new checkout

string
required

An easily identifiable name for this checkout, something descriptive

string

A cross identifiable id between systems, this should be something you can reference back on your system

string

A brief description of what this checkout is for

string

What the buyer sees on their card statement for this charge, after your merchant prefix:
PREFIX*STATEMENT ALIAS.

Only accepted when soft descriptors are enabled for your merchant account.

The whole descriptor, prefix and * included, may be at most 22 characters, using
letters, digits, spaces and . , -. Card issuers may still shorten, uppercase or
strip characters, so how it appears is best effort.

string
required

The merchant's terms of service url that will be displayed to the buyer

string
required

The merchant's privacy policy url that will be displayed to the buyer

buyer
object
required

Information about the buyer

date

The day this checkout will expire, won't accept payments after this date
defaults to 1 year from now

string

The user timezone, in IANA format (e.g.: America/Sao_Paulo)
defaults to UTC

string
required

The currency for this checkout item, in ISO format (e.g.: USD)
The supported currencies are configuration dependent, check with your CSM for currency availability for your merchant account

number
required

The amount to be charged in decimal notation (e.g. 10.52)

string
enum

The authentication options for this checkout
forces the buyer to use one of the authentication options

defaults to 'ALL'
  • GUEST_ONLY - The buyer must pay as a guest
  • AUTHENTICATED_ONLY - The buyer must pay as an authenticated user
  • ALL - The buyer can pay as a guest or an authenticated user
Allowed:
string
enum

How strictly 3D Secure is enforced for this checkout

You may only send a method that is enabled for your merchant account. Which of

the methods below you are allowed to send is configuration dependent, check with your CSM which
ones are enabled for your merchant account. This applies to every method including
SKIP_3DS — if skipping 3D Secure is not enabled for your account, you cannot ask to skip

it. Sending a method that is not enabled for you is rejected with a validation error, it is
never quietly replaced with one you are allowed to send, so a checkout either enforces 3D Secure
the way you asked or it is not created at all.

  • REQUIRE_3DS: The charge fails if 3D Secure cannot be completed, for any reason
  • PREFER_3DS: The charge fails if 3D Secure is attempted and fails, but proceeds when the buyer's card cannot support 3D Secure at all
  • SKIP_3DS: 3D Secure is not attempted

Omit this field to use the default configured for your merchant account.

Allowed:
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json