NOnomba
Transfers

Perform wallet transfer from a sub account

Changed on

You can use this endpoint to perform a wallet transfer from a sub account

post/v2/transfers/wallet/{subAccountId}

Request

  • Base URL
    https://api.nomba.com
  • URL
    https://api.nomba.com/v2/transfers/wallet/{subAccountId}
  • Auth
    HTTP bearer

Path parameters

subAccountIdstring required

The accountId to transfer from.

Headers

accountIdstring uuid required
Example:890022ce-bae0-45c1-9b9d-ee7872e6ca27

The parent accountId of the business.

Request body

amountnumber double required

The amount to be transferred.

receiverAccountIdstring uuid required

The receiver's accountId.

merchantTxRefstring required

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

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

narrationstring

The payment narration

Example request

{
  "amount": 3500,
  "receiverAccountId": "890022ce-bae0-45c1-9b9d-ee7872e6ca27",
  "merchantTxRef": "UNQ_123abGGhh5546",
  "narration": "Testing Payment"
}

Response

OK - your request was successful.

code'200' | '201' | '400' | '401' | '403' | '429' | '500' 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.

descriptionstring required

Response description

Example response

{
  "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"
  }
}

Changes

  • 278a25dccfe5Revision changes
    • warning

      added the new 200 enum value to the response property for the response status

    • warning

      added the new 200 enum value to the response property for the response status

    • warning

      added the new 201 enum value to the response property for the response status

    • warning

      added the new 201 enum value to the response property for the response status

    • warning

      added the new 400 enum value to the response property for the response status

    • warning

      added the new 400 enum value to the response property for the response status

    • warning

      added the new 401 enum value to the response property for the response status

    • warning

      added the new 401 enum value to the response property for the response status

    • warning

      added the new 403 enum value to the response property for the response status

    • warning

      added the new 403 enum value to the response property for the response status

    • warning

      added the new 429 enum value to the response property for the response status

    • warning

      added the new 429 enum value to the response property for the response status

    • warning

      added the new 500 enum value to the response property for the response status

    • warning

      added the new 500 enum value to the response property for the response status