Skip to main content
POST
Bind a named account

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

Path Parameters

account_id
string
required

The account id.

Body

application/json
partner
string
required
Example:

"safehaven"

accountNumber
string
required
Example:

"0123456789"

bankCode
string
accountName
string
mandateRef
string

Response

OK

id
string

nam_…

accountId
string
accountLabel
string

the bound ledger account's name

partner
string

safehaven | nomba | …

partnerName
string
accountNumber
string
bankCode
string
accountName
string
currency
string
status
enum<string>

PENDING: asked the partner, no number yet

Available options:
PENDING,
ACTIVE,
FROZEN,
CLOSED,
FAILED
mandateRef
string
partnerRef
string
failureReason
string
pendingApprovalId
string
issuedAt
string<date-time>
closedAt
string<date-time>
createdAt
string<date-time>