Perform wallet transfer from a sub account

Transfer funds from a specific sub-account to another Nomba account (P2P). Near-instant settlement with no external processor. Sub-account transfers must be enabled by Nomba before use.

POST /v2/transfers/wallet/{subAccountId}

Perform wallet transfer from a sub account

cURL

curl --request POST \
  --url https://api.nomba.com/v2/transfers/wallet/{subAccountId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'accountId: <accountid>' \
  --data '
{
  "amount": 3500,
  "receiverAccountId": "890022ce-bae0-45c1-9b9d-ee7872e6ca27",
  "merchantTxRef": "UNQ_123abGGhh5546",
  "narration": "Testing Payment"
}
'

200

{
  "code": "200",
  "description": "Success",
  "data": {
    "amount": 5502,
    "meta": {
      "merchantTxRef": "3JVW2xJCjj443oannREBuTaXDdji",
      "api_client_id": "6a7bed88-7c93-4a1c-a445-f88edbca6489",
      "api_account_id": "01a10aeb-d989-460a-bbde-9842f2b4320f",
      "rrn": "230908151711"
    },
    "fee": 50,
    "timeCreated": "2023-09-08T14:17:13.634Z",
    "id": "API-P2P-C24AD-a6443bf0-011c-4bc2-b739-4a2e33e2a27b",
    "type": "p2p",
    "status": "SUCCESS"
  }
}

Always requery the transaction using Fetch a single transaction on a sub account to confirm its final status before issuing a refund. Only refund if data.status is REFUND.

For a complete guide on response codes and transaction statuses, see Response Codes.

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. Both methods return an access token. Send it in the Authorization header: Authorization: Bearer <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

200

application/json

OK - your request was successful.

code · enum<string> · required

Response code. This reflects the HTTP status code of the response, e.g. 200 when the request completed successfully and 201 when it was accepted and is still being processed.

Available options: 200, 201, 400, 401, 403, 429, 500

Example:

"200"

description · string · required

Response description

Example:

"Success"

data · object · required

Transfer data

Show child attributes