inquirePaymentToken

• Endpoint: POST /aggregate-pay/api/gateway/inquirePaymentToken
• Tags: Collection Service/Payment Tokenization

Parameters

Field	In	Type	Required	Constraints	Description
Content-Type	header	string	Yes
sign	header	string	Yes		签名信息请参考技术文档

Parameter Examples

• Content-Type: "application/json"
• sign: "FPFVT3o227JrFRbqu19boZCpVVTF9KznxyRawUmxpfXilHV/0yK46haPhAjNu1hPUMy7Vw/ILXhfzffNm4Fj0apWknlTY9OJxnSoQxS9BTFtc61tn5yV1q69x/kkBl82/qwg+XTJ4fOzy7Mar3VaC1E2PlDA6RkkKBUyNE6RYgsdB+Su7an4+4HVTNAnoe74WyvBgxTLMNg28igBTdqxaO3w/UBY6ObVp7vkqkQGdL1Y+HgmMYaAVwrM3+ALWGId0sJ+YqTY4WJ+0xCRGhaSnybiIjZsQEYyID68WNUfuavDLDsEhaMm/HfQvf5p0R1Ltovp3wwJnEbQcjY458iX5A=="

Request Body

Content-Type: application/json

Field	Type	Required	Constraints	Description	Enum
data	object	Yes		Request data body
data.userId	string	Yes	maxLength: 64	The user ID by the merchant, needs to ensure the uniqueness of each user
data.tokenScope	string	No	maxLength: 16	If not filled, it defaults to tokenAcq
data.paymentTokenID	string	No	maxLength: 64	PMMax token
data.paymentMethodType	string	No		payment method. You can post CARD or WALLET, and so on
data.targetOrg	string	No		The target organization. If paymentMethodType is CARD, targetOrg should be null or empty string.
data.cardOrg	string	No		card organization. If paymentMethodType is CARD, cardOrg can be null ,VISA,MASTERCARD and so on.
data.referralCode	string	No		token binding unique identifier
version	string	Yes		API version. Current value: 1.2
keyVersion	string	Yes		Signature Algorithm Version, Current value: 1
requestTime	string	Yes		Request time, compliant with rfc3339 specification, format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX The time must be within two minutes of the current time
appId	string	Yes		Merchant AppId，The unique identifier assigned to the merchant app by PayerMax
merchantNo	string	No	maxLength: 32	Merchant Id, the unique identifier generated when the merchant signs the contract with PayerMax

Example

{
  "version": "1.2",
  "keyVersion": "1",
  "requestTime": "2022-01-22T10:00:00.500+08:00",
  "appId": "46153e2b787241ae8b01857bb087d1bd",
  "merchantNo": "010229810189301",
  "data": {
    "userId": "TEST",
    "tokenScope": "tokenAcq",
    "paymentTokenID": "PMTOKEN20230424072005899168200035002",
    "paymentMethodType": "CARD",
    "targetOrg": null,
    "cardOrg": "VISA",
    "referralCode": "xxx"
  }
}

Responses

200

Field	Type	Required	Constraints	Description	Enum
data	object	Yes
data.tokenList	array[object]	Yes		list of token
data.tokenList[].paymentTokenID	string	Yes	maxLength: 64	PMMax token
data.tokenList[].userId	string	Yes	maxLength: 64	The user ID by the merchant, needs to ensure the uniqueness of each user
data.tokenList[].tokenScope	string	Yes	maxLength: 16	Scope of application	tokenAcq
data.tokenList[].paymentTokenExpiry	string	Yes	maxLength: 32	Token validity period,Comply with rfc3339 specification, format: yyyy-MM-dd’T’HH:mm:ss.SSSXXX
data.tokenList[].paymentTokenStatus	string	Yes	maxLength: 16	Token status, this field is required when paying with card token	Deleted, Activated, Expired
data.tokenList[].cardInfo	string	No	maxLength: 19	Mask card number, desensitized according to the first 6 and the last 4, such as 533333**2222
data.tokenList[].ifCVV	string	No	maxLength: 1	Whether CVV is required. Y: When using Token to pay, you need to input CVV again; N: CVV does not need to be entered again when using Token payment. Note: CVV is verified again according to the rules of the issuing bank
data.tokenList[].brand	string	No	maxLength: 32	Card groups, such as Visa, Mastercard, and dual-standard cards are returned
data.tokenList[].paymentMethodType	string	Yes	maxLength: 32	payment method type, such as CARD,ONE_TOUCH
data.tokenList[].targetOrg	string	No	maxLength: 32	The target organisation, where paymentMethodType is CARD, targetOrg is empty string
data.tokenList[].accountDisplay	string	No		Mask account number, such as 63-9****72123, where paymentMethodType is CARD, accountDisplay is empty string
data.tokenList[].referralCode	string	No		token binding unique identifier
code	string	Yes		Return code, ‘APPLY_SUCCESS’ means success
msg	string	Yes		Return message, ‘Success.’

Response Example

{
  "msg": "",
  "code": "APPLY_SUCCESS",
  "data": {
    "tokenList": [
      {
        "tokenScope": "tokenAcq",
        "targetOrg": "",
        "ifCVV": "N",
        "cardInfo": "455701******1010",
        "paymentTokenID": "PMTOKEN20230710080439571142400031000",
        "accountDisplay": "",
        "paymentTokenStatus": "Activated",
        "userId": "czy_0088",
        "brand": "VISA",
        "paymentMethodType": "CARD",
        "paymentTokenExpiry": "2023-07-14T00:00:00.537Z",
        "referralCode": "xxxx"
      }
    ]
  }
}

Enum Reference

data.tokenList[].tokenScope

• tokenAcq

data.tokenList[].paymentTokenStatus

• Deleted
• Activated
• Expired