文档
Start typing to search…

付款方

创建付款方

端点目标 URL

沙盒环境请求地址：POST https://preapi.futurepay-develop.com/api/v1/payer/create

生产环境请求地址：POST https://api.futurepay.global/api/v1/payer/create

字段说明

调用的特定输入参数

字段名称必填类 型描述
merchantReferenceMstring商户请求流水号，不能重复
payerTypeOint付款人类型，若不传，该值固定为「员工」;(10-法人/最终受益人，20-董事/股东，30-员工)
identityNationalityCodeMstring付款方证件所在国家的国际标准化组织（ISO）国家代码（如US代表美国，CN代表中国 ISO 3166-1 标准）
firstNameMstring付款方名字
lastNameMstring付款方姓式
identityNumberMstring付款方证件号码
identitySexMstring付款方性别(1-男性，2-女性)
identityTypeMstring付款方证件类型（1-身份证，2-护照）
identityBirthdayMstring付款方出生日期（yyyy-MM-dd格式）
residenceCountryCodeMstring付款方居住所在国家的国际标准化组织（ISO）国家代码（如US代表美国，CN代表中国 ISO 3166-1 标准）
residenceAddressMstring付款方详细居住地址
residenceProvinceMstring付款方居住地址所在省/州
residenceCityMstring付款方居住地址所在市
emailMstring付款方邮箱
zipCodeMstring付款方居住所在地邮编
certImageFontIdMstring正面文件照材料id
certImageBackIdOstring反面文件照材料id(若证件类型为身份证，该值必填)

响应data参数

字段名类型说明
merchantReferenceString商户请求流水号
payerIdString付款方Id
resultCodeString付款方状态，ACCEPT(通过) REJECT(禁止) REVIEW(等待中)
errorMsgString失败原因
identityTypeString付款方证件类型（1-身份证，2-护照）
emailString付款方邮箱
fullNameString全名
identitySexString付款方性别(1-男性，2-女性)
identityNationalityCodeString付款方证件所在国家的国际标准化组织（ISO）国家代码（如US代表美国，CN代表中国 ISO 3166-1 标准）
identityBirthdayString付款方出生日期（yyyy-MM-dd格式）
identityNumberString付款方证件号码
residenceCountryCodeString付款方居住所在国家的国际标准化组织（ISO）国家代码（如US代表美国，CN代表中国 ISO 3166-1 标准）
residenceAddressString付款方详细居住地址
residenceProvinceNameString付款方居住地址所在省/州
residenceCityNameString付款方居住地址所在市
zipCodeString付款方居住所在地邮编
createTimeString创建时间
updateTimeString修改时间

集成

创建付款方调用输入

{
    "merchantReference":"12cc3zxczccczxccxccqq",
    "identityBirthday":"2000-01-12",
    "firstName":"彦祖",
    "lastName":"王",
    "identitySex":1,
    "identityType":2,
    "identityNationalityCode":"CN",
    "residenceCountryCode":"CN",
    "residenceProvince":"hunan",
    "residenceCity":"chagngshi",
    "residenceAddress":"quzhxcqwexc",
    "identityNumber":"wedd5456dcddddd",
    "zipCode":"123456",
    "certImageFontId":"176311127114407062829",
    "email":"[email protected]"
}

创建付款方调用输出

{
    "code": "0",
    "msg": "succeeded",
    "serverTime": 1763113556851,
    "data": {
        "merchantReference": "12cc3zxczccczxcccxccqq",
        "payerId": "1987801350012055559",
        "resultCode": "REVIEW",
        "errorMsg": "",
        "payerType": 30,
        "identityType": 2,
        "email": "[email protected]",
        "fullName": "彦祖 王",
        "identitySex": "1",
        "identityNationalityCode": "CN",
        "identityBirthday": "2000-01-12",
        "identityNumber": "wedd5456dcddddd",
        "residenceCountryCode": "CN",
        "residenceAddress": "quzhxcqwexc",
        "residenceProvinceName": "hunan",
        "residenceCityName": "chagngshi",
        "zipCode": "123456",
        "createTime": "2025-11-14 09:45:56",
        "updateTime": "2025-11-14 09:45:56"
    },
    "success": true
}

修改付款方

端点目标 URL

沙盒环境请求地址：POST https://preapi.futurepay-develop.com/api/v1/payer/update

生产环境请求地址：POST https://api.futurepay.global/api/v1/payer/update

字段说明

调用的特定输入参数

