Recebíveis
Métricas e análises
GET /v1/receivables/{receivableId}
GET /v1/receivables/{receivableId}
Recupera um único recebível pelo seu identificador. A resposta é o objeto de recebível completo,
acrescido de merchant + _links no nível raiz.
Não existe um endpoint de analytics de recebíveis na API pública. Para um recorte de recebíveis, use a Listagem com os filtros de
status,released,transactionIdedaterange*.
Requisição
curl -X GET "https://api.selectwin.io/v1/receivables/rec_01hqzvabc" \
-H "SelectKey: sk_live_aBcDeFgHiJkLmNoPqRsTuVwXyZ"Escopo necessário: receivables:read.
Parâmetros de caminho
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
receivableId | string | Sim | Identificador do recebível (rec_*) |
Resposta 200 OK
{
"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",
"merchant": { "name": "Seller Name", "merchantId": "bus_1234567890", "isSubAccount": false },
"_links": {
"self": { "href": "https://api.selectwin.io/v1/receivables/rec_01hqzvabc", "method": "GET", "description": "Read a receivable." },
"list": { "href": "https://api.selectwin.io/v1/receivables", "method": "GET", "description": "List all receivables." }
}
}Veja a descrição de cada campo em Visão Geral.
Respostas de Erro
| Código | code | Descrição |
|---|---|---|
| 404 | receivableNotFound | Recebível inexistente ou fora do escopo da empresa |
{
"error": {
"status": "Not Found",
"statusCode": 404,
"category": "client",
"code": "receivableNotFound",
"message": "Receivable not found."
}
}How is this guide?