search

POSTFetch 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

Content Type : JSON

Head

AttributeDescription
version
string
optional

Version of the API.

Example: v1

requestTimestamp
string
optional

EPOCH timestamp of the time at which request is being sent.
Example: 1588402269

channelId
string
optional

The parameter value identifies the Channel for which API call is initiated.

Possible values:
WEB
For websites, the value to be passed should be "WEB"
,
WAP
For Mobile websites/App, the value to be passed should be "WAP"
txnToken
string
mandatory

This is the unique transaction token received in the response of Initiate Transaction API. It is valid for 15 minutes.

Example: f0bed899539742309eebd8XXXX7edcf61588842333227

Body

AttributeDescription
payMethods
array of object
mandatory

List of payment methods (object) for convenience charges.
Example: [{"payMethod":"CREDIT_CARD", "instId":"VISA"}]

PayMethods
+
AttributeDescription
payMethod
string
mandatory

Payment method

Possible Values: BALANCE, UPI, CREDIT_CARD, DEBIT_CARD, NET_BANKING, EMI

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

Content Type : JSON

Head

AttributeDescription
version
string

Version of the API passed in the request.
Example: v1

responseTimestamp
string

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 and sent in the request

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: S, F, U

resultMsg
string

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 Transaction amount.
The object of Payment Modes.

ConsultDetails
+
AttributeDescription
payMethod
string

Payment method for transaction

baseTransactionAmount
object

Transaction amount which is sent in the Initiate Transaction API request.

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 the fee and the 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 transaction amount to be paid by a 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 & 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
Staging
Production
https://securegw-stage.paytm.in/theia/api/v1/fetchPcfDetails?mid={mid}&orderId={order-id}copy icon
REQUEST
RESPONSE
CURL
JAVA
NODE
PHP
PYTHON
DOTNET
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"}}'
copy icon