curl --request GET \
--url https://api.sandbox.z2pay.com/v1/receivables/{id} \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sandbox.z2pay.com/v1/receivables/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sandbox.z2pay.com/v1/receivables/{id}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"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"
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Receivable not found"
}
}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.
curl --request GET \
--url https://api.sandbox.z2pay.com/v1/receivables/{id} \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sandbox.z2pay.com/v1/receivables/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sandbox.z2pay.com/v1/receivables/{id}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"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"
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Receivable not found"
}
}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.
404, não 403. O recebível pertence à conta da chave que o
gerou; fora dela, o endereço simplesmente não existe.Exemplo
curl https://api.sandbox.z2pay.com/v1/receivables/rcv_k3m9x2q7v5b8n4c6z1p0w7r2u \
-H "x-api-key: SUA_CHAVE_DE_SANDBOX"
{
"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 — o mesmo
valor, do lado da carteira.Authorizations
API Key da Credential (gerada no Backoffice)
Path Parameters
ID do recebível
Response
Dados do recebível
ID do recebível (rcv_).
Transação de origem (txn_).
Pagamento de origem (pay_).
Recebedor desta parcela (rec_).
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.
Natureza: credit (venda); refund e chargeback (débitos); refund_reversal e chargeback_refund (devolução de um débito).
credit, refund, refund_reversal, chargeback, chargeback_refund credit soma na carteira, debit subtrai. Os valores são sempre positivos.
credit, debit projected (previsão) → confirmed (confirmado pelo adquirente) → paid (pago, liquidando) → liquidated (na carteira). anticipated = adiantado; cancelled = não será recebido.
projected, confirmed, paid, liquidated, anticipated, cancelled credit_card, debit_card, pix ou boleto.
Bandeira do cartão, quando o adquirente informa.
Número desta parcela.
Total de parcelas da venda.
Moeda (ISO 4217).
Bruto da parcela, em centavos.
Taxas descontadas, em centavos. Zero enquanto projected.
Líquido, em centavos. Igual ao bruto enquanto projected.
Custo da antecipação, em centavos; zero quando não antecipado. Valor presente = netAmount − anticipationFeeAmount.
Data prevista de recebimento.
Data de pagamento confirmada pelo adquirente; null até o adquirente confirmar.
Quando o valor caiu na carteira.
Data e hora de criação do registro (ISO 8601).
Muda a cada alteração do recebível — base da sincronização incremental (dateField=updatedAt).