Merchant Credit Payment Options

Headers

FieldMandatoryDescription
Content-TypeYesapplication/json
X-VerifyYesSHA256(base64 encoded payload + '/v3/merchant/credit/options' + salt key) + '###' + salt index
{  
   "merchantId": "PPE_MRC_123",
   "userAuthToken": "USER_TOKEN568909123"
}
{
  "request": "eyAgCiAgICJtZXJjaGFudElkIjogIlBQRV9NUkNfMTIzIiwKICAgInVzZXJBdXRoVG9rZW4iOiAiVVNFUl9UT0tFTjU2ODkwOTEyMyIKfQ=="
}
{  
   "merchantId": "PPE_MRC_123",
   "mobileNumber": "9988776655"
}
{
  "request": "eyAgCiAgICJtZXJjaGFudElkIjogIlBQRV9NUkNfMTIzIiwKICAgIm1vYmlsZU51bWJlciI6ICI5OTg4Nzc2NjU1Igp9"
}

Request Parameters

Field NameData TypeMandatoryDescription
merchantIdStringYesUnique Id assigned to the merchant in the PhonePe system. Assigned during merchant onboarding.
userAuthTokenStringConditionaluserAuthToken generated from user linking.
Mandatory if not passing mobileNumber.
mobileNumberStringConditionalToken to identify the user generated during otp verify call.
Mandatory if not passing userAuthToken.
{
  "success": true,
  "code": "SUCCESS",
  "message": "Your request has been successfully completed.",
  "data": {
    "upiAccounts": [
      {
        "instrumentId": "ASY1231",
        "instrumentType": "ACCOUNT",
        "instrumentLogo": "https://ppe/{width}/{height}/SBIN.png",
        "instrumentDetails": {
          "maskedAccountNo": "XXXXXmaskedNo",
          "accountHolderName": "accouXX XXXXXX XXme",
          "bankName": "bank Name",
          "bankCode": "bank Code"
        }
      }
    ]
  }
}
{
  "success": true,
  "code": "SUCCESS",
  "message": "Your request has been successfully completed.",
  "data": {
    "phonepeVpas": [
      {
        "instrumentId": "kuh453459345b23khjhg453454bf4r3rf",
        "instrumentType": "VPA_TOKEN",
        "instrumentDetails": {
          "vpa": "[email protected]",
          "accountHolderName": "accouXX XXXXX XXme"
        }
      }
    ]
  }
}

Response Parameters

Field NameData TypeDescription
successBooleanRedundant field. To be ignored by merchants.
codeStringSee "CREDIT OPTIONS : Response Codes" table for the list of possible values and their meanings.
messageStringShort message describing the code
dataObjectObject containing details of actual response data

CREDIT OPTIONS : Response Codes

Code ValueDescription
SUCCESSSuccessful Scenario.
BAD_REQUESTInvalid request payload.
INTERNAL_SERVER_ERRORSomething went wrong on the server-side.
USER_NOT_FOUNDNo user found for the given mobile number or userAuthToken.
INVALID_USER_AUTH_TOKENThe user auth token provided for this token is either expired or not mapped to the merchant. Please regenerate the token & try again.

Response Data Description: Data Level Fields

Field NameData TypeDescription
upiAccountsListList of linked bank accounts in which the user can receive payment.
phonepeVpasListList of VPAs in which the user can receive payment.
Note: Multiple VPAs can be linked to the same bank account.

Response Data Description: phonepeVpas Fields

Field NameData TypeDescription
instrumentIdStringUnique identifier for this VPA. To be passed in pay call.
instrumentTypeStringType of instrument i.e. VPA_TOKEN. To be passed in pay call.
vpaStringMasked VPA by default. Clear VPA returned based on merchant whitelisting
accountHolderNameStringMasked Account holder name of the account linked with Vpa. Clear account holder name returned based on merchant whitelisting
ifscStringIFSC code of the bank . Optional field. Based on merchant whitelisting

Response Data Description: upiAccounts Fields

Field NameData TypeDescription
instrumentIdStringUnique identifier for this bank account. To be passed in pay call
instrumentTypeStringType of instrument. i.e. ACCOUNT. To be passed in pay call.
instrumentLogoStringSuggested bank logo/icon for display to user. Can be sized according to requirement
maskedAccountNoStringMasked account number
accountHolderNameStringMasked Account holder name as per bank records by default. Clear account holder name returned based on merchant whitelisting.
ifscStringIFSC code of the bank account. Optional field. Based on merchant whitelisting.
bankNameStringBank name
bankCodeStringBank code
Language
Click Try It! to start a request and see the response here!