Payment options can be fetched using this API.

Request Headers

Header NameHeader Value
Content-Typeapplication/json
X-VERIFYSHA256("/pg/v1/options/{merchantId}" + saltKey) + "###" + saltIndex
X-MERCHANT-IDUnique Merchant ID assigned to the merchant by PhonePe

Path Parameters

Parameter NameTypeDescriptionMandatory
merchantIdSTRINGUnique Merchant ID assigned to the merchant by PhonePeYes

Query Parameters

Parameter NameTypeDescriptionMandatory
includeNetBankingBanksListBooleanWhether or not to include Net Banking banks list in response
Comments:
If passed as true, Net Banking banks list will be included in the response.
No

Sample Response

{
  "success": true,
  "code": "SUCCESS",
  "message": "Your request has been successfully completed.",
  "data": {
    "upiCollect": {
      "enabled": true
    },
    "intent": {
      "enabled": true
    },
    "cards": {
      "enabled": true
    },
    "netBanking": {
      "enabled": true,
      "popularBanks": [
        {
          "bankId": "ICIC",
          "bankName": "ICICI Bank",
          "bankShortName": "ICICI",
          "available": "AVAILABLE",
          "accountConstraintSupported": false,
          "priority": 1
        },
        {
          "bankId": "KVBL",
          "bankName": "Karur Vysya Bank",
          "bankShortName": "Karur",
          "available": "AVAILABLE",
          "accountConstraintSupported": false,
          "priority": 2
        },
        {
          "bankId": "LAVB",
          "bankName": "Laxmi Vilas Bank",
          "bankShortName": "Laxmi",
          "available": "AVAILABLE",
          "accountConstraintSupported": false,
          "priority": 3
        },
        {
          "bankId": "SBIN",
          "bankName": "State Bank Of India",
          "bankShortName": "SBI",
          "available": "AVAILABLE",
          "accountConstraintSupported": false,
          "priority": 0
        }
      ],
      "allBanks": [
        {
          "bankId": "ICIC",
          "bankName": "ICICI Bank",
          "bankShortName": "ICICI",
          "available": "AVAILABLE",
          "accountConstraintSupported": false,
          "priority": 1
        },
        {
          "bankId": "KVBL",
          "bankName": "Karur Vysya Bank",
          "bankShortName": "Karur",
          "available": "AVAILABLE",
          "accountConstraintSupported": false,
          "priority": 2
        },
        {
          "bankId": "LAVB",
          "bankName": "Laxmi Vilas Bank",
          "bankShortName": "Laxmi",
          "available": "AVAILABLE",
          "accountConstraintSupported": false,
          "priority": 3
        },
        {
          "bankId": "SBIN",
          "bankName": "State Bank Of India",
          "bankShortName": "SBI",
          "available": "AVAILABLE",
          "accountConstraintSupported": false,
          "priority": 0
        }
      ]
    }
  }
}
{
  "success": true,
  "code": "SUCCESS",
  "message": "Your request has been successfully completed.",
  "data": {
    "upiCollect": {
      "enabled": true
    },
    "intent": {
      "enabled": true
    },
    "cards": {
      "enabled": true
    },
    "netBanking": {
      "enabled": true
    }
  }
}

Response Parameters

Parameter NameTypeDescription
successBOOLEANA boolean to indicate the success/failure of the request.
codeSTRINGResponse code explaining reason for status.
For status SUCCESS, only one possible response code is present - SUCCESS
For status FAILURE, following response codes are possible:
INTERNAL_SERVER_ERROR
BAD_REQUEST
AUTHORIZATION_FAILED
INVALID_MERCHANT_ID
messageSTRINGMessage giving more information about the code.
upiCollectJSONObject with details for UPI Collect payment option
intentJSONObject with details for Intent payment option
cardsJSONObject with details for Cards payment option
netBankingJSONObject with details for Net Banking payment option
enabledBOOLEANWhether the particular payment option is enabled for the merchant
popularBanksARRAYList of popular banks that support Net Banking
allBanksARRAYList of all banks that support Net Banking
bankIdSTRINGA short code to identify the bank, to be used in Pay API.
bankNameSTRINGFull name of the bank, to be used for display purposes.
bankShortNameSTRINGShort name of the bank, to be used for display purposes.
availableENUMIndicates whether the bank is currently available for Net Banking transactions. Its value will be one of the following:
AVAILABLE
UNAVAILABLE
DEGRADED
allBanksBOOLEANIndicates whether the bank supports account constraint or not.
allBanksINTIndicates the priority of the bank.

To Fetch Bank Logo

Bank Logo images can be obtained from PhonePe by using the template URL and replacing with the value of the "bankId" field from the above response.

👍

https://img.phonepe.com/images/banks/40/40/{bankId}.png

For example, if "bankId" is "HDFC", the logo image URL will be
https://img.phonepe.com/images/banks/40/40/HDFC.png

Also, if the logo image for a bank does not exist, a default bank logo image can be used with the below URL.

🚧

https://img.phonepe.com/images/banks/40/40/DEFAULT.png

Language
Click Try It! to start a request and see the response here!