Post a batched daily interest accrual for a program

curl --request POST \
  --url https://ledger.clarivo.co/v1/accruals/batch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "program_id": "11111111-1111-1111-1111-111111111111",
  "accrual_date": "2023-12-25",
  "loans": [
    {
      "loan_id": "11111111-1111-1111-1111-111111111111",
      "outstanding_principal_minor": "88849",
      "interest_minor": "88849"
    }
  ]
}
'

import requests

url = "https://ledger.clarivo.co/v1/accruals/batch"

payload = {
    "program_id": "11111111-1111-1111-1111-111111111111",
    "accrual_date": "2023-12-25",
    "loans": [
        {
            "loan_id": "11111111-1111-1111-1111-111111111111",
            "outstanding_principal_minor": "88849",
            "interest_minor": "88849"
        }
    ]
}
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({
    program_id: '11111111-1111-1111-1111-111111111111',
    accrual_date: '2023-12-25',
    loans: [
      {
        loan_id: '11111111-1111-1111-1111-111111111111',
        outstanding_principal_minor: '88849',
        interest_minor: '88849'
      }
    ]
  })
};

fetch('https://ledger.clarivo.co/v1/accruals/batch', 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/accruals/batch",
  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([
    'program_id' => '11111111-1111-1111-1111-111111111111',
    'accrual_date' => '2023-12-25',
    'loans' => [
        [
                'loan_id' => '11111111-1111-1111-1111-111111111111',
                'outstanding_principal_minor' => '88849',
                'interest_minor' => '88849'
        ]
    ]
  ]),
  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/accruals/batch"

	payload := strings.NewReader("{\n  \"program_id\": \"11111111-1111-1111-1111-111111111111\",\n  \"accrual_date\": \"2023-12-25\",\n  \"loans\": [\n    {\n      \"loan_id\": \"11111111-1111-1111-1111-111111111111\",\n      \"outstanding_principal_minor\": \"88849\",\n      \"interest_minor\": \"88849\"\n    }\n  ]\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/accruals/batch")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"program_id\": \"11111111-1111-1111-1111-111111111111\",\n  \"accrual_date\": \"2023-12-25\",\n  \"loans\": [\n    {\n      \"loan_id\": \"11111111-1111-1111-1111-111111111111\",\n      \"outstanding_principal_minor\": \"88849\",\n      \"interest_minor\": \"88849\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ledger.clarivo.co/v1/accruals/batch")

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  \"program_id\": \"11111111-1111-1111-1111-111111111111\",\n  \"accrual_date\": \"2023-12-25\",\n  \"loans\": [\n    {\n      \"loan_id\": \"11111111-1111-1111-1111-111111111111\",\n      \"outstanding_principal_minor\": \"88849\",\n      \"interest_minor\": \"88849\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "accrual_event_id": "11111111-1111-1111-1111-111111111111",
  "journal_entry_id": "11111111-1111-1111-1111-111111111111",
  "loan_count": 2,
  "total_accrued_minor": "88849",
  "posted_at": "2023-11-07T05:31:56Z"
}

{
  "accrual_event_id": "11111111-1111-1111-1111-111111111111",
  "journal_entry_id": "11111111-1111-1111-1111-111111111111",
  "loan_count": 2,
  "total_accrued_minor": "88849",
  "posted_at": "2023-11-07T05:31:56Z"
}

{
  "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>"
    }
  ]
}

POST

accruals

batch

Post a batched daily interest accrual for a program

curl --request POST \
  --url https://ledger.clarivo.co/v1/accruals/batch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "program_id": "11111111-1111-1111-1111-111111111111",
  "accrual_date": "2023-12-25",
  "loans": [
    {
      "loan_id": "11111111-1111-1111-1111-111111111111",
      "outstanding_principal_minor": "88849",
      "interest_minor": "88849"
    }
  ]
}
'

import requests

url = "https://ledger.clarivo.co/v1/accruals/batch"

