• 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 Fetch PCF Details API

      Use Case


      This API is used to fetch convenience charges corresponding to the Transaction amount. The merchant will call this API to fetch the different fee amounts/ charge amounts for different payment instruments. Please note that this API can be used by those merchants for whom flag of pcfEnabled is returned true in response of Fetch Payment Option API.

      Request Attributes


      API Content Type: JSON

      Head1

      Head

      ATTRIBUTEDESCRIPTION
      version string(4)
      optional
      Version of the API.
      Example: v1
      requestTimestamp string(15)
      optional
      EPOCH timestamp of the time at which request is being sent.
      Example: 1588402269
      channelId string(3)
      optional
      The parameter value identifies the Channel for which API call is initiated.
      Possible Values: WEBFor websites, the value to be passed should be "WEB", WAPFor Mobile websites/App, the value to be passed should be "WAP"
      txnToken string(64)
      mandatory
      This is the unique transaction token received in the response of Initiate Transaction API. It is valid for 15 minutes.
      Example: f0bed899539742309eebd8XXXX7edcf61588842333227
      Body1

      Body

      ATTRIBUTEDESCRIPTION
      payMethods array of object
      mandatory
      List of payment methods(object) for convenience charges -
      e.g [{"payMethod":"CREDIT_CARD", "instId":"VISA"}]
      PayMethods +
      AttributeDescription
      payMethod string
      mandatory
      Payment method
      Possible Values: BALANCE For Paytm Wallet, UPIFor Bhim Upi, CREDIT_CARDFor Credit Card, DEBIT_CARDFor Debit Card, NET_BANKINGFor Net Banking
      instId string
      optional
      Instrument Details
      Possible Values:
      For CREDIT_CARD/DEBIT_CARD: VISA, MASTER, AMEX, MAESTRO, DINERS, RUPAY
      For NET_BANKING: SBI, ICICI, PNB, HDFC. List of Bank Codes

      Response Attributes


      API Content Type: JSON

      Head2

      Head

      ATTRIBUTEDESCRIPTION
      version string(2)
      Version of the API passed in the request.
      Example: v1
      responseTimestamp string(15)
      EPOCH timestamp of the time at which response is being sent.
      Example: 1588402269
      requestId string
      Unique reference ID for a transaction which is generated by merchant.
      Body2

      Body

      ATTRIBUTEDESCRIPTION
      resultInfo object
      This parameter gives the information about the result of the API response
      ResultInfo +
      AttributeDescription
      resultCode string
      This is the resultCode corresponding to a particular message and is returned to the merchant. It's maximum length is 64. The different result codes corresponding to this API are mentioned below
      resultStatus string
      This parameter indicates the status of API call.
      Possible Values: SFor Success, FFor Failure, UFor Unknown
      resultMsg string(256)
      This parameter is the result message which contains information about the result.The different result messages corresponding to this API are mentioned below
      extraParamsMap object
      Map for any extra information (in case of error).
      consultDetails object
      Charges with Tax and Tranasction amount
      object of Payment Modes
      ConsultDetails +
      AttributeDescription
      payMethod string
      Payment method for transaction
      baseTransactionAmount object
      Transaction amount which is sent in request of Initiate Transaction API.
      Money +
      AttributeDescription
      value string
      This parameter contains the amount to be charged to the customer and can have two places of decimal.
      Example: 1.00
      currency string
      This parameter indicates the currency in which transaction amount is to be deducted.
      Possible Values: INR
      feeAmount object
      Extra charge for transaction
      Money +
      AttributeDescription
      value string
      This parameter contains the amount to be charged to the customer and can have two places of decimal.
      Example: 1.00
      currency string
      This parameter indicates the currency in which transaction amount is to be deducted.
      Possible Values: INR
      taxAmount object
      Tax amount for transaction
      Money +
      AttributeDescription
      value string
      This parameter contains the amount to be charged to the customer and can have two places of decimal.
      Example: 1.00
      currency string
      This parameter indicates the currency in which transaction amount is to be deducted.
      Possible Values: INR
      totalConvenienceCharges object
      Sum of Fee amount and Tax amount
      Money +
      AttributeDescription
      value string
      This parameter contains the amount to be charged to the customer and can have two places of decimal.
      Example: 1.00
      currency string
      This parameter indicates the currency in which transaction amount is to be deducted.
      Possible Values: INR
      totalTransactionAmount object
      Total trasaction amount which has to pay by customer
      Money +
      AttributeDescription
      value string
      This parameter contains the amount to be charged to the customer and can have two places of decimal.
      Example: 1.00
      currency string
      This parameter indicates the currency in which transaction amount is to be deducted.
      Possible Values: INR
      text string
      Extra charge with text
      displayText string
      Mode Display Text

      Response Codes and Messages


      resultCoderesultStatusresultMsg
      0000SSuccess
      1001FRequest parameters are not valid
      1006FSession Expired Exception
      2013FMid in the query param doesn’t match with the Mid send in the request
      2014FOrderId in the query param doesn’t match with the OrderId send in the request
      00000900USystem error
      StagingProduction
      REQUESTRESPONSE
      curl -X POST 'https://securegw-stage.paytm.in/theia/api/v1/fetchPcfDetails?mid={mid}&orderId=ORDERID_98765' \
      --header 'Content-Type: application/json' \
      --data '{"body":{"payMethods":[{"payMethod":"CREDIT_CARD","instId":"VISA"}]},"head":{"txnToken":"f0bed899539742309eebd8XXXX7edcf61588842333227"}}'