Skip to main content
curl -X GET "https://api.chargefy.io/v1/receivables?status=pending&limit=10" \
  -H "Authorization: Bearer {{API_KEY}}"
{
  "object": "list",
  "data": [
    {
      "id": "rec_123",
      "object": "receivable",
      "amount": 7830,
      "charge": "ch_123",
      "created_at": "2026-05-22T00:00:00Z",
      "currency": "brl",
      "expected_at": "2026-06-22T00:00:00Z",
      "installment": 1,
      "livemode": true,
      "metadata": {},
      "organization": "org_123",
      "payment_intent": "pi_123",
      "platform": null,
      "recipient": "organization",
      "settled_at": null,
      "source_organization": "org_123",
      "status": "pending",
      "type": "principal",
      "updated_at": null
    }
  ],
  "has_more": false,
  "url": "/v1/receivables"
}
Lista receivables em ordem decrescente de criação. Use os filtros de expected_at para montar uma agenda de recebimentos por data de liquidação.

Filtros

charge
string
Filtra por charge (ch_*).
payment_intent
string
Filtra por payment intent (pi_*).
status
string
Filtra por status: pending, paid, canceled ou refunded.
recipient
string
Filtra por beneficiário: organization, platform ou chargefy.
type
string
Filtra por perna: principal, chargefy_fee ou platform_fee.
platform
string
Filtra por plataforma de contexto (plat_*).
expected_at[gte]
string
Filtra recebíveis com liquidação prevista a partir de um timestamp ISO-8601 ou Unix seconds.
expected_at[gt]
string
Filtra recebíveis com liquidação prevista depois de um timestamp.
expected_at[lte]
string
Filtra recebíveis com liquidação prevista até um timestamp.
expected_at[lt]
string
Filtra recebíveis com liquidação prevista antes de um timestamp.
created[gte]
string
Filtra recebíveis criados a partir de um timestamp ISO-8601 ou Unix seconds.
created[gt]
string
Filtra recebíveis criados depois de um timestamp.
created[lte]
string
Filtra recebíveis criados até um timestamp.
created[lt]
string
Filtra recebíveis criados antes de um timestamp.
limit
integer
Quantidade de itens, de 1 a 100.
starting_after
string
Cursor para a próxima página.
ending_before
string
Cursor para a página anterior.
curl -X GET "https://api.chargefy.io/v1/receivables?status=pending&limit=10" \
  -H "Authorization: Bearer {{API_KEY}}"
{
  "object": "list",
  "data": [
    {
      "id": "rec_123",
      "object": "receivable",
      "amount": 7830,
      "charge": "ch_123",
      "created_at": "2026-05-22T00:00:00Z",
      "currency": "brl",
      "expected_at": "2026-06-22T00:00:00Z",
      "installment": 1,
      "livemode": true,
      "metadata": {},
      "organization": "org_123",
      "payment_intent": "pi_123",
      "platform": null,
      "recipient": "organization",
      "settled_at": null,
      "source_organization": "org_123",
      "status": "pending",
      "type": "principal",
      "updated_at": null
    }
  ],
  "has_more": false,
  "url": "/v1/receivables"
}