POSTCard to PAR API

Use Case

This API is used to Fetch PAR for a card on basis of card PAN or affiliated token.

Request Attributes

Content Type : JSON

Head

Attribute	Description
version string mandatory	Version of the API. Example: v1
requestTimestamp string mandatory	EPOCH timestamp of the time at which request is being sent. Example: 1588402269
requestId string optional	Unique reference ID which is given in request payload
signature string 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.
signatureType string mandatory	Authorization method for this request. Possible values: CHECKSUM
clientId string optional	Paytm uses the merchant key on the basis of clientId parameter value. It is required only if the merchant has more than one key.
encryptionKey Version string optional	Paytm uses the merchant key on the basis of the encryption key version. It is required only if the merchant has more than one key. Possible values: v1

Body

Attribute	Description
mid string 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
requestType string mandatory	Indicates the Type of Request Value for which PAR is requested PAN: The encrypted real card PAN without expiry and CVV information. TIN: Unique Token Reference ID provided by Paytm Token Service Possible Value: PAN/TIN Note: Pleaseencryptcardnumberonlywith sharedRSAKeyandadditinRequestValue. Please do not encrypt complete card Json.
requestValue string mandatory	Value of the request type Ex: if requestType = TIN then requestValue is 61af6a68f2108f05055755e9 Possible Value: Any

Response Attributes

Content Type : JSON

Head

Attribute	Description
version string	Version of the API. Example: v1
responseTimestamp string	EPOCH timestamp of the time at which request is being sent. Example: 1588402269 Possible Value: ANY
requestId string	Merchant’s Unique Request ID for card tokenization. Possible Value: Any

Body

Attribute

Description

resultInfo

string

This parameter gives the information about the result of the API response

resultinfo

Attribute	Description
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 For Success , F For Failure
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 in section " Response Codes and Messages".

panUnique Reference

string

The unique reference allocated to the Primary Account Number by the card network also known as PAR.

Possible value: Any.

Note: PAR availability is subject to card network response.

cardScheme

string

Card Scheme.

Possible value: Any

cardSuffix

string

Last 4 digits of the actual card.

cardType

string

Type of the card.
Possible value: CC, DC

displayName

string

Display Name of card

issuingBankName

string

Issuing Bank name of card.

issuingBankCode

string

Issuing Bank Code

globalPanIndex

string

The secondary unique reference allocated to Primary Account Number by Paytm also known as GCIN.

Response Codes & Messages

resultCode	resultStatus	resultMsg
00	S	SUCCESS
400	F	BAD_REQUEST
405	F	Invalid Token Index Number
406	F	Invalid request id
407	F	Incorrect mid
409	F	Incorrect details passed
410	F	Mandatory fields missing
500	F	INTERNAL_SYSTEM_ERROR
502	F	SYSTEM_ERROR
1001	F	Signature Validation Failure
1002	F	CheckSum Validation Failure
1003	F	Jwt Validation Failure
1005	F	Signature type is missing
1006	F	Head is missing
1400	F	Signature Type is invalid
461	F	PAR not found
421	F	Card Scheme is not supported

⇾

Staging

Production

https://securestage.paytmpayments.com/coft-center/get/panUniqueReference copy icon

REQUEST

RESPONSE

CURL

PHP

DOTNET

PYTHON

NODE

curl -X POST 'https://securestage.paytmpayments.com/coft-center/get/panUniqueReference
' \
--header 'Content-Type: application/json' \
--data '{"body":{"mid":"merchant1","requestType":"TIN", "requestValue":"61af6a68f2108f05055755e9"},"head":{"version": "v1","requestTimestamp": "1544614590000", "requestId":"merchre000001","signature": "d7186f022c5a44cc8915bf74e4e8c9f61534487392716", "signatureType": "CHECKSUM","clientId": ""}}'