Skip to main content
GET
Buscar recebível por ID
GET /receivables/:id Faz parte do recurso Recebíveis — o conceito, o ciclo de vida e a tabela de status estão lá. Retorna o recebível com o mesmo objeto da listagem. É a consulta a fazer quando você guardou o id de uma parcela e quer saber se ela já caiu — ou quanto ela vale agora, já que os valores mudam quando o adquirente confirma.
ID de outra conta responde 404, não 403. O recebível pertence à conta da chave que o gerou; fora dela, o endereço simplesmente não existe.

Exemplo

walletTransactionId é o elo com o extrato. Enquanto o recebível não liquida, ele vem null. Ao liquidar, é o id do lançamento em GET /wallets/owner/{ownerId}/transactions — o mesmo valor, do lado da carteira.

Authorizations

x-api-key
string
header
required

API Key da Credential (gerada no Backoffice)

Path Parameters

id
string
required

ID do recebível

Response

Dados do recebível

id
string
required

ID do recebível (rcv_).

transactionId
string | null
required

Transação de origem (txn_).

paymentId
string
required

Pagamento de origem (pay_).

recipientId
string
required

Recebedor desta parcela (rec_).

walletTransactionId
string | null
required

Lançamento do extrato gerado na liquidação (GET /wallets/owner/{recipientId}/transactions). null enquanto não liquidou, ou quando o valor foi pago fora da carteira.

type
enum<string>
required

Natureza: credit (venda); refund e chargeback (débitos); refund_reversal e chargeback_refund (devolução de um débito).

Available options:
credit,
refund,
refund_reversal,
chargeback,
chargeback_refund
flow
enum<string>
required

credit soma na carteira, debit subtrai. Os valores são sempre positivos.

Available options:
credit,
debit
status
enum<string>
required

projected (previsão) → confirmed (confirmado pelo adquirente) → paid (pago, liquidando) → liquidated (na carteira). anticipated = adiantado; cancelled = não será recebido.

Available options:
projected,
confirmed,
paid,
liquidated,
anticipated,
cancelled
paymentMethod
string | null
required

credit_card, debit_card, pix ou boleto.

cardBrand
string | null
required

Bandeira do cartão, quando o adquirente informa.

installmentNumber
integer
required

Número desta parcela.

totalInstallments
integer
required

Total de parcelas da venda.

currency
string
required

Moeda (ISO 4217).

grossAmount
integer
required

Bruto da parcela, em centavos.

feeAmount
integer
required

Taxas descontadas, em centavos. Zero enquanto projected.

netAmount
integer
required

Líquido, em centavos. Igual ao bruto enquanto projected.

anticipationFeeAmount
integer
required

Custo da antecipação, em centavos; zero quando não antecipado. Valor presente = netAmount − anticipationFeeAmount.

expectedAt
string<date-time>
required

Data prevista de recebimento.

paymentAt
string<date-time> | null
required

Data de pagamento confirmada pelo adquirente; null até o adquirente confirmar.

liquidatedAt
string<date-time> | null
required

Quando o valor caiu na carteira.

createdAt
string<date-time>
required

Data e hora de criação do registro (ISO 8601).

updatedAt
string<date-time>
required

Muda a cada alteração do recebível — base da sincronização incremental (dateField=updatedAt).