Merchant Credit Payment Options

Headers

Field

Mandatory

Description

Content-Type

Yes

application/json

X-Verify

Yes

SHA256(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 Name

Data Type

Mandatory

Description

merchantId

String

Yes

Unique Id assigned to the merchant in the PhonePe system. Assigned during merchant onboarding.

userAuthToken

String

Conditional

userAuthToken generated from user linking.
Mandatory if not passing mobileNumber.

mobileNumber

String

Conditional

Token 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 Name

Data Type

Description

success

Boolean

Redundant field. To be ignored by merchants.

code

String

See "CREDIT OPTIONS : Response Codes" table for the list of possible values and their meanings.

message

String

Short message describing the code

data

Object

Object containing details of actual response data

CREDIT OPTIONS : Response Codes

Code Value

Description

SUCCESS

Successful Scenario.

BAD_REQUEST

Invalid request payload.

INTERNAL_SERVER_ERROR

Something went wrong on the server-side.

USER_NOT_FOUND

No user found for the given mobile number or userAuthToken.

INVALID_USER_AUTH_TOKEN

The 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 Name

Data Type

Description

upiAccounts

List

List of linked bank accounts in which the user can receive payment.

phonepeVpas

List

List 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 Name

Data Type

Description

instrumentId

String

Unique identifier for this VPA. To be passed in pay call.

instrumentType

String

Type of instrument i.e. VPA_TOKEN. To be passed in pay call.

vpa

String

Masked VPA by default. Clear VPA returned based on merchant whitelisting

accountHolderName

String

Masked Account holder name of the account linked with Vpa. Clear account holder name returned based on merchant whitelisting

ifsc

String

IFSC code of the bank . Optional field. Based on merchant whitelisting

Response Data Description: upiAccounts Fields

Field Name

Data Type

Description

instrumentId

String

Unique identifier for this bank account. To be passed in pay call

instrumentType

String

Type of instrument. i.e. ACCOUNT. To be passed in pay call.

instrumentLogo

String

Suggested bank logo/icon for display to user. Can be sized according to requirement

maskedAccountNo

String

Masked account number

accountHolderName

String

Masked Account holder name as per bank records by default. Clear account holder name returned based on merchant whitelisting.

ifsc

String

IFSC code of the bank account. Optional field. Based on merchant whitelisting.

bankName

String

Bank name

bankCode

String

Bank code

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