paytm developer docs logoDeveloperDocumentation
search

POSTDisburse Status​ Query​ ​API

Use Case

This API is used to check the wallet or bank account disbursal transaction status.

 

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

Content Type : JSON

Body

AttributeDescription
orderId
string(50)
mandatory

Unique reference ID provided by merchant for each disbursal/transfer request.

Response Attributes

Content Type : JSON

Body

AttributeDescription
statusCode
string

Failure reason code where status is FAILURE. A detailed list of statusCode is mentioned at the bottom of this page.

status
string

Disbursal request status. This attribute should be used to fetch the final status of the order. It can be FAILURE, ACCEPTED, SUCCESS, CANCELLED, PENDING, and QUEUED.

statusMessage
string

Description of each statusCode.

result
object

Result details for the transfer APIs.

Result
+
AttributeDescription
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.

Example: INTEGR7769XXXXXX9383

orderId
string(50)

The Unique reference ID of the Order. It is alphanumeric and special characters allowed are “@” “-” “_” “.”.
Example: OREDRID_98765

Unique reference id provided by the merchant for this disbursal request.

paytmOrderId
string(50)

Unique ID generated at paytm end corresponding to each transaction.

amount
string

Amount in INR requested by the merchant for disbursal.

commissionAmount
string

Commission amount in INR payable by the merchant. This will contain digits up to two decimal points.

tax
string

Tax amount in INR payable by the merchant.This will contain digits up to two decimal points.

rrn
string(10)

Unique reference number created by a bank against each transaction.It is null for wallet transfers.

Response Codes & Messages

