Skip to main content
GET
Retrieve a Receivable Sale

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

receivable_sale_id
string
required

The ID of the Receivable Sale object to retrieve.

Maximum string length: 64

Response

A Receivable Sale object.

A receivable sale is the aggregate of a program's eligible receivables for a single business day, which you purchase as a single unit.

id
string
required

Unique ID of the Receivable Sale object.

Maximum string length: 64
Pattern: ^receivable_sale_\w+$
Example:

"receivable_sale_3f9a1c7e5b2d4a6f8e0c1b3d5f7a9c2e"

status
enum<string>
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.
Available options:
created,
settled,
failed
Example:

"settled"

request_date
string<date>
required

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

Example:

"2026-06-03"

currency_code
enum<string>
required

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

Available options:
USD
Example:

"USD"

purchase_amount
integer
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.

Example:

1250000

purchase_amount_breakdown
object
required

The components that make up the sale's purchase_amount, in minor units. The components always sum to purchase_amount.

This object is an open map: Lead may add new components (for example, a premium) in the future without a version change. Each component is a signed integer, so a component that reduces the amount due is negative. Sum every key present rather than only the ones listed here.

receivables_count
integer
required

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

Required range: x >= 0
Example:

42

core_transaction_id
string | null
required

The core transaction that debited purchase_amount from your account. Null until the sale is settled.

Pattern: ^core_transaction_.+~\d+$
Example:

"core_transaction_xyz123"

created_at
string<date-time>
required

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

Example:

"2026-06-04T06:00:00Z"

settled_at
string<date-time> | null
required

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

Example:

"2026-06-04T14:30:00Z"

updated_at
string<date-time>
required

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

Example:

"2026-06-04T14:30:00Z"

failure
object

Why the sale failed. Present only when the sale is failed; omitted otherwise.