InquireApplyRequest
- Endpoint:
POST /aggregate-pay/api/gateway/InquireApplyRequest - Tags: Collection Service/Payment Tokenization
Parameters
| Field | In | Type | Required | Constraints | Description |
|---|---|---|---|---|---|
sign | header | string | Yes | ||
Content-Type | header | string | Yes |
Parameter Examples
sign:"FPFVT3o227JrFRbqu19boZCpVVTF9KznxyRawUmxpfXilHV/0yK46haPhAjNu1hPUMy7Vw/ILXhfzffNm4Fj0apWknlTY9OJxnSoQxS9BTFtc61tn5yV1q69x/kkBl82/qwg+XTJ4fOzy7Mar3VaC1E2PlDA6RkkKBUyNE6RYgsdB+Su7an4+4HVTNAnoe74WyvBgxTLMNg28igBTdqxaO3w/UBY6ObVp7vkqkQGdL1Y+HgmMYaAVwrM3+ALWGId0sJ+YqTY4WJ+0xCRGhaSnybiIjZsQEYyID68WNUfuavDLDsEhaMm/HfQvf5p0R1Ltovp3wwJnEbQcjY458iX5A=="Content-Type:"application/json"
Request Body
Content-Type: application/json
| Field | Type | Required | Constraints | Description | Enum |
|---|---|---|---|---|---|
data | object | Yes | |||
data.userId | string | Yes | The user ID by the merchant, needs to ensure the uniqueness of each user.After the payment method is saved, the payment method will be recommended according to the userId. | ||
data.tokenScope | string | Yes | constant value:tokenAcq | ||
data.requestId | string | Yes | Merchant request id, which uniquely identifies a transaction of the merchant, cannot be repeated | ||
version | string | Yes | API version. Current value: 1.4 | ||
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
json
{
"data": {
"userId": "ZHANGSAN",
"tokenScope": "tokenAcq",
"requestId": "DirectApi1716803778191"
}
}Responses
200
| Field | Type | Required | Constraints | Description | Enum |
|---|---|---|---|---|---|
data | object | Yes | |||
data.redirectUrl | string | No | Token authentication url, when status is PENDING, the value is required | ||
data.requestId | string | Yes | Merchant request id, which uniquely identifies a transaction of the merchant, cannot be repeated | ||
data.status | string | Yes | apply request status | PENDING, SUCCESS, FAILED | |
data.paymentTokenID | string | No | PMMax token, when status is SUCCESS, the value is required | ||
code | string | Yes | Return code, ‘APPLY_SUCCESS’ means success | ||
msg | string | Yes | Return message, ‘Success.’ |
Response Example
json
{
"data": {
"redirectUrl": "https://cashier-n-test-new.payermax.com/index.html#/paySDKH5/newAuthResultSimulator?pmaxUrlMock=1¬ifyType=CONTROL&referenceNo=TUC858400171807425915435000029&frontCallbackURL=http://baidu.com",
"requestId": "DirectApi1718074257802",
"status": "PENDING"
}
}Enum Reference
data.status
PENDINGSUCCESSFAILED
