Crear sesión de pago

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

product_cart

Product Item Request · object[]

required

Mostrar atributos secundarios

product_cart.product_id

string

required

unique id of the product

product_cart.quantity

integer<int32>

required

Rango requerido: x >= 0

product_cart.addons

Attach Addon Request · object[] | null

only valid if product is a subscription

Mostrar atributos secundarios

product_cart.addons.addon_id

string

required

product_cart.addons.quantity

integer<int32>

required

Rango requerido: x >= 0

product_cart.amount

integer<int32> | null

Amount the customer pays if pay_what_you_want is enabled. If disabled then amount will be ignored Represented in the lowest denomination of the currency (e.g., cents for USD). For example, to charge $1.00, pass 100. Only applicable for one time payments

If amount is not set for pay_what_you_want product, customer is allowed to select the amount.

allowed_payment_method_types

enum<string>[] | null

Customers will never see payment methods that are not in this list. However, adding a method here does not guarantee customers will see it. Availability still depends on other factors (e.g., customer location, merchant settings).

Disclaimar: Always provide 'credit' and 'debit' as a fallback. If all payment methods are unavailable, checkout session will fail.

Opciones disponibles:

credit,

debit,

upi_collect,

upi_intent,

apple_pay,

cashapp,

google_pay,

multibanco,

bancontact_card,

eps,

ideal,

przelewy24,

paypal,

affirm,

klarna,

sepa,

ach,

amazon_pay,

afterpay_clearpay

billing_address

Checkout Session Billing Address · object

Billing address information for the session

Mostrar atributos secundarios

billing_address.country

enum<string>

required

Two-letter ISO country code (ISO 3166-1 alpha-2)

Opciones disponibles:

AF,

AX,

AL,

DZ,

AS,

AD,

AO,

AI,

AQ,

AG,

AR,

AM,

AW,

AU,

AT,

AZ,

BS,

BH,

BD,

BB,

BY,

BE,

BZ,

BJ,

BM,

BT,

BO,

BQ,

BA,

BW,

BV,

BR,

IO,

BN,

BG,

BF,

BI,

KH,

CM,

CA,

CV,

KY,

CF,

TD,

CL,

CN,

CX,

CC,

CO,

KM,

CG,

CD,

CK,

CR,

CI,

HR,

CU,

CW,

CY,

CZ,

DK,

DJ,

DM,

DO,

EC,

EG,

SV,

GQ,

ER,

EE,

ET,

FK,

FO,

FJ,

FI,

FR,

GF,

PF,

TF,

GA,

GM,

GE,

DE,

GH,

GI,

GR,

GL,

GD,

GP,

GU,

GT,

GG,

GN,

GW,

GY,

HT,

HM,

VA,

HN,

HK,

HU,

IS,

IN,

ID,

IR,

IQ,

IE,

IM,

IL,

IT,

JM,

JP,

JE,

JO,

KZ,

KE,

KI,

KP,

KR,

KW,

KG,

LA,

LV,

LB,

LS,

LR,

LY,

LI,

LT,

LU,

MO,

MK,

MG,

MW,

MY,

MV,

ML,

MT,

MH,

MQ,

MR,

MU,

YT,

MX,

FM,

MD,

MC,

MN,

ME,

MS,

MA,

MZ,

MM,

NA,

NR,

NP,

NL,

NC,

NZ,

NI,

NE,

NG,

NU,

NF,

MP,

NO,

OM,

PK,

PW,

PS,

PA,

PG,

PY,

PE,

PH,

PN,

PL,

PT,

PR,

QA,

RE,

RO,

RU,

RW,

BL,

SH,

KN,

LC,

MF,

PM,

VC,

WS,

SM,

ST,

SA,

SN,

RS,

SC,

SL,

SG,

SX,

SK,

SI,

SB,

SO,

ZA,

GS,

SS,

ES,

LK,

SD,

SR,

SJ,

SZ,

SE,

CH,

SY,

TW,

TJ,

TZ,

TH,

TL,

TG,

TK,

TO,

TT,

TN,

TR,

TM,

TC,

TV,

UG,

UA,

AE,

GB,

UM,

US,

UY,

UZ,

VU,

VE,

VN,

VG,

VI,

WF,

EH,

YE,

ZM,

ZW

billing_address.city

string | null

City name

billing_address.state

string | null

State or province name

billing_address.street

string | null

Street address including house number and unit/apartment if applicable

billing_address.zipcode

string | null

Postal code or ZIP code

billing_currency

null | enum<string>

This field is ingored if adaptive pricing is disabled

Opciones disponibles:

AED,

ALL,

AMD,

ANG,

AOA,

ARS,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BHD,

BIF,

BMD,

BND,

BOB,

BRL,

BSD,

BWP,

BYN,

BZD,

CAD,

CHF,

CLP,

CNY,

COP,

CRC,

CUP,

CVE,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

ETB,

EUR,

FJD,

FKP,

GBP,

GEL,

GHS,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HRK,

HTG,

HUF,

IDR,

ILS,

INR,

IQD,

JMD,

JOD,

JPY,

KES,

KGS,

KHR,

KMF,

KRW,

KWD,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

LYD,

MAD,

MDL,

MGA,

MKD,

MMK,

MNT,

MOP,

MRU,

MUR,

MVR,

MWK,

MXN,

MYR,

MZN,

