> ## Documentation Index
> Fetch the complete documentation index at: https://docs.z2pay.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Buscar recebível por ID
> Retorna um recebível da sua conta — a parcela de uma venda para um recebedor, com status, valores e datas.
`GET /receivables/:id`
Faz parte do recurso [Recebíveis](/pt-BR/receivables) — o conceito, o ciclo de vida e a
tabela de status estão lá.
Retorna o recebível com o mesmo objeto da [listagem](/pt-BR/receivables/list). É 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
```bash theme={null}
curl https://api.sandbox.z2pay.com/v1/receivables/rcv_k3m9x2q7v5b8n4c6z1p0w7r2u \
-H "x-api-key: SUA_CHAVE_DE_SANDBOX"
```
```json theme={null}
{
"id": "rcv_k3m9x2q7v5b8n4c6z1p0w7r2u",
"transactionId": "txn_b4k7m2p9x3c6v1n8q5w0z7r4t",
"paymentId": "pay_c8n2k5x9m4p7v1b3q6w0z2r5t",
"recipientId": "rec_h7d4s9k2m6p1q8w3x5z0v4b7n",
"walletTransactionId": null,
"type": "credit",
"flow": "credit",
"status": "confirmed",
"paymentMethod": "credit_card",
"cardBrand": "visa",
"installmentNumber": 2,
"totalInstallments": 3,
"currency": "BRL",
"grossAmount": 10000,
"feeAmount": 350,
"netAmount": 9650,
"anticipationFeeAmount": 0,
"expectedAt": "2026-11-15T03:00:00.000Z",
"paymentAt": "2026-11-15T03:00:00.000Z",
"liquidatedAt": null,
"createdAt": "2026-09-16T14:02:11.000Z",
"updatedAt": "2026-09-17T09:00:04.000Z"
}
```
**`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`](/pt-BR/wallets/owner-transactions) — o mesmo
valor, do lado da carteira.
## OpenAPI
````yaml openapi/psp.json GET /receivables/{id}
openapi: 3.0.3
info:
title: Z2Pay PSP API
version: 1.0.0
description: API pública do PSP — autenticação via API Key (Credential)
servers:
- url: https://api.sandbox.z2pay.com/v1
description: Sandbox
- url: https://api.z2pay.com/v1
description: Produção
security: []
tags:
- name: Cards
description: Cartões salvos de um cliente
- name: Chargebacks
description: Gerenciamento de chargebacks
- name: Customers
description: Gerenciamento de clientes (compradores)
- name: Fees
description: Tabela de taxas da conta (pix, boleto, cartão, saque, refund, chargeback)
- name: Payments
description: Consulta e estorno de pagamentos
- name: Receivables
description: >-
Recebíveis: o que cada venda vai depositar na carteira, por recebedor e
parcela, com data prevista e status
- name: Recipients
description: Gerenciamento de recebedores (sellers/merchants que recebem repasses)
- name: Refunds
description: Gerenciamento de reembolsos e estornos
- name: Splits
description: Regras de divisão do valor de uma venda entre recebedores
- name: Transactions
description: Gerenciamento de transações e payments
- name: Wallets
description: Saldo, extrato e resumo da carteira de um recebedor, agrupados por moeda
- name: Webhooks
description: Configuração, gerenciamento e histórico de entregas de webhooks
- name: Withdrawals
description: Solicitação e acompanhamento de saques (payouts) por recipient
paths:
/receivables/{id}:
get:
tags:
- Receivables
summary: Buscar recebível por ID
description: Retorna um recebível da conta. ID de outra conta responde 404.
operationId: ReceivableController_getById
parameters:
- name: id
in: path
required: true
description: ID do recebível
schema:
type: string
responses:
'200':
description: Dados do recebível
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: ID do recebível (rcv_).
transactionId:
type: string
nullable: true
description: Transação de origem (txn_).
paymentId:
type: string
description: Pagamento de origem (pay_).
recipientId:
type: string
description: Recebedor desta parcela (rec_).
walletTransactionId:
type: string
nullable: true
description: >-
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:
type: string
enum:
- credit
- refund
- refund_reversal
- chargeback
- chargeback_refund
description: >-
Natureza: credit (venda); refund e chargeback (débitos);
refund_reversal e chargeback_refund (devolução de um
débito).
flow:
type: string
enum:
- credit
- debit
description: >-
credit soma na carteira, debit subtrai. Os valores são
sempre positivos.
status:
type: string
enum:
- projected
- confirmed
- paid
- liquidated
- anticipated
- cancelled
description: >-
projected (previsão) → confirmed (confirmado pelo
adquirente) → paid (pago, liquidando) → liquidated (na
carteira). anticipated = adiantado; cancelled = não será
recebido.
paymentMethod:
type: string
nullable: true
description: credit_card, debit_card, pix ou boleto.
cardBrand:
type: string
nullable: true
description: Bandeira do cartão, quando o adquirente informa.
installmentNumber:
type: integer
description: Número desta parcela.
totalInstallments:
type: integer
description: Total de parcelas da venda.
currency:
type: string
description: Moeda (ISO 4217).
grossAmount:
type: integer
description: Bruto da parcela, em centavos.
feeAmount:
type: integer
description: Taxas descontadas, em centavos. Zero enquanto projected.
netAmount:
type: integer
description: Líquido, em centavos. Igual ao bruto enquanto projected.
anticipationFeeAmount:
type: integer
description: >-
Custo da antecipação, em centavos; zero quando não
antecipado. Valor presente = netAmount −
anticipationFeeAmount.
expectedAt:
type: string
format: date-time
description: Data prevista de recebimento.
paymentAt:
type: string
format: date-time
nullable: true
description: >-
Data de pagamento confirmada pelo adquirente; null até o
adquirente confirmar.
liquidatedAt:
type: string
format: date-time
nullable: true
description: Quando o valor caiu na carteira.
createdAt:
type: string
format: date-time
description: Data e hora de criação do registro (ISO 8601).
updatedAt:
type: string
format: date-time
description: >-
Muda a cada alteração do recebível — base da sincronização
incremental (dateField=updatedAt).
required:
- id
- transactionId
- paymentId
- recipientId
- walletTransactionId
- type
- flow
- status
- paymentMethod
- cardBrand
- installmentNumber
- totalInstallments
- currency
- grossAmount
- feeAmount
- netAmount
- anticipationFeeAmount
- expectedAt
- paymentAt
- liquidatedAt
- createdAt
- updatedAt
example:
id: rcv_k3m9x2q7v5b8n4c6z1p0w7r2u
transactionId: txn_b4k7m2p9x3c6v1n8q5w0z7r4t
paymentId: pay_c8n2k5x9m4p7v1b3q6w0z2r5t
recipientId: rec_h7d4s9k2m6p1q8w3x5z0v4b7n
walletTransactionId: null
type: credit
flow: credit
status: confirmed
paymentMethod: credit_card
cardBrand: visa
installmentNumber: 2
totalInstallments: 3
currency: BRL
grossAmount: 10000
feeAmount: 350
netAmount: 9650
anticipationFeeAmount: 0
expectedAt: '2026-11-15T03:00:00.000Z'
paymentAt: '2026-11-15T03:00:00.000Z'
liquidatedAt: null
createdAt: '2026-09-16T14:02:11.000Z'
updatedAt: '2026-09-17T09:00:04.000Z'
'401':
description: Chave de API ausente, malformada ou inválida
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
description: >-
Identificador estável do erro. É por ele que você deve
ramificar, não pela mensagem.
message:
type: string
description: >-
Descrição legível. Pode mudar sem aviso e não deve ser
usada em condicional.
example:
error:
code: UNAUTHORIZED
message: Invalid API key
'404':
description: Recebível não encontrado
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
description: >-
Identificador estável do erro. É por ele que você deve
ramificar, não pela mensagem.
message:
type: string
description: >-
Descrição legível. Pode mudar sem aviso e não deve ser
usada em condicional.
example:
error:
code: NOT_FOUND
message: Receivable not found
security:
- apiKey: []
components:
securitySchemes:
apiKey:
type: apiKey
in: header
name: x-api-key
description: API Key da Credential (gerada no Backoffice)
````