Record a loan payment and post to ledger
curl --request POST \
--url https://ledger.clarivo.co/v1/payments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"loan_id": "11111111-1111-1111-1111-111111111111",
"borrower_id": "22222222-2222-2222-2222-222222222222",
"amount_minor": "88849",
"currency": "USD",
"effective_at": "2026-04-15",
"source_method": "ach",
"external_ref": "stripe_ch_xyz123"
}
'import requests
url = "https://ledger.clarivo.co/v1/payments"
payload = {
"loan_id": "11111111-1111-1111-1111-111111111111",
"borrower_id": "22222222-2222-2222-2222-222222222222",
"amount_minor": "88849",
"currency": "USD",
"effective_at": "2026-04-15",
"source_method": "ach",
"external_ref": "stripe_ch_xyz123"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
loan_id: '11111111-1111-1111-1111-111111111111',
borrower_id: '22222222-2222-2222-2222-222222222222',
amount_minor: '88849',
currency: 'USD',
effective_at: '2026-04-15',
source_method: 'ach',
external_ref: 'stripe_ch_xyz123'
})
};
fetch('https://ledger.clarivo.co/v1/payments', 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://ledger.clarivo.co/v1/payments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'loan_id' => '11111111-1111-1111-1111-111111111111',
'borrower_id' => '22222222-2222-2222-2222-222222222222',
'amount_minor' => '88849',
'currency' => 'USD',
'effective_at' => '2026-04-15',
'source_method' => 'ach',
'external_ref' => 'stripe_ch_xyz123'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://ledger.clarivo.co/v1/payments"
payload := strings.NewReader("{\n \"loan_id\": \"11111111-1111-1111-1111-111111111111\",\n \"borrower_id\": \"22222222-2222-2222-2222-222222222222\",\n \"amount_minor\": \"88849\",\n \"currency\": \"USD\",\n \"effective_at\": \"2026-04-15\",\n \"source_method\": \"ach\",\n \"external_ref\": \"stripe_ch_xyz123\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://ledger.clarivo.co/v1/payments")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"loan_id\": \"11111111-1111-1111-1111-111111111111\",\n \"borrower_id\": \"22222222-2222-2222-2222-222222222222\",\n \"amount_minor\": \"88849\",\n \"currency\": \"USD\",\n \"effective_at\": \"2026-04-15\",\n \"source_method\": \"ach\",\n \"external_ref\": \"stripe_ch_xyz123\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://ledger.clarivo.co/v1/payments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"loan_id\": \"11111111-1111-1111-1111-111111111111\",\n \"borrower_id\": \"22222222-2222-2222-2222-222222222222\",\n \"amount_minor\": \"88849\",\n \"currency\": \"USD\",\n \"effective_at\": \"2026-04-15\",\n \"source_method\": \"ach\",\n \"external_ref\": \"stripe_ch_xyz123\"\n}"
response = http.request(request)
puts response.read_body{
"payment_event_id": "11111111-1111-1111-1111-111111111111",
"journal_entry_id": "11111111-1111-1111-1111-111111111111",
"allocation": {
"fees_minor": "88849",
"interest_minor": "88849",
"principal_minor": "88849",
"suspense_minor": "88849"
},
"posted_at": "2023-11-07T05:31:56Z",
"correlation_id": "11111111-1111-1111-1111-111111111111"
}{
"payment_event_id": "11111111-1111-1111-1111-111111111111",
"journal_entry_id": "11111111-1111-1111-1111-111111111111",
"allocation": {
"fees_minor": "88849",
"interest_minor": "88849",
"principal_minor": "88849",
"suspense_minor": "88849"
},
"posted_at": "2023-11-07T05:31:56Z",
"correlation_id": "11111111-1111-1111-1111-111111111111"
}{
"type": "https://errors.hpts.example.com/bad_request",
"title": "<string>",
"status": 499,
"detail": "<string>",
"instance": "<string>",
"trace_id": "<string>"
}{
"type": "https://errors.hpts.example.com/bad_request",
"title": "<string>",
"status": 499,
"detail": "<string>",
"instance": "<string>",
"trace_id": "<string>"
}{
"type": "https://errors.hpts.example.com/bad_request",
"title": "<string>",
"status": 499,
"detail": "<string>",
"instance": "<string>",
"trace_id": "<string>"
}{
"type": "https://errors.hpts.example.com/bad_request",
"title": "<string>",
"status": 499,
"conflict_kind": "idempotency_in_progress",
"detail": "<string>",
"instance": "<string>",
"trace_id": "<string>",
"original_request_fingerprint": "<string>",
"received_request_fingerprint": "<string>",
"original_journal_entry_id": "11111111-1111-1111-1111-111111111111"
}{
"type": "https://errors.hpts.example.com/bad_request",
"title": "<string>",
"status": 499,
"detail": "<string>",
"instance": "<string>",
"trace_id": "<string>",
"errors": [
{
"field": "/amount_minor",
"code": "required",
"message": "<string>"
}
]
}{
"type": "https://errors.hpts.example.com/bad_request",
"title": "<string>",
"status": 499,
"detail": "<string>",
"instance": "<string>",
"trace_id": "<string>"
}{
"type": "https://errors.hpts.example.com/bad_request",
"title": "<string>",
"status": 499,
"detail": "<string>",
"instance": "<string>",
"trace_id": "<string>"
}payments
Record a loan payment and post to ledger
Records a payment event and atomically posts the allocated journal
entries per the configured waterfall (fees → interest → principal
by default). Returns the resulting journal_entry_id.
Requires hpts:payments:write scope.
POST
/
payments
Record a loan payment and post to ledger
curl --request POST \
--url https://ledger.clarivo.co/v1/payments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"loan_id": "11111111-1111-1111-1111-111111111111",
"borrower_id": "22222222-2222-2222-2222-222222222222",
"amount_minor": "88849",
"currency": "USD",
"effective_at": "2026-04-15",
"source_method": "ach",
"external_ref": "stripe_ch_xyz123"
}
'import requests
url = "https://ledger.clarivo.co/v1/payments"
payload = {
"loan_id": "11111111-1111-1111-1111-111111111111",
"borrower_id": "22222222-2222-2222-2222-222222222222",
"amount_minor": "88849",
"currency": "USD",
"effective_at": "2026-04-15",
"source_method": "ach",
"external_ref": "stripe_ch_xyz123"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
loan_id: '11111111-1111-1111-1111-111111111111',
borrower_id: '22222222-2222-2222-2222-222222222222',
amount_minor: '88849',
currency: 'USD',
effective_at: '2026-04-15',
source_method: 'ach',
external_ref: 'stripe_ch_xyz123'
})
};
fetch('https://ledger.clarivo.co/v1/payments', 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://ledger.clarivo.co/v1/payments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'loan_id' => '11111111-1111-1111-1111-111111111111',
'borrower_id' => '22222222-2222-2222-2222-222222222222',
'amount_minor' => '88849',
'currency' => 'USD',
'effective_at' => '2026-04-15',
'source_method' => 'ach',
'external_ref' => 'stripe_ch_xyz123'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://ledger.clarivo.co/v1/payments"
payload := strings.NewReader("{\n \"loan_id\": \"11111111-1111-1111-1111-111111111111\",\n \"borrower_id\": \"22222222-2222-2222-2222-222222222222\",\n \"amount_minor\": \"88849\",\n \"currency\": \"USD\",\n \"effective_at\": \"2026-04-15\",\n \"source_method\": \"ach\",\n \"external_ref\": \"stripe_ch_xyz123\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://ledger.clarivo.co/v1/payments")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"loan_id\": \"11111111-1111-1111-1111-111111111111\",\n \"borrower_id\": \"22222222-2222-2222-2222-222222222222\",\n \"amount_minor\": \"88849\",\n \"currency\": \"USD\",\n \"effective_at\": \"2026-04-15\",\n \"source_method\": \"ach\",\n \"external_ref\": \"stripe_ch_xyz123\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://ledger.clarivo.co/v1/payments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"loan_id\": \"11111111-1111-1111-1111-111111111111\",\n \"borrower_id\": \"22222222-2222-2222-2222-222222222222\",\n \"amount_minor\": \"88849\",\n \"currency\": \"USD\",\n \"effective_at\": \"2026-04-15\",\n \"source_method\": \"ach\",\n \"external_ref\": \"stripe_ch_xyz123\"\n}"
response = http.request(request)
puts response.read_body{
"payment_event_id": "11111111-1111-1111-1111-111111111111",
"journal_entry_id": "11111111-1111-1111-1111-111111111111",
"allocation": {
"fees_minor": "88849",
"interest_minor": "88849",
"principal_minor": "88849",
"suspense_minor": "88849"
},
"posted_at": "2023-11-07T05:31:56Z",
"correlation_id": "11111111-1111-1111-1111-111111111111"
}{
"payment_event_id": "11111111-1111-1111-1111-111111111111",
"journal_entry_id": "11111111-1111-1111-1111-111111111111",
"allocation": {
"fees_minor": "88849",
"interest_minor": "88849",
"principal_minor": "88849",
"suspense_minor": "88849"
},
"posted_at": "2023-11-07T05:31:56Z",
"correlation_id": "11111111-1111-1111-1111-111111111111"
}{
"type": "https://errors.hpts.example.com/bad_request",
"title": "<string>",
"status": 499,
"detail": "<string>",
"instance": "<string>",
"trace_id": "<string>"
}{
"type": "https://errors.hpts.example.com/bad_request",
"title": "<string>",
"status": 499,
"detail": "<string>",
"instance": "<string>",
"trace_id": "<string>"
}{
"type": "https://errors.hpts.example.com/bad_request",
"title": "<string>",
"status": 499,
"detail": "<string>",
"instance": "<string>",
"trace_id": "<string>"
}{
"type": "https://errors.hpts.example.com/bad_request",
"title": "<string>",
"status": 499,
"conflict_kind": "idempotency_in_progress",
"detail": "<string>",
"instance": "<string>",
"trace_id": "<string>",
"original_request_fingerprint": "<string>",
"received_request_fingerprint": "<string>",
"original_journal_entry_id": "11111111-1111-1111-1111-111111111111"
}{
"type": "https://errors.hpts.example.com/bad_request",
"title": "<string>",
"status": 499,
"detail": "<string>",
"instance": "<string>",
"trace_id": "<string>",
"errors": [
{
"field": "/amount_minor",
"code": "required",
"message": "<string>"
}
]
}{
"type": "https://errors.hpts.example.com/bad_request",
"title": "<string>",
"status": 499,
"detail": "<string>",
"instance": "<string>",
"trace_id": "<string>"
}{
"type": "https://errors.hpts.example.com/bad_request",
"title": "<string>",
"status": 499,
"detail": "<string>",
"instance": "<string>",
"trace_id": "<string>"
}Authorizations
bearerAuthbearerAuth
OAuth2 JWT bearer tokens. Tokens are validated at API Gateway via a
Lambda Authorizer that verifies signature against the issuer's JWKS,
checks iss, aud, exp, nbf, and the tenant_id custom claim.
Granular scopes are required per operation.
Headers
Required on every POST. Must be a deterministic, client-chosen
identifier unique per tenant. Recommended format:
<event_type>:<resource_id>:<natural_key>.
Retained for 24h minimum.
Required string length:
8 - 255Pattern:
^[A-Za-z0-9][A-Za-z0-9._:\-]{7,254}$Example:
"payment:loan_42:proc_txn_abc123"
Deprecated — use traceparent instead (ADR-0011).
Client-supplied correlation ID. Accepted until 2026-10-01 for
backward compatibility; will be removed after that date.
Pattern:
^[A-Za-z0-9\-]{8,128}$W3C Trace Context traceparent header for distributed tracing (RFC 7230).
When present, the service extracts the parent span context and creates
child spans under it, enabling end-to-end trace correlation across
API Gateway, the service, and the database.
Format: 00-<trace-id>-<parent-id>-<flags>
Pattern:
^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$Example:
"00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01"
W3C Trace Context tracestate header. Carries vendor-specific trace
metadata (e.g. AWS X-Ray sampling decision). Passed through unchanged.
Body
application/json
Pattern:
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$Example:
"11111111-1111-1111-1111-111111111111"
Pattern:
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$Example:
"11111111-1111-1111-1111-111111111111"
Non-negative integer amount in the currency's minor unit, serialized as a string to preserve precision (JS numbers cannot safely represent values above 2^53). BIGINT on the wire, BIGINT in the database.
Required string length:
1 - 19Pattern:
^(0|[1-9][0-9]{0,18})$Examples:
"88849"
"10000000"
ISO 4217 three-letter currency code.
Required string length:
3Pattern:
^[A-Z]{3}$Examples:
"USD"
"MXN"
"EUR"
Accounting date. Must be within an open period.
Available options:
ach, card, wire, cash, internal Processor/bank reference (e.g., Stripe charge ID).
Required string length:
1 - 255Override default per-program waterfall. Each element is one of "fees", "interest", "principal", in desired allocation order.
Required array length:
1 - 3 elementsAvailable options:
fees, interest, principal Free-form key-value metadata. Never used for financial logic.
Size limit 2 KB serialized. Keys must match ^[a-zA-Z][a-zA-Z0-9_]*$.
Show child attributes
Show child attributes
Response
Idempotency hit. Same key + same payload returned the original result.
Pattern:
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$Example:
"11111111-1111-1111-1111-111111111111"
Pattern:
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$Example:
"11111111-1111-1111-1111-111111111111"
Show child attributes
Show child attributes
RFC 3339 timestamp, UTC.
Pattern:
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$Example:
"11111111-1111-1111-1111-111111111111"