statusCode status statusMessage
DE_001 SUCCESS Successful disbursal to Bank Account is done.
DE_002 ACCEPTED Request accepted
DE_010 FAILURE parameter is mandatory and it's can't be null or blank.
DE_011 FAILURE parameter doesn't contain valid value
DE_012 FAILURE An amount must be a positive number with maximal 2 decimal places
DE_013 FAILURE param doesn't contain valid length, It should be or less
DE_014 FAILURE PPBL account no should be 12 digits and starts with 91
DE_015 FAILURE Purpose not valid
DE_016 FAILURE Month not valid
DE_017 FAILURE Year not valid
DE_018 FAILURE You can disburse the amount up to 6 months before from the current month
DE_019 FAILURE MID is not valid
DE_020 FAILURE Uploaded file is blank
DE_021 FAILURE Disburse amount should be Rs. 1 or more
DE_022 FAILURE Disburse amount should not be more than Rs. 200000
DE_023 FAILURE Mid is not active
DE_024 FAILURE Account no should be alphanumeric with length between 9 to 18 digits
DE_025 FAILURE IFSC code is invalid.
DE_026 FAILURE Uploaded file must be of csv format
DE_027 FAILURE File must contain 4 headers
DE_028 FAILURE Cannot exceed columns more than
DE_029 FAILURE Total amount to be disbursed is more than the subwallet balance
DE_030 FAILURE File already exists with this name
DE_034 FAILURE Invalid Pay Mode
DE_035 FAILURE Your request has been rejected by your configured Approver.
DE_036 FAILURE Uploaded file contains records more than records
DE_039 FAILURE No record found.
DE_040 FAILURE Duplicate order id
DE_041 FAILURE Unable to process your request. Please try after some time
DE_042 FAILURE Date format is not correct as it should be yyyy-MM-dd
DE_043 FAILURE Duplicate Account Number Found in the file
DE_044 FAILURE Invalid beneficiary Mobile No. or Email Id
DE_045 FAILURE Please provide either PhoneNo / Email Id
DE_046 FAILURE Disbursal Date provided is not of valid format
DE_048 FAILURE Phone No. not Registered
DE_049 FAILURE Disburse amount should not be more than Rs. 100000
DE_050 FAILURE Callback URL passed is Invalid
DE_051 FAILURE Disbursal to other bank accounts not supported
DE_052 FAILURE Bank Transfer Mode not valid
DE_053 FAILURE IMPS not allowed for amount more than 2 lakhs
DE_054 FAILURE SubwalletGuid is not correct, Please check and try again
DE_055 FAILURE Unable to disburse from given subWalletGuid. Please use another or create a new one
DE_056 FAILURE UPI not allowed for amount more than 1 lakhs
DE_057 FAILURE Invalid request
DE_058 FAILURE Merchant Commission not configured
DE_065 FAILURE Velocity limit exceeded
DE_101 PENDING Your request is in process. Kindly check after sometime.
DE_102 PENDING Disbursal to Bank Account failed. Your refund to sub-wallet is in process.
DE_103 FAILURE Invalid Response Code.
DE_104 FAILURE PhoneNo. required to validate beneficiary name
DE_105 FAILURE Beneficiary name not matched.
DE_106 FAILURE Mobile number is not registered.
DE_107 FAILURE KYC is Not Done.
DE_108 FAILURE Unable to validate Beneficiary Name.
DE_110 FAILURE VPA Validation Failed
DE_111 CANCELLED Your order has been cancelled.
DE_113 QUEUED Your order is queued for next retry
DE_114 QUEUED Your order is cancelled. Refund is initiated
DE_116 QUEUED Your order is queued due to low balance in subwallet.
DE_1218 FAILURE Could not find details for input beneficiary contactRefId
DE_1219 FAILURE Could not fetch details for the contactRefId. Please try again
DE_1220 FAILURE Multiple matches found for given beneficiary contactRefId
DE_400 FAILURE Invalid Request Parameter.
DE_401 FAILURE Authentication Parameters Required.
DE_402 FAILURE Access Denied.
DE_403 FAILURE API Not Found.
DE_404 FAILURE Unable to authenticate request.
DE_405 FAILED Remote IP not whitelist. Please ask your admin to whitelist Remote IP: <IP Address> from Payouts dashboard under developer's settings.
DE_406 FAILURE Invalid Client-Token
DE_407 FAILURE Client-Token Required
DE_408 FAILURE Checksum Required.
DE_409 FAILURE Checksum Verification Failed.
DE_500 FAILURE System Error.
DE_601 PENDING Disbursal to bank account is in process. Please check again in some time
DE_602 FAILURE Disbursal to bank account failed. Please try after some time.
DE_603 FAILURE Disbursal to bank account failed.
DE_604 PENDING Disbursal to Bank Account is in process and pending at Beneficiary Bank.
DE_606 FAILURE Invalid account number.
DE_607 FAILURE Error at bank end.
DE_609 FAILURE Unable to fetch details.
DE_610 FAILURE No fds available
DE_612 FAILURE Account blocked/frozen.
DE_613 FAILURE Invalid IFSC/MICR.
DE_614 FAILURE Account is closed.
DE_615 FAILURE Invalid account number or IFSC code.
DE_616 FAILURE Daily allowed amount limit for the beneficiary is exceeded.
DE_617 FAILURE Beneficiary account is NRE account.
DE_618 FAILURE Invalid NBIN (IFSC code).
DE_619 FAILURE NPCI rejects as net debit cap is exceeded for remitter.
DE_620 FAILURE Card is restricted at beneficiary account.
DE_621 FAILURE Transaction declined, Bank not enabled for P2A functionality.
DE_622 FAILURE Maximum limit amount exceeded.
DE_623 FAILURE Exceeded maximum allowed number of transfers per day .
DE_625 FAILURE Invalid IFSC code.
DE_626 FAILURE Transaction is declined based on From account type and To account type.
DE_627 FAILURE Transaction is declined based on transaction limit imposed on the From account type and To account type.
DE_628 FAILURE Beneficiary PPI is Gift prepaid and this is not the first transaction.
DE_629 FAILURE Acquiring bank has not implemented customer initiated person-to-merchant transaction.
DE_631 FAILURE Amount is greater than 2 Lakhs (Applicable for Bank where NDC is greater than 2 Lakhs).
DE_632 FAILURE Invalid payment reference.
DE_633 FAILURE Invalid amount
DE_634 FAILURE Invalid transaction.
DE_636 FAILURE Unable to process.
DE_637 FAILURE Blocked/Lost/Hotlisted card
DE_638 FAILURE Expired card
DE_639 FAILURE Debit Request Failure
DE_640 FAILED Transaction has been declined as it exceeds the limits set by beneficiary bank.
DE_641 FAILURE No record found.
DE_643 FAILURE Remmiter and beneficiary accounts are same.
DE_646 FAILURE Fund transfer not allowed for this transaction type.
DE_647 FAILURE Refund not allowed for this transaction type.
DE_648 FAILURE Product Service Unavailable.
DE_649 FAILURE

