PaymentTokenID申请

• Endpoint: POST /aggregate-pay/api/gateway/applyPaymentToken
• Tags: 收单/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.requestId	string	Yes	maxLength: 64	请求单号，唯一标识商户的一笔请求
data.country	string	Yes	maxLength: 2	国家代码，大写字母
data.paymentMethodType	string	Yes	maxLength: 64	支付方式类型，支持CARD、BANKTRANSFER
data.targetOrg	string	No	maxLength: 32	目标机构，当paymentMethodType=BANKTRANSFER，值传YUSHANBANK
data.userId	string	Yes	maxLength: 64	商户内部的用户Id，需要保证每个ID唯一性
data.frontCallbackUrl	string	Yes	maxLength: 1024	商户指定的跳转URL，完成token绑定后会被跳转到该地址，以http/https开头或者商户应用的scheme地址。
data.tokenScope	string	Yes	maxLength: 16	固定值：tokenAcq
data.mitType	string	No		mit类型，token申请完成后用于mit代扣的类型；为空时，生成的token只能用于CIT；不为空时，值为SCHEDULE、UNSCHEDULE，生成的token可用于CIT和MIT代扣	SCHEDULE, UNSCHEDULE
data.cardInfo	object	No		卡信息，当paymentMethodType=CARD时，必需
data.cardInfo.cardOrg	string	Yes		卡组织，当paymentMethod为CARD时且不上送卡信息时必填 具体参见【纯API支付-支付方式列表】
data.cardInfo.cardIdentifierNo	string	Yes		卡标识、卡号
data.cardInfo.cardHolderFullName	string	Yes		持卡人姓名
data.cardInfo.cardExpirationMonth	string	Yes		卡有效期-月，两位月份
data.cardInfo.cardExpirationYear	string	Yes		卡有效期-年，只取后两位年份
data.cardInfo.cvv	string	No		卡cvv，Visa和MasterCard为3位数字，AEMX为4位数字
data.envInfo	object	No
data.envInfo.userAgent	string	No		用户浏览器信息
data.envInfo.clientIp	string	No		用户Ip地址
data.envInfo.terminalType	string	No		终端类型：值为WEB、WAP、APP
data.envInfo.osType	string	No		操作系统类型：值为ANDROID、IOS
data.envInfo.osVersion	string	No		操作系统版本
data.envInfo.browserType	string	No		浏览器类型
data.envInfo.timeZone	string	No		时区
data.envInfo.deviceId	string	No		商户设备唯一标识
data.envInfo.deviceLanguage	string	No		设备默认语言
data.envInfo.screenHeight	string	No		设备高度
data.envInfo.screenWidth	string	No		设备宽度
data.riskParams	object	No		详见风控业务数据【商户上送信息】
version	string	Yes	maxLength: 8	接口版本 当前值为：1.4
keyVersion	string	Yes	maxLength: 8	密钥版本 当前值为：1
requestTime	string	Yes	maxLength: 32	请求时间，符合rfc3339规范，格式：yyyy-MM-dd'T'HH:mm:ss.SSSXXX 时间需要在当前时间两分钟内
appId	string	Yes	maxLength: 64	商户应用Id，PayerMax分配给商户应用的唯一标识
merchantNo	string	No	maxLength: 32	商户号，商户与PayerMax业务签约时生成的唯一标识

Example

{
  "version": "1.4",
  "keyVersion": "1",
  "requestTime": "2024-07-02T11:39:58.720+00:00",
  "appId": "d68f5da6a01766666621a64114c6b322c",
  "merchantNo": "P01011118267336",
  "data": {
    "requestId": "DirectApi1718074257802",
    "country": "RU",
    "paymentMethodType": "CARD",
    "targetOrg": null,
    "userId": "052718",
    "frontCallbackUrl": "https://www.frontcallbackurl.example.com",
    "tokenScope": "tokenAcq",
    "mitType": "UNSCHEDULE",
    "cardInfo": {
      "cardOrg": "VISA",
      "cardIdentifierNo": "4444333322221111",
      "cardHolderFullName": "James Smith",
      "cardExpirationMonth": "03",
      "cardExpirationYear": "30",
      "cvv": "123"
    },
    "envInfo": {
      "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/96.0.4664.110 Safari/537.36",
      "clientIp": "12.233.22.213",
      "terminalType": "app",
      "osType": "ios",
      "osVersion": "15.5",
      "browserType": "",
      "timeZone": "",
      "deviceId": "eYOIkvFpZzztg00Yu6USdprBQZCWxDhiUAHCiK&K/cH9mT6wMaMOzAKe",
      "deviceLanguage": "zh_CN",
      "screenHeight": "768",
      "screenWidth": "1024"
    },
    "riskParams": {
      "accountNo": "xsxxx",
      "bindEmail": "xx@example.com",
      "regTime": "2024-03-14 12:08:34"
    }
  }
}

Responses

200

Field	Type	Required	Constraints	Description	Enum
data	object	Yes
data.redirectUrl	string	No		token认证地址，当status=PENDING时有值
data.requestId	string	Yes		请求单号
data.status	string	Yes		状态	PENDING, SUCCESS, FAILED
data.paymentTokenID	string	No		token值，当status=SUCCESS时有值
code	string	Yes		返回码，’APPLY_SUCCESS’代表成功
msg	string	Yes		返回描述，’Success.’

Response Example

{
  "msg": "",
  "code": "APPLY_SUCCESS",
  "data": {
    "redirectUrl": "https://cashier-n-test-new.payermax.com/index.html#/paySDKH5/newAuthResultSimulator?pmaxUrlMock=1&notifyType=CONTROL&referenceNo=TUC858400171807425915435000029&frontCallbackURL=http://baidu.com",
    "requestId": "DirectApi1718074257802",
    "status": "PENDING"
  }
}

Enum Reference

data.mitType

• SCHEDULE
• UNSCHEDULE

data.status

• PENDING
• SUCCESS
• FAILED