Visão geral

Um Recebível (Receivable) representa um valor a receber na sua conta, gerado a partir de uma

Introdução

Um Recebível (Receivable) representa um valor a receber na sua conta, gerado a partir de uma transação aprovada. Cada parcela de uma venda parcelada e cada destinatário de um split geram seus próprios recebíveis, com data prevista de liberação (expectedOn) e status próprio.

O recurso de Recebíveis é somente leitura na API pública: você lista e consulta recebíveis; a criação e a mudança de status acontecem automaticamente conforme as transações são processadas.

Estrutura do Recebível

{
  "id": "rec_01hqzvabc",
  "transactionId": "tra_01hqzvabc",
  "recipient": "com_123456789ABCDE001",
  "split": null,
  "status": "pending",
  "amount": 4850,
  "grossAmount": 5000,
  "antecipationFee": 0,
  "installmentNumber": 1,
  "currency": "BRL",
  "description": "Payment successfully completed.",
  "authorizationCode": "A1B2C3",
  "liable": true,
  "released": false,
  "expectedOn": "2026-04-20T00:00:00.000Z",
  "paidAt": null,
  "refundedAt": null,
  "canceledAt": null,
  "chargedBackAt": null,
  "disputedAt": null,
  "fraudChekingAt": null,
  "chargeProcessingFee": true,
  "createdAt": "2026-04-12T17:56:33.000Z",
  "updatedAt": "2026-04-12T17:56:33.000Z"
}

Campos

Campo	Tipo	Descrição
`id`	string	Identificador do recebível (`rec_...`)
`transactionId`	string \| null	Transação que originou o recebível (`tra_`; legado `trx_`)
`recipient`	string \| null	Empresa destinatária do valor
`split`	string \| null	Split associado, se aplicável
`status`	string	Status do recebível (veja abaixo)
`amount`	number	Valor líquido em centavos
`grossAmount`	number	Valor bruto em centavos
`antecipationFee`	number \| null	Taxa de antecipação aplicada (centavos) — chave mantém a grafia histórica `antecipationFee`
`installmentNumber`	integer \| null	Número da parcela
`currency`	string	Moeda (ISO 4217)
`description`	string \| null	Descrição do status
`authorizationCode`	string \| null	Código de autorização da transação
`liable`	boolean \| null	Se o destinatário responde por chargebacks
`released`	boolean \| null	Se o recebível já foi liberado para o saldo disponível
`expectedOn`	datetime \| null	Data prevista de liberação
`paidAt` / `refundedAt` / `canceledAt`	datetime \| null	Marcos do ciclo de vida
`chargedBackAt` / `disputedAt`	datetime \| null	Marcos de chargeback / disputa
`fraudChekingAt`	datetime \| null	Início da verificação de fraude — chave mantém a grafia histórica `fraudChekingAt`
`chargeProcessingFee`	boolean \| null	Se a taxa de processamento é cobrada
`createdAt` / `updatedAt`	datetime	Timestamps ISO 8601

Valores em centavos. amount é o líquido (após taxas); grossAmount é o bruto. As chaves usam recipient/split (não recipientId/splitId) e mantêm as grafias históricas antecipationFee e fraudChekingAt.

Status do Recebível

Status	Descrição
`scheduled`	Agendado para liberação futura (`expectedOn`)
`pending`	Aguardando liquidação
`paid`	Liberado/pago
`canceled`	Cancelado
`refunded`	Reembolsado (transação estornada)
`dispute`	Afetado por disputa
`chargeback`	Afetado por chargeback

O fluxo de status acompanha o da transação de origem — veja o ciclo de status dos recebíveis.

Recursos Disponíveis

Recurso	Método	Endpoint	Escopo	Descrição
Listar	GET	`/v1/receivables`	`receivables:list`	Lista paginada de recebíveis (projeção completa)
Consultar	GET	`/v1/receivables/{receivableId}`	`receivables:read`	Recupera um recebível pelo id (`rec_*`)

A resposta de consulta individual acrescenta merchant + _links ao objeto acima.

Webhooks

Os recebíveis emitem eventos receivable.* (created, scheduled, paid, refunded, canceled, dispute, chargeback) — veja o Catálogo de Eventos. O payload.object do webhook é idêntico ao objeto de leitura acima (sem _links).

Integração

Transactions — cada recebível aponta para a transação de origem (transactionId).
Finance — o saldo (/v1/balance) reflete os recebíveis liberados.
Subscriptions — ciclos cobrados geram recebíveis como qualquer transação.