v1

latestOpenAPI 3.1.02026-07-24820248.4 KB

Create a Checkout Session

Crea una Checkout Session

post/{country_iso}/checkout-sessions

Path parameters

country_iso'cl' | 'mx' | 'br' required

Headers

x-api-keystring required

Api Key de la organización

Request body

flow_namestring required

Nombre del flow de checkout

expiration_datetimestring

Fecha de expiración de la Checkout Session en formato ISO.

external_idstring required

Identificador único externo. Largo máximo de 128 caracteres

mode'ENROLLMENT' | 'PAYMENT' | 'SAVE_PAYMENT_INSTRUMENT' required

Modo de la Checkout Session

form_informationobject

Información obtenida del formulario

communication_channel'mail' | 'sms' | 'wsp'

Sets the channel that the messaging will use for delivering the checkout url

allow_partial_paymentboolean

Señala si la Checkout Session puede habilitar abonos parciales.

id_templatestring

ID publico de el template que se quiere enviar por mensajería si la secuencia de creación de checkout session existe y está activa.

Response

idstring required

Identificador único de la Checkout Session

flow_namestring

Nombre del flow con el cual se creó la Checkout Session

urlstring

Url que dirige directamente a la sesión de pago

state'open' | 'expired' | 'completed'

Estado de la Checkout Session

id_organizationstring

Identificador único de la organización

expiration_datetimestring

Fecha y hora en formato ISO en la cual la Checkout Session expirará

mode'PAYMENT' | 'ENROLLMENT' | 'SAVE_PAYMENT_INSTRUMENT'

Modo de la Checkout Session

form_informationobject

external_idstring

Identificador entregado por la organización para poder identificar las transacciones o inscripciones realizadas con una Checkout Session.

additional_query_parametersstring

Parámetros adicionales para agregar en la url de una Checkout Session.

legacy_creation_parametersstring

Parámetros adicionales utilizados por antiguas checkout sessions.

transactionsobject

payment_methodsobject[]

payment_instrumentobject