\n
"},"unauthorized_error":{"title":"Unauthorized","required":["success","message","code"],"properties":{"success":{"type":"boolean","description":"`false` if an error occurred"},"message":{"type":"string","default":"unauthorized","description":"Invalid credentials"},"code":{"type":"number","description":"Error code in the A-Pay system"}}}}},"paths":{"/Remotes/payment-systems-info":{"get":{"tags":["Payment system"],"summary":"Getting data about payment systems","description":"Getting data about payment systems for the project.","parameters":[{"in":"query","name":"project_id","schema":{"type":"number"},"description":"Project ID in the A-Pay system","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"oneOf":[{"title":"Success","required":["success","payment_systems"],"properties":{"success":{"type":"boolean","description":"`true` if there are no errors"},"payment_systems":{"type":"array","items":{"type":"object","description":"Information about payment system","required":["name","min_deposit","max_deposit","min_withdrawal","max_withdrawal","deposit","withdrawal"],"properties":{"name":{"$ref":"#/components/schemas/ps_all"},"currency":{"$ref":"#/components/schemas/currency"},"deposit":{"type":"boolean","description":"`false` if the payment system does not support deposits else `true`"},"withdrawal":{"type":"boolean","description":"`false` if the payment system does not support withdrawals else `true`"},"min_deposit":{"type":"string","description":"Minimum deposit amount"},"max_deposit":{"type":"string","description":"Maximum deposit amount"},"min_withdrawals":{"type":"string","description":"Minimum withdrawal amount"},"max_withdrawals":{"type":"string","description":"Maximum withdrawal amount"}}}}}},{"title":"Error","required":["success","message","code"],"properties":{"success":{"type":"boolean","description":"`false` if an error occurred"},"message":{"type":"string","description":"Description of error"},"code":{"type":"number","description":"Error code in the A-Pay system"}}}]}}}},"400":{"description":"Error","content":{"application/json":{"schema":{"oneOf":[{"title":"required field missing","description":"required field missing","required":["success","message","code"],"properties":{"success":{"type":"boolean","description":"`false` if an error occurred"},"message":{"description":"Validation error in parameters","default":"required field missing"},"code":{"type":"number","description":"Error code in the A-Pay system"}}}]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/unauthorized_error"}}}}}}}}}
```
### Auto display method and auto update minimum and maximum payment limits
Use this request to automatically display our active payment methods and their limits on your platform. You can call the method periodically (e.g., every 5 minutes) to keep your data up to date.
The response also contains information about which directions are currently available — deposits, withdrawals, or both.
There is a slight difference depending on how you are integrated with us:
#### **H2H integration**
For H2H integration, follow this logic:
1. Send a request to get available payment systems.
2. If a payment system you have integrated is present in the response — display it.\
If it’s missing — hide it.
3. Update minimum and maximum limits according to the response.
4. Use the `deposit` and `withdrawal` flags to determine whether the payment system should be displayed, and for which directions it’s available.
#### **Payment page integration**
For integrations via our payment page, there are two options:
**a. Single payment system request**
The behavior is similar to the H2H integration. However, withdrawals are not available when using our payment page. In this case, you should ignore the `withdrawal` flag and display the method **only if `deposit = true`**.
**b. Multiple payment systems request**
When you send a request containing several payment systems (e.g., `upi_p2p`, `phonepe`, `paytm`):
* Display the payment method if **at least one** of the requested systems is returned in the response with `deposit = true`.
* Hide the method only if **none** of the requested systems appear, or all of them have `deposit = false`.
* You can ignore the `withdrawal` flag, as withdrawals are not available when using our payment page.
For example, if you request the following payment systems via the payment page: `upi_p2p`, `phonepe`, `paytm`, and you periodically send us requests to check their availability:
* If we respond with only `upi_p2p` where `deposit = true` — do **not** hide the method, since a deposit option is still available.
* If we respond with only systems where `deposit = false`, or none of the requested systems are returned — hide the method.
# Getting payment system balances
{% hint style="warning" %}
The integration of our service into your platform is expected to be done with the help of developers, so make sure you involve them
{% endhint %}
Use this request to retrieve the current balances of the Payment Systems available to your project. API docs for this request are available [here](https://api.a-pay.one/#tag/Payment-system/paths/~1Remotes~1payment-systems-balances/get).
## Get payment system balances
> Get payment systems balances for the project
```json
{"openapi":"3.0.3","info":{"title":"A-Pay","version":"1.0.0"},"tags":[{"name":"Payment system","description":"Payment systems"}],"servers":[{"url":"https://Payment system currency
\n \n | Currency | Payment systems | Decimal places |\n |----------|-----------------|----------------|\n | ARS | `cvu_fast_p2p`, `cvu_p2p`, `mercado_ars_p2p` | `0` |\n | BDT | `apaybdt`, `bangla_qr`, `bkash_a`, `bkash_api_v`, `bkash_b`, `bkash_p2p`, `nagad_a`, `nagad_api_v`, `nagad_b`, `nagad_p2p`, `p2p_rocket`, `tap_p2p`, `upay`, `upay_w` | `0` |\n | BHD | `stcpay_p2p` | `3` e.g. 0.001 |\n | BOB | `veripagos_fast`, `yape_bob_p2p` | `0` |\n | BRL | `pix_p2p` | `0` |\n | EGP | `egp_card`, `egp_fast`, `egp_tel`, `egp_tel_fast` | `0` |\n | ETB | `cbebirr_p2p`, `etb_fast`, `etb_mpesa_p2p`, `etb_p2p`, `telebirr_fast_p2p` | `0` |\n | EUR | `eur_card` | `2` e.g. 0.01 |\n | GNF | `orange_gin_p2p` | `0` |\n | GTQ | `fri_p2p` | `2` e.g. 0.01 |\n | INR | `imps`, `imps_top`, `inr_p2c`, `inr_p2p`, `paytm`, `phonepe`, `phonepe_fast`, `upi_a`, `upi_fast`, `upi_fast_qr`, `upi_fast_v`, `upi_fast_vip`, `upi_link`, `upi_p2p`, `upi_push` | `0` |\n | JMD | `lynk_p2p`, `scotiabank_p2p` | `0` |\n | KES | `mpesa` | `0` |\n | KHR | `ababank`, `wing_l` | `0` |\n | LKR | `ipay_fast`, `ipay_l`, `lkr_banktransfer`, `lkr_qr`, `paygo_p2p` | `0` |\n | MMK | `kbzpay_p2p`, `wavepay_l` | `0` |\n | MXN | `spei_p2p` | `0` |\n | NIO | `ach_p2p` | `2` e.g. 0.01 |\n | NPR | `esewa`, `esewa_p2p`, `fonepay_qr`, `imepay_l`, `khalti`, `khalti_l` | `0` |\n | PEN | `yape_pen_p2p` | `0` |\n | PKR | `bankalfalah`, `easypaisa`, `easypaisa_l`, `jazzcash`, `jazzcash_fast`, `jazzcash_l`, `nayapay_l`, `pkr_bt_p2p`, `pkr_w`, `pkr_w2`, `raast_p2p` | `0` |\n | PYG | `bancard_qr`, `itau_p2p`, `tigo_p2p` | `0` |\n | TND | `d17_l`, `flouci`, `flouci_l` | `0` |\n | USD | `banistmo_p2p`, `bcgeneral_p2p`, `yappy_p2p` | `2` e.g. 0.01 |\n | UYU | `brou_p2p`, `mercado2_uyu_p2c`, `mercado_uyu_p2c`, `prex_p2p` | `0` |\n | XOF | `moov_mli_p2p`, `orange_mli_p2p`, `orange_sen_p2p`, `wave_mli_p2p`, `wave_sen_p2p` | `0` |\n
Sequence diagram of the payment with A-Pay Payment Page
Example of the request for the first case
```json { "currency": "INR", //Currency of payment "payment_system": [//list of payment system for request "upi_fast", "upi_fast_v", "upi_p2p" ], "custom_transaction_id": "custom123", "custom_user_id": "user123", "return_url": "https://example.com", "language": "EN" } ```How it looks on mobile
How it looks on desktop
Example of the request with the amount buttons
{
"currency": "INR", //Currency of payment
"payment_system": [//list of payment system for request
"upi_fast",
"upi_fast_v",
"upi_p2p"
],
"buttons": [
100,
200,
300,
400
],
"custom_transaction_id": "custom123",
"custom_user_id": "user123",
"return_url": "https://example.com",
"language": "EN"
}
How it looks on mobile
How it looks on desktop
Example of the request with fixed amount
```json { "amount": 300, //Amount of deposit "currency": "INR", //Currency of payment "payment_system": [//list of payment system for request "upi_fast", "upi_fast_v", "upi_p2p" ], "custom_transaction_id": "custom123", "custom_user_id": "user123", "return_url": "https://example.com", "language": "EN" } ```Example of the answer to the payment page request
```json { "success": true, "url": "https://a-pay4.one/pay?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MjI5LCJleHAiOjE3MDE0NDMwODd9.zZXK5K1ipGYj01G2MGFzERdRW5vIXQgxKo1B6GSmYcQ", "order_id": "7fa13dbc3b79e05e" } ```How it looks on mobile
How it looks on desktop
Example of the request for the second case
```json { "amount": 300, //Required. The amount of deposit that the user has entered on your site "currency": "PKR", //Required. Currency in which the user makes a deposit "payment_system": [ //Required. Only 1 payment system. Payment system that is connected to your product "jazzcash_fast", ], "custom_transaction_id": "custom123", //Required "custom_user_id": "user123", //Required. Client number for identification in the system "language": "EN", "return_url": "https://example.com", //Required. returnlink to your site "data": { //Data depending on the specific payment system "account_number": "" //User's account number } } ```Example of the answer to the payment page request
```json { "success": true, "url": "https://a-pay4.one/pay?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MjI5LCJleHAiOjE3MDE0NDMwODd9.zZXK5K1ipGYj01G2MGFzERdRW5vIXQgxKo1B6GSmYcQ", "order_id": "7fa13dbc3b79e05e" } ```How it looks on mobile
How it looks on desktop
