Skip to main content
POST
/
statements
/
users
/
{tenantUserId}
/
{periodStart}
/
{periodEnd}
/
payments
Record a payment against a statement
curl --request POST \
  --url https://api.royalti.io/statements/users/{tenantUserId}/{periodStart}/{periodEnd}/payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "bank_transfer",
  "amount": 123,
  "paymentDate": "2023-11-07T05:31:56Z",
  "reference": "<string>",
  "note": "<string>"
}
'
import requests

url = "https://api.royalti.io/statements/users/{tenantUserId}/{periodStart}/{periodEnd}/payments"

payload = {
"method": "bank_transfer",
"amount": 123,
"paymentDate": "2023-11-07T05:31:56Z",
"reference": "<string>",
"note": "<string>"
}
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({
method: 'bank_transfer',
amount: 123,
paymentDate: '2023-11-07T05:31:56Z',
reference: '<string>',
note: '<string>'
})
};

fetch('https://api.royalti.io/statements/users/{tenantUserId}/{periodStart}/{periodEnd}/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://api.royalti.io/statements/users/{tenantUserId}/{periodStart}/{periodEnd}/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([
'method' => 'bank_transfer',
'amount' => 123,
'paymentDate' => '2023-11-07T05:31:56Z',
'reference' => '<string>',
'note' => '<string>'
]),
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.royalti.io/statements/users/{tenantUserId}/{periodStart}/{periodEnd}/payments"

payload := strings.NewReader("{\n \"method\": \"bank_transfer\",\n \"amount\": 123,\n \"paymentDate\": \"2023-11-07T05:31:56Z\",\n \"reference\": \"<string>\",\n \"note\": \"<string>\"\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.royalti.io/statements/users/{tenantUserId}/{periodStart}/{periodEnd}/payments")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"bank_transfer\",\n \"amount\": 123,\n \"paymentDate\": \"2023-11-07T05:31:56Z\",\n \"reference\": \"<string>\",\n \"note\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/statements/users/{tenantUserId}/{periodStart}/{periodEnd}/payments")

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 \"method\": \"bank_transfer\",\n \"amount\": 123,\n \"paymentDate\": \"2023-11-07T05:31:56Z\",\n \"reference\": \"<string>\",\n \"note\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "message": "<string>",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "TenantUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "periodStart": "2023-11-07T05:31:56Z",
    "periodEnd": "2023-11-07T05:31:56Z",
    "flags": {
      "onHold": true,
      "disputed": true
    },
    "gross": "<string>",
    "net": "<string>",
    "paidAmount": "<string>",
    "priorBalance": "<string>",
    "reportingCurrency": "USD",
    "frozenAt": "2023-11-07T05:31:56Z",
    "lastCalculatedAt": "2023-11-07T05:31:56Z",
    "ok": true
  }
}
{
"status": "error",
"message": "Unauthorized"
}
{
"status": "error",
"message": "Resource not found"
}

Description

Record payment Records a payment against the active Statement for (tenantUserId, periodStart..periodEnd). Rejected if the statement is still draft (must be finalized or later). Authorization:
  • Required role: admin or higher

Code Examples

const response = await fetch('https://api.royalti.io/statements/users/example-id/example-id/example-id/payments', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "method": "bank_transfer",
    "amount": 1,
    "paymentDate": "2024-01-21T12:00:00Z",
    "reference": "sample-reference",
    "note": "sample-note"
  })
});

const data = await response.json();
console.log(data);
import requests

response = requests.post(
  'https://api.royalti.io/statements/users/example-id/example-id/example-id/payments',
  json={"method":"bank_transfer","amount":1,"paymentDate":"2024-01-21T12:00:00Z","reference":"sample-reference","note":"sample-note"}
)

data = response.json()
print(data)
curl -X POST https://api.royalti.io/statements/users/example-id/example-id/example-id/payments \
  -H "Content-Type: application/json" \
  -d '{"method":"bank_transfer","amount":1,"paymentDate":"2024-01-21T12:00:00Z","reference":"sample-reference","note":"sample-note"}'

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Path Parameters

tenantUserId
string<uuid>
required
periodStart
string<date-time>
required
periodEnd
string<date-time>
required

Body

application/json
method
string
required
Example:

"bank_transfer"

amount
number
required

Must be a positive number.

paymentDate
string<date-time>
required
reference
string | null
note
string | null

Response

Payment recorded.

Every statements response wraps the payload in { status, message, data }. data carries the per-endpoint payload PLUS the per-tenant feature flag.

status
enum<string>
Available options:
success,
error
message
string
data
object

Response payload shared by the ITEM 2 lifecycle mutations (finalize, payments, adjustments, hold, resume, void, disputes): the updated Statement row, shaped via the same shapeForClient mapper as StatementRosterRow, plus ok: true. The underlying Sequelize row carries additional endpoint-specific detail (e.g. statusHistory) not exhaustively modeled here — treat this as the roster-row core.