v1

latestOpenAPI 3.0.12026-07-2679100267.2 KB

Transfers

Perform wallet transfer from the parent account

You can use this endpoint to perform a wallet transfer.

post/v2/transfers/wallet

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.

codestring required

Response Code

descriptionstring required

Response description

Example response

{
  "code": "00",
  "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"
  }
}