HomeAPI ReferenceAPI Documentation
Dashboard

How Transfers work

When a transfer is initiated, it comes with a status NEW this means the transfer has been queued for processing, and you would need to use the reference you passed to call the Fetch a Transfer endpoint to retrieve the updated status of the transfer.

What happens when a transfer is completed ?

When a transfer is completed we would push a notification to you via your Webhook You can use this to confirm the status of the transfer.

If a transfer is already being processed and it fails during processing, we would also push a hook notification to you on your specified hook URL.

{
  "event.type": "Transfer",
  "transfer": {
    "id": 570,
    "account_number": "0690000040",
    "bank_code": "044",
    "fullname": "Alexis Sanchez",
    "date_created": "2018-06-11T14:07:49.000Z",
    "currency": "NGN",
    "amount": 9000,
    "fee": 45,
    "status": "SUCCESSFUL",
    "reference": "rave-transfer-152812343460966",
    "narration": "New transfer",
    "approver": null,
    "complete_message": "Approved Or Completed Successfully",
    "requires_approval": 0,
    "is_approved": 1,
    "bank_name": "ACCESS BANK NIGERIA"
  }
}

{
  "event.type": "Transfer",
  "transfer": {
    "id": 570,
    "account_number": "0690000040",
    "bank_code": "044",
    "fullname": "Alexis Sanchez",
    "date_created": "2018-06-11T14:07:49.000Z",
    "currency": "NGN",
    "amount": 9000,
    "fee": 45,
    "status": "Failed",
    "reference": "rave-transfer-152812343460966",
    "narration": "New transfer",
    "approver": null,
    "complete_message": "reason for failure",
    "requires_approval": 0,
    "is_approved": 1,
    "bank_name": "ACCESS BANK NIGERIA"
  }
}

📘

Topping up your balance on test environment

To use the Initiate Transfer ] endpoint you need to top up your balance, navigate to transfers and click on the Top up balance notification, use this access bank test account to fund your balance 0690000031 .

📘

Test accounts to use as Destination accounts

Kindly make use of test account numbers between the range of 0690000031 - 0690000041.

You can use the accounts to test funding and also test transfers into an account.

🚧

International Transfers (US, EU, Asia)

This transfer method is only available in beta for selected merchants, once it becomes available to all merchants it would be announced. This means that transfers you test in the sandbox and live environments wouldn't be completed they would only be left in pending.

Available countries you can transfer to

CountryCurrency
NG (Nigeria)NGN
GH (Ghana)GHS
KE (Kenya)KES
UG (Ugandan)UGX
TZ (Tanzania)TZS
US (United States)USD
OT (Other countries)GBP, EUR, AUD etc.

Mocking transfers on the test environment

When transfers are done to the test accounts provided on the test environment, they always remain in a pending state. To mock failed and successful transfers you would need to pass an identifier in your reference, see how to do that below.

  1. Pass _PMCK as a suffix to your reference, this allows us to know it's a mock transfer e.g. merchantreg0293039_PMCK . This always creates a mock transfer that would have its status as successful.

  2. Append ST_F as a suffix to your reference, this allows us to know you are mocking a failed transfer e.g. merchantreg0293039_PMCK_ST_F.

  3. When doing a mocked transfer, the final response i.e. Successful or failed comes after 10 minutes.

  4. To specify the time interval you want the response/callback to come, append DU_{minutes} as a suffix e.g. merchant837484758_PMCKDU_1 would return a callback for a successful transfer after 1 minute and merchant837484758_PMCK_ST_FDU_1 would return a callback for a failed transfer after 1 minute.