Receivable

List all Receivables

Changed on

List the Receivables for your program, most recently created first.

get/v2/receivables

Request

  • Base URL
    https://api.sandbox.lead.bank
  • URL
    https://api.sandbox.lead.bank/v2/receivables
  • Auth
    HTTP bearer

Query parameters

type'card_network_settlement' | 'user_credit_balance'

The origin of the event that created the receivable. This value does not change after the receivable is created.

  • card_network_settlement: the receivable was created from a card network settlement. card_network_settlement_details is present.
  • user_credit_balance: the receivable was created from a User Credit Transaction drawn on a User Credit Balance. user_credit_balance_details is present.
Example:card_network_settlement

Return only receivables with this type.

receivable_sale_idstring

Unique ID of the Receivable Sale object.

Example:receivable_sale_3f9a1c7e5b2d4a6f8e0c1b3d5f7a9c2e

Return only receivables that are part of this receivable sale.

afterstring date

Return only receivables whose receivable_sale_details.request_date is after this date.

on_or_afterstring date

Return only receivables whose receivable_sale_details.request_date is the same as or after this date.

beforestring date

Return only receivables whose receivable_sale_details.request_date is before this date.

on_or_beforestring date

Return only receivables whose receivable_sale_details.request_date is the same as or before this date.

A set of filters on the list using the object's field receivable_sale_details.request_date.

limitinteger

Maximum number of objects to be returned.

starting_afterstring

Unique ID of the Receivable object.

Example:receivable_2NfK8sLq4RtVwXyZ1aBcDeFgHiJ

A cursor for use in pagination. Pass the ID of the last Receivable in the previous page to fetch the next page.

ending_beforestring

Unique ID of the Receivable object.

Example:receivable_2NfK8sLq4RtVwXyZ1aBcDeFgHiJ

A cursor for use in pagination. Pass the ID of the first Receivable in the current page to fetch the previous page.

Response

A list of Receivable objects.

has_moreboolean required

Whether more objects are available beyond this page.

Example response

{
  "objects": [
    {
      "id": "receivable_2NfK8sLq4RtVwXyZ1aBcDeFgHiJ",
      "currency_code": "USD",
      "type": "card_network_settlement",
      "held_for": "sale",
      "origination_date": "2026-06-01",
      "amount": 250000,
      "amount_breakdown": {
        "principal": 250000,
        "interest_rate": 9.99
      },
      "receivable_sale_details": {
        "receivable_sale_id": "receivable_sale_3f9a1c7e5b2d4a6f8e0c1b3d5f7a9c2e",
        "request_date": "2026-06-03"
      },
      "card_network_settlement_details": {
        "settlement_reporting_id": "123456789",
        "card_network": "visa",
        "settlement_date": "2026-06-01"
      },
      "user_credit_balance_details": {
        "user_credit_balance_id": "user_credit_balance_1HCpXwx2EK9oYluWbacgeCnFcLf",
        "user_credit_transaction_id": "user_credit_transaction_2JdQyVm8LpT4nWxZ7aBcEfGhKjR"
      },
      "created_at": "2026-06-01T09:15:00Z",
      "updated_at": "2026-06-03T10:00:00Z"
    }
  ]
}

Changes