NAD,

NGN,

NIO,

NOK,

NPR,

NZD,

OMR,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SEK,

SGD,

SHP,

SLE,

SLL,

SOS,

SRD,

SSP,

STN,

SVC,

SZL,

THB,

TND,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

USD,

UYU,

UZS,

VES,

VND,

VUV,

WST,

XAF,

XCD,

XOF,

XPF,

YER,

ZAR,

ZMW

confirm

boolean

If confirm is true, all the details will be finalized. If required data is missing, an API error is thrown.

customer

Attach Existing Customer · object

Customer details for the session

Attach Existing Customer
New Customer

Mostrar atributos secundarios

customer.customer_id

string

required

customization

Checkout Session Customization · object

Customization for the checkout session page

Mostrar atributos secundarios

customization.force_language

string | null

Force the checkout interface to render in a specific language (e.g. en, es)

customization.show_on_demand_tag

boolean

Show on demand tag

Default is true

customization.show_order_details

boolean

Show order details by default

Default is true

customization.theme

enum<string>

Theme of the page

Default is System.

Opciones disponibles:

dark,

light,

system

discount_code

string | null

feature_flags

Checkout Session Flags · object

Mostrar atributos secundarios

feature_flags.allow_currency_selection

boolean

if customer is allowed to change currency, set it to true

Default is true

feature_flags.allow_customer_editing_city

boolean

feature_flags.allow_customer_editing_country

boolean

feature_flags.allow_customer_editing_email

boolean

feature_flags.allow_customer_editing_name

boolean

feature_flags.allow_customer_editing_state

boolean

feature_flags.allow_customer_editing_street

boolean

feature_flags.allow_customer_editing_zipcode

boolean

feature_flags.allow_discount_code

boolean

If the customer is allowed to apply discount code, set it to true.

Default is true

feature_flags.allow_phone_number_collection

boolean

If phone number is collected from customer, set it to rue

Default is true

feature_flags.allow_tax_id

boolean

If the customer is allowed to add tax id, set it to true

Default is true

feature_flags.always_create_new_customer

boolean

Set to true if a new customer object should be created. By default email is used to find an existing customer to attach the session to

Default is false

force_3ds

boolean | null

Override merchant default 3DS behaviour for this session

metadata

object

Additional metadata associated with the payment. Defaults to empty if not provided.

Mostrar atributos secundarios

metadata.{key}

string

minimal_address

boolean

If true, only zipcode is required when confirm is true; other address fields remain optional

return_url

string | null

The url to redirect after payment failure or success.

show_saved_payment_methods

boolean

Display saved payment methods of a returning customer False by default

subscription_data

Subscription Data · object

Mostrar atributos secundarios

subscription_data.on_demand

On Demand Subscription Request · object

Mostrar atributos secundarios

subscription_data.on_demand.mandate_only

boolean

required

If set as True, does not perform any charge and only authorizes payment method details for future use.

subscription_data.on_demand.adaptive_currency_fees_inclusive

boolean | null

Whether adaptive currency fees should be included in the product_price (true) or added on top (false). This field is ignored if adaptive pricing is not enabled for the business.

subscription_data.on_demand.product_currency

null | enum<string>

Optional currency of the product price. If not specified, defaults to the currency of the product.

Opciones disponibles:

AED,

ALL,

AMD,

ANG,

AOA,

ARS,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BHD,

BIF,

BMD,

BND,

BOB,

BRL,

BSD,

BWP,

BYN,

BZD,

CAD,

CHF,

CLP,

CNY,

COP,

CRC,

CUP,

CVE,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

ETB,

EUR,

FJD,

FKP,

GBP,

GEL,

GHS,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HRK,

HTG,

HUF,

IDR,

ILS,

INR,

IQD,

JMD,

JOD,

JPY,

KES,

KGS,

KHR,

KMF,

KRW,

KWD,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

LYD,

MAD,

MDL,

MGA,

MKD,

MMK,

MNT,

MOP,

MRU,

MUR,

MVR,

MWK,

MXN,

MYR,

MZN,

NAD,

NGN,

NIO,

NOK,

NPR,

NZD,

OMR,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SEK,

SGD,

SHP,

SLE,

SLL,

SOS,

SRD,

SSP,

STN,

SVC,

SZL,

THB,

TND,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

USD,

UYU,

UZS,

VES,

VND,

VUV,

WST,

XAF,

XCD,

XOF,

XPF,

YER,

ZAR,

ZMW

subscription_data.on_demand.product_description

string | null

Optional product description override for billing and line items. If not specified, the stored description of the product will be used.

subscription_data.on_demand.product_price

integer<int32> | null

Product price for the initial charge to customer If not specified the stored price of the product will be used Represented in the lowest denomination of the currency (e.g., cents for USD). For example, to charge $1.00, pass 100.

subscription_data.trial_period_days

integer<int32> | null

Optional trial period in days If specified, this value overrides the trial period set in the product's price Must be between 0 and 10000 days

Response

Checkout session successfully created

checkout_url

string

required

Checkout url

session_id

string

required

The ID of the created checkout session

API Reference

Checkout Sessions

Payments

Subscriptions

Discounts

Licenses

Customers

Customer Wallets

Products

Addons

Meters

Usage Events

Refunds

Disputes

Payouts

Brands

Webhooks

Miscellaneous

Authorizations

Body

Response