Criar um checkout

POST /v1/checkouts · Requer o escopo checkouts:write

Abre uma sessão de checkout para uma oferta. A resposta traz uma checkout_url — a página hospedada onde o comprador paga com Pix. Quando ele conclui, o status da sessão vira completed.

Ofertas recorrentes ainda não são suportadas no checkout — uma oferta recurring retorna 400 (recurring_checkout_not_supported). As sessões expiram 24 horas após a criação.

Parâmetros do corpo

string

obrigatório

A oferta a vender. Deve ser uma oferta ativa de um produto ativo.

string

Um cliente existente (cus_…) a vincular. Deve estar ativo.

string

Sua referência para este checkout, de 1 a 255 caracteres. Único por conta — reutilize para tornar POST /v1/checkouts seguro de repetir (uma repetição retorna 409 em vez de uma segunda sessão).

string

Para onde a página hospedada envia o comprador após o pagamento. http/https, até 2048 caracteres.

string

Para onde o comprador vai se abandonar o checkout.

object

Pares chave–valor livres, devolvidos no objeto de checkout.

Requisição

cURL

curl --request POST https://api.moneydev.com.br/v1/checkouts \
  --header "Authorization: Bearer $ACCESS_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "offer_id": "offer_a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
    "customer_id": "cus_9b2c4f1a-3d5e-4a7b-8c9d-1e2f3a4b5c6d",
    "external_id": "order_1042",
    "success_url": "https://loja.example.com/pedido/1042/ok",
    "cancel_url": "https://loja.example.com/pedido/1042"
  }'

Resposta

201 Created com o objeto de checkout. Redirecione o comprador para a checkout_url.

{
  "id": "checkout_7f8a9b0c-1d2e-4f3a-8b4c-5d6e7f8a9b0c",
  "object": "checkout",
  "customer_id": "cus_9b2c4f1a-3d5e-4a7b-8c9d-1e2f3a4b5c6d",
  "external_id": "order_1042",
  "mode": "payment",
  "status": "open",
  "currency": "BRL",
  "amount_total_minor": 49900,
  "checkout_url": "https://pay.moneydev.com.br/c/8Xr2v9Qk1mNpZ...",
  "success_url": "https://loja.example.com/pedido/1042/ok",
  "cancel_url": "https://loja.example.com/pedido/1042",
  "metadata": {},
  "line_items": [
    {
      "id": "item_2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e",
      "object": "checkout_line_item",
      "product_id": "prod_4d5e6f7a-8b9c-4d0e-1f2a-3b4c5d6e7f8a",
      "offer_id": "offer_a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
      "name": "Plano Pro",
      "description": "Acesso completo por 12 meses",
      "offer_name": "Anual",
      "quantity": 1,
      "currency": "BRL",
      "unit_amount_minor": 49900,
      "total_amount_minor": 49900,
      "type": "one_time",
      "billing_interval": null,
      "interval_count": null,
      "metadata": {}
    }
  ],
  "expires_at": "2026-08-29T13:15:00.000Z",
  "completed_at": null,
  "created_at": "2026-08-28T13:15:00.000Z",
  "updated_at": "2026-08-28T13:15:00.000Z"
}

Erros

Status	`code`	Causa
`400`	`invalid_offer_id`	`offer_id` não é um ID `offer_` válido
`400`	`invalid_customer_id`	`customer_id` não é um ID `cus_` válido
`400`	`invalid_external_id`	`external_id` foi enviado vazio
`400`	`invalid_success_url` / `invalid_cancel_url`	A URL não é `http`/`https`
`400`	`recurring_checkout_not_supported`	A oferta é `recurring`
`404`	`offer_not_found`	Oferta ausente, inativa, arquivada, ou o produto dela não está ativo
`404`	`customer_not_found`	`customer_id` informado mas nenhum cliente ativo corresponde
`409`	`checkout_external_id_already_exists`	`external_id` já usado em outro checkout

Objeto de checkout

string

ID do checkout, com prefixo checkout_.

string

Sempre "checkout".

string | null

Cliente vinculado, ou null.

string | null

Sua referência, ou null.

string

payment.

string

open, completed, expired ou canceled. Leituras expiram automaticamente uma sessão open que passou de expires_at.

string

Moeda ISO 4217.

integer

Total em unidades menores.

string

URL da página hospedada para o comprador.

string | null

Redirecionamento pós-pagamento, ou null.

string | null

Redirecionamento de abandono, ou null.

object

Seus metadados.

array

Os itens vendidos. Cada um tem id (item_…), product_id, offer_id, name, description, offer_name, quantity, currency, unit_amount_minor, total_amount_minor, type, billing_interval, interval_count e metadata.

string

Expiração em ISO 8601 (24 h após a criação).

string | null

Data/hora de conclusão em ISO 8601, ou null.

string

Data/hora de criação em ISO 8601.

string

Data/hora da última alteração em ISO 8601.

Introdução

Conta

Clientes

Produtos

Ofertas

Checkouts

Criar um checkout

Parâmetros do corpo

Requisição

Resposta

Erros

Objeto de checkout

​Parâmetros do corpo

​Requisição

​Resposta

​Erros

​Objeto de checkout

Parâmetros do corpo

Requisição

Resposta

Erros

Objeto de checkout