Skip to content
AigerimMussina edited this page Feb 7, 2019 · 8 revisions

Welcome to allpay wiki!

Here you will find a technical description of business processes allpay and a description of public API. This document is intended for developers who want to integrate with the allpay payment system.

This section is used for easy navigation and contains a listing of all available integrations in the allpay system. Each paragraph consists of

  • diagram of the movement of money (in the rectangles the role in the allpay system is indicated, and in the rectangles with rounded edges - the name of the operation)
  • brief non-technical description of the integration
  • list of documentation necessary and sufficient for writing integrations.

Roles in the system allpay

Role Description
Customer An individual registered in the allpay system, the owner of an electronic wallet and electronic money
Agent Legal entity or individual entrepreneur, registered in the system allpay, which carries out the replenishment and withdrawal of electronic money from customers wallets
Merchant Legal entity or individual entrepreneur registered in the allpay system, accepting allpay electronic money as payment for goods and services

1. Terminal operations. Replenishment.

Transfer of money from agent to client

This operation can be used to replenish the account of an arbitrary customer of the allpay system at the request of the agent system. It is essentially a transfer of money in favor of the client. The electronic money as a result of the operation will be debited from the agent account on whose behalf the deposit was made.

2. Terminal operations. Payment by terminal number.

Transfer of money from the agent to the client, and then payment by this money of the services of the merchant according to the terminal number

This operation allows you to pay to the specified terminal. Money is debited from the agent’s account on behalf of which the request is authorized and, after passing through the customer’s account specified in the request, they are transferred to the merchant’s account to which the terminal belongs.

3. Terminal payment services.

Transfer of money from the agent to the client, and then payment of utilities and other services with this money

This operation allows you to pay for services. Under the services meant, utilities, telephone, replenishment of the balance on other services and so on. The money is debited from the agent’s account on whose behalf the request is authorized and, after passing through the client’s account, they appear in the account of the merchant whose services are to be paid.

Upon receipt of the money, the merchant replenishes the account in whose favor the payment was made(already out of the allpay system).

4. Connect allpay as a payment option to your store.

Payment of merchant goods or services from the client’s wallet

This operation allows you to redirect the client to the allpay website to pay for goods or services in the style of PayPal. A request is made on the merchant's website and the client is redirected to the allpay website for payment. After payment, the allpay system notifies the merchant's site about the successful payment.

5. Connect to allpay as a merchant (service provider)

Transfer of money from the allpay system to the merchant for payment for utilities and other services

This integration implies that the system allpay is the initiator of the payment, while you are a service provider.

6. Terminal Operations. Withdrawal via client token.

Transfer of money from client to agent

This operation can be used to withdraw from the account of an arbitrary client of the allpay system at the request of the agent system. It is essentially a transfer of money in favor of the agent. Electronic money as a result of the operation will be deducted from the client account. Withdrawal requires a client token.