search

POSTPayoutLink Create API

Use Case

This API is used for creating 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

orderId

string
optional

It should be alphanumeric, orderId is merchant’s unique reference ID for a disburse transaction passed in the request. This is Order ID for which the disburse order status needs to be fetched. Length should be 50 characters or less
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. 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 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

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

payoutLinkStatus

string

This is the payout link Status

Example: LINK_PROCESSING

paymentDetails

string

This object contains order(payment) level details

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_013 FAILUREparam doesn't contain valid length, It should be <length> or less
DE_019 FAILUREMID is not valid
DE_021 FAILUREDisburse amount should be Rs. 1 or more
DE_023 FAILUREMid is not active
DE_040 FAILUREDuplicate order id
DE_041 FAILUREUnable to process your request. Please try after some time
DE_050 FAILURECallback URL passed is Invalid
DE_054 FAILURESubwalletGuid is not correct, Please check and try again
DE_057 FAILUREInvalid 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_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_1204EXPIREDPayout 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/createcopy icon
REQUEST
RESPONSE
CURL
JAVA
NODE
PHP
PYTHON
DOTNET
curl -X POST 'https://staging-dashboard.paytm.com/bpay/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