Recebíveis

Listar recebíveis

GET /v1/receivables

GET /v1/receivables

Retorna uma lista paginada de recebíveis com a projeção completa de campos.

Requisição

curl -X GET "https://api.selectwin.io/v1/receivables?limit=20&offset=0" \
  -H "SelectKey: sk_live_aBcDeFgHiJkLmNoPqRsTuVwXyZ"

Parâmetros de consulta

ParâmetroTipoDescrição
limit / offset / sortPaginação (1–100, padrão limit=20; sort = ascending/descending)
statusstringFiltra por status (texto livre; ex.: pending, paid, scheduled, fraud-review)
releasedstringFiltra por liberação (yes / no)
transactionIdstringFiltra pelos recebíveis de uma transação (tra_* ou legado trx_*)
idstringFiltra por um recebível específico (rec_*)
daterange*stringFiltros por intervalo de data de criação (daterange, daterangegt, daterangegte, daterangelt, daterangelte)

Resposta 200 OK

{
  "offset": 0,
  "limit": 20,
  "total": 128,
  "hasMore": true,
  "page": { "current": 1, "total": 7, "offset": { "first": 0, "prev": 0, "next": 20, "last": 120 } },
  "data": [
    {
      "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", "method": "GET", "description": "List all receivables." } }
}

Os itens de data trazem a projeção completa do recebível (mesmo objeto descrito em Visão Geral, sem _links por item). Para consultar um único recebível com merchant

  • _links, use GET /v1/receivables/{receivableId}.

How is this guide?

On this page