Skip to main content
A receivable is Lead’s claim on a loan your program originated while that loan is on Lead’s books. Lead creates it when a funding posts or a card network settles. You read receivables with GET /v2/receivables and GET /v2/receivables/{receivable_id}.

Fields

Types

  • user_credit_balance. Created from a user credit transaction that drew principal on a user credit balance, such as the funding user credit transaction Lead posts when a funding posts. One receivable per draw.
  • card_network_settlement. Created from a card network settlement of your program’s card spend. One receivable per settlement.

The amount_breakdown block

amount is fixed when the receivable is created. A refund, payment, or charge-off reported during the hold period does not change it. You settle those with your borrower, and the receivable sells at its original amount. amount is what you pay Lead for the loan. It does not include partner-owed fees and premiums. Lead bills those separately under your program agreement.

The receivable_sale_details block

If Lead receives origination data late, origination_date can be earlier than created_at. If the hold period has already passed, the receivable joins the next receivable sale.

The user_credit_balance_details block

The card_network_settlement_details block

Lifecycle

A receivable has no status field. Read where it is from receivable_sale_details and the receivable sale it belongs to. The receivable sale is the authority on whether a receivable has been sold. If the sale fails, its receivables stay in that sale, and Lead retries the sale at the same total. See Receivable Sale Statuses.

List and retrieve

GET /v2/receivables returns your program’s receivables, most recently created first. Filters:
  • type. user_credit_balance or card_network_settlement.
  • receivable_sale_id. Receivables in one receivable sale.
  • request_date, request_date[after], request_date[on_or_after], request_date[before], request_date[on_or_before]. Receivables due to be sold on a day or in a range.
  • limit (1 to 100, default 10), starting_after, ending_before. Cursor pagination. Cursors are receivable IDs.
GET /v2/receivables/{receivable_id} returns one receivable. It returns 404 if the ID does not exist or belongs to another program.

Sandbox

For a funding program, create a funding and advance it with POST /v2/fundings/{id}/advance. Lead creates the receivable. For a card program, call POST /v2/simulate/card_network_settlements to simulate a settlement. Receivable Overview · The Receivable Sale Object · The Funding Object · The User Credit Balance Object