API Reference
PricingSales

Creates a new Checkout

post
https://api-sandbox.paymentlabs.io/checkouts

Creates a new Checkout.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
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
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

redirectLinks
object

The urls to redirect to when the checkout is successful, fails, or expires

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:
Responses

Updated 1 day ago

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

Updated 1 day ago