Pular para o conteúdo principal
POST
Criar um checkout

Autorizações

Authorization
string
header
obrigatório

Chave de API sk_vl_... criada no painel em Desenvolvedores → Chaves de API.

Corpo

application/json
product_cart
object[]
obrigatório

Exatamente 1 item.

Required array length: 1 element
customer
Cliente salvo · object

Cliente salvo (customer_id) ou dados para preencher o formulário.

allowed_payment_method_types
enum<string>[]

Formas aceitas. Padrão: todas.

Required array length: 1 - 3 elements
Opções disponíveis:
pix,
card,
boleto
success_url
string<uri>

Para onde o cliente volta depois de pagar (HTTPS).

cancel_url
string<uri>

Para onde o cliente volta ao desistir (HTTPS).

expires_in
integer
padrão:86400

Validade do link em segundos.

Intervalo obrigatório: 300 <= x <= 86400
external_reference
string

O seu identificador (id do pedido, SKU). Até 100 caracteres.

Maximum string length: 100
Exemplo:

"pedido-1001"

metadata
object

Até 20 pares chave/valor em texto (chave até 40, valor até 500 caracteres). Volta igual nas respostas e nos webhooks.

Exemplo:

Resposta

Compra criada.

id
string

Id da compra.

Pattern: ^cs_[A-Za-z0-9_-]{16}$
Exemplo:

"cs_Xk2v9QeR7tLmN3bA"

object
enum<string>

Sempre checkout_session.

Opções disponíveis:
checkout_session
status
enum<string>

open: aguardando; processing: em análise; paid: pago; failed: tentativa falhou; expired: venceu.

Opções disponíveis:
open,
processing,
paid,
failed,
expired
livemode
boolean

Ambiente da compra.

checkout_url
string<uri>

Link para mandar ao cliente.

Exemplo:

"https://pay.valorapayments.com.br/s/cs_Xk2v9QeR7tLmN3bA"

product_cart
object[]
amount
object
allowed_payment_method_types
enum<string>[]

Formas aceitas.

Opções disponíveis:
pix,
card,
boleto
customer_id
string | null

Cliente associado.

payment_id
string | null

Pagamento gerado quando o cliente escolhe a forma de pagamento.

method
enum<string> | null

Forma escolhida pelo cliente.

Opções disponíveis:
pix,
card,
boleto
success_url
string | null

Retorno depois de pagar.

cancel_url
string | null

Retorno ao desistir.

external_reference
string | null

O seu identificador.

metadata
object

Até 20 pares chave/valor em texto (chave até 40, valor até 500 caracteres). Volta igual nas respostas e nos webhooks.

Exemplo:
expires_at
string<date-time>

Prazo da compra.

completed_at
string<date-time> | null

Quando foi paga.

created_at
string<date-time>

Criação.