v1

latestOpenAPI 3.0.02026-07-2671191208.7 KB

Checkout

Criar smart checkout

post/v1/marketplace/checkout

Headers

establishment_idstring required

ID do estabelecimento.

integration-keystring required

Chave de integração.

x-tokenstring required

x-token utilizado para autenticação. Pode ser encontrado em nosso portal, na guia de integração com a api pública.

Request body

titlestring required

Descrição do checkout.

durationnumber

Tempo de expiração do link em minutos.

multiple_paymentsboolean

Permite múltiplos pagamentos.

interest'STORE' | 'CLIENT'

CLIENT: as taxas são repassadas ao comprador, resultando no aumento do valor bruto da transação. - STORE: as taxas são cobradas do estabelecimento, mantendo inalterado o valor bruto da transação.

brand_plan'MASTERCARD' | 'VISA' | 'ELO' | 'OTHERS'

Plano utilizado para calcular as taxas quando o interest for CLIENT.

amountnumber required

Valor do checkout em centavos.

Example request

{
  "reference_id": "ABC-123",
  "billet": {
    "due_date": "2026-07-15",
    "issue_date": "2026-07-02",
    "days_until_expiration": 5,
    "iof_percentage": "0.00820",
    "messages": [
      "Não receber após o vencimento"
    ],
    "discount": {
      "items": [
        {
          "limit_date": "2026-07-10",
          "value": 5
        }
      ]
    },
    "fine": {
      "percentage": "2.00",
      "quantity_days": 3
    },
    "interest_percentage": "1.00"
  }
}

Response

_idstring required

ID do pedido de checkout.

titlestring required

Descrição do checkout.

checkout_tokenstring required

Token do checkout.

amountnumber required

Valor do checkout em centavos.

statusstring required

Status do checkout.

reference_idstring

Identificador definido pelo cliente para controle e rastreamento interno do checkout.

created_atstring required

Data de criação.

updated_atstring required

Data de atualização.