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 Virtual Account flows are explained below.

How are flows defined in Ayoconnect's Virtual Account solution?

Flows are an important part in the Virtual Account APIs as there are some limitations in the values of 'A-Correlation-ID' value, whereby all API calls that are part of the same flow must have the same 'A-Correlation-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.

Once you have created a Virtual Account using a given 'A-Correlation-ID' value, that same 'A-Correlation-ID' value needs to be passed when updating or getting the status of that Virtual Account as they are considered as part of the same flow

This also means that if you would like to create a new Virtual Account, you would need to provide a new 'A-Correlation-ID' value. For example, if you have a 'Create Virtual Account' flow with a 'A-Correlation-ID' header of '12345', you can't use the same 'A-Correlation-ID' header again in the 'Create Virtual Account' flow.

Flows

There is 1 MAIN FLOW that you can perform using Ayoconnect's Virtual Account Solution:

Virtual Account Flow

APIs part of this flow:

• Create Virtual Account
• Get Virtual Account
• Update Virtual Account

Sample Case

1. You have created a VA number of 5555512345678910 with A-correlation-ID value of 12345ABCDE0000011111.
2. If yo want to extend the VA expiry or change the amount value using VA Update API or you want to hit the API of Get VA details for VA number 5555512345678910, you must also insert 12345ABCDE0000011111 as the header value of A-correlation-ID when using VA Update API or Get VA API.
3. Only if you are creating a new Virtual Account Number, then you use a different value for the A-correlation-ID.