Generate Account Number
Generates a bank account number for this account in the given currency through the account-number provider. Returns the existing details if one was already generated.
Authorizations
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 secondsx-signature: SHA256 HMAC HEX signature calculated overt={x-timestamp}&{requestBody}using your API Secret.
Path Parameters
the unique onboard account ID
Query Parameters
Currency of the bank account number to generate or retrieve.
"NGN"
Response
Bank account number created
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