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 Card Acceptance solution?

Flows are an important part in the Card Acceptance APIs as there are some limitations in the values of X-Correlation-ID, whereby all API calls that are part of the same flow must have the sameX-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.

Flows

There are 5 main flows that a merchant can perform using Ayoconnect's Card Acceptance Solution:

Flow	Details
Card Registration	Generate a url which opens up to Ayoconnect's PCIDSS compliant webview. A customer will be able to input their card details and perform authentication and authorization of their card. If authentication and authorization is successful, card will be tokenized and usable for a payment flow
Card Payment	Initiate payment on the tokenized card.
Get Payment Status	Get the latest payment status of a payment request that a merchant has initiated
Get Cards List	Get list of cards that are registered under a customer
Card Unbinding	Disable an existing card token. The card token will not longer be eligible for any future payments

Card Registration

This flow is an_asychronous_ flow

APIs part of this flow:

Generate Webview API

Card Payment

This flow is an_asychronous_ flow for Customer Initiated Transactions

This flow is sychronous_ flow for Merchant Initiated Transactions

APIs part of this flow:

Charge Payment API

Get Payment Status

This flow is a_sychronous_ flow

APIs part of this flow:

Payment Status API

Get Cards List

This flow is a_sychronous_ flow

APIs part of this flow:

Card List API

Unbinding

This flow is a_sychronous_ flow

APIs part of this flow:

Unbinding Card API