Transaction cannot be processed as current account limits will be breached
DE_650 FAILURE CA Form 60 Val Current Account Form 60 Daily deposit limit breached.
DE_651 FAILURE Fraud verification Maquette suspicious response.
DE_652 FAILURE Nodal IMPS Nodal IMPS Amount Limit Breached.
DE_653 FAILURE Nodal IMPS Beneficiary Does Not exist.
DE_654 FAILURE Refund Processing Service No successful parent transaction found for request.
DE_655 FAILURE Refund Processing service Refund amount is greater than max amount available for refund
DE_656 FAILURE Credit account freeze.
DE_657 FAILURE Host (CBS) offline / Beneficiary node offline
DE_658 FAILURE Account does not exist in CBS
DE_659 FAILURE Bank is not enabled for IMPS P2U
DE_660 FAILURE This IFSC is no longer valid. Please update account details
DE_661 FAILURE Invalid payee mobile
DE_662 FAILURE Invalid virtual address
DE_663 FAILURE Money transfer is not allowed to receiver account
DE_664 FAILURE Money transfer request declined by the receiver bank. Please try again
DE_665 FAILURE Payee bank UPI not supported
DE_666 FAILURE Money transfer request declined by the remitter bank
DE_667 FAILURE Bank account is not active
DE_668 FAILURE UPI user not found
DE_669 FAILURE UPI not registered or UPI registered but bank a/c not linked
DE_670 FAILURE Your request was unsuccessful. Please try again
DE_671 FAILURE You have exceeded the daily transaction amount limit set by your bank
DE_672 FAILURE You can not send money to this UPI ID
DE_673 FAILURE Invalid UPI id
DE_674 FAILURE Beneficiary bank account details are not correct
DE_675 FAILURE Something went wrong at the receiver bank servers. Please try again
DE_676 FAILURE Beneficiary account does not exist
DE_677 FAILURE Request declined by the receiver bank
DE_678 FAILURE Invalid payer UPI address
DE_684 FAILURE Credit adjustment
DE_685 FAILURE Fresh reversal
DE_686 FAILURE Credit adjustment
DE_689 FAILURE Inactive/Dormant Account
DE_690 FAILURE Money transfer request declined by the receiver bank
DE_691 FAILED Disbursal to bank account failed. Please try after some time.
DE_692 FAILED Beneficiary bank doe not allow transactions for lower amounts
DE_701 FAILURE Merchant does not exists.
DE_702 FAILURE User doesn't exist
DE_703 FAILURE Wallet could not found, please verify walletGuid.
DE_704 FAILURE Sub wallet not found.
DE_705 FAILURE Agent wallet balance cann't be negative. Please fund your wallet and try again.
DE_706 FAILURE Refund is not possible as refund possibly already done or current refund request may cause refund to exceed actual transaction amount
DE_707 FAILURE Refund amount should be equal to the transaction amount
DE_708 FAILURE Sub wallet guid is not associated with this merchant
DE_709 FAILURE Invalid Transaction Amount
DE_901 FAILURE Disbursal to wallet failed. Please try after sometime.
DE_902 FAILURE Disbursal to wallet failed.
DE_905 FAILURE Corporate wallet not found.
DE_906 FAILURE Paytm wallet does not exist.
DE_907 FAILURE Merchant can't transfer money to his own wallet.
DE_908 FAILURE Invalid userId, email or phone no.
DE_909 FAILURE Payee mobile not verified.
DE_910 FAILURE Payee email not verified.
DE_911 FAILURE Payee mobile and email not verified.
DE_912 FAILURE Adding funds to subwallet not supported.
DE_913 FAILURE Sub Wallet not assigned to merchant.
DE_914 FAILURE Fund cannot be refilled in this wallet.
DE_915 FAILURE Funds cannot be added as user wallet type is basic.
DE_916 FAILURE SubWallet is not active.
DE_917 FAILURE Invalid Subwallet Expiry Date, Past expiry date is not allowed.
DE_919 FAILURE Invalid merchant.
DE_921 FAILURE Merchant does not exist.
DE_921 FAILURE Merchant does not exist.
DE_922 FAILURE Insufficient funds in corporate sub wallet.
DE_923 FAILURE Paytm Wallet is not active.
DE_924 FAILURE Maximum allowed transaction amount exceed.
DE_925 FAILURE Max per transaction amount exceed.
DE_926 FAILURE Maximum number of allowed transactions exceed.
DE_927 FAILURE Maximum allowed transactions amount in a year exceed.
DE_928 FAILURE Maximum number of allowed transactions in a year exceed.
DE_929 FAILURE Cumulative txn type limit breached.
DE_931 FAILURE Maximum allowed wallet balance is exceed.
DE_932 FAILURE Exceed maximum allowed money addition in wallet for this month.
DE_933 FAILURE RBI approved min KYC wallet spending limits exceeded. No new fund additions are allowed.
DE_934 FAILURE The destination Paytm user will need to do KYC to add/receive money.
DE_935 FAILURE Sub_Wallet limit exceeded.
DE_936 FAILURE Max Allowed sub wallet limit exceeded.
DE_937 FAILURE Maximum per transaction amount exceed.
DE_940 FAILURE Invalid Txn Id.
DE_941 FAILURE Risk Reject.
DE_943 FAILURE Monthly limit for number of Payment to Merchant transactions will exceed.
DE_944 FAILURE Daily limit for total amount of Payment to Merchant transactions will exceed.
DE_945 FAILURE Monthly limit for total amount of Payment to Merchant transactions will exceed.
DE_946 FAILURE Daily limit for number of Payment to Merchant transactions will exceed.
DE_947 FAILURE RBI approved KYC wallet limits exceeded. No new fund additions are allowed.
DE_948 FAILURE Receiver has not completed his KYC.
DE_949 FAILURE Monthly credit limit breach.
DE_961 FAILURE Invalid user id.
DE_963 FAILURE User exist but no corresponding wallet found.
DE_964 FAILURE Merchant exist but no corresponding wallet found.
DE_965 FAILURE Found multiple accounts with same phone no. and all are unverified.
DE_966 FAILURE Found multiple accounts with same mail-id and all are unverified.
DE_967 FAILURE Merchant is incative.
DE_969 FAILURE Sales wallet not found.
DE_970 FAILURE Invalid salesWalletGuid.
DE_971 FAILURE Invalid salesWalletName/salesWalletGuid.
DE_972 FAILURE Payer wallet could not found.
DE_973 FAILURE Adding funds to wallet not supported.
DE_974 FAILURE Cashback Audit Details not available.
DE_975 FAILURE Payer Wallet not active.
DE_976 PENDING CashBack Pending!! Communication already sent to user
DE_978 FAILURE Cashback PPIType is invalid
DE_979 FAILURE PendingDaysLimit is out of range.
DE_983 FAILURE You cannot add this amount as you will exceed wallet credit limit. Please try with a lower amount
DE_983 FAILURE You cannot add this amount as you will exceed wallet credit limit. Please try with a lower amount
DE_688 SUCCESS Penalty Credit
DE_038 PENDING Your request is pending from Approver's end. Kindly check after sometime
DE_1801 FAILURE Auto expired, as approval was pending for more than 6 months.
DE_687 SUCCESS Wrong credit
DE_605 FAILURE Transaction was rejected due to Risk threshold by NPCI/Beneficiary Bank
DE_611 FAILURE Debit Card associated with beneficiary bank has expired. Please reach out to beneficiary bank
DE_630 FAILURE Transaction deemed Failed
DE_624 FAILURE Payee bank UPI not supported
DE_608 FAILURE Per Transaction limit exceeded as set by the Beneficiary bank
DE_693 FAILURE Transaction has been declined by NPCI / Beneficiary Bank due to risk policy
DE_694 FAILURE Transaction has been declined as it exceeds the limits set by Remiiter bank.
DE_635 FAILURE VPA length greater than 25 Characters
DE_642 FAILURE Transaction not permitted on this account
DE_695 FAILURE Transactions are rejected by beneficiary bank to this account
DE_696 FAILURE VPA has Expired
DE_697 FAILURE Collect Request on this VPA is Blocked
DE_698 FAILURE Payment request was declined by the remitter bank as your account is invalid.
DE_801 FAILURE Current account is out of balance
DE_802 FAILURE Foreign inward remittance not allowed
DE_803 FAILURE Invalid BC ID
⇾
Staging
Production
https://staging-dashboard.paytm.com/bpay/api/v1/disburse/order/querycopy icon
REQUEST
RESPONSE
CURL
JAVA
NODE
PHP
PYTHON
DOTNET
curl -X POST 'https://staging-dashboard.paytm.com/bpay/api/v1/disburse/order/query' \
--header 'Content-Type: application/json' \
--header 'x-mid: {mid}' \
--header 'x-checksum: {checksum}' \
--data '{"orderId":"ORDERID_98765"}'
copy icon