字段名称必填类 型描述
merchantReferenceMstring商户请求流水号，不能重复
residenceCountryCodeMstring付款方居住所在国家的国际标准化组织（ISO）国家代码（如US代表美国，CN代表中国 ISO 3166-1 标准）
residenceAddressMstring付款方详细居住地址
residenceProvinceMstring付款方居住地址所在省/州
residenceCityMstring付款方居住地址所在市
emailMstring付款方邮箱
zipCodeMstring付款方居住所在地邮编

响应data参数

字段名类型说明
merchantReferenceString商户请求流水号
payerIdString付款方Id
resultCodeString付款方状态，ACCEPT(通过) REJECT(禁止) REVIEW(等待中)
errorMsgString失败原因
identityTypeString付款方证件类型（1-身份证，2-护照）
emailString付款方邮箱
fullNameString全名
identitySexString付款方性别(1-男性，2-女性)
identityNationalityCodeString付款方证件所在国家的国际标准化组织（ISO）国家代码（如US代表美国，CN代表中国 ISO 3166-1 标准）
identityBirthdayString付款方出生日期（yyyy-MM-dd格式）
identityNumberString付款方证件号码
residenceCountryCodeString付款方居住所在国家的国际标准化组织（ISO）国家代码（如US代表美国，CN代表中国 ISO 3166-1 标准）
residenceAddressString付款方详细居住地址
residenceProvinceNameString付款方居住地址所在省/州
residenceCityNameString付款方居住地址所在市
zipCodeString付款方居住所在地邮编
createTimeString创建时间
updateTimeString修改时间

集成

修改付款方调用输入

{
    "merchantReference":"12cc3zxczccczxcccxccqq",
    "residenceCountryCode":"CN",
    "residenceProvince":"hunan",
    "residenceCity":"chenzhcou",
    "residenceAddress":"asdasd",
    "zipCode":"12345cccc6",
    "email":"[email protected]"
}

修改付款方调用输出

{
    "code": "0",
    "msg": "succeeded",
    "serverTime": 1763114720729,
    "data": {
        "merchantReference": "12cc3zxczccczxcccxccqq",
        "payerId": "1987801350012055559",
        "resultCode": "REVIEW",
        "errorMsg": "",
        "payerType": 30,
        "identityType": 2,
        "email": "[email protected]",
        "fullName": "彦祖 王",
        "identitySex": "1",
        "identityNationalityCode": "CN",
        "identityBirthday": "2000-01-12",
        "identityNumber": "wedd5456dcddddd",
        "residenceCountryCode": "CN",
        "residenceAddress": "asdasd",
        "residenceProvinceName": "hunan",
        "residenceCityName": "chenzhcou",
        "zipCode": "12345cccc6",
        "createTime": "2025-11-14 09:45:56",
        "updateTime": "2025-11-14 10:05:20"
    },
    "success": true
}

查询付款方列表

端点目标 URL

沙盒环境请求地址：POST https://preapi.futurepay-develop.com/api/v1/payer/list

生产环境请求地址：POST https://api.futurepay.global/api/v1/payer/list

字段说明

调用的特定输入参数

字段名称必填类 型描述
merchantReferenceMstring商户请求流水号，不能重复
resultCodeMstring付款方状态，ACCEPT(通过) REJECT(禁止) REVIEW(等待中)
payerTypeMstring付款人类型
fullNameMstring付款方名称
pageNumOstring当前页
pageSizeOstring每页大小

集成

查询付款方列表调用输入

{
    "pageNum":"1",
    "pageSize":"5",
    "resultCode":"ACCEPT"
}

查询付款方列表调用输出

