POST
Create a new checkout

Authorizations

x-hub-signature
string
header
required

HMAC-SHA256 hex digest keyed with the shared secret: over the raw request body for POST requests, or over the query string (the characters after "?") for GET requests. The signed query string is the one the WHATWG URL parser serializes, so a query built with URLSearchParams and appended unchanged verifies, while a hand-assembled query must be percent-encoded the same way.

Body

application/json

Checkout configuration

amount
integer
required

Payment amount in cents

Required range: x >= 1
Example:

10000

ITBIS
integer
required

Tax amount (ITBIS) in cents

Required range: x >= 0
Example:

1800

metadata
string | null
required

Optional metadata to associate with the checkout

Example:

"order-12345"

webhookURL
string<uri>
required

URL to receive payment status webhook notifications

Example:

"https://example.com/webhooks/payment"

forceNo3DS
boolean
required

Skip 3D Secure authentication (use with caution)

Example:

false

currency
enum<string>
default:DOP

ISO 4217 currency of amount and ITBIS. The card is always charged in Dominican pesos, so a USD checkout is converted at the exchange rate current when the checkout is created.

Available options:
DOP,
USD
Example:

"DOP"

statementDescriptor
string

What the cardholder sees on their statement, sent to Azul as AltMerchantName. At most 25 characters, with no quotes or backslashes.

Required string length: 1 - 25
Example:

"RAPIDOTICKETS BOLETAS"

customer
object

Who is paying. Creates the customer on first use and updates its details on later checkouts.

items
object[]

What is being sold. Each product is created on first use and renamed on later checkouts. The items must add up to amount.

Minimum array length: 1

Response

Successfully created checkout

id
string<uuid>
required

Unique identifier for the created checkout

Example:

"550e8400-e29b-41d4-a716-446655440000"