Skip to main content
POST
Record a remittance

Authorizations

Authorization
string
header
required

A sandbox or production secret key.

Headers

Idempotency-Key
string
required

A caller-owned key for safely retrying one write.

Required string length: 8 - 255

Body

application/json
payer_reference
string
required
Required string length: 3 - 200
currency
enum<string>
required
Available options:
KES,
USD,
EUR,
GBP
received_at
string<date-time>
required
allocations
object[]
required
Required array length: 1 - 100 elements

Response

The remittance was reconciled

id
string
required
Pattern: ^rem_[A-Za-z0-9_-]+$
object
string
required
Allowed value: "remittance"
status
enum<string>
required
Available options:
received,
reconciled,
exception
payer_reference
string
required
amount
object
required
allocations
object[]
required
received_at
string<date-time>
required
reconciled_at
string<date-time> | null
required
Last modified on July 30, 2026