Receivable Sale

List all Receivable Sales

Changed on

List the Receivable Sales for your program, most recently created first. More than one Receivable Sale can exist for the same request_date.

get/v2/receivable_sales

Request

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

Query parameters

afterstring date

Return only sales whose request_date is after this date.

on_or_afterstring date

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

beforestring date

Return only sales whose request_date is before this date.

on_or_beforestring date

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

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

status'created' | 'settled' | 'failed'

The status of the receivable sale.

  • created: the sale has been created and its member receivables and amounts are frozen.
  • settled: the purchase_amount has been debited from your account. core_transaction_id and settled_at are set.
  • failed: the sale could not be settled because your account has insufficient funds or is closed. failure describes why. Any other problem leaves the sale created.
Example:settled

Return only sales with this status.

limitinteger

Maximum number of objects to be returned.

starting_afterstring

Unique ID of the Receivable Sale object.

Example:receivable_sale_3f9a1c7e5b2d4a6f8e0c1b3d5f7a9c2e

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

ending_beforestring

Unique ID of the Receivable Sale object.

Example:receivable_sale_3f9a1c7e5b2d4a6f8e0c1b3d5f7a9c2e

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

Response

A list of Receivable Sale objects.

has_moreboolean required

Whether more objects are available beyond this page.

Example response

{
  "objects": [
    {
      "id": "receivable_sale_3f9a1c7e5b2d4a6f8e0c1b3d5f7a9c2e",
      "status": "settled",
      "request_date": "2026-06-03",
      "currency_code": "USD",
      "purchase_amount": 1250000,
      "purchase_amount_breakdown": {
        "principal": 1250000,
        "fees": 685
      },
      "receivables_count": 42,
      "core_transaction_id": "core_transaction_xyz123",
      "failure": {
        "reason": "non_sufficient_funds",
        "details": "Your account has insufficient funds. Please add funds and notify Lead."
      },
      "created_at": "2026-06-04T06:00:00Z",
      "settled_at": "2026-06-04T14:30:00Z",
      "updated_at": "2026-06-04T14:30:00Z"
    }
  ]
}

Changes