Skip to content

接口参数

API

##1、请求参数
参数类型是否必填最大长度描述示例值
merchantIdString30PayerMax分配给商户的唯一标识
bizTypeString30业务代码,此接口需传入“inquirePaymentToken”
versionString5接口版本。当前值为:2.62.6
signString64采用MD5字符串签名,DD6F959727F2724B7FFFE164DFF77DDC1
userIdString64商户内部的用户ID,**必须唯一**ZNW3e
tokenScopeString16不填默认为tokenAcq
paymentTokenIDString64

##2、响应参数

参数类型是否必返最大长度描述示例值
bizCodeString10返回码0000
messageString256返回描述
dataObject返回数据体,由**公共参数和特定参数**组成,详见下方的【data参数】

##data参数

参数类型是否必返最大长度描述示例值
signString64采用MD5字符串签名,DD6F959727F2724B7FFFE164DFF77DDC1
+tokenListArraytoken列表
└paymentTokenIDString64
└userIdString16商户内部的的用户号,必须唯一
└tokenScopeString16产品范围
└paymentTokenExpiryString32token有效期,符合rfc3339规范,格式:yyyy-MM-dd’T’HH:mm:ss.SSSXXX
└paymentTokenStatusString16token状态,卡token支付时,此字段为必填
└cardInfoString19掩码卡号,按照前6后4脱敏,如533333********2222paymentMethodType=CARD时cardInfo有值,paymentMethodType为其他值时,cardInfo为空字符串
└ifCVVString1是否需要CVV。 Y: 使用Token支付时需要再次输入CVV; N:使用Token支付时不需要再次输入CVV。 注:根据发卡行规则存在再次验证CVV的情况paymentMethodType=CARD时ifCVV有值,paymentMethodType为其他值时,ifCVV为空字符串
└brandString32卡组,如Visa,Mastercard,双标卡则都返回paymentMethodType=CARD时brand有值,paymentMethodType为其他值时,brand为空字符串
└paymentMethodTypeString16支付方式类型值为CARD、ONE_TOUCH等
└targetOrgString16目标机构当paymentMethodType不是CARD时,值为DANA、GCASH等,paymentMethodType为CARD时,targetOrg为空字符串
└accountDisplayString32掩码授权账号,如63-9****72123paymentMethodType为CARD时,accountDisplay为空字符串,paymentMethodType值不是CARD时,显示掩码授权账号

示例

请求示例

json
{
    "merchantId": "SP103301558",
    "bizType": "inquirePaymentToken",
    "version": "2.6",
    "userId": "czy_0088",
    "tokenScope": "tokenAcq",
    "paymentTokenID": "",
    "sign": "xxxx"
}

返回示例

json
{
    "data": {
        "sign": "DD6F959727F2724B7FFFE164DFF77DDC1",
        "tokenList": [
            {
                "tokenScope": "tokenAcq",
                "targetOrg": "KAKAOPAY",
                "ifCVV": "",
                "cardInfo": "",
                "paymentTokenID": "ed27884948d3b6cd0d17052e46064baf",
                "accountDisplay": "63-9****72180",
                "paymentTokenStatus": "Activated",
                "userId": "czy_0088",
                "brand": "",
                "paymentMethodType": "AUTO_DEBIT",
                "paymentTokenExpiry": "2123-07-13T09:24:37.000Z"
            },
            {
                "tokenScope": "tokenAcq",
                "targetOrg": "",
                "ifCVV": "N",
                "cardInfo": "455701******8902",
                "paymentTokenID": "PMTOKEN20230710080439571142400031000",
                "accountDisplay": "",
                "paymentTokenStatus": "Activated",
                "userId": "czy_0088",
                "brand": "VISA",
                "paymentMethodType": "CARD",
                "paymentTokenExpiry": "2023-07-14T00:00:00.537Z"
            }
        ]
    },
    "bizCode": "0000",
    "message": "success"
}

此页面的内容有帮助吗?

感谢您帮助改进 PayerMax 产品文档!

Last updated:

Released under the MIT License.