payload = {
    "program_id": "11111111-1111-1111-1111-111111111111",
    "accrual_date": "2023-12-25",
    "loans": [
        {
            "loan_id": "11111111-1111-1111-1111-111111111111",
            "outstanding_principal_minor": "88849",
            "interest_minor": "88849"
        }
    ]
}
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({
    program_id: '11111111-1111-1111-1111-111111111111',
    accrual_date: '2023-12-25',
    loans: [
      {
        loan_id: '11111111-1111-1111-1111-111111111111',
        outstanding_principal_minor: '88849',
        interest_minor: '88849'
      }
    ]
  })
};

fetch('https://ledger.clarivo.co/v1/accruals/batch', 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/accruals/batch",
  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([
    'program_id' => '11111111-1111-1111-1111-111111111111',
    'accrual_date' => '2023-12-25',
    'loans' => [
        [
                'loan_id' => '11111111-1111-1111-1111-111111111111',
                'outstanding_principal_minor' => '88849',
                'interest_minor' => '88849'
        ]
    ]
  ]),
  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/accruals/batch"

	payload := strings.NewReader("{\n  \"program_id\": \"11111111-1111-1111-1111-111111111111\",\n  \"accrual_date\": \"2023-12-25\",\n  \"loans\": [\n    {\n      \"loan_id\": \"11111111-1111-1111-1111-111111111111\",\n      \"outstanding_principal_minor\": \"88849\",\n      \"interest_minor\": \"88849\"\n    }\n  ]\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/accruals/batch")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"program_id\": \"11111111-1111-1111-1111-111111111111\",\n  \"accrual_date\": \"2023-12-25\",\n  \"loans\": [\n    {\n      \"loan_id\": \"11111111-1111-1111-1111-111111111111\",\n      \"outstanding_principal_minor\": \"88849\",\n      \"interest_minor\": \"88849\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ledger.clarivo.co/v1/accruals/batch")

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  \"program_id\": \"11111111-1111-1111-1111-111111111111\",\n  \"accrual_date\": \"2023-12-25\",\n  \"loans\": [\n    {\n      \"loan_id\": \"11111111-1111-1111-1111-111111111111\",\n      \"outstanding_principal_minor\": \"88849\",\n      \"interest_minor\": \"88849\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "accrual_event_id": "11111111-1111-1111-1111-111111111111",
  "journal_entry_id": "11111111-1111-1111-1111-111111111111",
  "loan_count": 2,
  "total_accrued_minor": "88849",
  "posted_at": "2023-11-07T05:31:56Z"
}

{
  "accrual_event_id": "11111111-1111-1111-1111-111111111111",
  "journal_entry_id": "11111111-1111-1111-1111-111111111111",
  "loan_count": 2,
  "total_accrued_minor": "88849",
  "posted_at": "2023-11-07T05:31:56Z"
}

{
  "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>"
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Idempotency-Key

string

required

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 - 255

Pattern: ^[A-Za-z0-9][A-Za-z0-9._:\-]{7,254}$

Example:

"payment:loan_42:proc_txn_abc123"

X-Trace-Id

string

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}$

traceparent

string

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"

tracestate

string

W3C Trace Context tracestate header. Carries vendor-specific trace metadata (e.g. AWS X-Ray sampling decision). Passed through unchanged.

Body

application/json

program_id

string<uuid>

required

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"

accrual_date

string<date>

required

day_count_convention

enum<string>

required

Available options:

ACT_365,

ACT_360,

30_360

loans

object[]

required

Required array length: 1 - 100000 elements

Show child attributes

Response

Idempotency replay.

accrual_event_id

string<uuid>

required

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"

journal_entry_id

string<uuid>

required

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"

loan_count

integer

required

Required range: x >= 1

total_accrued_minor

string

required

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 - 19

Pattern: ^(0|[1-9][0-9]{0,18})$

Examples:

"88849"

"10000000"

posted_at

string<date-time>

required

RFC 3339 timestamp, UTC.

API documentation

Endpoints

Post a batched daily interest accrual for a program

Authorizations

Headers

Body

Response