Saltar al contenido principal
PATCH
Update Checkout Session
Actualiza una sesión de checkout existente con este endpoint. Solo se actualizarán los campos que envíes.
Actualizar una sesión de checkout no extiende su vencimiento. La sesión sigue venciendo 2,5 horas después de su creación (3,5 horas en sandbox). Si la sesión ya venció, este endpoint devuelve CHECKOUT_SESSION_EXPIRED_TIME y debes crear una nueva sesión de checkout.

Autorizaciones

public-api-key
string
header
predeterminado:<Your public-api-key>
requerido
private-secret-key
string
header
predeterminado:<Your private-secret-key>
requerido

Parámetros de ruta

checkout_session
string
requerido

Cuerpo

application/json
merchant_order_id
string
requerido

El identificador único de la orden del cliente (MAX 255; MIN 3).

payment_description
string
requerido

La descripción del pago (MAX 255; MIN 3).

country
string
requerido

País donde se debe procesar la transacción (MAX 2; MIN 2; ISO 3166-1).

account_id
string
predeterminado:{{account_id}}
requerido

El identificador único de la cuenta. Encuentras este dato en el dashboard de Yuno (UUID, 36 caracteres).

customer_id
string

El identificador único del cliente, creado con el endpoint Create Customer (UUID, 36 caracteres).

callback_url
string

La URL a la que redirigimos a tu cliente después de la compra. Es obligatoria en los métodos de pago alternativos con redirección. (MAX 526; MIN 3)

amount
object

Indica el objeto del monto del pago, con el valor y la moneda.

alternative_amount
object

Representación del monto de la transacción en una moneda alternativa.

metadata
object[]

Indica una lista de objetos de metadata. Puedes agregar hasta 120 objetos de metadata.

workflow
enum<string>

Tipo de workflow del checkout.

Opciones disponibles:
SDK_CHECKOUT,
CHECKOUT,
SDK_SEAMLESS
installments
object

El objeto para enviar el plan de cuotas creado en Yuno que se les muestra a tus clientes para que elijan. Este campo opcional se usa cuando la sesión necesita un plan de cuotas en particular. Si no se envía, se muestra el plan de cuotas creado para la cuenta en cada caso, si existe.

Respuesta

200

merchant_order_id
string
Ejemplo:

"007"

checkout_session
string
Ejemplo:

"c67ce158-6053-4661-a1de-aed5c945b935"

country
string
Ejemplo:

"BR"

payment_description
string
Ejemplo:

"Payment Test"

callback_url
any
amount
object
created_at
string
Ejemplo:

"2025-11-14T00:43:22.719648Z"

metadata
any
workflow
string
Ejemplo:

"SDK_CHECKOUT"

installments
object
used
boolean
predeterminado:true
Ejemplo:

false

customer_id
string

Id del cliente.

Ejemplo:

"5e7baf7d-88d5-47c4-8baf-93354d5e195e"

recurring_payment
object

Pago recurrente.

checkout_id
string

Id del checkout.

Ejemplo:

"fd9b15a0-92a4-4e2c-8e4c-27764a1aa43e"