Create Checkout Session

post https://api.trytoku.com/checkout-sessions

Crea un link a un checkout para inscribir un medio de pago.

time	status	user agent
Retrieving recent requests…

Loading…

Body Params

id_customer

string

ID del customer al que se le crea la checkout session

id_account

string

ID de la cuenta asociada al medio de pago. Si no se entrega, se utiliza la cuenta principal de la organización

type

string

required

Defaults to ENROLLMENT

Tipo de checkout session a crear. Los valores son ENROLLMENT o PAYMENT

toku_product

string

Defaults to cards_batch_mx_recurring_pst

Medio de pago a inscribir. Los valores posibles son cards_batch_mx_recurring_pst o payment_orchestration_onetime. No debe proporcionarse si es de tipo PAYMENT. Si no se entrega, se redirigirá al selector de medios de pago

creator_id

string

Email de quién crea la checkout session

notify

boolean

required

Decide si notificar. En caso de notificación, se enviará un email al creator_id y al correo del cliente, si está disponible. Solo aplica para el tipo ENROLLMENT

external_id

string

ID interno de la organización

amount

float

Requerido solo si es de tipo PAYMENT

display_toku_products

array of strings

Defaults to []

Filtra los productos a mostrar en base a los activos. En caso de ser una lista vacía se mostrarán todos

display_toku_products

new_card

boolean

Defaults to false

Redirige al usuario a un formulario para ingresar una nueva tarjeta. No se permitirá la selección de tarjetas previamente domiciliadas. Habilitado solo para tipo PAYMENT.

id_payment_method

string

Fuerza el uso de un método de pago inscrito previamente. Se puede ingresar un id_payment_method o un token ligado a una tarjeta. Activar id_payment_method y new_card es incompatible al crear una checkout_session. Habilitado solo para tipo PAYMENT.

additional_metadata

json

Defaults to {}

Metadata adicional con la que se quiera crear la sesion de checkout.

expiration_date

date

Fecha de expiración en formato ISO8601. Por defecto son 7 días. Ejemplo: "2024-12-19T14:26:56.463050+04:00" .

Headers

x-api-key

string

required

API Key de la organizacion

content-type

string

required

Defaults to application/json

Debe ser application/json

Responses

Language

Credentials

Header


xxxxxxxxxx
16
1
curl --request POST \
2
     --url https://api.trytoku.com/checkout-sessions \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "type": "ENROLLMENT",
8
  "toku_product": "cards_batch_mx_recurring_pst",
9
  "notify": true,
10
  "display_toku_products": [
11
    "[]"
12
  ],
13
  "new_card": false,
14
  "additional_metadata": {}
15
}
16
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400