• Getting Started
    • Website Integration
      Mobile Integration (Android/IOS)
      Enterprise Solutions
      Accept Payments
      Process Payments
      Disbursals
      API References
      Webhooks
      Testing
      Refunds
      Guides
      Other Processes

      Claim Back Funds from main funding account API

      Checksum required: Yes

      Use Case


      This API is used to claim back funds from disbursal accounts/subwallet to main funding account

      HTTP Headers

      ATTRIBUTEDESCRIPTIONMANDATORY
      x-midString(50)Unique identifier provided to every merchant by Paytm.Yes
      x-checksum StringChecksum string created by using Paytm checksum library.Yes

      Request Attributes

      API Content format: JSON


      ATTRIBUTEDESCRIPTIONMANDATORY
      subwalletGuid String(50)Sub wallet/disbursal account GUID. This is available on Paytm dashboardYes
      amountStringAmount in INR to be claimed back from disbursal accountYes

      Response Attributes

      ATTRIBUTEDESCRIPTION
      statusCode String(30)Failure reason code where status is FAILURE. A detailed list of statusCode is mentioned at the bottom of this page.
      status String(30)Disbursal request status. It can be FAILURE or ACCEPTED or SUCCESS.
      statusMessage StringDescription of each statusCode.

      Response codes and Messages

      statusCodestatusstatusMessage
      DE_001SUCCESSRequest Successfully fullfilled.
      DE_1001FAILUREUnable to process the request, Please check and try again.
      DE_1002FAILUREInvalid merchant.
      DE_1003FAILURESub wallet not found.
      DE_1004FAILUREWallet balance is insufficient for this transaction. Please add money in your wallet and retry.
      DE_1005FAILUREInvalid currency code.
      DE_1006FAILUREMerchant is inactive.
      DE_1007FAILUREWallet could not be found, please verify walletGuid.
      DE_1008FAILUREPayee wallet could not be found.
      DE_1009FAILURESub wallet guid is not associated with this merchant.
      DE_1010FAILUREMerchant can't transfer money to his own wallet.
      DE_1011FAILUREMerchant can't transfer money which is not added in Business. wallet manually
      DE_1012FAILUREFund transfer not allowed to top up wallet.
      DE_1013FAILUREFund transfer not allowed from top up wallet.
      DE_1014FAILUREMax per transaction amount exceed.
      DE_1015FAILUREMaximum number of allowed transactions exceed.
      DE_1016FAILUREInvalid Transaction Amount.
      DE_1017FAILUREUnable to fetch subwallet of merchant.

      Endpoints

      Staging: https://staging-dashboard.paytm.com/bpay/api/v1/account/debit

      Production: https://dashboard.paytm.com/bpay/api/v1/account/debit

      Request CodeResponse JSON
      curl -X POST 'https://staging-dashboard.paytm.com/bpay/api/v1/account/debit' --header 'Content-Type: application/json' --header 'x-mid: {mid}' --header 'x-checksum: {checksum}' --data '{"subwalletGuid":"{subwalletGuid}","amount":"{amount}"}'