LElead
Receivable

Retrieve a Receivable

Changed on

Retrieve a Receivable by its ID.

get/v2/receivables/{receivable_id}

Request

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

Path parameters

receivable_idstring required

The ID of the Receivable object to retrieve.

Response

A Receivable object.

idstring required

Unique ID of the Receivable object.

currency_code'USD' required

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

type'card_network_settlement' | 'user_credit_balance' 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.
held_for'sale' 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.
origination_datestring 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.

amountinteger 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.
created_atstring date-time required

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

updated_atstring date-time required

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

Example response

{
  "id": "receivable_2NfK8sLq4RtVwXyZ1aBcDeFgHiJ",
  "currency_code": "USD",
  "type": "card_network_settlement",
  "held_for": "sale",
  "origination_date": "2026-06-01",
  "amount": 250000,
  "amount_breakdown": {
    "principal": 250000,
    "interest_rate": 9.99
  },
  "receivable_sale_details": {
    "receivable_sale_id": "receivable_sale_3f9a1c7e5b2d4a6f8e0c1b3d5f7a9c2e",
    "request_date": "2026-06-03"
  },
  "card_network_settlement_details": {
    "settlement_reporting_id": "123456789",
    "card_network": "visa",
    "settlement_date": "2026-06-01"
  },
  "user_credit_balance_details": {
    "user_credit_balance_id": "user_credit_balance_1HCpXwx2EK9oYluWbacgeCnFcLf",
    "user_credit_transaction_id": "user_credit_transaction_2JdQyVm8LpT4nWxZ7aBcEfGhKjR"
  },
  "created_at": "2026-06-01T09:15:00Z",
  "updated_at": "2026-06-03T10:00:00Z"
}

Changes