Skip to main content
GET
Get the bank account number for a sub-account.
Fetches virtual account number details for a sub-account.

Authorizations

x-api-key
string
header
required

Requires authentication via API key and HMAC signature.

  • x-api-key: Your API key generated from your Onboard Business dashboard.
  • x-timestamp: Unix epoch timestamp (seconds) used in signature, allowed skew is 30 seconds
  • x-signature: SHA256 HMAC HEX signature calculated over t={x-timestamp}&{requestBody} using your API Secret.

Path Parameters

subAccountIdRef
string
required

The unique onboard sub-account ID or reference

Query Parameters

currency
string
default:USD

Currency of the bank account number to generate or retrieve.

Example:

"NGN"

Response

Bank account number details

Destination account details the customer must pay into to fund the deposit. Mirrors a Beneficiary (without an id). Carries only the account details needed to make the payment; transaction context (amount, status, etc.) lives on the enclosing CashDepositTransaction.

details can be nullable when the account number provider is still generating it

payinCurrency
string
required

Currency the destination account accepts for the deposit.

Example:

"NGN"

details
object

Details for local bank accounts