POSTPayout To Card API
Use Case
This API is used for disbursing amounts from merchant's sub wallet to beneficiary cards.
Header
Content-Type: application/json
ATTRIBUTE | DESCRIPTION |
---|---|
x-mid string(50) |
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) |
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
Content Type : JSON
ATTRIBUTE | DESCRIPTION |
---|---|
mid string mandatory |
Unique identifier provided to every merchant by Paytm |
orderId string mandatory |
Merchant’s unique reference ID for a disburse transaction passed in the request. This is the Order ID for which the disburse order status needs to be fetched. It should be alphanumeric with a maximum length of up to 50 characters. |
subwalletGuid string mandatory |
Merchants sub wallet guid. Sub wallet GUID will be present on the dashboard. |
amount string mandatory |
Amount in INR payable by the merchant. It should contain digits up to two decimal points and the only special character allowed is (“.”). |
beneficiaryCardToken string mandatory |
Card Token is an encrypted card number. It is case-sensitive and should be alphanumeric. |
beneficiaryTxnId string optional |
This is only applicable if you are using Paytm Payment Gateway Services. Original PG order TXN ID needs to passed. Note : Either pass "beneficiaryTxnId" or "beneficiaryCardToken" for performing transaction |
cardTransactionType string mandatory |
CardTransactionType should be DISBURSAL. cardTransactionType are case sensitive. |
disburseOnlyIfInstant boolean mandatory |
Disbursement will be initiated if instant payment is supported on this card. Value can be true or false. |
txnSubType string mandatory |
Value of txnSubType can only be CARD_NUMBER/TXN_ID. These values are case-sensitive. |
comments string optional |
Disbursal comments. Its length should be 50 characters or below. |
callbackUrl string optional |
URL where we will post disbursal status. URL on which callback will be received in case of Success or Failure of Order. The merchant needs to whitelist this URL with Paytm. |
Response Attributes
Content-Type : JSON
ATTRIBUTE | DESCRIPTION |
---|---|
status string |
Status of merchant request |
statusCode string |
Status code of request |
statusMessage string |
Status message for request |
Response Codes & Messages
status | statusCode | statusMessage |
---|---|---|
DE_1400 | SUCCESS | Success |
DE_1224 | FAILURE | Card is not supported |
DE_1225 | FAILURE | Instant Payment is not supported |
DE_1401 | FAILURE | Disbursal To Card Invalid Response Code |
DE_1402 | FAILURE | Disbursal to card failed from Bank |
DE_1403 | FAILURE | Card currently not supported for payments |
DE_1404 | PENDING | Your request is in process.Card transaction is pending at beneficiary bank end |
DE_1406 | FAILURE | Couldn't fetch details for the Card |
DE_1407 | FAILURE | Card type not supported for transaction |
DE_1408 | FAILURE | Card token is not valid |
DE_1409 | FAILURE | Amount limit reached |
DE_1410 | FAILURE | Card Transaction failed. Please try again after sometime |
DE_1411 | FAILURE | Card scheme not supported |
DE_1412 | FAILURE | Transaction details are not valid |
DE_1413 | FAILURE | Transaction Id is not valid |
DE_1414 | FAILURE | Non-Bank card transaction |
DE_069 | FAILURE | Maximum allowed monthly money transfer limit from your Paytm Payouts Account is exhausted. Monthly Limit - {param} |
DE_1104 | FAILURE | Disbursement process failed |
curl -X POST 'https://staging-dashboard.paytm.com/bpay/api/v1/disburse/order/card' \
--header 'x-mid: bankdi06869211999427' \
--header 'x-checksum: FIKXZrl66n1VwOQwh3W1RigxgoV2b5Btjnw6s+wEeKhJn9aKDP5qNqlxUnQ7Y/YJzecve9qbXicKKRQKWXggUUKukrYDG8Bnt02b52QQ7v8=' \
--header 'Content-Type: application/json' \
--data '{"orderId":"Jan13_0431", "subwalletGuid":"477ed482-1207-405b-9d45-50b5ec1bf444", "amount":"1", "purpose":"BONUS", "beneficiaryCardToken":"jNDZy6HRh1T6YglUmwFocI2QCuFBrZEqPVNbK3kSUW8=", "cardTransactionType":"DISBURSAL", "disburseOnlyIfInstant":"true", "txnSubType":"CARD_NUMBER"}'