Skip to main content
POST
Send a partner statement

Authorizations

Authorization
string
header
required

An API key, pk_live_… or pk_test_….

Headers

Idempotency-Key
string
required

Your unique key for this write, at most 255 characters. A retry with the same key and body gets the first answer back.

Maximum string length: 255

Body

application/json
partner
string
required
Example:

"safehaven"

currency
string
required
Example:

"NGN"

businessDate
string
required
Example:

"2026-10-31"

format
string
required

CSV | JSONL

content
string<byte>
required
closingBalance
string

Minor units, as a string.

Pattern: ^[0-9]+$

Response

OK

id
string

stm_

partner
string
partnerName
string
currency
string
businessDate
string
source
enum<string>
Available options:
API,
UPLOAD
uploadedBy
object

Who did something: a person signed in to the console, or an API key.

status
enum<string>

MATCHED: every line matched

LATE: expected, not received by the partner's cut-off

Available options:
INGESTED,
MATCHED,
HAS_BREAKS,
LATE
lines
integer<int32>
matched
integer<int32>
breaks
integer<int32>
closingBalance
string

as the partner reports it Minor units, as a string.

difference
string

statement closing balance minus the settlement account Minor units, as a string.

receivedAt
string<date-time>