Direct Wallet Debit

API to debit the money directly from PhonePe wallet.

Request Headers

Header Name

Header Value

Content-Type

application/json

X-VERIFY

SHA256(base64 encoded payload +
' /v3/debit/instant' + salt key) +
'###' + salt index

{
 "merchantId": "DemoMerchant",
 "transactionId": "TX123456789",
 "userAuthToken":"1604832205579140b0931ce0abbb450b9a40e81ed06ce216",
 "amount": 100,
 "merchantOrderId": "OD1234",
 "subMerchant": "DemoMerchant",
 "message": "Payment for order OD1234"
}
{
 "request" : "ew0KCeKAnG1lcmNoYW50SWTigJ06IOKAnEpJT+KAnSwNCgnigJx0cmFuc2FjdGlvbklk4oCdOiDigJxUWE4xMjM0NeKAnSwNCgnigJxtZXJjaGFudE9yZGVySWTigJ0gOiDigJxPNDIzODTigJ0sDQoJ4oCcbW9iaWxlTnVtYmVy4oCdOiDigJw5ODc2NTQzMjEw4oCdLA0KCeKAnG1lcmNoYW50VXNlcklk4oCdOiDigJxVU0VSMTIzNDXigJ0sDQoJ4oCcZW1haWw6IOKAnG5pc2hhbnQubUBnbWFpbC5jb23igJ0sDQoJ4oCcc2hvcnROYW1l4oCdIDog4oCcTmlzaGFudCBNaXR0YWzigJ0NCn0="
}

Request Parameters

Parameter Name

Type

Description

Mandatory

merchantId

string

Unique merchant id assigned to the merchant

Yes

transactionId

string

Unique Transaction ID generated by the merchant to track this request to PhonePe

Yes

amount

int

Amount in paise

Yes

mobileNumber

string

Mobile number on which OTP will be sent

Yes

merchantOrderId

string

Order ID for the merchant transaction

Yes

userAuthToken

string

Auth token generated from otp verify

Yes

email

string

Email id of customer

No

shortName

string

Name of customer

No

Response Parameters

Parameter Name

Type

Description

success

boolean

Denotes if API call is successful.

code

string

See below for list of values

data

object

See below table

message

string

Short message about code

Response Codes

Code

Description

INVALID_TRANSACTION_ID

Duplicate TransactionID

BAD_REQUEST

Invalid request payload

AUTHORIZATION_FAILED

Incorrect X-VERIFY header

INTERNAL_SERVER_ERROR

Something went wrong

INVALID_USER_AUTH_TOKEN

The userAuthToken provided is either invalid or not mapped to merchant.

PAYMENT_SUCCESS

Payment is successful

PAYMENT_ERROR

Payment failed

USER_BLACKLISTED

Customer is blacklisted on PhonePe side

MERCHANT_USER_NOT_FOUND

No user exists for merchant id and user id combination.

USER_BLOCKED

User is blocked for 1 day.

TIMED_OUT

Payment timed out (Status check is required)

Response Data

Parameter Name

Type

Description

transactionId

String

Unique Transaction ID generated by the merchant to track this request to PhonePe

merchantId

String

Unique Merchant ID assigned to the merchant by PhonePe

amount

Long

Transaction amount in paise

status

String

Status of the request

merchantUserId

String

Unique ID assigned to the user by the merchant. This is used for linking the user’s PhonePe account.

mobileNumber

String

Mobile number of the user

providerReferenceId

String

PhonePe transaction id

payResponseCode

String

PhonePe internal status code

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