Esse objeto representa uma sessão de checkout que pode ser criada para fazer um pagamento. Você pode criar uma sessão de checkout usando o ID gerado quando o recurso Customer foi criado.
A criação de uma sessão de checkout só é necessária para o fluxo SDK_CHECKOUT.
Somente um pagamento é suportado por cada sessão de checkout. A sessão de checkout expira 5 horas após sua criação.
Atributos
checkout_session string
O identificador exclusivo da sessão de checkout (MAX 64; MIN 36).
Example: 9104911d-5df9-429e-8488-ad41abea1a4b
customer_id string
O identificador exclusivo do cliente (MAX 64; MIN 36).
Example: 9104911d-5df9-429e-8488-ad41abea1a4b
merchant_order_id string
O identificador exclusivo do pedido do cliente (MAX 255; MIN 3).
Exemplo: 1234
payment_description string
A descrição do payment (MAX 255; MIN 3).
Exemplo: Compra no mercado de Pepito
callback_url string
O URL para onde redirecionar o cliente após o pagamento (MAX 526; MIN 3).
Exemplo: https://www.company.com/customer_1231324
country enum
País em que a transação deve ser processada (MAX 2; MIN 2; ISO 3166-1).
Possíveis valores de enum: Verifique a referência do país.
created_at carimbo de data/hora
Data e hora de criação da sessão de checkout (MAX 27; MIN 27; ISO 8601).
Example: 2022-05-09T20:46:54.786342Z
amount objeto
Especifica o objeto de valor de payment , com o valor e a moeda.
currency enum
A moeda usada para fazer o payment (MAX 3; MIN 3; ISO 4217).
Possíveis valores de enum: Verifique a referência do país.
value flutuar
O valor payment (múltiplo de 0,0001).
Exemplo: 23,5676
metadata matriz de objetos
Especifica uma lista de objetos de metadados. Você pode adicionar até 50 objetos de metadados.
metadata object objeto
Especifica uma chave de metadados e o respectivo valor.
key string
Especifica uma chave de metadados.
Exemplo: idade
value string
Especifica o valor da chave de metadados definida.
Exemplo: 28
installments matriz de objetos
[Opcional] O objeto para enviar o plano de parcelamento criado no Yuno para mostrar aos seus clientes e permitir que eles escolham. Esse campo opcional é usado caso um determinado plano de parcelamento precise ser usado na sessão. Se não for enviado, exibiremos o plano de parcelamento criado para a conta para cada cenário, se houver.
plan_id string
Especifica um ID de plano criado no Yuno para mostrar ao seu cliente na sessão de checkout. Se não for definido, usaremos os criados para a conta, se aplicável. (MÁXIMO 64; MÍNIMO 64).
Possíveis valores de enum: Verifique a referência do país.
plan matriz de objetos
Parcelas a serem exibidas ao cliente com a checkout_session. Esse struct opcional é usado caso um determinado plano de parcelas precise ser usado na sessão e não tenha um plano de parcelas criado para ele. Se não for enviado, exibiremos o plano de parcelas criado para a conta em cada cenário, se houver.
installment object objeto
Especifica uma parcela disponível para a sessão de checkout.
installment int
O número de parcelas mensais que os compradores podem escolher
Exemplo: 3
rate flutuar
A taxa que será aplicada ao valor final da transação pelo provedor de pagamento após o uso de parcelas.
Exemplo: 1,5