🈁Getting data about PS

There is a request, by creating and sending which you will find out which payment system is connected to your project and what limits there are on it. API docs about that request are here.

Getting data about payment systems

get

Getting data about payment systems for the project.

Authorizations
Query parameters
project_idnumberRequired

Project ID in the A-Pay system

Example: 123
Responses
200

OK

application/json
Responseone of
or
get
/Remotes/payment-systems-info
GET /Remotes/payment-systems-info?project_id=1 HTTP/1.1
Host: <domain>
apikey: YOUR_API_KEY
Accept: */*
{
  "success": true,
  "payment_systems": [
    {
      "name": "inr_p2c",
      "currency": "INR",
      "deposit": true,
      "withdrawal": false,
      "min_deposit": "10.00",
      "max_deposit": "10000.00",
      "min_withdrawals": "10.00",
      "max_withdrawals": "10000.00"
    }
  ]
}

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.

Last updated