Skip to main content
POST
Perform bank account transfer from the sub account

Authorizations

Authorization
string
header
required

Nomba authenticates API calls with OAuth2 HTTP bearer tokens. There are two methods of authentication; Client-Credentials method and PKCE (Proof Key for Code Exchange) method. In each of the methods, You will get an ACCESS_TOKEN. You need to use an "Authorization" HTTP header to provide your ACCESS_TOKEN. For example: Authorization: {ACCESS_TOKEN}.

Headers

accountId
string<uuid>
required

The parent accountId of the business.

Example:

"890022ce-bae0-45c1-9b9d-ee7872e6ca27"

Path Parameters

subAccountId
string
required

The sub accountId to transfer from.

Body

application/json

The request payload required to perform bank account transfer.

A structure representing an object required to post a bank account transfer.

amount
number<double>
required

The amount to be transferred.

Example:

3500

accountNumber
string
required

The destination bank account number.

Required string length: 10
Example:

"0554772814"

accountName
string
required

The name on the account.

Example:

"M.A Animashaun"

bankCode
string
required

The code of the recipient bank.

Example:

"058"

merchantTxRef
string
required

Unique reference used to track a transaction from an external process.

This is an idempotency key and must be unique per transaction.

Example:

"UNQ_123abGGhh5546"

senderName
string

Sender name

Example:

"Nightly Post"

narration
string

The payment narration

Example:

"Testing Payment"

Response

OK - your request was successful.

code
string
required

Response Code

Example:

"00"

description
string
required

Response description

Example:

"Success"

data
object
required

Transfer data