Skip to main content
GET
Retrieve a Receivable

Authorizations

Authorization
string
header
required

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

Path Parameters

receivable_id
string
required

The ID of the Receivable object to retrieve.

Maximum string length: 64

Response

A Receivable object.

id
string
required

Unique ID of the Receivable object.

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

"receivable_2NfK8sLq4RtVwXyZ1aBcDeFgHiJ"

currency_code
enum<string>
required

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

Available options:
USD
Example:

"USD"

type
enum<string>
required

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.
Available options:
card_network_settlement,
user_credit_balance
Example:

"card_network_settlement"

held_for
enum<string>
required

Whether the receivable is meant for sale or to stay on Lead's balance sheet.

  • sale: the receivable is held for sale.
  • investment: the receivable is held for investment on Lead's balance sheet. A receivable can move from investment to sale.
Available options:
sale
Example:

"sale"

amount
integer
required

The overall amount of the receivable, in minor units. Equal to the sum of amount_breakdown.principal, amount_breakdown.interest, and amount_breakdown.fees.

  • For receivables held for sale, the amount is locked at the loan amount to be sold when the receivable is reclassified for sale.
  • For receivables held for investment, the amount is live: it grows with originations and decreases with payments and charge-offs.
Example:

250000

amount_breakdown
object
required

The principal, interest, and fees that make up the receivable's amount, in minor units, along with the interest rate applied.

receivable_sale_details
object
required

The sale this receivable is part of. Each field is set at a different point in the receivable's lifecycle, so either may be null.

created_at
string<date-time>
required

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

Example:

"2026-06-01T09:15:00Z"

updated_at
string<date-time>
required

The ISO-8601 timestamp at which any field on the Receivable object was last updated.

Example:

"2026-06-03T10:00:00Z"

origination_date
string<date>

The date the receivable originated. For a card network settlement this is the settlement date; for other sources it is the date the source object was created. When receivable data arrives late, this is the date the receivable should have originated on, while created_at is when the Receivable object was created. Omitted when the receivable is held for investment.

Example:

"2026-06-01"

card_network_settlement_details
object

Present when type is card_network_settlement; omitted otherwise.

user_credit_balance_details
object

Present when type is user_credit_balance; omitted otherwise.