Skip to main content
POST
/
v1
/
checkouts
Criar checkout
curl --request POST \
  --url https://api.valorapayments.com.br/v1/checkouts \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "product_id": "prod_abc123",
  "return_url": "https://meusite.com/obrigado",
  "cancel_url": "https://meusite.com/cancelado",
  "title": "Plano Premium",
  "slug": "plano-premium"
}
'
{
  "checkout_id": "chk_a1b2c3d4",
  "business_id": "<string>",
  "product_id": "<string>",
  "slug": "plano-premium-x7a3b2c1",
  "title": "<string>",
  "return_url": "<string>",
  "cancel_url": "<string>",
  "metadata": "<string>",
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
x-api-key
string
header
required

Chave de API gerada no painel Valora. Envie em todas as requisições.

Body

application/json
​
product_id
string
required

ID do produto cadastrado na Valora

Example:

"prod_abc123"

​
return_url
string<uri>
required

URL de redirecionamento após pagamento bem-sucedido

​
cancel_url
string<uri>
required

URL de redirecionamento após cancelamento

​
title
string

Título exibido na página de checkout

Example:

"Plano Premium"

​
slug
string

Slug personalizado para a URL do checkout. Gerado automaticamente se omitido.

Example:

"plano-premium"

​
metadata
string

JSON serializado com dados extras

Response

Checkout criado

​
checkout_id
string
Example:

"chk_a1b2c3d4"

​
business_id
string
​
product_id
string
​
slug
string
Example:

"plano-premium-x7a3b2c1"

​
title
string | null
​
return_url
string
​
cancel_url
string
​
metadata
string | null
​
status
enum<string>
Available options:
active,
inactive
​
created_at
string<date-time>