Who's involved
Clients work only with A-PAY. Your integration links A-PAY to the payment system through the A-PAY API.
Client
Accepts payments through A-PAY. Gets access to the new PS once the A-PAY Sales team connects it.
A-PAY
Creates the “Integrations” chat, provides Swagger and the API token, connects wallets, provides payment links and the test checklist.
External integration team
That's youFills in the PS checklist, builds the integration, connects the PS, prepares wallet instructions and runs the tests.
PS
The payment system you are connecting. It is linked to A-PAY only through your integration.
Process
Five stages, top to bottom. Your steps are on the right, A-PAY's responses on the left. Click a block to jump to its step.
Steps
Step numbers match the diagram. After step 1, send all requests to A-PAY in the “Integrations” chat.
-
1
Get the name of your assigned A-PAY manager
YouThe A-PAY manager will create the “Integrations” chat and add everyone needed. From then on, it is your working channel with A-PAY.
A-PAYCreates the “Integrations” chat -
2
Fill in the PS checklist
YouDescribe the PS you want to integrate in the checklist.
-
3
Get the Swagger link and API token
A-PAYSwagger describes the A-PAY API you build the integration against. The API token is needed to connect to this API.
A-PAYProvides the Swagger link and API token -
4
Build the integration
YouHow to fit the PS flow into the A-PAY API is up to you. The one requirement: the integration must follow the API contract in Swagger.
-
5
Connect the PS and apply its schemes
YouConnect the PS through the API and apply the PS schemes as described in the documentation. This is also where the wallet sync mode is set.
-
6
Provide wallet connection instructions
YouA-PAY connects the PS wallets using these instructions. Prepare them from the template, which has five sections:
- General information. Whether a proxy is needed, whether p2proxy is used, integration type.
- Filling in API data. Wallet fields: where to get them, format, uniqueness, whether required, example.
- Notes. Connection specifics.
- Wallet connection steps. Step-by-step flow.
- Possible errors. Optional: error text, cause, how to fix it.
-
7
Request wallet connection
YouAsk A-PAY to connect the wallets and send the wallet details needed for it.
A-PAYConnects the wallets using your instructions -
8
Request payment links
YouYou will use the links to check that the PS and all its methods work as described in the documentation.
A-PAYProvides payment links and a checklist of recommended test scenarios -
9
Test the PS
YouGo through every PS method using the payment links and the test scenario checklist. If the tests fail, fix the integration and test again.
ResultTests passed, the integration is connected to A-PAY -
10
Connecting clients
A-PAYA-PAY passes the information about the new PS to the Sales team, which connects clients to it.