Skip to main content
POST
Create a direct-debit mandate

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
settlement_account_id
string<uuid>
required

One of your NGN settlement accounts; the mandate is taken on that account.

limit_amount
string<decimal>
required

Maximum NGN per debit the account holder approves.

Response

data
object
required