paytm developer docs logoDeveloperDocumentation
search

POSTPayoutLink Create API

Use Case

This API is used to create payout links for the 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

orderId

string
optional

Merchant’s unique reference ID for payout link passed in the request and the Order ID for which the payout link status needs to be fetched. It should be alphanumeric with a maximum length up to 50 characters.
Example: OREDRID_98765

subwalletGuid

string
mandatory

 Merchants sub wallet guid
Example: 28054249-XXXX-XXXX-af8f-fa163e429e83

amount

string
mandatory

 Amount in INR payable by the merchant. Should contain digits up to two decimal points. The only special character allowed is (“.”)
Example: 1.00

beneficiaryName

string
optional

 Name of the beneficiary to whom the merchant has to pay
Example: Rahul

beneficiaryPhoneNo

string
mandatory

 Phone Number of the beneficiary to whom the merchant has to pay
Example: 7777777777

expiryDate

string
optional

 Expiry Date of Payout Link in (yyyy-mm-dd) format. Maximum Expiry could be 10 days from the created date.
Example: 2020-10-08

notifyMode

string
mandatory

 Notify Mode can be SMS or EMAIL or both
Example: ["SMS","EMAIL"]

comments

string
mandatory

 Comments about the link
Example: Your Comment Here

beneficiaryEmail

string
mandatory

 Email of the beneficiary to whom the merchant has to pay. If EMAIL is used as notification mode then beneficiaryEmail is mandatory.
Example: test@example.com

Response Attributes

ATTRIBUTE

DESCRIPTION

status

string

This attribute should be used to fetch the final status of the order

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 payout link

Example: ORDERID_98765

subwalletGuid

string

It is a 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

payoutLinkStatus

string

This is the payout link Status

Example: LINK_PROCESSING

paymentDetails

string

This object contains order(payment) level details

Response Codes & Messages

statusCodestatusstatusMessage
PL_001SUCCESSSuccess
PL_1216SUCCESSPayout link payment completed
PL_010FAILUREparam is mandatory and it's can't be null or blank
PL_011FAILUREparam doesn't contain a valid value
PL_013FAILUREparam doesn't contain valid length, It should be <length> or less
PL_019FAILUREMID is not valid
PL_021 FAILUREDisburse amount should be Rs. 1 or more
PL_023FAILUREMid is not active
PL_040FAILUREDuplicate order id
PL_041 FAILUREUnable to process your request. Please try after some time
PL_054FAILURESubwalletGuid is not correct, Please check and try again
PL_057FAILUREInvalid request
PL_400FAILUREInvalid Request Parameter
PL_401FAILUREAuthentication Parameters Required
PL_402FAILUREAccess Denied
PL_403FAILUREAPI Not Found
PL_404FAILUREUnable to authenticate the request
PL_405FAILURERemote IP not whitelisted
PL_406FAILUREInvalid Client-Token
PL_407FAILUREClient-Token Required
PL_408FAILUREChecksum Required
PL_409FAILUREChecksum Verification Failed
PL_410FAILUREMethod Not Supported
PL_411FAILUREMedia-Type Not Supported
PL_500FAILURESystem Error
PL_1208LINK_PROCESSINGPayoutLink is getting created
PL_1209FAILUREPayout link already submitted
PL_1210CANCELLEDPayout link cancelled
PL_1213LINK_FAILEDPayout link generation failed
PL_1214PENDINGPayout link payment pending
PL_1215FAILUREPayout link payment failed
⇾
Staging
Production
https://staging-dashboard.paytm.com/pls/api/v1/payout-link/createcopy icon
REQUEST
RESPONSE
CURL
JAVA
NODE
PHP
PYTHON
DOTNET
curl -X POST 'https://staging-dashboard.paytm.com/pls/api/v1/payout-link/create' \
--header 'Content-Type: application/json' \
--header 'x-mid: {mid}' \
--header 'x-checksum: {checksum}' \
--data '{"subwalletGuid":"28054249-XXXX-XXXX-af8f-fa163e429e83","orderId":"ORDERID_98765","amount":"1.00","beneficiaryEmail":"test@example.com","beneficiaryPhoneNo":"7777777777","notifyMode":["SMS","EMAIL"],"comments":"Your Comment Here"}' \
copy icon