API Flows

Before we start, let's define how a flow is defined within Ayoconnect's solutions:

Flow - a single flow is defined as a combination of APIs. Details of Cards Acceptance flows are explained below

Why are flows important in Ayoconnect's Instant Transfer solution?

Flows are an important part in the Instant Transfer APIs as there are some limitations in the values of X-External-ID, whereby all API calls that are part of the same flow must have the same X-External-ID header.

Failing to do so will result in a broken flow, and it may not be possible to resolve any issues raised for that flow.

Flows

There are 3 MAIN FLOWS that you can perform using Ayoconnect's Instant Transfer Solution:

Flow	Details
Add Beneficiary	Cross-check your intended beneficiary details through Ayoconnect against the bank to ensure that it's valid and available to receive funds before you initiate a disbursement to it
Disbursement	Initiate a disbursement to the intended beneficiary once you have confirmed that it is active and available to receive funds. You can check the status of your disbursement once you have initiated it as well.
Check Account Balance	Get the available disbursement balance on your Instant Transfer account. This is dependent on the amount you have topped up with Ayoconnect, reduced by the amount you have disbursed / withdrawn through the account

Please follow the guidelines below for all the flows:

To transfer to a new recipient, you must successfully complete the Add Beneficiary Flow first, then you can perform the Disbursement Flow.
Instant Transfer APIs are Asynchronous, you will only get the final result in the Callbacks, not in the initial Response (the initial response is usually given as Processing). Except for Get balance API where you will get the result in the Response.
The API of Check Transaction Status is not necessarily to be included in an automatic flow: Add Beneficairy + Disbursement, since for every Disbursement flow you will get a callback that contains the Final Status of the transaction. Only use this Check Status API if necessary, e.g: a disbursement status is in Pending state longer than usual, you can perform Check Disbursement Status to retrieve the final status. But if the Pending state persists more than 6 hours, please reach out to our Operation Team to get the final status.
Never Fail a Pending transaction before getting the callback of the Final Status from Ayoconnect.
For every transaction in the Instant Transfers system, we have an idempotency check integrated only on the correlationID and NOT based on transactionID or any other parameters. This means Instant Transfer flow expects to receive a unique correlationID value for each transaction.
During a Disbursement flow, in case you are getting HTPP error of 503 or 504 or timeout, do not fail the transactions, please keep them as Pending. Watch for the status parameter inside our callback, if it's still 0, then it should be kept as Pending/Processing. If the status value is 1; Success, if the value is 4; Failed.