Skip to main content
POST
Add balance to a wallet

Path parameters

Request body

Example request

Example response

Every top-up posts balanced ledger legs: a manual top-up debits Cash and credits Customer Credit (Code 11); a promotional top-up debits Credits & Adjustments instead (Code 8) — no cash moved.

Errors

Errors use the standard envelope — see Errors.

Authorizations

Authorization
string
header
required

Tenant API key obtained from POST /auth/register or POST /v1/developer/keys.

Path Parameters

id
string<uuid>
required

Body

application/json
amount
integer<int64>
required

Minor currency units.

source
enum<string>
default:manual
Available options:
manual,
promotional
expires_at
string<date-time> | null

Promotional top-ups only.

Response

The recorded top-up transaction

data
object

One append-only wallet movement with the balance after it.