• Callback Response
  • Getting Started
    • Mobile Integration (Android/IOS)
      Enterprise Solutions
      Retail Solutions
      Accept Payments
      Process Payments
      Disbursals
      API References
      Refunds
      Guides
      Other links
      Mini Program Platform
  • Features for Investments PG
  • post Refund List API

    Use Case


    To fetch the list of refund requests completed between two dates.

    Request Attributes


    API Content Type: JSON

    Head1

    Head

    ATTRIBUTEDESCRIPTION
    tokenType string
    mandatory
    Authentication method
    Example: CHECKSUM
    clientId string(3)
    mandatory
    Paytm use the merchant key on the basis of clientId parameter value. It requires only if the merchant has more than one key.
    Example: C11
    signature string(108)
    mandatory
    Paytm validates the request and ensures that parameters are not tempered by verifying the signature in the request. For creating the checksum (signature) refer to the steps given in Checksum logic.
    Note: Create the signature using the body parameter of the request.
    Body1

    Body

    ATTRIBUTEDESCRIPTION
    mid string(20)
    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.
    Example: INTEGR7769XXXXXX9383
    isSort string
    mandatory
    Used to sort the refund results in ascending or descending order based on refund date
    Example: true
    startDate string
    mandatory
    Include refunds from start date time (yyyy-MM-ddTHH:mm:ss zzzz)
    Example: "2020-06-01T00:34:00+05:30"
    endDate string
    mandatory
    Include refunds till end date time (yyyy-MM-ddTHH:mm:ss zzzz)
    Example: "2020-06-01T00:34:00+05:30"
    pageNum string
    optional
    Page number for which merchant has requested
    Example: 2
    pageSize string
    optional
    Page size that merchant has requested
    Example: 20

    Note
    1. The current capacity is that only refund records up to 20K can be sorted in a given time range.
    2. The difference between start time and end time should be less then or equal to 30 Days.
    3. On a single page we can display upto 50 records.

    Response Attributes


    API Content Type: JSON

    Body2

    Body

    ATTRIBUTEDESCRIPTION
    status string
    Status of Request
    Example: Success
    count int
    Number of result found
    Example: 1
    resultCode string
    resultCode
    Example: 00000000
    errorMessage string
    Message
    Example: Success
    orders object
    Order Details
    Orders +
    AttributeDescription
    orderId string
    The unique reference ID of the Order. It is alphanumeric and special characters allowed are “@” “-” “_” “.”.
    Example: OREDRID_98765
    merchantRefundRequestTimeStamp string
    EPOCH timestamp of the time at which request is being sent
    Example: 2020-06-02 14:40:06
    acceptRefundTimeStamp string
    EPOCH timestamp of the time at which request is being accepted
    Example: 2020-06-02 14:40:06
    txnTimeStamp string
    Timestamp of the payment transaction.
    acceptRefundStatus string
    Status of Paytm accepting the refund
    Example: SUCCESS
    mid string
    This is a unique identifier provided to every merchant by Paytm. MID is part of your account credentials and is different on staging and production environment.
    Example: INTEGR7769XXXXXX9383
    txnAmount string
    Order value of the transaction in INR.
    refundId string
    This is a unique Paytm Refund Id that is issued by Paytm for each refund request.
    refundAmount string
    Amount for which refund is to be made
    refId string
    Unique Reference Id for the refund transaction which is generated by the merchant.

    Response Codes and Messages


    resultCodestatusresultMessage
    00000000TXN_SUCCESSSuccess
    00000010TXN_FAILUREINTERNAL_SERVER_ERROR
    00000022TXN_FAILURECHECKSUM_VALIDATION_FAILED
    00000030TXN_FAILUREILLEGAL_PARAM
    00000031TXN_FAILUREFACADE_EXCEPTION
    00000040TXN_FAILUREMERCHANT_NOT_FOUND
    00000073TXN_FAILUREInvalid date format or invalid date range
    StagingProduction
    REQUESTRESPONSE
    curl -X POST 'https://securegw-stage.paytm.in/merchant-passbook/api/v1/refundList' \
    --header 'content-type: application/json' \
    --data-raw '{"head": {"tokenType": "CHECKSUM","clientId": "C11","signature": "{signature}"},"body": {"mid":"{mid}","isSort":"true","startDate":"2020-06-01T00:34:00+05:30","endDate":"2020-06-30T14:35:24+05:30","pageSize":10,"pageNum":1}}'