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-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 4 MAIN FLOWS that you can perform using Ayoconnect's Card Acceptance Solution:

Flow	Details
Card Registration	Generate a url to initiate tokenization process to register a customer's card
Payment	Initiate payment on the registered card on behalf of customer
Get Payment Status	Get the latest payment status of a payment request you've initiated
Get Cards List	Get list of cards that are registered under a customer
Card Unbinding	To disable the token used and the registered card will no longer be eligible for payment

Card Registration Flow

APIs part of this flow:

Get Access Token
Generate Webview API

Payment Flow

APIs part of this flow:

Get Access Token
Charge Payment API

Get Payment Status Flow

APIs part of this flow:

Get Access Token
Payment Status API

Get Cards List Flow

APIs part of this flow:

Get Access Token
Card List API