search

POSTPayoutLink Deactivate API

Use Case

This API is used for deactivating payout links for merchants.

HTTP Headers

ATTRIBUTE DESCRIPTION

x-mid

string(50)
mandatory

Paytm provides MID as a unique identifier to each merchant. For your staging MID, click here. You get the production MID post the account activation.

x-checksum

string(108)
mandatory

Signature encryption for validation. It's value to be sent should be the checksum string created by using Paytm checksum library.
Note: Create the signature using all the request parameters.

Request Attributes

API Content Type: JSON

ATTRIBUTE DESCRIPTION

mid

string
optional

Paytm provides MID as a unique identifier to each merchant. For your staging MID, click here. You get the production MID post the account activation.
Example: INTEGR7769XXXXXX9383

payoutLinkId

string
mandatory

It is a unique alphanumeric Id generated by Paytm for each payoutLink.
Example: 51D2J06xxxxxxxxxx641YSg0P

Response Attributes

API Content Type: JSON

ATTRIBUTE DESCRIPTION

statusCode

string

payoutlink deactivate request status
Example: SUCCESS

status

string

payoutlink deactivate request statusCode
Example: DE_001

statusMessage

string

payoutlink deactivate request statusMessage
Example: The link is deactivated successfully

Response Codes & Messages

statusCodestatusstatusMessage
DE_001SUCCESSSuccess
DE_1216SUCCESSPayout link payment completed
DE_010FAILUREparam is mandatory and it's can't be null or blank
DE_011FAILUREparam doesn't contain a valid value
DE_013FAILUREparam doesn't contain valid length, It should be <length> or less
DE_019FAILUREMID is not valid
DE_021FAILUREDisburse amount should be Rs. 1 or more
DE_023FAILUREMid is not active
DE_040FAILUREDuplicate order id
DE_041FAILUREUnable to process your request. Please try after some time
DE_050FAILURECallback URL passed is Invalid
DE_054FAILURESubwalletGuid is not correct, Please check and try again
DE_057FAILUREInvalid request
DE_400FAILURE Invalid Request Parameter
DE_401FAILUREAuthentication Parameters Required
DE_402FAILUREAccess Denied
DE_403FAILUREAPI Not Found
DE_404FAILUREUnable to authenticate the request
DE_405FAILURERemote IP not whitelisted
DE_406FAILUREInvalid Client-Token
DE_407FAILUREClient-Token Required
DE_408FAILUREChecksum Required
DE_409FAILUREChecksum Verification Failed
DE_410FAILUREMethod Not Supported
DE_411FAILUREMedia-Type Not Supported
DE_500FAILURESystem Error
DE_705FAILUREMerchant wallet balance can not be negative. Please fund your wallet and try again
DE_1204EXPIRED Payout link has expired
DE_1208LINK_PROCESSINGPayoutLink is getting created
DE_1209FAILUREPayout link already submitted
DE_1210CANCELLEDPayout link cancelled
DE_1213LINK_FAILEDPayout link generation failed
DE_1214PENDINGPayout link payment pending
DE_1215FAILUREPayout link payment failed
Staging
Production
https://staging-dashboard.paytm.com/bpay/api/v1/payout-link/deactivatecopy icon
REQUEST
RESPONSE
CURL
JAVA
NODE
PHP
PYTHON
DOTNET
curl -X POST 'https://staging-dashboard.paytm.com/bpay/api/v1/payout-link/deactivate' \
--header 'Content-Type: application/json' \
--header 'x-mid: {mid}' \
--header 'x-checksum: {checksum}' \
--data '{"payoutLinkId":"51D2J06xxxxxxxxxx641YSg0P"}' \
copy icon