Skip to main content
POST
Perform wallet transfer from a 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 accountId to transfer from.

Body

application/json

The request payload required to perform a wallet transfer.

A structure representing an object required to post a wallet transfer.

amount
number<double>
required

The amount to be transferred.

Example:

3500

receiverAccountId
string<uuid>
required

The receiver's accountId.

Example:

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

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"

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