curl --request GET \
--url https://api.sandbox.lead.bank/v2/receivables/{receivable_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.sandbox.lead.bank/v2/receivables/{receivable_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.sandbox.lead.bank/v2/receivables/{receivable_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.lead.bank/v2/receivables/{receivable_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.lead.bank/v2/receivables/{receivable_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.sandbox.lead.bank/v2/receivables/{receivable_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.lead.bank/v2/receivables/{receivable_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "receivable_9TbQ3wEr5YuIoPaSdFgHjKlZxCv",
"currency_code": "USD",
"type": "user_credit_balance",
"held_for": "sale",
"origination_date": "2026-06-04",
"amount": 251000,
"amount_breakdown": {
"principal": 250000,
"interest": 500,
"interest_rate": 9.99,
"fees": 500
},
"receivable_sale_details": {
"receivable_sale_id": null,
"request_date": "2026-06-05"
},
"user_credit_balance_details": {
"user_credit_balance_id": "user_credit_balance_1HCpXwx2EK9oYluWbacgeCnFcLf",
"user_credit_transaction_id": "user_credit_transaction_2JdQyVm8LpT4nWxZ7aBcEfGhKjR"
},
"created_at": "2026-06-04T08:05:00Z",
"updated_at": "2026-06-04T08:05:00Z"
}{
"code": "request_malformed",
"message": "The request is invalid and cannot be parsed by the server.",
"errors": [
{
"code": "url_malformed",
"message": "The request URL could not be parsed."
}
]
}{
"code": "authentication_missing",
"message": "The request has no authentication credentials. Send your API token in the Authorization header.",
"errors": [
{
"code": "authentication_missing",
"message": "The Authorization header is missing. Send your API token as a bearer token.",
"parameters": [
"Authorization"
]
}
]
}{
"code": "object_not_found",
"message": "No object exists at the requested ID, or it is not visible to this caller."
}{
"code": "parameters_invalid",
"message": "One or more parameters are invalid.",
"errors": [
{
"code": "malformed",
"message": "receivable_id must match the format receivable_*.",
"parameters": [
"receivable_id"
]
}
]
}{
"code": "rate_limit_exceeded",
"message": "You have exceeded the rate limit for this endpoint. Retry with backoff."
}{
"code": "internal_server_error",
"message": "An unexpected error occurred. Contact support with the Request-Id header value."
}{
"code": "gateway_timeout",
"message": "An upstream system did not respond in time. Retry with backoff."
}Retrieve a Receivable
Retrieve a Receivable by its ID.
curl --request GET \
--url https://api.sandbox.lead.bank/v2/receivables/{receivable_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.sandbox.lead.bank/v2/receivables/{receivable_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.sandbox.lead.bank/v2/receivables/{receivable_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.lead.bank/v2/receivables/{receivable_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.lead.bank/v2/receivables/{receivable_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.sandbox.lead.bank/v2/receivables/{receivable_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.lead.bank/v2/receivables/{receivable_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "receivable_9TbQ3wEr5YuIoPaSdFgHjKlZxCv",
"currency_code": "USD",
"type": "user_credit_balance",
"held_for": "sale",
"origination_date": "2026-06-04",
"amount": 251000,
"amount_breakdown": {
"principal": 250000,
"interest": 500,
"interest_rate": 9.99,
"fees": 500
},
"receivable_sale_details": {
"receivable_sale_id": null,
"request_date": "2026-06-05"
},
"user_credit_balance_details": {
"user_credit_balance_id": "user_credit_balance_1HCpXwx2EK9oYluWbacgeCnFcLf",
"user_credit_transaction_id": "user_credit_transaction_2JdQyVm8LpT4nWxZ7aBcEfGhKjR"
},
"created_at": "2026-06-04T08:05:00Z",
"updated_at": "2026-06-04T08:05:00Z"
}{
"code": "request_malformed",
"message": "The request is invalid and cannot be parsed by the server.",
"errors": [
{
"code": "url_malformed",
"message": "The request URL could not be parsed."
}
]
}{
"code": "authentication_missing",
"message": "The request has no authentication credentials. Send your API token in the Authorization header.",
"errors": [
{
"code": "authentication_missing",
"message": "The Authorization header is missing. Send your API token as a bearer token.",
"parameters": [
"Authorization"
]
}
]
}{
"code": "object_not_found",
"message": "No object exists at the requested ID, or it is not visible to this caller."
}{
"code": "parameters_invalid",
"message": "One or more parameters are invalid.",
"errors": [
{
"code": "malformed",
"message": "receivable_id must match the format receivable_*.",
"parameters": [
"receivable_id"
]
}
]
}{
"code": "rate_limit_exceeded",
"message": "You have exceeded the rate limit for this endpoint. Retry with backoff."
}{
"code": "internal_server_error",
"message": "An unexpected error occurred. Contact support with the Request-Id header value."
}{
"code": "gateway_timeout",
"message": "An upstream system did not respond in time. Retry with backoff."
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The ID of the Receivable object to retrieve.
64Response
A Receivable object.
Unique ID of the Receivable object.
64^receivable_\w+$"receivable_2NfK8sLq4RtVwXyZ1aBcDeFgHiJ"
A three-letter currency code as defined in ISO 4217.
USD "USD"
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_detailsis present.user_credit_balance: the receivable was created from a User Credit Transaction drawn on a User Credit Balance.user_credit_balance_detailsis present.
card_network_settlement, user_credit_balance "card_network_settlement"
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 frominvestmenttosale.
sale "sale"
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.
250000
The principal, interest, and fees that make up the receivable's amount, in minor units, along with the interest rate applied.
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
The ISO-8601 timestamp at which the Receivable object was created.
"2026-06-01T09:15:00Z"
The ISO-8601 timestamp at which any field on the Receivable object was last updated.
"2026-06-03T10:00:00Z"
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.
"2026-06-01"
Present when type is card_network_settlement; omitted otherwise.
Show child attributes
Show child attributes
Present when type is user_credit_balance; omitted otherwise.
Show child attributes
Show child attributes
Was this page helpful?

