POST
/
v1
/
checkouts

Authorizations

Authorization
string
headerrequired

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
return_url
string

It's where the user will be redirected at the end of the checkout, whether it's success, cancelled or failed

total_amount
integer

Defines the total cost of the checkout (subtotal + shipping + tax)

session_id
string

An ID for the checkout session, it can be the cart ID or anything else

order_id
string

The ID of the current order if created

subtotal_amount
integer

Defines the total cost of the checkout before taxes and without discounts

discount_amount
integer

Defines the absolute discount amount

tax_rate
integer

Defines the percent of taxes (express as integer)

tax_cost
integer
discount_code
string

Defines the code used for the discount

line_items
object[]

Response

200 - application/json
id
string
total_amount
integer

Total amount to pay

total_amount_before_discount
integer

Total amount to pay before any discount

subtotal_amount
integer

Subtotal amount of this checkout

discount_amount
integer

Total discount applied to this checkout

tax_rate
integer

Tax rate

discount_code
string

Discount code applied to this checkout

is_testmode
boolean

Wether the checkout is in testmode or not

line_items
object[]

Items included in the checkout

merchant
object
session_id
string

Defines a session for the current user

order_id
string

Order id associated to this checkout