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

      post Account Passbook API

      Use Case


      This API provides the transactional level details and the closing balance per transaction. Merchants can use this API for their reconciliation needs.

      HTTP Headers

      PARAMETER DESCRIPTION MANDATORY
      x-midstring(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. mandatory
      x-checksumstring(108) Signature encryption for validation. It's value to be sent should be the checksum string created by using Paytm checksum library. mandatory

      Request Attributes


      API Content Type: JSON

      Body1

      Body

      ATTRIBUTEDESCRIPTION
      subwalletGuid string
      mandatory
      Sub wallet/disbursal account GUID. This is available on Paytm dashboard
      fromDate string
      mandatory
      Pass the from date from which txns need to fetch
      Date format YYYY-MM-DD
      toDate string
      mandatory
      Pass the end date
      Date format YYYY-MM-DD
      startResult long
      optional
      Start Result from which you want to fetch the records
      endResult long
      optional
      End result of the records

      Response Attributes


      API Content Type: JSON

      Body2

      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(30)
      It can be SUCCESS or FAILURE
      statusMessage string
      Description of each statusCode.
      result Result
      Result details and Number of Records
      Result +
      AttributeDescription
      resultSize long
      Number of records to fetch for this Page.
      startResult long
      Start number from the total records
      endResult long
      End number from the total records
      result object
      Result Details
      Result +
      AttributeDescription
      merchantDisplayName string(50)
      Merchant name
      merchantId string(50)
      Unique merchant identifier provided to every merchant by Paytm
      creditOrDebit string(50)
      Credit or Debit
      txnAmount string
      Amount
      commission string
      Commission amount
      businessTxnType string
      Business Transaction Type
      tax string
      Tax amount
      tds string
      Tds amount
      txnId string
      Wallet transaction id
      merchantTxnType string
      Disbursed to Food Wallet
      Disbursed to Gift Wallet
      Disbursed to Fuel Wallet
      Disbursed to User Wallet
      Disbursed to Communication Wallet
      Disbursed to Allowance Wallet
      Disbursed to Loyalty Wallet
      Funds Received
      Funds Added to Sub Account
      Funds Reclaimed from Sub Account
      Disbursed to Bank
      Refund From Bank
      txnType string
      Transaction type
      txnStatus string
      Txn status at wallet end
      txnDate string
      Date of transaction
      orderId string
      Merchant order id
      paytmOrderID string
      Paytm order id which generated aginst the disbursal request.
      mode string
      This field contains disbursal mode like below
      Food Wallet
      Gift Wallet
      Fuel Wallet
      Wallet
      Communication Wallet
      Allowance Wallet
      Loyalty Wallet
      Paytm Points
      Bank Account - IMPS
      Bank Account - RTGS
      ValidationService - UPI
      ValidationService - Bank Account
      purpose string
      This field contains the purpose(like Salary Disbursement, Reimbursement, etc) for which disbursal made.
      closingBalance string
      Disbursal account closing balance
      beneficiary string
      Beneficiary account details
      subWalletName string
      Disbursal account name

      Response Codes and Messages


      statusCodestatusstatusMessage
      DE_001SUCCESSSuccess
      DE_010FAILUREparam is mandatory and it can't be null or blank
      DE_400FAILURERequest Parameter Invalid
      DE_401FAILUREAuthentication Parameters Required
      DE_402FAILUREAccess Denied
      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
      StagingProduction
      REQUESTRESPONSE
      curl -X POST 'https://staging-dashboard.paytm.com/bpay/api/v1/account/statement' \
      --header 'Content-Type: application/json' \
      --header 'x-mid: {mid}' \
      --header 'x-checksum: {checksum}' \
      --data '{"subwalletGuid":"28054249-XXXX-XXXX-af8f-fa163e429e83","fromDate":"2020-01-20","toDate":"2020-02-20"}'