EDedubank
Receivables

Get all receivables

The list of items will include the receivables and their respective payments, in other words, the payments that generated the receivables that were CREATED, PAID, REFUNDED and CANCELED.

For receivables from the "recipient" of a split transaction, enter the seller_id recipient in the Authorization. In this case, the body return include main_seller_id

If expected_on_range_gte is not informed, the last 90 days will be considered

get/v1/receivables

Request

  • Base URL
    https://api.edubank.com.br (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header authorization
    • or API key in header x-api-key
    • or API key in header authorization
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

pagestring required

Select the page

limitstring required

Limits the number of objects returned, which can be between 1 and 100

sort'ASC' | 'DESC' required

Determine how to sort the list by object creation date

status'PAID' | 'CREATED' | 'REFUNDED' | 'CANCELED'

Status of receivables

expected_on_range_gtestring

Receivables expected on with a date greater than

expected_on_range_ltestring

Receivables expected on with a date lower than

Response

The record has been successfully getted

pagestring required

Select the page

limitstring required

Limits the number of objects returned, which can be between 1 and 100

sort'ASC' | 'DESC' required

Determine how to sort the list by object creation date

last_pagenumber required

Last page

max_itemsnumber required

Max items

Example response

{
  "items": [
    {
      "create_at": "2026-10-01",
      "expected_on": "2026-10-01",
      "status": "CREATED",
      "receivable_amount": 198,
      "payment_type": "PIX",
      "payment_amount": 200,
      "payment_received_at": "2026-09-01T23:59:59+00:00",
      "split_rule": [
        {
          "amount": 9550,
          "percentage": "0.1234",
          "processing_fee": "MAIN"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.