Add a seller's payout account
Starts adding a bank account for the customer whose token you send. KetaPay looks up the
account name with the bank (an unknown account fails with bank_account_not_found) and
sends the customer a one-time code naming the account (“Code to add Zenith Bank
****6789”). The account stays pending_confirmation, and receives no money, until you
call POST /payout_accounts/{id}/confirm with that code within 10 minutes.
Confirming makes it the customer’s payout account; any earlier one stops receiving money.
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"
Body
Response
Account looked up and confirmation code sent
"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"