POST
Get bank transfer details to pay

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

Response

Transfer details

object
string
required
Allowed value: "bank_transfer_instructions"
checkout_session_id
string<uuid>
required
bank_name
string
required
Example:

"Zenith Bank"

account_number
string
required
Pattern: ^\d{10}$
Example:

"9912345678"

account_name
string
required
Example:

"KetaPay Escrow / Ada Obi"

amount
integer
required

Transfer exactly this (the buyer's total)

Required range: x >= 0
Example:

152418750

expires_at
string<date-time>
required