Skip to main content
GET
Get account details to share

Authorizations

Authorization
string
header
required

Server API key, scoped. pk_test_ keys hit the sandbox tenant.

Headers

X-Request-Id
string

Optional client correlation id, up to 128 characters. It is not echoed: the response's X-Request-Id is always our own req_… id. We log your value with the request as client_request_id, so support can find a request by either id. A longer value is refused with 400 parameter_invalid.

Maximum string length: 128

Path Parameters

account_id
string
required

Account.

Pattern: ^acc_[0-9A-HJKMNP-TV-Z]{26}$

Response

OK.

What a payer needs to pay into the account.

object
string
required

Always account_share_details.

Allowed value: "account_share_details"
account_id
string
required

Account id.

Pattern: ^acc_[0-9A-HJKMNP-TV-Z]{26}$
account_name
string
required

Name on the account.

account_number
string
required

NUBAN for NGN.

bank_name
string
required

Bank.

currency
enum<string>
required

Currency.

Available options:
NGN,
USD,
GBP,
EUR,
GHS,
KES
routing
object[]
required

Extra details for non-naira accounts.

share_text
string
required

Ready-to-paste text for "Copy all details" and "Share details".