Sweep funds into a reserve account

curl --request POST \
  --url https://api.kordio.io/ledger/v1/reserves \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "source_account_id": "payable:acme",
  "template": "merchant_payable",
  "counterparty_ref": "acme",
  "currency": "USDC",
  "amount": "500000",
  "idempotency_key": "sweep_acme_2026_05_27"
}
'

import requests

url = "https://api.kordio.io/ledger/v1/reserves"

payload = {
    "source_account_id": "payable:acme",
    "template": "merchant_payable",
    "counterparty_ref": "acme",
    "currency": "USDC",
    "amount": "500000",
    "idempotency_key": "sweep_acme_2026_05_27"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    source_account_id: 'payable:acme',
    template: 'merchant_payable',
    counterparty_ref: 'acme',
    currency: 'USDC',
    amount: '500000',
    idempotency_key: 'sweep_acme_2026_05_27'
  })
};

fetch('https://api.kordio.io/ledger/v1/reserves', 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.kordio.io/ledger/v1/reserves",
  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([
    'source_account_id' => 'payable:acme',
    'template' => 'merchant_payable',
    'counterparty_ref' => 'acme',
    'currency' => 'USDC',
    'amount' => '500000',
    'idempotency_key' => 'sweep_acme_2026_05_27'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://api.kordio.io/ledger/v1/reserves"

	payload := strings.NewReader("{\n  \"source_account_id\": \"payable:acme\",\n  \"template\": \"merchant_payable\",\n  \"counterparty_ref\": \"acme\",\n  \"currency\": \"USDC\",\n  \"amount\": \"500000\",\n  \"idempotency_key\": \"sweep_acme_2026_05_27\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	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://api.kordio.io/ledger/v1/reserves")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"source_account_id\": \"payable:acme\",\n  \"template\": \"merchant_payable\",\n  \"counterparty_ref\": \"acme\",\n  \"currency\": \"USDC\",\n  \"amount\": \"500000\",\n  \"idempotency_key\": \"sweep_acme_2026_05_27\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.kordio.io/ledger/v1/reserves")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"source_account_id\": \"payable:acme\",\n  \"template\": \"merchant_payable\",\n  \"counterparty_ref\": \"acme\",\n  \"currency\": \"USDC\",\n  \"amount\": \"500000\",\n  \"idempotency_key\": \"sweep_acme_2026_05_27\"\n}"

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

{
  "object": "account",
  "reserve_account_id": "reserve:merchant_payable:acme:usdc",
  "transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "balance": "500000",
  "remaining_balance": "500000"
}

Sweep funds into a reserve account

Creates a reserve account (if it doesn’t yet exist) for the (template, counterparty_ref, currency) triple and books a balanced transaction that debits the source account and credits the reserve. Reserves model holdbacks, escrow, FX holds, and any other case where unrestricted funds need to be earmarked for a named counterparty.

Listing and balance reads use the standard /v1/accounts surface (?kind=reserve&counterparty_ref=<x>). The platform does NOT auto-release on expires_at; that’s customer policy.

POST

ledger

reserves

Sweep funds into a reserve account

curl --request POST \
  --url https://api.kordio.io/ledger/v1/reserves \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "source_account_id": "payable:acme",
  "template": "merchant_payable",
  "counterparty_ref": "acme",
  "currency": "USDC",
  "amount": "500000",
  "idempotency_key": "sweep_acme_2026_05_27"
}
'

import requests

url = "https://api.kordio.io/ledger/v1/reserves"

payload = {
    "source_account_id": "payable:acme",
    "template": "merchant_payable",
    "counterparty_ref": "acme",
    "currency": "USDC",
    "amount": "500000",
    "idempotency_key": "sweep_acme_2026_05_27"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    source_account_id: 'payable:acme',
    template: 'merchant_payable',
    counterparty_ref: 'acme',
    currency: 'USDC',
    amount: '500000',
    idempotency_key: 'sweep_acme_2026_05_27'
  })
};

