Getting the Allowed List For a Customer
Knowledge Base
Categories: Billing & Transactions API
Get the Allowed Payment Gateway List for a Customer Using the API
When you want to retrieve the list of allowed payment gateways for a customer account. This article explains the required parameters and API request format for fetching supported payment gateways for add fund and payment transactions.
Description
Gets the allowed list of Payment Gateways for the specified Customer.
Parameters
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| customer-id | Integer | Required | The Customer for whom the allowed Payment Gateway list is to be retrieved. |
| payment-type | String | Optional | Type of Transaction. Values can be AddFund or Payment. If type is not provided, by default, it will return the Gateway(s) that support both AddFund and Payment. |
HTTP Method
GET
Example Test URL Request
https://test.httpapi.com/api/pg/allowedlist-for-customer.json?auth-userid=0&api-key=key&payment-type=type&customer-id=0
Response
Returns a hash map of allowed Payment Gateways containing the below details:
-
Payment Gateway Type (gatewaytype)
-
Payment Gateway Name (gatewayname)
-
Payment Type Id (paymenttypeid)
-
Payment Gateway URL (posturl)
-
Payment Gateway Display Position (displayposition)
-
Payment Gateway Access Level (customeraccesslevel)
In case of any errors, a status key with value as ERROR alongwith an error message will be returned.
Did you find this article helpful?