POST
Confirm a payout account with the seller's code

Authorizations

Authorization
string
header
default:sk_test_docs_246e232c64ccc7a001bf61ec0f2e6ab0
required

Authorization: Bearer <secret key>. Secret keys belong to your organisation, are shown once when created in the dashboard, and are scoped (see x-required-scope on each operation). Keep them on your server. Live keys are issued after your business is verified. Publishable keys (pk_) are only for @ketapay/checkout and don't work here.

KetaPay-Customer-Token
string
header
required

Proof that your customer approved this call, from POST /customer_sessions/{id}/verify. Sent together with your secret key. Valid for 15 minutes, for that customer's escrows only.

Headers

Idempotency-Key
string
required

Unique key for this operation. Retries with the same key return the first result.

Maximum string length: 255
Example:

"7f3e2a10-6c4d-4b8e-9a1f-2d5c8e7b6a40"

Path Parameters

id
string<uuid>
required

Body

application/json
code
string
required
Pattern: ^\d{6}$
Example:

"482913"

Response

The active payout account

id
string<uuid>
required
object
string
required
Allowed value: "payout_account"
status
enum<string>
required

pending_confirmation: waiting for the seller's code. active: receives payouts (one per seller). inactive: replaced by a newer confirmed account. cancelled: not confirmed in time, or too many wrong codes.

Available options:
pending_confirmation,
active,
inactive,
cancelled
bank_code
string
required
bank_name
string
required
Example:

"Zenith Bank"

account_number_last4
string
required
Example:

"6789"

account_name
string
required

The name the bank holds for this account. Shown to the seller before they confirm; it does not have to match their name.

Example:

"TUNDE BELLO"

created_at
string<date-time>
required
confirmed_at
string<date-time> | null
required