LElead
Receivable Sale

Retrieve a Receivable Sale

Changed on

Retrieve a Receivable Sale by its ID, including its rollup totals. To list the Receivables in it, use GET /v2/receivables?receivable_sale_id={receivable_sale_id}.

get/v2/receivable_sales/{receivable_sale_id}

Request

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

Path parameters

receivable_sale_idstring required

The ID of the Receivable Sale object to retrieve.

Response

A Receivable Sale object.

idstring required

Unique ID of the Receivable Sale object.

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

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.
request_datestring date required

The business day being sold. This may be earlier than created_at when a sale is generated for a past business day.

currency_code'USD' required

A three-letter currency code as defined in ISO 4217.

purchase_amountinteger required

The total amount you pay for the sale, in minor units, debited from your account as a single entry when the sale settles. Equal to the sum of the member receivables' amounts, frozen when the sale is created, and to the sum of the components in purchase_amount_breakdown.

receivables_countinteger required

The number of receivables in the sale. List them with GET /v2/receivables?receivable_sale_id={id}.

core_transaction_idstring required
created_atstring date-time required

The ISO-8601 timestamp at which the Receivable Sale object was created.

settled_atstring date-time nullable required

The ISO-8601 timestamp at which the sale settled and purchase_amount was debited. Null until the sale is settled.

updated_atstring date-time required

The ISO-8601 timestamp at which the Receivable Sale object was last updated.

Example response

{
  "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