Skip to main content
POST
Withdraw to a settlement account

Authorizations

X-Ladder-Key
string
header
required

Your key id: pk_test_… (sandbox) or pk_live_… (live).

X-Ladder-Timestamp
string
header
required

Unix seconds, as a string; must be within 5 minutes of server time.

X-Ladder-Signature
string
header
required

Lower-case hex HMAC-SHA512 over timestamp, method, path+query and the SHA-256 of the body. See Authentication.

Headers

Idempotency-Key
string
required

Unique per logical request (max 255 chars). A retry with the same key and body returns the original response with Idempotent-Replayed: true; a different body returns 409.

Body

application/json
currency
enum<string>
required
Available options:
GHS,
USD,
NGN
amount
string<decimal>
required
settlement_account_id
string<uuid>
required

A verified settlement account of yours in the same currency (GET /kyb/settlement-accounts).

Response

data
object
required