search

POSTPayoutLink Status Check API

Use Case

This API is used to check the Current Status of the Payout Links.

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

orderId

string
mandatory

Order ID is merchant’s unique reference ID for a transaction passed in the transaction payload. This is Order ID for which the transaction status needs to be fetched.
Example: OREDRID_98765

Response Attributes

ATTRIBUTE DESCRIPTION

status

string

API response status
Example: SUCCESS

statusCode

string

API response statusCode
Example: DE_001

statusMessage

string

API response statusMessage
Example: Success

result

object

Result Response
 

Result

ATTRIBUTE DESCRIPTION

orderId

string

Unique reference id provided by the merchant for this disbursal request
Example: ORDERID_98765

subwalletGuid

string

It is sub wallet guid through which payment for the payout link was done.
Example: 28054249-XXXX-XXXX-af8f-fa163e429e83

subwalletName

string

Name of the subwallet used for payment.
Example: test

beneficiaryName

string

Beneficiary name
Example: Rahul

beneficiaryPhoneNo

string

Beneficiary phone number
Example: 7777777777

amount

string

Disbursement amount
Example: 1.00

beneficiaryEmail

string

Beneficiary email
Example: test@example.com

comments

string

comments
Example: Your Comment Here

expiryDate

string

Payout link expiry date
Example: 2020-10-04

payoutLinkId

string

Unique id generated by Paytm for every payout link
Example: 51D2J06xxxxxxxxxx641YSg0P

payoutLink

string

payout link generated
Example: https://paytm.me/o6Nq-uc

lastNotificationSent

string

local date-time of last Notification Sent
Example: 2020-09-25 15:07:49

createdOn

string

payout link created on date time.
Example: 2020-09-25

payoutLinkStatus

string

This is the payout link Status
Example: ACTIVE

paymentDetails

object

This object contains order(payment) level details
 

PaymentDetails

ATTRIBUTE DESCRIPTION

status

string

Order payment status
Example: SUCCESS

statusCode

string

Order payment status code
Example: DE_001

statusMessage

string

Order payment status message
Example: Successful disbursal to Bank Account is done

mid

string

Uniquer merchant Id
Example: INTEGR7769XXXXXX9383

orderId

string

Unique reference id provided by the merchant for this disbursal request
Example: ORDERID_98765

paytmOrderId

string

Unique order id created by paytm for every order.
Example: 2020090514592329673476925

amount

string

Disbursal amount
Example: 9.00

commissionAmount

string

Commission charged.
Example: 0.18

tax

string

Tax amount
Example: 0.03

transferMode

string

Transfer mode for payment
Example: IMPS

payMode

string

Payment mode used
Example: BANK_TRANSFER

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_400FAILUREInvalid 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_409FAILURE Checksum Verification Failed
DE_410FAILUREMethod Not Supported
DE_411FAILURE Media-Type Not Supported
DE_500FAILURESystem Error
DE_705FAILUREMerchant wallet balance can not be negative. Please fund your wallet and try again
DE_1204EXPIREDPayout link has expired
DE_1208LINK_PROCESSINGPayoutLink is getting created
DE_1209 FAILUREPayout 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/v2/payout-link/fetchcopy icon
REQUEST
RESPONSE
CURL
JAVA
NODE
PHP
PYTHON
DOTNET

curl -X POST 'https://staging-dashboard.paytm.com/bpay/api/v2/payout-link/fetch' \
--header 'Content-Type: application/json' \
--header 'x-mid: {mid}' \
--header 'x-checksum: {checksum}' \
--data '{"orderId":"ORDERID_98765"}' \
copy icon