fetch('https://api.kordio.io/ledger/v1/reserves', 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.kordio.io/ledger/v1/reserves",
  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([
    'source_account_id' => 'payable:acme',
    'template' => 'merchant_payable',
    'counterparty_ref' => 'acme',
    'currency' => 'USDC',
    'amount' => '500000',
    'idempotency_key' => 'sweep_acme_2026_05_27'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://api.kordio.io/ledger/v1/reserves"

	payload := strings.NewReader("{\n  \"source_account_id\": \"payable:acme\",\n  \"template\": \"merchant_payable\",\n  \"counterparty_ref\": \"acme\",\n  \"currency\": \"USDC\",\n  \"amount\": \"500000\",\n  \"idempotency_key\": \"sweep_acme_2026_05_27\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	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://api.kordio.io/ledger/v1/reserves")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"source_account_id\": \"payable:acme\",\n  \"template\": \"merchant_payable\",\n  \"counterparty_ref\": \"acme\",\n  \"currency\": \"USDC\",\n  \"amount\": \"500000\",\n  \"idempotency_key\": \"sweep_acme_2026_05_27\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.kordio.io/ledger/v1/reserves")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"source_account_id\": \"payable:acme\",\n  \"template\": \"merchant_payable\",\n  \"counterparty_ref\": \"acme\",\n  \"currency\": \"USDC\",\n  \"amount\": \"500000\",\n  \"idempotency_key\": \"sweep_acme_2026_05_27\"\n}"

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

{
  "object": "account",
  "reserve_account_id": "reserve:merchant_payable:acme:usdc",
  "transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "balance": "500000",
  "remaining_balance": "500000"
}

Authorizations

Authorization

string

header

required

Same flow; ledger:write is required for any mutation.

Headers

Idempotency-Key

string

Required on writes. Stable identifier you choose. The same key always returns the same transaction, forever. Can also be supplied as idempotency_key in the request body. Header wins.

Allowed character set: A-Z, a-z, 0-9, _, :, ., -. Max 255 bytes. Replays of an accepted key return the original response with header Idempotent-Replayed: true so callers can tell a replay from a freshly-committed result.

Required string length: 1 - 255

Pattern: ^[A-Za-z0-9_:.\-]+$

Example:

"pi_acme_1234_capture"

Body

application/json

source_account_id

string

required

Account whose balance is debited to fund the reserve.

Example:

"payable:acme"

template

string

required

Name of a registered account_template whose accounting_type matches the reserve's intended sign (typically liability with balance_non_negative: true).

Example:

"merchant_payable"

counterparty_ref

string

required

Opaque customer-defined identifier of the counterparty the reserve is held for.

Example:

"acme"

currency

string

required

Currency of the sweep. Must equal the source account's currency.

Example:

"USDC"

amount

required

Amount in minor units to sweep into the reserve. Accepts a decimal string (recommended) or an integer on write.

Pattern: ^\d+$

Example:

"500000"

expires_at

string<date-time> | null

Informational only. Persisted in transaction metadata so a customer-side scheduler can find expired reserves and POST /release; the platform does NOT auto-release.

idempotency_key

string

Optional body alternative to the Idempotency-Key header. Header wins.

metadata

object

Response

Reserve sweep booked

object

enum<string>

required

Discriminator naming the shape of this resource (e.g. account, transaction).

Available options:

reserve_op_result

Example:

"account"

reserve_account_id

string

required

Example:

"reserve:merchant_payable:acme:usdc"

transaction_id

string<uuid>

required

balance

string

required

Reserve posted balance after this op, in minor units, as a decimal string. Parse with a big-integer or decimal type, never a JS number.

Pattern: ^-?\d+$

Example:

"500000"

remaining_balance

string

Alias of balance; preserved for symmetry with the decision-doc contract. Decimal string of minor units.

Pattern: ^-?\d+$

Example:

"500000"

Get started

Core concepts

Guarantees

Reference

Endpoints

Sweep funds into a reserve account

Authorizations

Headers

Body

Response