Confirm a payout account with the seller's code
Activates the account. Five wrong codes cancel it; start again with
POST /payout_accounts. Payouts waiting in the seller’s KetaPay balance are sent to it
straight away.
Authorizations
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.
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
Unique key for this operation. Retries with the same key return the first result.
255"7f3e2a10-6c4d-4b8e-9a1f-2d5c8e7b6a40"
Path Parameters
Body
^\d{6}$"482913"
Response
The active payout account
"payout_account"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.
pending_confirmation, active, inactive, cancelled "Zenith Bank"
"6789"
The name the bank holds for this account. Shown to the seller before they confirm; it does not have to match their name.
"TUNDE BELLO"