{
    "code": "0",
    "msg": "succeeded",
    "serverTime": 1763115318642,
    "data": {
        "list": [
            {
                "merchantReference": null,
                "payerId": "220",
                "resultCode": "ACCEPT",
                "errorMsg": "",
                "payerType": 20,
                "identityType": 2,
                "email": "[email protected]",
                "fullName": "huang test",
                "identitySex": "1",
                "identityNationalityCode": "AX",
                "identityBirthday": "2025-10-01",
                "identityNumber": "zxczxczxc",
                "residenceCountryCode": "AF",
                "residenceAddress": "zxczxc",
                "residenceProvinceName": "Ghazni",
                "residenceCityName": "Ghazni",
                "zipCode": "zxczxc",
                "createTime": "2025-10-13 05:35:54",
                "updateTime": "2025-10-13 05:37:28"
            },
            {
                "merchantReference": null,
                "payerId": "201",
                "resultCode": "ACCEPT",
                "errorMsg": "",
                "payerType": 30,
                "identityType": 2,
                "email": "[email protected]",
                "fullName": "凯文 李",
                "identitySex": "1",
                "identityNationalityCode": "CN",
                "identityBirthday": "2000-01-12",
                "identityNumber": "wedd5456dcddddd",
                "residenceCountryCode": "CN",
                "residenceAddress": "asdasd",
                "residenceProvinceName": "浙江省",
                "residenceCityName": "杭州市",
                "zipCode": "123456",
                "createTime": "2025-08-04 06:04:49",
                "updateTime": "2025-08-04 06:14:13"
            },
            {
                "merchantReference": null,
                "payerId": "198",
                "resultCode": "ACCEPT",
                "errorMsg": "",
                "payerType": 20,
                "identityType": 2,
                "email": "[email protected]",
                "fullName": "梁 付",
                "identitySex": "1",
                "identityNationalityCode": "CN",
                "identityBirthday": "1992-09-20",
                "identityNumber": "E934822910",
                "residenceCountryCode": "CN",
                "residenceAddress": "鼓楼",
                "residenceProvinceName": "福建省",
                "residenceCityName": "福州市",
                "zipCode": "123123",
                "createTime": "2025-08-01 09:59:28",
                "updateTime": "2025-08-01 10:02:19"
            }
        ],
        "pageNum": 1,
        "pageSize": 3,
        "total": 14
    },
    "success": true
}

查询付款方详情

查询付款方详情

端点目标 URL

沙盒环境请求地址：POST https://preapi.futurepay-develop.com/api/v1/payer/get-payer-status

生产环境请求地址：POST https://api.futurepay.global/api/v1/payer/get-payer-status

字段说明

调用的特定输入参数

字段名称必填类 型描述
merchantReferenceMstring创建付款方时提交的请求流水号

响应data参数

字段名类型说明
merchantReferenceString商户请求流水号
payerIdString付款方Id
resultCodeString付款方状态，ACCEPT(通过) REJECT(禁止) REVIEW(等待中)
errorMsgString失败原因
identityTypeString付款方证件类型（1-身份证，2-护照）
emailString付款方邮箱
fullNameString全名
identitySexString付款方性别(1-男性，2-女性)
identityNationalityCodeString付款方证件所在国家的国际标准化组织（ISO）国家代码（如US代表美国，CN代表中国 ISO 3166-1 标准）
identityBirthdayString付款方出生日期（yyyy-MM-dd格式）
identityNumberString付款方证件号码
residenceCountryCodeString付款方居住所在国家的国际标准化组织（ISO）国家代码（如US代表美国，CN代表中国 ISO 3166-1 标准）
residenceAddressString付款方详细居住地址
residenceProvinceNameString付款方居住地址所在省/州
residenceCityNameString付款方居住地址所在市
zipCodeString付款方居住所在地邮编
createTimeString创建时间
updateTimeString修改时间

集成

查询付款方调用输入

{
    "merchantReference":"81092123hkjhaew124"
}

查询付款方调用输出

{
    "code": "0",
    "msg": "succeeded",
    "serverTime": 1763351012446,
    "data": {
        "merchantReference": "12cc3zxczccczxcccxccqq",
        "payerId": "1987801350012055559",
        "resultCode": "REVIEW",
        "errorMsg": "",
        "payerType": 30,
        "identityType": 2,
        "email": "[email protected]",
        "fullName": "彦祖 王",
        "identitySex": "1",
        "identityNationalityCode": "CN",
        "identityBirthday": "2000-01-12",
        "identityNumber": "wedd5456dcddddd",
        "residenceCountryCode": "CN",
        "residenceAddress": "asdasd",
        "residenceProvinceName": "hunan",
        "residenceCityName": "chenzhcou",
        "zipCode": "12345cccc6",
        "createTime": "2025-11-14 09:45:56",
        "updateTime": "2025-11-14 10:05:20"
    },
    "success": true
}

WEBHOOK

{
    "appId": "1929723739684102144", 
    "merchantId": "1929723739654762496", 
    "notificationItems": [
        {
            "eventCode": "CREATE_PAYER_RESULT", 
            "payerId": 1987801350012055559, 
            "resultCode": "ACCEPT", 
            "merchantReference": "12cc3zxczccczxcccxccqq", 
            "errorMsg": "", 
            "eventDate": 1763358623010
        }
    ]
}

Updated 21 days ago