Create checkout

post

https://sandbox-api.pagaleve.io/v1/checkouts

This endpoint starts a checkout session in Pagaleve. The request must contain all information related to the customer's checkout.

This includes order, customer, shipping and billing information. Upon receiving a successful response, you will redirect the customer to the redirect_checkout_url returned in the response message

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

approve_url

string

required

URL used to redirect to the e-commerce when the consumer successfully completes the checkout at Pagaleve

cancel_url

string

required

URL used to redirect to the e-commerce when the consumer cancels the checkout at Pagaleve

is_pix_upfront

boolean

Flag to identify if the transaction is PIX upfront

metadata

object

Object with any information that needs to be retrieved later by the client.

order

object

required

Order details

provider

string

Platform/E-commerce from which the customer is generating the order. This is an internal enumeration. Example values: VTEX, SHOPIFY, WOO_COMMERCE, etc.

reference

string

External reference ID of the order on the platform. Will be used in payment creation.

shopper

object

required

Customer data

webhook_url

string

Webhook URL that will be called to notify a status change in the order.

Headers

Idempotency-Key

string

The API supports idempotency for security in request retries, thus avoiding executing the same operation twice.

Subsidiary-Id

string

When a holding company queries subsidiary data, this field is required and must contain the subsidiary ID.

Responses

201Checkout created successfully

400First case occurs when the recipient is not a marketplace and the second is when the buyer's data (email, phone) is not valid.

409This error occurs when the checkout with the given ID has already been started.

412This error occurs when valid commission fee values were not sent.