搜索...
VERSION
转到商户后台
English

光子易开放平台接口文档

2025-05-14 (最新)
如果您需要更多帮助，请联系技术支持: tech-support@photonpay.com

简介

光子易 OpenAPI 为企业跨境支付赋能，提供了付款、收单、发卡等丰富的产品能力，满足企业各种使用场景。我们建议您详细阅读 API 文档，以熟悉与产品相关的功能和工作流程。在阅读与使用的过程中，如果您遇到任何疑问，欢迎联系光子易客户经理和技术支持工程师，我们将为您进行一对一指导。

开始

概览

欢迎来到光子易。

光子易开放平台接口设计灵活，可以为您的企业跨境支付赋能，我们提供了付款、收单、发卡等丰富的产品能力，满足企业各种使用场景。

我们建议您完整阅读API文档，以熟悉与产品相关的功能和工作流程。在阅读与使用的过程中，如果您遇到任何疑问，欢迎联系光子易客户经理和技术支持工程师，我们将为您进行一对一指导。

版本管理

光子易使用版本控制来改进我们的API，不影响已有客户的使用。 当我们进行了API版本功能增加、修改、删除时，我们会新建一个版本日期以便帮助客户区分版本。点击跳转 更新日志 查看详情。

授权

光子易开放平台使用开发者账号(appId/appSecret)对请求进行身份验证，开发者账号信息通过商户平台进行管理(设置 > 开发者)。请勿将开发者账号信息放置在可公开访问的区域，例如 GitHub、GitLab 等，避免信息泄漏。

目前光子易开放平台支持以下两种授权方式：

1. X-PD-TOKEN ，访问令牌授权，开发者需要通过 生成令牌 进行身份验证，身份验证通过后，基于接口返回的令牌访问其他业务接口。
2. X-PD-AUTHORIZATION ，直接授权方式，开发者直接将开发者参数进行 basic Base64({appId}/{appSecret}) 编码拼接后，填写至 headers 中 X-PD-AUTHORIZATION 参数，直接访问业务接口。

post 生成令牌

光子易开放平台所有业务接口的访问均需要对请求进行身份验证，可以使用开发者账号通过此接口获取访问令牌。

header Parameters
Authorization
required
string

basic Base64({appId}/{appSecret})

Responses (200)

Response Schema: application/json
code
required
string

响应的code 0000代表成功

object (appLoginData)

登陆成功的响应

msg
required
string

succeed

Request samples 

curl --request POST \
--url 'https://x-api1.uat.photontech.cc/oauth2/token/accessToken' \
--header 'content-type: application/json' \
--header 'Authorization: basic YzhCZFY5UGUvZDU2MDA1ZjI0YTZjYWM2YzZjZDE2MDRhNmM0YTZjZDEzNWMxYWM1MQ=='

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : {
    } ,
  • "msg" : "succeed"
}

post 发布授权码

使用开发者账号获取AuthCode，可以换发Token，部分OpenApi接口会需要authCode作为入参。

header Parameters
Authorization
required
string

basic Base64({appId}/{appSecret})

Responses (200)

Response Schema: application/json
code
required
string

响应的code 0000代表成功

object (authCodeData)

返回的对象

msg
required
string

succeed

Request samples 

curl --request POST \
--url 'https://x-api.photonpay.com/oauth2/token/issueAuthCode' \
--header 'content-type: application/json' \
--header 'Authorization: basic YzhCZFY5UGUvZDU2MDA1ZjI0YTZjYWM2YzZjZDE2MDRhNmM0YTZjZDEzNWMxYWM1MQ=='

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : {
    } ,
  • "msg" : "succeed"
}

加签

加签是光子易开放平台和商户对于交互消息完整性的校验。加签行为主要发生两个部分：第一部分，商户服务器端针对向光子易开放平台发送的请求报文进行加签；第二部分，光子易开放平台针对通知商户的异步消息进行加签。光子易平台要求使用 RSA 私钥进行加签， 使用 RSA 公钥进行验签。 因此，在以上两部分描述的交互中， 存在商户公私钥、PhotonPay 公私钥，开发者需要使用商户私钥，对第一部分报文进行加签，使用 PhotonPay 公钥对第二部分消息进行验签。在对接的开始前， 开发者需要使用 PKCS#8 方式生成商户公私钥，并在商户平台(设置 > 开发者)配置商户公钥，然后获取 PhotonPay 公钥。

加签规则如下:
1. 使用 MD5withRSA 对 request.body 进行签名（MD5withRSA 表示对内容进行 MD5 加密得到固定长度哈希串，再将哈希串进行 RSA 签名，得到最终签名内容）；
2. 将加签内容进行 Base64 编码；
3. 将编码后的内容放在请求头部 X-PD-SIGN 参数中。
注意，加签是对 request.body 进行签名，当查询等 request.body 为空时，则无需加签。

收单

端到端支付

端到端

为拥有 PCI 资质的商户提供 server to server 的对接方式，提供无/少跳转的方式提供支付服务，支持的交易类型为 sale、auth

安全

光子易风控系统拥有海量数据，并且与国际拒付黑白名单保持实时同步，在支付的过程中加载光子易风控插件，能实时监控并保护您的交易安全。
对接如下：
1. 在您的支付页面添加以下安全脚本控件： 

// UAT 环境<script src="https://cdn1.uat.photontech.cc/ageis.js"></script>
<script src="https://cdn.photonpay.com/ageis.js"></script>


2. 在点击提交的时候使用 photonPayApi.getFingerprintId() 得到设备指纹 ID 并传递给交易接口参数 risk.fingerprintId 。注意，在调用方法时如果出现报错 “photonPayApi is not defined”，需要在方法前添加代码 window.__AGEIS() ，参考如下： 

// 仅供参考
window.__AGEIS();
var fingerPrintId = photonPayApi.getFingerprintId();
console.log(fingerPrintId)

post 消费

发起消费交易，消费成功时会产生实际扣款

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
amount
required
number <bigdecimal>

订单金额 请按照4217币种的最小单位传递 eg.(CNY) 110.86 (JPY) 1110【创建token快捷支付时，金额为0代表只创建令牌，非0代表创建令牌并支付】

currency
required
string

订单币种 ISO4217 币种的字母码 eg. USD, CNY, EUR

expiredMinutes
integer <int32>

过期时间(分钟) 当传递这个值后,订单送给渠道后的会按照这个时间过期

required
Array of objects (goods)

商品信息

notifyUrl
string

异步通知地址

payMethod
required
string

更多描述参考 支付方式

Credit Card
redirectUrl
string

跳转地址 收银台模式和3D模式及跳转必传

remark
string

备注信息

reqId
required
string

请求订单号

required
object (risk)

风控信息

object (shippingAddress)

地址信息, 比如说支付时商品邮寄地址等信息(商品信息virtual为N时，shipping为必填项)

required
object (shopper)

在正向交易中,传递的关于购物者的一些信息

siteId
required
string

店铺号

required
object (billingAddress)

交易的账单地址信息

object (browser)

浏览器信息, PC 3D 必填

required
object (card)

信用卡支付, 需要把json转成string传递

secure3d
string
Enum: "N" "Y"
tokenReason
string

创建token快捷支付原因，如：easy pay

tokenType
string
Enum: "none" "payment_token" "network_payment_token"

创建token快捷支付必填，默认none：非创建token可不传

Responses (200)

Response Schema: application/json
code
string
continueUrl
string

接着交易的URL(3D,本地化跳转URL)

expiredAt
string
Value: "2022-03-18T08:43:27"

过期时间

invoiceDesc
string

票据号描述/还款指引

invoiceNo
string

票据号/还款码

maskCardNo
string

信用卡支付返回的卡号

memberNo
string

商户ID

msg
string

系统的交易结果描述

qrCode
string

base64的二维码

remark
string

请求的remark参数，原文返回

reqId
string

请求订单号

secure3d
string
Enum: "N" "Y"

是否3D支付

siteId
string

店铺号

status
string
Enum: "cancelled" "expired" "failed" "pending" "succeed" "suspend"

订单的状态

tokenExpiration
string
Value: "2025-06-01"

token快捷支付令牌过期时间

tokenization
string

创建token快捷支付返回的令牌

userLoginId
string

第三方用户登录账号

transactionId
string

交易订单号

Request samples

Content type
application/json
Example
{
  • "amount" : "20" ,
  • "billing" : {
    } ,
  • "currency" : "USD" ,
  • "goodsInfo" : [
    ] ,
  • "notifyUrl" : "you notify url" ,
  • "payInfo" : "{\"cardNo\": \"4444333322221111\", \"firstName\": \"Bren\", \"lastName\": \"Qiu\", \"cvv\": \"123\", \"expireYear\": \"2023\", \"expireMonth\": \"12\"}" ,
  • "payMethod" : "Credit Card" ,
  • "redirectUrl" : "you redirect url" ,
  • "remark" : "remark" ,
  • "reqId" : "20230424141154" ,
  • "risk" : {
    } ,
  • "shopper" : {
    } ,
  • "siteId" : "【收单】-【站点管理】-【详情】中的站点编号"
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "maskCardNo" : "444433******1111" ,
  • "memberNo" : "2023010558663764" ,
  • "msg" : "succeed" ,
  • "remark" : "remark" ,
  • "reqId" : "20230424141154" ,
  • "secure3d" : "N" ,
  • "siteId" : "20230105586637641001" ,
  • "status" : "succeed" ,
  • "transactionId" : "TR1648561479508692992"
}

post 授权交易

发起授权交易(信用卡)，授权交易并不会产生实际扣款，需要调用 授权交易完成 接口对授权交易进行完成操作

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
amount
required
number <bigdecimal>

订单金额 请按照4217币种的最小单位传递 eg.(CNY) 110.86 (JPY) 1110【创建token快捷支付时，金额为0代表只创建令牌，非0代表创建令牌并支付】

currency
required
string

订单币种 ISO4217 币种的字母码 eg. USD, CNY, EUR

expiredMinutes
integer <int32>

过期时间(分钟) 当传递这个值后,订单送给渠道后的会按照这个时间过期

required
Array of objects (goods)

商品信息

notifyUrl
string

异步通知地址

payMethod
required
string

更多描述参考 支付方式

Credit Card
redirectUrl
string

跳转地址 收银台模式和3D模式及跳转必传

remark
string

备注信息

reqId
required
string

请求订单号

required
object (risk)

风控信息

object (shippingAddress)

地址信息, 比如说支付时商品邮寄地址等信息(商品信息virtual为N时，shipping为必填项)

required
object (shopper)

在正向交易中,传递的关于购物者的一些信息

siteId
required
string

店铺号

required
object (billingAddress)

交易的账单地址信息

object (browser)

浏览器信息, PC 3D 必填

required
object (card)

信用卡支付, 需要把json转成string传递

secure3d
string
Enum: "N" "Y"
tokenReason
string

创建token快捷支付原因，如：easy pay

tokenType
string
Enum: "none" "payment_token" "network_payment_token"

创建token快捷支付必填，默认none：非创建token可不传

Responses (200)

Response Schema: application/json
code
string
continueUrl
string

接着交易的URL(3D,本地化跳转URL)

expiredAt
string
Value: "2022-03-18T08:43:27"

过期时间

invoiceDesc
string

票据号描述/还款指引

invoiceNo
string

票据号/还款码

maskCardNo
string

信用卡支付返回的卡号

memberNo
string

商户ID

msg
string

系统的交易结果描述

qrCode
string

base64的二维码

remark
string

请求的remark参数，原文返回

reqId
string

请求订单号

secure3d
string
Enum: "N" "Y"

是否3D支付

siteId
string

店铺号

status
string
Enum: "cancelled" "expired" "failed" "pending" "succeed" "suspend"

订单的状态

tokenExpiration
string
Value: "2025-06-01"

token快捷支付令牌过期时间

tokenization
string

创建token快捷支付返回的令牌

userLoginId
string

第三方用户登录账号

transactionId
string

交易订单号

Request samples

Content type
application/json
Example
{
  • "amount" : "20" ,
  • "billing" : {
    } ,
  • "currency" : "USD" ,
  • "goodsInfo" : [
    ] ,
  • "notifyUrl" : "you notify url" ,
  • "payInfo" : "{\"cardNo\": \"4444333322221111\", \"firstName\": \"Bren\", \"lastName\": \"Qiu\", \"cvv\": \"123\", \"expireYear\": \"2023\", \"expireMonth\": \"12\"}" ,
  • "payMethod" : "Credit Card" ,
  • "redirectUrl" : "you redirect url" ,
  • "remark" : "remark" ,
  • "reqId" : "20230424141154" ,
  • "risk" : {
    } ,
  • "shopper" : {
    } ,
  • "siteId" : "【收单】-【站点管理】-【详情】中的站点编号"
}

Response samples

Content type
application/json
Example
{
  • "code" : "0000" ,
  • "maskCardNo" : "444433******1111" ,
  • "memberNo" : "2023010558663764" ,
  • "msg" : "succeed" ,
  • "remark" : "remark" ,
  • "reqId" : "20230424141154" ,
  • "secure3d" : "N" ,
  • "siteId" : "20230105586637641001" ,
  • "status" : "succeed" ,
  • "transactionId" : "TR1648561479508692992"
}

post mit签约

进行 mit 签约，支持签约同时进行交易

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
amount
required
number <bigdecimal>

订单金额 请按照4217币种的最小单位传递 eg.(CNY) 110.86 (JPY) 1110【金额为0代表只创建mit，非0代表创建mit并支付】

currency
required
string

订单币种 ISO4217 币种的字母码 eg. USD, CNY, EUR

expiredMinutes
integer <int32>

过期时间(分钟) 当传递这个值后,订单送给渠道后的会按照这个时间过期

required
Array of objects (goods)

商品信息

notifyUrl
string

异步通知地址

payMethod
required
string

支付方式

Credit Card
redirectUrl
string

跳转地址 收银台模式和3D模式及跳转必传

remark
string

备注信息

reqId
required
string

请求订单号

required
object (risk)

风控信息

object (shippingAddress)

地址信息, 比如说支付时商品邮寄地址等信息(商品信息virtual为N时，shipping为必填项)

required
object (shopper)

在正向交易中,传递的关于购物者的一些信息

siteId
required
string

店铺号

merchantInitialReason
string
Enum: "RECURRING" "UNSCHEDULED"

若签约后是作RECURRING使用，则此参数必传

agreementUrl
required
string

协议url

required
object (billingAddress)

交易的账单地址信息

object (browser)

浏览器信息, PC 3D 必填

required
object (card)

信用卡支付, 需要把json转成string传递

secure3d
string
Enum: "N" "Y"

Responses (200)

Response Schema: application/json
agreementNo
string

mit签约返回的凭证号

code
string
continueUrl
string

接着交易的URL(3D,本地化跳转URL)

expiredAt
string
Value: "2022-03-18T08:43:27"

过期时间

invoiceDesc
string

票据号描述/还款指引

invoiceNo
string

票据号/还款码

maskCardNo
string

信用卡支付返回的卡号

memberNo
string

商户ID

msg
string

系统的交易结果描述

qrCode
string

base64的二维码

remark
string

请求的remark参数，原文返回

reqId
string

请求订单号

secure3d
string
Enum: "N" "Y"

是否3D支付

siteId
string

店铺号

status
string
Enum: "cancelled" "expired" "failed" "pending" "succeed" "suspend"

订单的状态

transactionId
string

交易订单号

Request samples

Content type
application/json
Example
{
  • "agreementUrl" : "Agreement Url" ,
  • "merchantInitialReason" : "RECURRING" ,
  • "amount" : "20" ,
  • "billing" : {
    } ,
  • "currency" : "USD" ,
  • "goodsInfo" : [
    ] ,
  • "notifyUrl" : "you notify url" ,
  • "payInfo" : "{\"cardNo\": \"4444333322221111\", \"firstName\": \"Bren\", \"lastName\": \"Qiu\", \"cvv\": \"123\", \"expireYear\": \"2023\", \"expireMonth\": \"12\"}" ,
  • "payMethod" : "Credit Card" ,
  • "redirectUrl" : "you redirect url" ,
  • "remark" : "remark" ,
  • "reqId" : "20230424141154" ,
  • "risk" : {
    } ,
  • "shopper" : {
    } ,
  • "siteId" : "【收单】-【站点管理】-【详情】中的站点编号"
}

Response samples

Content type
application/json
{
  • "agreementNo" : "clktmtohrncDWw" ,
  • "code" : "0000" ,
  • "maskCardNo" : "444433******1111" ,
  • "memberNo" : "2023010558663764" ,
  • "msg" : "succeed" ,
  • "remark" : "remark" ,
  • "reqId" : "20230516141155" ,
  • "secure3d" : "N" ,
  • "siteId" : "20230105586637641001" ,
  • "status" : "succeed" ,
  • "transactionId" : "TR1658354573473091584"
}

post mit扣款

发起 mit 扣款交易，在此之前需要进行 mit 签约

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
amount
required
number <bigdecimal>

订单金额 请按照4217币种的最小单位传递 eg.(CNY) 110.86 (JPY) 1110

currency
required
string

订单币种 ISO4217 币种的字母码 eg. USD, CNY, EUR

expiredMinutes
integer <int32>

过期时间(分钟) 当传递这个值后,订单送给渠道后的会按照这个时间过期

required
Array of objects (goods)

商品信息

notifyUrl
string

异步通知地址

payMethod
required
string

支付方式

Mit
redirectUrl
string

跳转地址 收银台模式和3D模式及跳转必传

remark
string

备注信息

reqId
required
string

请求订单号

required
object (risk)

风控信息

object (shippingAddress)

地址信息, 比如说支付时商品邮寄地址等信息(商品信息virtual为N时，shipping为必填项)

required
object (shopper)

在正向交易中,传递的关于购物者的一些信息

siteId
required
string

店铺号

agreementNo
required
string

mit签约返回的凭证号

object (billingAddress)

交易的账单地址信息

object (browser)

浏览器信息, PC 3D 必填

merchantInitialReason
required
string
Enum: "RECURRING" "UNSCHEDULED"

Responses (200)

Response Schema: application/json
agreementNo
string

mit签约返回的凭证号

code
string
continueUrl
string

接着交易的URL(3D,本地化跳转URL)

expiredAt
string
Value: "2022-03-18T08:43:27"

过期时间

invoiceDesc
string

票据号描述/还款指引

invoiceNo
string

票据号/还款码

maskCardNo
string

信用卡支付返回的卡号

memberNo
string

商户ID

msg
string

系统的交易结果描述

qrCode
string

base64的二维码

remark
string

请求的remark参数，原文返回

reqId
string

请求订单号

secure3d
string
Enum: "N" "Y"

是否3D支付

siteId
string

店铺号

status
string
Enum: "cancelled" "expired" "failed" "pending" "succeed" "suspend"

订单的状态

transactionId
string

交易订单号

Request samples

Content type
application/json
{
  • "agreementNo" : "clkdkLGsxxu328" ,
  • "amount" : "20" ,
  • "billing" : {
    } ,
  • "currency" : "USD" ,
  • "goodsInfo" : [
    ] ,
  • "merchantInitialReason" : "RECURRING" ,
  • "notifyUrl" : "you notify url" ,
  • "payMethod" : "Mit" ,
  • "redirectUrl" : "you redirect url" ,
  • "remark" : "remark" ,
  • "reqId" : "20230424141154" ,
  • "risk" : {
    } ,
  • "shopper" : {
    } ,
  • "siteId" : "【收单】-【站点管理】-【详情】中的站点编号"
}

Response samples

Content type
application/json
{
  • "agreementNo" : "clkdkLGsxxu328" ,
  • "code" : "0000" ,
  • "maskCardNo" : "444433******1111" ,
  • "memberNo" : "2023010558663764" ,
  • "msg" : "succeed" ,
  • "remark" : "remark" ,
  • "reqId" : "20230516141557" ,
  • "secure3d" : "N" ,
  • "siteId" : "20230105586637641001" ,
  • "status" : "succeed" ,
  • "transactionId" : "TR1658355589086056448"
}

收银台

收银台

为商户提供便捷快速的对接方式，无 PCI 资质要求

接入步骤

1. 使用接口 创建支付会话 , 传入相应的支付方式 payMethod 和支付跳转地址 redirectUrl 等必要参数，获取支付会话 Code(authCode)
2. 在 checkout 页面引入收银台 js, 使用创建支付会话接口得到的 authCode 及 payMethod 参数值打开收银台 

测试地址
<script src="https://cdn1.uat.photontech.cc/PhotonPay.js"></script>
生产地址
<script src="https://cdn.photonpay.com/PhotonPay.js"></script>
 //点击checkout调用函数
cashierAPI.payout({authCode: params.authCode,payMethod: params.payMethod})

3. 用户完成支付后, 收银台将页面将重定向到 redirectUrl ，同时附带参数 status=[canceled/succeed/failed/pending]&reqId={reqId} ，建议使用异步消息通知获取交易最终结果

post 创建支付会话

使用收银台之前，需要预先创建支付会话，获取唤起收银台 js 的支付参数

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
amount
required
number <bigdecimal>

订单金额 请按照4217币种的最小单位传递 eg.(CNY) 110.86 (JPY) 1110

currency
required
string

订单币种 ISO4217 币种的字母码 eg. USD, CNY, EUR

required
Array of objects (goods)

商品信息

notifyUrl
string

异步通知地址

payMethod
required
string

更多描述参考 支付方式

Credit Card
redirectUrl
required
string

跳转地址必传

remark
string

备注信息

reqId
required
string

请求订单号

required
object (risk)

风控信息

object (shippingAddress)

地址信息, 比如说支付时商品邮寄地址等信息(商品信息virtual为N时，shipping为必填项)

required
object (shopper)

在正向交易中,传递的关于购物者的一些信息

agreementUrl
string

协议url。(若签约后是作RECURRING使用,则此参数必传)

merchantInitialReason
string
Enum: "RECURRING" "UNSCHEDULED"

若签约后是作RECURRING使用，则此参数必传

required
object (billingAddress)

交易的账单地址信息

siteId
required
string

店铺号

Responses (200)

Response Schema: application/json
authCode
string

创建支付请求临时授权码

code
string
msg
string

系统的交易结果描述

Request samples

Content type
application/json
{
  • "amount" : "20" ,
  • "billing" : {
    } ,
  • "currency" : "USD" ,
  • "goodsInfo" : [
    ] ,
  • "notifyUrl" : "you notify url" ,
  • "payMethod" : "Credit Card" ,
  • "redirectUrl" : "you redirect url" ,
  • "remark" : "remark" ,
  • "reqId" : "20230424141154" ,
  • "risk" : {
    } ,
  • "shopper" : {
    } ,
  • "agreementUrl" : "" ,
  • "merchantInitialReason" : "" ,
  • "siteId" : "【收单】-【站点管理】-【详情】中的站点编号"
}

Response samples

Content type
application/json
{
  • "authCode" : "cjeUgwzkJn0u80" ,
  • "payId" : "20230424141154" ,
  • "payMethod" : "Credit Card"
}

post 创建订阅支付会话

使用收银台创建产品之前，需要预先创建订阅支付会话，获取唤起收银台 js 的支付参数

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
reqId
required
string

请求ID

redirectUrl
required
string

跳转地址 收银台模式和3D模式及跳转必传

notifyUrl
string

异步通知地址

payMethod
required
string
Value: "Credit Card"

支付方式

metadata
string

业务方自定义数据

remark
string

备注信息

required
Array of objects (lineItems)

产品&价格信息, 只能有一条数据

object (agreement)

订阅协议信息

required
object (shopper)

在正向交易中,传递的关于购物者的一些信息

required
object (subscriptionRisk)

风控信息

required
object (billingAddress)

交易的账单地址信息

Responses (200)

Response Schema: application/json
authCode
string

创建支付请求临时授权码

code
string
msg
string

系统的交易结果描述

Request samples

Content type
application/json
{
  • "reqId" : "2025072256879107" ,
  • "redirectUrl" : "you redirect url" ,
  • "notifyUrl" : "you notify url" ,
  • "metadata" : "" ,
  • "remark" : "remark" ,
  • "payMethod" : "Credit Card" ,
  • "agreement" : {
    } ,
  • "lineItems" : [
    ] ,
  • "shopper" : {
    } ,
  • "billing" : {
    } ,
  • "risk" : {
    }
}

Response samples

Content type
application/json
{
  • "authCode" : "cjeUgwzkJn0u80" ,
  • "payId" : "20230424141154" ,
  • "payMethod" : "Credit Card"
}

产品管理

产品管理

post 创建产品

创建产品

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
siteId
required
string

所属站点ID

name
required
string

产品名称，不超过50个字符

description
string

产品特点的描述，不超过100个字符

imageUrl
string

产品图片地址

调用 文件上传 接口获取文件 key。 businessKey 传 payments_paddle_price

Responses (200)

Response Schema: application/json
code
String

响应的code 0000代表成功

msg
String

错误消息

object (productCreateDetail)

Request samples

Content type
application/json
{
  • "siteId" : "20210518873904071001" ,
  • "name" : "product name" ,
  • "description" : "product name desc" ,
  • "imageUrl" : "Ka69qdmAdojoqo"
}

Response samples

Content type
application/json
{ }

get 查询产品

查询产品

query Parameters
siteId
required
string
Example: siteId=2023120591143591009

所属站点ID

productId
required
string
Example: productId=prod_1952351825428549632

产品ID

header Parameters
X-PD-TOKEN
required
string
Example: 2023120591143591009

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
String

响应的code 0000代表成功

msg
String

错误消息

object (productQueryDetail)

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "msg" : "succeed" ,
  • "data" : {
    }
}

get 查询产品列表

查询产品列表

query Parameters
pageIndex
required
integer <int64>

当前页/默认第一页

pageSize
required
integer <int64>

分页大小

siteId
required
string

站点ID（强制过滤条件）

id
string
Example: id=prod_1947269273994928128,prod_1947269728590372864

按产品ID过滤（逗号分隔多个ID）

include
string
Example: include=prices

关联数据加载（仅支持prices），返回产品关联的价格信息

status
string
Enum: "draft" "active" "archived"

按状态过滤（draft:初始状态/active:已激活/archived:已下架），默认返回所有状态

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

Array of objects (productPagingDetail)

返回的对象

msg
string

错误消息

numbers
integer <int32>

当前页记录数

pageIndex
integer <int64>

当前页/默认第一页

pageSize
integer <int64>

分页大小

total
integer <int64>

总记录数

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "msg" : "succeed" ,
  • "data" : [
    ] ,
  • "pageIndex" : 1 ,
  • "pageSize" : 10 ,
  • "total" : 1
}

价格管理

价格管理

post 创建价格

创建价格

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
productId
required
string

关联的产品ID

currency
required
string

货币

amount
required
bigDecimal

产品每条价格计划的单价

type
required
string
Enum: "recurring" "one_time"

价格类型，recurring:定期 one_time:一次性

billingCycle
string
Enum: "daily" "weekly" "monthly" "quarterly" "yearly"

计费周期，type=recurring时必填 daily:每天 weekly:每周 monthly:每月 quarterly:每季度 yearly:每年

trialDays
integer

试用期天数,仅type=recurring有效（最大值999）

Responses (200)

Response Schema: application/json
code
String

响应的code 0000代表成功

msg
String

错误消息

object (priceCreateDetail)

Request samples

Content type
application/json
{
  • "productId" : "2023120591143591004" ,
  • "currency" : "USD" ,
  • "amount" : 10 ,
  • "type" : "recurring" ,
  • "billingCycle" : "monthly" ,
  • "trialDays" : 10
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "msg" : "succeed" ,
  • "data" : {
    }
}

get 查询价格

查询价格

query Parameters
priceId
required
string
Example: priceId=price_1945738415521660928

价格ID

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
String

响应的code 0000代表成功

msg
String

错误消息

object (priceQueryDetail)

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "msg" : "succeed" ,
  • "data" : {
    }
}

get 查询价格列表

查询价格列表

query Parameters
pageIndex
required
integer <int64>

当前页/默认第一页

pageSize
required
integer <int64>

分页大小

priceId
string
Example: priceId=price_1945738415521660928,price_1950453992995704832

按价格ID过滤（逗号分隔多个ID）

productId
string

按关联的产品ID过滤

type
string

价格类型 recurring:定期 one_time:一次性

status
string
Enum: "active" "archived"

按状态过滤：active（已激活）或 archived（已下架）

include
string
Example: include=product

关联数据加载（当前仅支持 product）

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

Array of objects (pricePagingDetail)

返回的对象

msg
string

错误消息

numbers
integer <int32>

当前页记录数

pageIndex
integer <int64>

当前页/默认第一页

pageSize
integer <int64>

分页大小

total
integer <int64>

总记录数

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "msg" : "succeed" ,
  • "data" : [
    ] ,
  • "pageIndex" : 1 ,
  • "pageSize" : 10 ,
  • "total" : 1
}

其他交易类型

详细描述了 退款，预授权完成，预授权撤销，审核订单，查询订单等交易操作

get 查询

发起交易查询

query Parameters
reqId
required
string

请求id

siteId
required
string

站点id

transactionType
required
string
Enum: "sale" "auth" "refund" "capture" "void" "mit"

订单类型

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
arn
string

arn

code
string
expiredAt
string
Value: "2022-03-18T08:43:27"

过期时间

invoiceDesc
string

票据号描述/还款指引

invoiceNo
string

票据号/还款码

issuerCountry
string

卡国家

maskCardNo
string

信用卡支付返回的卡号

memberNo
string

商户ID

msg
string

系统的交易结果描述

originReqId
string

原始请求号

payMethod
string

卡组

remark
string

请求的remark参数，原文返回

reqId
string

请求订单号

secure3d
string
Enum: "N" "Y"

是否3D支付

siteId
string

店铺号

status
string
Enum: "cancelled" "expired" "failed" "pending" "succeed" "suspend"

订单的状态

transactionId
string

交易订单号

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "issuerCountry" : "US" ,
  • "maskCardNo" : "444433******1111" ,
  • "memberNo" : "2023010558663764" ,
  • "msg" : "succeed" ,
  • "payMethod" : "VISA" ,
  • "remark" : "remark" ,
  • "reqId" : "20230504141138" ,
  • "secure3d" : "N" ,
  • "siteId" : "20230105586637641001" ,
  • "status" : "succeed" ,
  • "transactionId" : "TR1654005852065107968"
}

post 退款

对已经完成支付的交易发起退款

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
amount
required
number <bigdecimal>

订单金额 请按照4217币种的最小单位传递 eg.(CNY) 110.86 (JPY) 1110

notifyUrl
string

异步通知地址

remark
string

备注信息

reqId
required
string

请求订单号

transactionId
required
string

交易订单号

Responses (200)

Response Schema: application/json
code
string
memberNo
string

商户ID

msg
string

系统的交易结果描述

originReqId
string

原始请求号

remark
string

请求的remark参数，原文返回

reqId
string

请求订单号

siteId
string

店铺号

status
string
Enum: "failed" "pending" "succeed"

订单的状态

transactionId
string

交易订单号

Request samples

Content type
application/json
{
  • "amount" : 10 ,
  • "reqId" : "20230504141921" ,
  • "transactionId" : "TR1654005852065107968"
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "memberNo" : "2023010558663764" ,
  • "msg" : "succeed" ,
  • "originReqId" : "20230504141138" ,
  • "remark" : "" ,
  • "reqId" : "20230504141921" ,
  • "siteId" : "20230105586637641001" ,
  • "status" : "succeed" ,
  • "transactionId" : "TR1654007791108624384"
}

post 授权交易完成

针对授权交易发起完成操作，完成交易扣款

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
amount
required
number <bigdecimal>

订单金额 请按照4217币种的最小单位传递 eg.(CNY) 110.86 (JPY) 1110

notifyUrl
string

异步通知地址

remark
string

备注信息

reqId
required
string

请求订单号

transactionId
required
string

交易订单号

Responses (200)

Response Schema: application/json
code
string
memberNo
string

商户ID

msg
string

系统的交易结果描述

originReqId
string

原始请求号

remark
string

请求的remark参数，原文返回

reqId
string

请求订单号

siteId
string

店铺号

status
string
Enum: "failed" "pending" "succeed"

订单的状态

transactionId
string

交易订单号

Request samples

Content type
application/json
{
  • "amount" : 30 ,
  • "reqId" : "20230504135125" ,
  • "transactionId" : "TR1654000549793763328"
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "memberNo" : "2023010558663764" ,
  • "msg" : "succeed" ,
  • "originReqId" : "20230504135034" ,
  • "remark" : "" ,
  • "reqId" : "20230504135125" ,
  • "siteId" : "20230105586637641001" ,
  • "status" : "succeed" ,
  • "transactionId" : "TR1654000759890644992"
}

post 交易撤销

针对授权交易发起撤销操作，取消授权交易

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
notifyUrl
string

异步通知地址

remark
string

备注信息

reqId
required
string

请求订单号

transactionId
required
string

交易订单号

Responses (200)

Response Schema: application/json
code
string
memberNo
string

商户ID

msg
string

系统的交易结果描述

originReqId
string

原始请求号

remark
string

请求的remark参数，原文返回

reqId
string

请求订单号

siteId
string

店铺号

status
string
Enum: "failed" "succeed"

订单的状态

transactionId
string

交易订单号

Request samples

Content type
application/json
{
  • "reqId" : "20230504142306" ,
  • "transactionId" : "TR1654008636499955712"
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "memberNo" : "2023010558663764" ,
  • "msg" : "succeed" ,
  • "originReqId" : "20230504142243" ,
  • "remark" : "" ,
  • "reqId" : "20230504142306" ,
  • "siteId" : "20230105586637641001" ,
  • "status" : "succeed" ,
  • "transactionId" : "TR1654008732742455296"
}

post 消费再确认

审核交易被挂起的订单，sale 交易返回状态为 suspend 的订单，需要做此操作

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
reqId
required
string

请求订单号

reviewType
string
Enum: "approve" "reject"

review类型

transactionId
required
string

交易订单号

Responses (200)

Response Schema: application/json
code
string
expiredAt
string
Value: "2022-03-18T08:43:27"

过期时间

invoiceDesc
string

票据号描述/还款指引

invoiceNo
string

票据号/还款码

issuerCountry
string

卡国家

maskCardNo
string

信用卡支付返回的卡号

memberNo
string

商户ID

msg
string

系统的交易结果描述

payMethod
string

卡组

remark
string

请求的remark参数，原文返回

reqId
string

请求订单号

secure3d
string
Enum: "N" "Y"

是否3D支付

siteId
string

店铺号

status
string
Enum: "cancelled" "expired" "failed" "pending" "succeed" "suspend"

订单的状态

transactionId
string

交易订单号

Request samples

Content type
application/json
{
  • "reqId" : "string" ,
  • "reviewType" : "approve" ,
  • "transactionId" : "string"
}

Response samples

Content type
application/json
{
  • "code" : "string" ,
  • "expiredAt" : "2022-03-18T08:43:27" ,
  • "invoiceDesc" : "string" ,
  • "invoiceNo" : "string" ,
  • "issuerCountry" : "string" ,
  • "maskCardNo" : "450000**********1234" ,
  • "memberNo" : "string" ,
  • "msg" : "string" ,
  • "payMethod" : "string" ,
  • "remark" : "string" ,
  • "reqId" : "string" ,
  • "secure3d" : "N" ,
  • "siteId" : "string" ,
  • "status" : "cancelled" ,
  • "transactionId" : "string"
}

del token快捷支付令牌删除

query Parameters
tokenization
required
string

token快捷支付令牌

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
string
msg
string

系统的交易结果描述

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "msg" : "succeed"
}

get token快捷支付令牌查询

query Parameters
siteId
required
string

站点id

shopperId
required
string

购物者id

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
string
msg
string

系统的交易结果描述

Array of objects (tokenizations)

token快捷支付令牌

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "msg" : "succeed" ,
  • "tokenizations" : [
    ]
}

post 创建Token

发起token创建

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
amount
required
number <bigdecimal>

订单金额 请按照4217币种的最小单位传递 eg.(CNY) 110.86 (JPY) 1110【创建token快捷支付时，金额为0代表只创建令牌，非0代表创建令牌并支付】

currency
required
string

订单币种 ISO4217 币种的字母码 eg. USD, CNY, EUR

expiredMinutes
integer <int32>

过期时间(分钟) 当传递这个值后,订单送给渠道后的会按照这个时间过期

required
Array of objects (goods)

商品信息

notifyUrl
string

异步通知地址

payMethod
required
string

更多描述参考 支付方式

Credit Card
redirectUrl
string

跳转地址 收银台模式和3D模式及跳转必传

remark
string

备注信息

reqId
required
string

请求订单号

required
object (risk)

风控信息

object (shippingAddress)

地址信息, 比如说支付时商品邮寄地址等信息(商品信息virtual为N时，shipping为必填项)

required
object (shopper)

在正向交易中,传递的关于购物者的一些信息

siteId
required
string

店铺号

required
object (billingAddress)

交易的账单地址信息

object (browser)

浏览器信息, PC 3D 必填

required
object (card)

信用卡支付, 需要把json转成string传递

secure3d
string
Enum: "N" "Y"
tokenReason
string

创建token快捷支付原因，如：easy pay

tokenType
string
Enum: "none" "payment_token" "network_payment_token"

创建token快捷支付必填，默认none：非创建token可不传

Responses (200)

Response Schema: application/json
code
string
continueUrl
string

接着交易的URL(3D,本地化跳转URL)

expiredAt
string
Value: "2022-03-18T08:43:27"

过期时间

invoiceDesc
string

票据号描述/还款指引

invoiceNo
string

票据号/还款码

maskCardNo
string

信用卡支付返回的卡号

memberNo
string

商户ID

msg
string

系统的交易结果描述

qrCode
string

base64的二维码

remark
string

请求的remark参数，原文返回

reqId
string

请求订单号

secure3d
string
Enum: "N" "Y"

是否3D支付

siteId
string

店铺号

status
string
Enum: "cancelled" "expired" "failed" "pending" "succeed" "suspend"

订单的状态

tokenExpiration
string
Value: "2025-06-01"

token快捷支付令牌过期时间

tokenization
string

创建token快捷支付返回的令牌

userLoginId
string

第三方用户登录账号

transactionId
string

交易订单号

Request samples

Content type
application/json
Example
{
  • "amount" : "20" ,
  • "billing" : {
    } ,
  • "currency" : "USD" ,
  • "goodsInfo" : [
    ] ,
  • "notifyUrl" : "you notify url" ,
  • "payInfo" : "{\"cardNo\": \"4444333322221111\", \"firstName\": \"Bren\", \"lastName\": \"Qiu\", \"cvv\": \"123\", \"expireYear\": \"2023\", \"expireMonth\": \"12\"}" ,
  • "payMethod" : "Credit Card" ,
  • "redirectUrl" : "you redirect url" ,
  • "remark" : "remark" ,
  • "reqId" : "20230424141154" ,
  • "risk" : {
    } ,
  • "shopper" : {
    } ,
  • "siteId" : "【收单】-【站点管理】-【详情】中的站点编号"
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "maskCardNo" : "444433******1111" ,
  • "memberNo" : "2023010558663764" ,
  • "msg" : "succeed" ,
  • "remark" : "remark" ,
  • "reqId" : "20230424141154" ,
  • "secure3d" : "N" ,
  • "siteId" : "20230105586637641001" ,
  • "status" : "succeed" ,
  • "transactionId" : "TR1648561479508692992"
}

post 更新token

对token进行更新操作

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
tokenization
required
string

创建token快捷支付返回的令牌

tokenStatus
required
string

token的状态

Responses (200)

Response Schema: application/json
code
string

Refer to the Response Code

msg
string

Description of transaction result

status
string
Enum: "active" "delete" "expired" "suspended"

Status of token

Request samples

Content type
application/json
{
  • "tokenization" : "cj17Wpoj5Wlog0" ,
  • "tokenStatus" : "suspended"
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "tokenStatus" : "active" ,
  • "msg" : "succeed"
}

post 上传物流信息

上传交易对应的物流信息

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
logisticsCompany
required
string

物流公司名称

reqId
required
string

请求订单号

siteId
required
string

店铺号

trackingNumber
required
string

物流单号

Responses (200)

Response Schema: application/json
code
string
msg
string

系统的交易结果描述

Request samples

Content type
application/json
{
  • "logisticsCompany" : "EMS" ,
  • "reqId" : "20230421135904" ,
  • "siteId" : "20230105586637641001" ,
  • "trackingNumber" : "ems20230504001"
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "msg" : "succeed"
}

Billing

订阅管理

post 创建订阅

创建订阅

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
reqId
required
string

请求ID

redirectUrl
string

跳转地址 收银台模式和3D模式及跳转必传

notifyUrl
string

异步通知地址

agreementUrl
string

协议URL,订阅周期性产品必传

agreementTime
string

协议签约时间, 2025-08-08T08:43:28,订阅周期性产品必传

payMode
required
string
Enum: "one_time" "recurring"

支付模式：一次性 one_time、周期性 recurring

secure3d
string
Enum: "N" "Y"

是否3D，创建周期性订阅时，需要3D N Y

expiredMinutes
integer <int32>

过期时间(分钟)

metadata
string

业务方自定义数据

required
Array of objects (lineItems)

产品&价格信息, 只能有一条数据

required
object (shopper-2)

客户信息

required
object (card-2)

信用卡支付

required
object (billingAddress)

交易的账单地址信息

object (browser)

浏览器信息, PC 3D 必填

required
object (risk-2)

风控信息

Responses (200)

Response Schema: application/json
code
string
msg
string

系统的交易结果描述

reqId
string

请求订单号

subscriptionId
string

订阅ID，周期性产品

siteId
string

站点ID

priceId
string

价格ID

amount
string

金额，金额 按照4217币种的最小单位传递 eg.(CNY) 110.86 (JPY) 1110【金额为0代表只创建mit，非0代表创建mit并支付】

currency
string

订单币种

status
string
Enum: "succeed" "pending" "failed"

支付状态

trialStart
string

试用期开始时间，试用期产品响应

trialEnd
string

试用期结束时间，试用期产品响应

secure3d
string
Enum: "Y" "N"

是否3D验证

continueUrl
string

接着交易的URL(3D,本地化跳转URL)

expiredAt
string

过期时间

memberNo
string

商户会员号

transactionId
string

订单号

object (subscriptionCreateInfoRespPayment)

支付方式详情

Request samples

Content type
application/json
{
  • "reqId" : "2025072256879107" ,
  • "redirectUrl" : "" ,
  • "notifyUrl" : "" ,
  • "agreementUrl" : "Agreement Url" ,
  • "agreementTime" : "2025-08-08T08:43:28" ,
  • "payMode" : "recurring" ,
  • "secure3d" : "N" ,
  • "expiredMinutes" : 60 ,
  • "metadata" : "" ,
  • "lineItems" : [
    ] ,
  • "shopper" : {
    } ,
  • "payInfo" : {
    } ,
  • "billing" : {
    } ,
  • "risk" : {
    }
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "msg" : "succeed" ,
  • "reqId" : "20250808141154" ,
  • "subscriptionId" : "sub_20250808123456" ,
  • "siteId" : "" ,
  • "priceId" : "" ,
  • "amount" : "998.00" ,
  • "currency" : "USD" ,
  • "status" : "active" ,
  • "trialStart" : "2025-08-25T15:09:33" ,
  • "trialEnd" : "2025-08-31T15:09:33" ,
  • "secure3d" : "N" ,
  • "continueUrl" : "2025-08-31T15:09:33" ,
  • "expiredAt" : "2025-08-31T15:09:33" ,
  • "memberNo" : "2022122256879107" ,
  • "transactionId" : "" ,
  • "paymentMethod" : {
    }
}

get 查询订阅

查询订阅

path Parameters
subscriptionId
required
string

订阅ID

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

object (subscriptionQueryInfoResp)

返回的对象

method
string

错误时, 返回的请求http method

msg
string

错误消息

path
string

错误时,返回的path 对象

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "msg" : "succeed" ,
  • "data" : {
    }
}

post 取消订阅

取消订阅

path Parameters
subscriptionId
required
string

订阅ID

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

object (subscriptionCancelInfoResp)

返回的对象

method
string

错误时, 返回的请求http method

msg
string

错误消息

path
string

错误时,返回的path 对象

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "msg" : "succeed" ,
  • "data" : {
    }
}

附录

支付方式

支付方式
支持国家
支付类型
Tokenization
MIT
必填参数(端到端支付必填)
交易币种
VISA 全球 Credit Card ☑️ ☑️ cardNo/firstName/lastName/cvv/expireYear/expireMonth 全币种
MasterCard 全球 Credit Card ☑️ ☑️ cardNo/firstName/lastName/cvv/expireYear/expireMonth 全币种
eps 奥地利(AT) eps - - countryCode/payerName EUR
giropay 德国(DE) giropay - - countryCode/payerName EUR
iDEAL 荷兰(NL) iDEAL - - countryCode/payerName/bankName[iDeal支持的银行] EUR
MyBank 意大利(IT) MyBank - - countryCode/payerName EUR
POLi 澳大利亚(AU)新西兰(NZ) POLi - - countryCode/payerName AUD,NZD
SafetyPay 奥地利(AT)比利时(BE)巴西(BR)智利(CL)哥斯达黎加(CR)德国(DE)厄瓜多尔(EC)西班牙(ES)墨西哥(MX)荷兰(NL) SafetyPay - - countryCode/payerName/email EUR,USD
Sofort 奥地利(AT)比利时(BE)瑞士(CH)德国(DE)西班牙(ES)英国(GB)意大利(IT)荷兰(NL)波兰(PL) Sofort - - countryCode/payerName EUR,GBP,CHF
TrustPay 斯洛伐克(SK) TrustPay - - countryCode/payerName EUR
OVO 印度尼西亚(ID) OVO - - phone IDR
LINKAJA 印度尼西亚(ID) LINKAJA - - - IDR
Wechat 中国香港(HK) Wechat - - - CNY,HKD
UPOP 全球 UnionPay - - - EUR,TWD,SGD CAD,AUD,USD GBP,CNY,HKD
ApplePay 全球 ApplePay - - applicationPrimaryAccountNumber/applicationExpirationDate /cardholderName/onlinePaymentCryptogram/eciIndicator [ApplePay获得卡信息加密数据解密得到] All currency
DANA 印度尼西亚(ID) DANA ☑️ ☑️ countryCode/terminalType/osType
[terminalType必填(WEB,WAP,APP);
terminalType为WAP/APP时osType必填(IOS,ANDROID)] 		IDR,USD
GCASH 菲律宾(PH) GCASH ☑️ ☑️ countryCode/terminalType/osType
[terminalType必填(WEB,WAP,APP);
terminalType为WAP/APP时osType必填(IOS,ANDROID)] 		PHP,USD
BPI 菲律宾(PH) BPI - - countryCode/terminalType/osType
[terminalType必填(WEB,WAP,APP);
terminalType为WAP/APP时osType必填(IOS,ANDROID)] 		PHP,USD
KAKAOPAY 韩国(KR) KAKAOPAY ☑️ ☑️ countryCode/terminalType/osType
[terminalType必填(WEB,WAP,APP);
terminalType为WAP/APP时osType必填(IOS,ANDROID)] 		KRW,USD
TNG 马来西亚(MY) TNG ☑️ ☑️ countryCode/terminalType/osType
[terminalType必填(WEB,WAP,APP);
terminalType为WAP/APP时osType必填(IOS,ANDROID)] 		MYR,USD
BOOST 马来西亚(MY) BOOST ☑️ ☑️ countryCode/terminalType/osType
[terminalType必填(WEB,WAP,APP);
terminalType为WAP/APP时osType必填(IOS,ANDROID)] 		MYR,USD
TRUEMONEY 泰国(TH) TRUEMONEY ☑️ ☑️ countryCode/terminalType/osType
[terminalType必填(WEB,WAP,APP);
terminalType为WAP/APP时osType必填(IOS,ANDROID)] 		THB,USD
RABBIT_LINE_PAY 泰国(TH) RABBIT_LINE_PAY ☑️ ☑️ countryCode/terminalType/osType
[terminalType必填(WEB,WAP,APP);
terminalType为WAP/APP时osType必填(IOS,ANDROID)] 		THB,USD
GRABPAY_SG 新加坡(SG) GRABPAY_SG ☑️ ☑️ countryCode/terminalType/osType
[terminalType必填(WEB,WAP,APP);
terminalType为WAP/APP时osType必填(IOS,ANDROID)] 		SGD,USD
ALIPAY_HK 中国(CN) ALIPAY_HK - - countryCode/terminalType/osType
[terminalType必填(WEB,WAP,APP);
terminalType为WAP/APP时osType必填(IOS,ANDROID)] 		HKD,USD
SHOPEEPAY 印度尼西亚(ID) SHOPEEPAY - - - IDR
QRIS 印度尼西亚(ID) QRIS - - - IDR

iDeal支持的银行

银行名称
bank code
Rabobank RABONL2U
ABN AMRO ABNANL2A
Van Lanschot Baniers FVLBNL22
Triodos Bank TRIONL2U
ING Bank INGBNL2A
SNS Bank SNSBNL2A
ASN ASNBNL21
RegioBank RBRBNL21
Knab KNABNL2H
Bunq BUNQNL2A
Moneyou MOYONL21
Handelsbanken HANDNL2A
Revolut REVOLT21

支付响应码

code
msg
status
0000 交易成功 succeed
1000 无效参数 failed
1001 无效加签 failed
1002 无效token failed
1003 payInfoJson格式错误 failed
1004 通知错误 failed
1005 请重试 failed
2001 重复订单 failed
2002 原始订单未成功 failed
2003 原始订单不存在 failed
2004 金额不足 failed
2005 订单已发生预授权完成 failed
2006 订单已发生拒付 failed
2007 无效siteId failed
2008 交易被禁止 failed
2009 不支持的支付方式 failed
2010 不支持的币种 failed
2011 已经不在退款的有效期 failed
2012 已经不在预授权完成的有效期 failed
2013 原始订单已经被审核 failed
2014 交易请求ID无效 failed
2015 未找到有效的二级商户号 failed
2016 未找到系统映射码 suspend
2017 未找到有效的通道 failed
2018 不支持3D交易 failed
2019 不支持多次交易 failed
2020 商户的账单信息不全 failed
2021 交易已过期 failed
2022 不允许发起交易 failed
2023 不允许发起退款 failed
2024 未找到产品配置 failed
2025 交易不存在 failed
2026 交易已结算 failed
2027 店铺授权无效 failed
2028 令牌已存在 failed
2029 mit协议已存在 failed
2030 令牌不存在 failed
2031 支付链修改失败 failed
2032 退款总额超过账户总额，交易失败 failed
3001 挂起订单等待审核 suspend
3002 挂起待处理 pending
3003 处理中 pending
4000 风控拒绝 failed
5001 联系发卡行 failed
5002 发卡行不予承兑 failed
5003 终端不允许交易 failed
5004 发卡行/收单行超时 failed
5005 无原始交易 failed
5006 无效银行卡/发卡行/收单行 failed
5007 无效金额 failed
5008 无效卡号 failed
5009 预授权已过期 failed
5010 系统错误，请重试 failed
5011 不可信账户 failed
5012 交易失败 failed
5013 挂失卡 failed
5014 交易拒绝，请联系发卡行 failed
5015 金额不足 failed
5016 过期卡 failed
5017 密码错误，请重新输入 failed
5018 不允许该卡交易 failed
5019 超过金额限制 failed
5020 受限制卡 failed
5021 超过频次限制 failed
5022 超过收单行限次/限额 failed
5023 结果响应超时 failed
5024 超过密码尝试次数 failed
5025 无效账户 failed
5026 发卡行不能提供该服务 failed
5027 不能识别该密码 failed
5028 无效验证码 failed
5029 无效的交易周期 failed
5030 不安全交易 failed
5031 发卡行不可用 failed
5032 无效发卡行 failed
5033 交易不可完成 failed
5034 系统异常 failed
5035 重复退款 failed
5036 重复交易 failed
5037 CVV错误 failed
5038 3ds验证失败 failed
5039 不允许退款 failed
5040 发卡行不能执行3ds验证 failed
5041 该笔交易已经过期

收款

店铺管理

get 获取站点枚举

获取可申请店铺的站点信息

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

Array of objects (节点对象)

返回的对象

method
string

错误时, 返回的请求http method

msg
string

错误消息

path
string

错误时,返回的path 对象

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : [
    ] ,
  • "msg" : "succeed"
}

post 申请店铺

申请收款

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
memberId
string

请求所指向的会员号，如不传则默认为token下的会员；若涉及matrix产品，可传入指定的连接会员号。

aliexpressAccount
string

速卖通账号，速卖通站点必传

currency
required
string

币种: USD;EUR;GBP;JPY;IDR;MXN

paymentServiceProvider
string

支付服务商，独立站必填：PayPal；Stripe；WorldPay；Adyen；Shopify Payment；First Data

requestId
required
string

请求流水号，长度64以内并且唯一

salesCategory
required
integer <int32>

销售类目：1(汽配及工业产品)2(美妆以及个人护理健康)3(服饰/鞋帽以及配饰)4(数码电器、3C产品)5(家具、花园产品)6(宠物用品)7(办公学习用品)8(运动户外用品)9(工具、家装用品)10(玩具、母婴用品)11(珠宝、古董以及艺术品)12(礼品卡、游戏卡以及虚拟物品)13(食品以及饮料)14(综合商品)15(其他)

shopAddress
required
string

店铺链接

shopName
required
string

店铺名称

shopRemark
string

店铺备注

shopSubjectName
string

店铺注册主体名称:亚马逊必填，其他站点不填

site
required
string

站点，根据 站点枚举 接口获取

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

object (openAddStoreInfoResp)

返回的对象

method
string

错误时, 返回的请求http method

msg
string

错误消息

path
string

错误时,返回的path 对象

Request samples

Content type
application/json
{
  • "memberId" : "2022122256879107" ,
  • "currency" : "USD" ,
  • "requestId" : "20230504143411" ,
  • "salesCategory" : 2 ,
  • "shopAddress" : "shop url" ,
  • "shopName" : "amazonnQqPPQ" ,
  • "shopSubjectName" : "my shop" ,
  • "site" : "platform_amazon_ZNAmerica"
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : {
    } ,
  • "msg" : "succeed"
}

post 授权店铺

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
authCode
string

authCode

shopId
string

店铺编号

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

data
string

返回的对象

method
string

错误时, 返回的请求http method

msg
string

错误消息

path
string

错误时,返回的path 对象

Request samples

Content type
application/json
{
  • "authCode" : "authorization code" ,
  • "shopId" : "510000011372"
}

Response samples

Content type
application/json

get 获取店铺信息

query Parameters
pageIndex
integer <int64>

当前页/默认第一页

pageSize
integer <int64>

分页大小

memberId
string

查询所指向的会员号，如不传则默认为token下的会员；如涉及matrix产品，如不传则指向会员和连接会员所有信息查询，或传入指定会员查询。

shopId
string

店铺编号

site
string

所属平台

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

Array of objects (OpenShopResp)

返回的对象

method
string

错误时, 返回的请求http method

msg
string

错误消息

numbers
integer <int32>

当前页记录数

pageIndex
integer <int64>

当前页/默认第一页

pageSize
integer <int64>

分页大小

path
string

错误时,返回的path 对象

total
integer <int64>

总记录数

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : [
    ] ,
  • "msg" : "succeed" ,
  • "numbers" : 1 ,
  • "pageIndex" : 1 ,
  • "pageSize" : 10 ,
  • "total" : 1
}

还原申报订单上传

get 电商传单平台查询

获取支持订单上传的平台信息

query Parameters
reqNo
required
string

请求序列号 唯一

memberId
string

请求所指向的会员号，如不传则默认为token下的会员；若涉及matrix产品，可传入指定的连接会员号。

tradeType
required
string

贸易类型 01 货物贸易-电商, 02 服务贸易-物流

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

Array of objects (电商传单平台查询返回)

返回的对象

method
string

错误时, 返回的请求http method

msg
string

错误消息

path
string

错误时,返回的path 对象

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : {
    } ,
  • "msg" : "succeed"
}

post 订单上传

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
memberId
string

请求所指向的会员号，如不传则默认为token下的会员；若涉及matrix产品，可传入指定的连接会员号。

contractNo
string

合同编号 (资金入账时对应关联的合同编号，01电商和06数娱类无须填写)

invoice
string

PI/CI/发票 (多个文件key用【,】分割)

logisticsCertificate
string

物流凭证文件 (02-B2B、04-物流，已发货状态下需上传，多个文件key用【,】分割)

required
Array of objects (订单明细)

订单明细 (Detail MaxSize Limit 500)

orderNumbers
string

订单数量

receipt
string

合同文件 (多个文件key用【,】分割)

reqNo
required
string

请求流水号 Request number (unique) String(20)

shippingStatus
string

发货状态，01:已发货，02:未发货 (02-B2B、04-物流，需要传入)

shopNo
required
string

店铺/应用编号 (仅类型为01电商平台和06数娱应用时为必填，其他场景无须填写)

tradeAuthCertificate
string

交易询单证明(02-B2B、04-物流，未发货状态下如无物流凭证，需上传该字段，多个文件key用【,】分割)

tradeType
required
string

贸易类型(01货物贸易-电商平台；02 货物贸易-B2B；03服务贸易-软件服务；04 服务贸易-物流；05 服务贸易-游戏；06 服务贸易-数娱应用类)

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

Array of objects (OpenOrderImportResp)

返回的对象

method
string

错误时, 返回的请求http method

msg
string

错误消息

path
string

错误时,返回的path 对象

Request samples

Content type
application/json
{
  • "orderDetailList" : [
    ] ,
  • "reqNo" : "20230504144553" ,
  • "shopNo" : "510000011242" ,
  • "memberId" : "2022122256879107" ,
  • "tradeType" : "01"
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : {
    } ,
  • "msg" : "succeed"
}

全球账户

get 查询可申请场景和币种

查询申请全球账户支持的使用场景、币种和银行等信息

query Parameters
useTypeCode
string(64)

全球账户的用途，详情可看全球账户附录中的全球账户的用途

country
string(64)

地区二字码

currency
string(64)

币种 ISO4217

memberId
string

请求所指向的会员号，如不传则默认为token下的会员；若涉及matrix产品，可传入指定的连接会员号。

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

Array of objects (结果)

返回的对象

method
string

错误时, 返回的请求http method

msg
string

错误消息

path
string

错误时,返回的path 对象

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : [
    ] ,
  • "msg" : "succeed"
}

post 更新全球账户信息

修改全球账户的昵称

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
requestId
required
String(64)

商户请求唯一编号，不可重复

globalAccountNo
required
string(64)

全球账号

nickName
required
string(64)

昵称

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

object (gaAccountNicknameRespData)

返回的对象

method
string

错误时, 返回的请求http method

msg
string

错误消息

path
string

错误时,返回的path 对象

Request samples

Content type
application/json
{
  • "requestId" : "MR123456" ,
  • "globalAccountNo" : "123456" ,
  • "nickName" : "abc"
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : {
    } ,
  • "msg" : "succeed"
}

post 关闭全球账户

关闭不再使用的全球账户

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
requestId
required
String(64)

商户请求唯一编号，不可重复

globalAccountNo
required
string(64)

全球账户，需要关闭的全球账户

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

object (gaAccountCloseRespData)

返回的对象

method
string

错误时, 返回的请求http method

msg
string

错误消息

path
string

错误时,返回的path 对象

Request samples

Content type
application/json
{
  • "requestId" : "MR123456" ,
  • "globalAccountNo" : "123456"
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : {
    } ,
  • "msg" : "succeed"
}

get 查询全球账户列表

获取已有申请成功的全球账户列表

query Parameters
memberId
string(64)

查询所指向的会员号，如不传则默认为token下的会员；如涉及matrix产品，如不传则指向会员和连接会员所有信息查询，或传入指定会员查询。

globalAccountNo
string(64)

全球账户

accountStatus
string
Enum: "abnormal" "unactivated" "activated" "pending_closed" "closed"

全球账户状态，有异常、未激活、已激活、待注销、已注销

useTypeCode
string(64)

全球账户的用途，详情可看全球账户附录中的全球账户的用途

country
string(64)

地区二字码

nickName
string(64)

全球账户的昵称，最大长度不能超过240位

accountCurrency
string(64)

账户币种 ISO4217

pageSize
integer <int64>

分页大小

pageIndex
integer <int64>

当前页/默认第一页

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

Array of objects (结果)

返回的对象

method
string

错误时, 返回的请求http method

msg
string

错误消息

numbers
integer <int32>

当前页记录数

pageIndex
integer <int64>

当前页/默认第一页

pageSize
integer <int64>

分页大小

path
string

错误时,返回的path 对象

total
integer <int64>

总记录数

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : [
    ] ,
  • "msg" : "succeed" ,
  • "numbers" : 2 ,
  • "pageIndex" : 1 ,
  • "pageSize" : 10 ,
  • "total" : 2
}

post 全球账户关联店铺或开发者应用

全球账户关联已授权成功的店铺或开发者应用，如果店铺未授权，请通过授权接口授权成功后再关联。

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
requestId
required
String(64)

商户请求唯一编号，不可重复

globalAccountNo
required
string(64)

全球账户

type
required
string(64)
Enum: "shop" "webApp"

关联类型，详情可看全球账户附录中的全球账号关联对象类型

correlationNo
required
string(64)

关联编号。如果关联开发者应用，填写应用编号；如果关联店铺，填写店铺编号。

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

object (gaAccountLinkRespData)

返回的对象

method
string

错误时, 返回的请求http method

msg
string

错误消息

path
string

错误时,返回的path 对象

Request samples

Content type
application/json
{
  • "requestId" : "MR123456" ,
  • "globalAccountNo" : "123456" ,
  • "type" : "shop" ,
  • "correlationNo" : "CN0001"
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : {
    } ,
  • "msg" : "succeed"
}

post 全球账户更换关联的店铺或开发者应用

全球账户已关联A店铺或开发者应用，需要更换为B店铺或应用

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
requestId
required
String(64)

商户请求唯一编号，不可重复

globalAccountNo
required
string(64)

全球账户

type
required
string(64)
Enum: "shop" "webApp"

关联类型，详情请见全球账户附录中的全球账号关联对象类型

originCorrelationNo
required
string(64)

原来的关联编号，更换的店铺编号或应用编号。

correlationNo
required
string(64)

关联编号，重新关联的店铺编号或应用编号。

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

object (gaAccountLinkRespData)

返回的对象

method
string

错误时, 返回的请求http method

msg
string

错误消息

path
string

错误时,返回的path 对象

Request samples

Content type
application/json
{
  • "requestId" : "MR123456" ,
  • "globalAccountNo" : "123456" ,
  • "type" : "shop" ,
  • "originCorrelationNo" : "CN0001" ,
  • "correlationNo" : "CN0002"
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : {
    } ,
  • "msg" : "succeed"
}

post 预申请全球账户

预申请全球账户（订单有效时间为1分钟，超过1分钟则订单失效）。账户分为免费申请和付费申请，如果是付费申请，费用列表中返回开户费价格，只需选择其中一个币种进行确认付费即可。

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
country
required
string(10)

地区二字码

currency
required
string(64)

币种 ISO4217

bankId
string(64)

银行编码

nickName
required
string(240)

全球账户的昵称，最大长度不能超过240位

requestId
required
string(64)

商户请求流水号，每笔交易的唯一请求号，不可重复

useTypeCode
required
string(64)

全球账户的用途，详情可看全球账户附录

memberId
string(64)

请求所指向的会员号，如不传则默认为token下的会员；若涉及matrix产品，可传入指定的连接会员号。

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

object (gaApplyAccRespData)

返回的对象

method
string

错误时, 返回的请求http method

msg
string

错误消息

path
string

错误时,返回的path 对象

Request samples

Content type
application/json
{
  • "country" : "US" ,
  • "currency" : "USD" ,
  • "nickName" : "GA-vJ99RO" ,
  • "requestId" : "20230504150953" ,
  • "useTypeCode" : "UT202205051026295894" ,
  • "memberId" : "2022122256879107"
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : {
    } ,
  • "msg" : "succeed"
}

post 确认申请全球账户

对预申请全球账户请求进行确认

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
applicationId
string(64)

预下单返回的平台申请单号，唯一。requestId和applicationId至少一个不为空

requestId
String(64)

商户请求流水号，每笔交易的唯一请求号，不可重复。requestId和applicationId至少一个不为空

memberId
string(64)

请求所指向的会员号，如不传则默认为token下的会员；若涉及matrix产品，可传入指定的连接会员号。

deductionCurrency
string(3)

付费币种，当申请类型为线上购买时必填

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

object (gaApplyAccConfirmRespData)

返回的对象

method
string

错误时, 返回的请求http method

msg
string

错误消息

path
string

错误时,返回的path 对象

Request samples

Content type
application/json
{
  • "requestId" : "MR123456" ,
  • "applicationId" : "AN1654021157688578048" ,
  • "memberId" : "2022122256879107" ,
  • "deductionCurrency" : "USD"
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : {
    } ,
  • "msg" : "succeed"
}

get 申请结果查询

申请结果查询

query Parameters
memberId
string

查询所指向的会员号，如不传则默认为token下的会员；如涉及matrix产品，如不传则指向会员和连接会员所有信息查询，或传入指定会员查询。

applicationId
string(64)

平台申请单号

globalAccountNo
string(64)

全球账户

useTypeCode
string(64)

全球账户的用途，详情可看全球账户附录

nickName
string(240)

全球账户的昵称，当全球账户申请成功后可查询

applyCurrency
string(3)

申请币种 ISO4217

pageSize
integer <int64>

分页大小

pageIndex
integer <int64>

当前页/默认第一页

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

Array of objects (结果)

返回的对象

method
string

错误时, 返回的请求http method

msg
string

错误消息

numbers
integer <int32>

当前页记录数

pageIndex
integer <int64>

当前页/默认第一页

pageSize
integer <int64>

分页大小

path
string

错误时,返回的path 对象

total
integer <int64>

总记录数

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : [
    ] ,
  • "msg" : "succeed" ,
  • "numbers" : 2 ,
  • "pageIndex" : 1 ,
  • "pageSize" : 10 ,
  • "total" : 2
}

get 入账流水查询

查询全球账户信息的入账流水信息

query Parameters
memberId
string(64)

查询所指向的会员号，如不传则默认为token下的会员；如涉及matrix产品，如不传则指向会员和连接会员所有信息查询，或传入指定会员查询。

settlementNo
string(64)

结算单号，结算单号和结算时间至少一个不为空

globalAccountNo
string(64)

全球账户编号

settlementAtStart
string
Example: settlementAtStart=2023-03-17T08:43:27

结算起始时间，查询时间范围不能超过7天，结算单号和结算时间和交易创建时间至少一个不为空

settlementAtEnd
string
Example: settlementAtEnd=2023-03-18T08:43:27

结算结束时间，查询时间范围不能超过7天，结算单号和结算时间和交易创建时间至少一个不为空

createdAtStart
string
Example: createdAtStart=2023-03-17T08:43:27

交易起始时间，查询时间范围不能超过7天，结算单号和结算时间和交易创建时间至少一个不为空

createdAtEnd
string
Example: createdAtEnd=2023-03-18T08:43:27

交易结束时间，查询时间范围不能超过7天，结算单号和结算时间和交易创建时间至少一个不为空

settlementStatus
string
Enum: "processing" "success" "rejected"

结算状态

settlementCurrency
string(3)

结算币种 ISO4217

pageSize
integer <int64>

分页大小

pageIndex
integer <int64>

当前页/默认第一页

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

Array of objects (结果)

返回的对象

method
string

错误时, 返回的请求http method

msg
string

错误消息

numbers
integer <int32>

当前页记录数

pageIndex
integer <int64>

当前页/默认第一页

pageSize
integer <int64>

分页大小

path
string

错误时,返回的path 对象

total
integer <int64>

总记录数

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : [
    ] ,
  • "msg" : "succeed" ,
  • "numbers" : 2 ,
  • "pageIndex" : 1 ,
  • "pageSize" : 10 ,
  • "total" : 2
}

get 下载全球账户的流水证明

下载全球账户的流水证明，文件格式为pdf

query Parameters
requestId
required
string(64)

商户请求唯一编号，不可重复

globalAccountNo
required
string(64)

全球账户

createdAtStart
required
string
Example: createdAtStart=2023-03-17T08:43:27

交易起始时间，查询时间范围不能超过7天

createdAtEnd
required
string
Example: createdAtEnd=2023-03-18T08:43:27

交易结束时间，查询时间范围不能超过7天

settlementStatus
string
Enum: "success" "rejected"

结算状态

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

object (gaSettleOrderStatementRespData)

返回的对象

method
string

错误时, 返回的请求http method

msg
string

错误消息

path
string

错误时,返回的path 对象

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : { } ,
  • "msg" : "succeed"
}

入账凭证

post 新增入账凭证

新增入账凭证

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
requestId
required
String(64)

商户请求唯一编号，不可重复

memberId
String(64)

请求所指向的会员号，如不传则默认为token下的会员；若涉及matrix产品，可传入指定的连接会员号。

entryVoucherType
required
String(64)
Enum: "b2b" "commerce" "webapp" "same_recharge" "e_wallet" "other"

入账凭证类型，详情可看全球账户附录中的入账凭证类型。判断交易来源，添加对应的凭证类型。

contractNo
string(64)

合同编号。当入账凭证类型为b2b时为必填。

buyerName
string(64)

买家名称。当入账凭证类型为b2b时为必填。

orderAmount
number

订单总金额，最多保留两位小数。当入账凭证类型为b2b时为必填。

orderCurrency
string(64)

订单币种。当入账凭证类型为b2b时为必填。

platformType
string(64)
Enum: "e_commerce" "self_build"

平参类型，详情可看全球账户附录中的电商平台类型。当入账凭证类型为commerce时为必填。

platformName
string(64)

平台名称，根据 站点枚举 接口获取。当入账凭证类型为commerce或webapp时为必填，可选择电商平台、独立站或开发者平台的名称。

otherPlatformName
string(64)

其它平台名称。当平台名称为other时为必填。

url
string(64)

链接。当入账凭证类型为commerce或webapp时为必填，可填写店铺网址或者应用下载链接。

contract
Array of strings

合同的key。入账凭证类型为b2b时，contract、invoice、logisticsProof至少要填一项，可上传文件或图片。

invoice
Array of strings

发票的key。入账凭证类型为b2b时，contract、invoice、logisticsProof至少要填一项，可上传文件或图片。

logisticsProof
Array of strings

物流凭证的key。入账凭证类型为b2b时，contract、invoice、logisticsProof至少要填一项，可上传文件或图片。入账凭证为commerce时，该参数为必填。

screenshotOfPayment
Array of strings

付款截图文件的key。当入账凭证类型为非b2b时为必填，可上传平台提现截图或付款截图。

platformOrderScreenshot
Array of strings

平台订单截图文件的key。当入账凭证类型为commerce时为必填。

otherSupportingDocuments
Array of strings

其它证明文件的key。非必填。

testAccount
string(64)

测试账号。当入账凭证类型为webapp时为必填，填写应用的测试账号。

testAccountPassword
string(64)

测试账号密码。当入账凭证类型为webapp时为必填，填写应用的账号密码。

descriptionOfTransactionSource
string(64)

交易来源解释。当入账凭证类型为other时为必填，填写交易的来源以及说明。

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

object (gaCertificateSaveRespData)

返回的对象

method
string

错误时, 返回的请求http method

msg
string

错误消息

path
string

错误时,返回的path 对象

Request samples

Content type
application/json
{
  • "requestId" : "MR123456" ,
  • "memberId" : "2022122256879107" ,
  • "entryVoucherType" : "b2b" ,
  • "contractNo" : "abc123456" ,
  • "buyerName" : "Abc" ,
  • "orderAmount" : 100.3 ,
  • "orderCurrency" : "USD" ,
  • "platformType" : "e_commerce" ,
  • "platformName" : "platform_amazon_ZNAmerica" ,
  • "otherPlatformName" : "" ,
  • "url" : " http://open.api.shop.001.com " ,
  • "contract" : [
    ] ,
  • "invoice" : [
    ] ,
  • "logisticsProof" : [
    ] ,
  • "screenshotOfPayment" : [
    ] ,
  • "platformOrderScreenshot" : [
    ] ,
  • "otherSupportingDocuments" : [
    ] ,
  • "testAccount" : "abc123456" ,
  • "testAccountPassword" : "abc123456" ,
  • "descriptionOfTransactionSource" : "abc123456"
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : {
    } ,
  • "msg" : "succeed"
}

post 修改入账凭证

修改入账凭证，哪个字段需要修改，则请求修改哪个字段

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
requestId
required
String(64)

商户请求唯一编号，不可重复

voucherId
required
String(64)

入账凭证编号

contractNo
string(64)

合同编号。当入账凭证类型为b2b时为必填。

buyerName
string(64)

买家名称。当入账凭证类型为b2b时为必填。

orderAmount
number

订单总金额，最多保留两位小数。当入账凭证类型为b2b时为必填。

orderCurrency
string(64)

订单币种。当入账凭证类型为b2b时为必填。

platformType
string(64)
Enum: "e_commerce" "self_build"

平参类型，详情可看全球账户附录中的电商平台类型。当入账凭证类型为commerce时为必填。

platformName
string(64)

平台名称，根据 站点枚举 接口获取。当入账凭证类型为commerce或webapp时为必填，可选择电商平台、独立站或开发者平台的名称。

otherPlatformName
string(64)

其它平台名称。当平台名称为other时为必填。

url
string(64)

链接。当入账凭证类型为commerce或webapp时为必填，可填写店铺网址或者应用下载链接。

contract
Array of strings

合同的key。入账凭证类型为b2b时，contract、invoice、logisticsProof至少要填一项，可上传文件或图片。

invoice
Array of strings

发票的key。入账凭证类型为b2b时，contract、invoice、logisticsProof至少要填一项，可上传文件或图片。

logisticsProof
Array of strings

物流凭证的key。入账凭证类型为b2b时，contract、invoice、logisticsProof至少要填一项，可上传文件或图片。入账凭证为commerce时，该参数为必填。

screenshotOfPayment
Array of strings

付款截图文件的key。当入账凭证类型为非b2b时为必填，可上传平台提现截图或付款截图。

platformOrderScreenshot
Array of strings

平台订单截图文件的key。当入账凭证类型为commerce时为必填。

otherSupportingDocuments
Array of strings

其它证明文件的key。非必填。

testAccount
string(64)

测试账号。当入账凭证类型为webapp时为必填，填写应用的测试账号。

testAccountPassword
string(64)

测试账号密码。当入账凭证类型为webapp时为必填，填写应用的账号密码。

descriptionOfTransactionSource
string(64)

交易来源解释。当入账凭证类型为other时为必填，填写交易的来源以及说明。

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

object (gaCertificateUpdateRespData)

返回的对象

method
string

错误时, 返回的请求http method

msg
string

错误消息

path
string

错误时,返回的path 对象

Request samples

Content type
application/json
{
  • "requestId" : "MR123456" ,
  • "voucherId" : "VN123456" ,
  • "entryVoucherType" : "b2b" ,
  • "contractNo" : "abc123456" ,
  • "buyerName" : "Abc" ,
  • "orderAmount" : 100.3 ,
  • "orderCurrency" : "USD" ,
  • "platformType" : "e_commerce" ,
  • "platformName" : "platform_amazon_ZNAmerica" ,
  • "otherPlatformName" : "" ,
  • "url" : " http://open.api.shop.001.com " ,
  • "contract" : [
    ] ,
  • "invoice" : [
    ] ,
  • "logisticsProof" : [
    ] ,
  • "screenshotOfPayment" : [
    ] ,
  • "platformOrderScreenshot" : [
    ] ,
  • "otherSupportingDocuments" : [
    ] ,
  • "testAccount" : "abc123456" ,
  • "testAccountPassword" : "abc123456" ,
  • "descriptionOfTransactionSource" : "abc123456"
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : {
    } ,
  • "msg" : "succeed"
}

get 查询入账凭证详情列表

查询入账凭证详情列表

query Parameters
voucherId
string(64)

入账凭证ID。voucherId、contractNo、entryVoucherType三者至少要先填一项。

contractNo
string(64)

合同编号。voucherId、contractNo、entryVoucherType三者至少要先填一项。

entryVoucherType
string
Enum: "b2b" "commerce" "webapp" "same_recharge" "e_wallet" "other"

入账凭证类型，详情可看全球账户附录中的入账凭证类型。voucherId、contractNo、entryVoucherType三者至少要先填一项。

createdAtStart
string
Example: createdAtStart=2023-03-17T08:43:27

创建起始时间

createdAtEnd
string
Example: createdAtEnd=2023-03-18T08:43:27

创建结束时间

pageSize
integer <int64>

分页大小

pageIndex
integer <int64>

当前页/默认第一页

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

object (gaCertificateInfoRespData)

返回的对象

method
string

错误时, 返回的请求http method

msg
string

错误消息

path
string

错误时,返回的path 对象

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : [
    ] ,
  • "msg" : "succeed" ,
  • "numbers" : 2 ,
  • "pageIndex" : 1 ,
  • "pageSize" : 10 ,
  • "total" : 2
}

post 确认或取消关联入账凭证

无论请求"新增入账凭证"或"修改入账凭证"接口，最后都需要请求"确认或取消关联入账凭证"接口。如果只修改结算交易关联的入账凭证，relateVoucherId 和 cancelVoucherId 可以为空。

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
requestId
required
String(64)

商户请求唯一编号，不可重复

settlementNo
required
String(64)

结算单号

relateVoucherId
Array of strings

关联的入账凭证ID。

cancelVoucherId
Array of strings

取消关联的入账凭证ID。只有入账凭证返回待完善时，才能取消关联这份凭证。

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

object (gaCertificateLinkRespData)

返回的对象

method
string

错误时, 返回的请求http method

msg
string

错误消息

path
string

错误时,返回的path 对象

Request samples

Content type
application/json
{
  • "requestId" : "MR123456" ,
  • "settlementNo" : "123456" ,
  • "relateVoucherId" : [
    ] ,
  • "cancelVoucherId" : [
    ]
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : {
    } ,
  • "msg" : "succeed"
}

全球账户附录

全球账户的用途

编码
描述
UT202203081816165768 电商收款
UT202211170855043040 开发者平台收款
UT202205051026295881 电子光子易账户汇入
UT202205051026295893 同名银行账户汇入
UT202205051026295894 外贸收款
UT202205051026295895 未分类

入账凭证类型

编码
描述
commerce 电商收款
webapp 开发者平台收款
e_wallet 电子光子易账户汇入
same_recharge 同名银行账户汇入
b2b 外贸收款
other 其他

入账凭证类型对应的必填参数说明

编码
描述
必填字段
commerce 电商收款 platformType、platformName(otherPlatformName)、url、
screenshotOfPayment、platformOrderScreenshot、logisticsProof
webapp 开发者平台收款 platformName(otherPlatformName )、url、testAccount、
testAccountPassword、screenshotOfPayment
e_wallet 同名银行账户汇入 screenshotOfPayment
same_recharge 同名银行账户汇入 screenshotOfPayment
b2b 外贸收款 contractNo、buyerName、orderAmount、orderCurrency、
contract/invoice/logisticsProof（三选一）
other 其他 descriptionOfTransactionSource、screenshotOfPayment

电商平台类型

编码
描述
e_commerce 电商平台
self_build 自建站

全球账号关联对象类型

编码
描述
shop 电商平台店铺
webApp 开发者平台应用

发卡

卡管理

您可以申请、冻结、注销虚拟卡和实体卡，操作挂失或处理盗卡，并查询卡片信息。

get 卡bin查询

查询支持开卡的卡 bin 信息

query Parameters
memberId
string

请求所指向的会员号，如不传则默认为token下的会员；若涉及matrix产品，可传入指定的连接会员号。

cardFormFactor
string

卡介质。

值： virtual_card虚拟卡；

physical_card实体卡。

可为空。若为空，则查询结果显示所有虚拟卡及实体卡卡介质。

cardType
string

卡类型。值: share 或 recharge 可为空。如为空，则查询结果将显示所有类型的卡。

cardScheme
string
Enum: "MasterCard" "Discover"

卡组织

cardCurrency
string
Enum: "USD" "EUR" "GBP"

卡币种

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

Array of objects (vccCardBinResp)

返回的对象

method
string

错误时, 返回的请求http method

msg
string

错误消息

path
string

错误时,返回的path 对象

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : [
    ] ,
  • "msg" : "succeed"
}

post 单卡开卡

申请虚拟卡或实体卡，每次请求只能申请单张卡片

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
memberId
String(64)

请求所指向的会员号，如不传则默认为token下的会员；若涉及matrix产品，可传入指定的连接会员号。

matrixAccount
string(64)

如果你想在matrix下申请卡，请填写matrix账号。如果不填，就在会员下默认创建。

cardBin
required
string(6)

您需要填入你想开卡的卡bin信息，目前支持的卡bin信息可在卡bin接口中查询。

cardCurrency
required
string(3)
Enum: "USD" "EUR" "GBP"

卡本币

cardExpirationDate
int

卡有效期。您可填写此卡的有效期，以月为计数单位。如：您需要虚拟卡的有效期为1年，则输入“12”即可。如不上传，则由系统自动分配虚拟卡有效期。（最小12个月，最大35个月）

cardScheme
string(20)
Enum: "MasterCard" "Discover"

卡组织

cardType
required
string(20)
Enum: "share" "recharge"

卡类型。share： 共享卡； recharge： 常规卡。

cardFormFactor
string(20)
Enum: "virtual_card" "physical_card"

卡介质。值： virtual_card虚拟卡；physical_card实体卡。不填默认虚拟卡。

cardholderId
string(64)

填入用卡人id后，卡将属于此用卡人。如不填则默认使用默认持卡人信息进行开卡。

cardDesignId
string(64)

自定义卡面ID。如不传，使用默认卡面。

cardLogoId
string(64)

自定义卡logoID。如不传则不打印logo。

maxOnDaily
number <integer>

日交易限额。为空时不做限制，非空时大于1。默认最高限额为20000USD，如有需要请联系业务人员申请。

maxOnMonthly
number <integer>

月交易限额。为空时不做限制，非空时大于1。默认最高限额为20000USD，如有需要请联系业务人员申请。

maxOnPercent
number <integer>

单笔交易最大金额。为空时不做限制，非空时大于1。默认最高限额为20000USD，如有需要请联系业务人员申请。

rechargeAmount
number(15,2) <bigdecimal>

转入金额，您想从币种光子易账户金额往卡里转入的资金。我们将为计算出最后实际到卡内的金额。转入金额和到账金额择一填写即可 (需遵循 ISO4217规范)。

requestId
required
String(64)

商户请求流水号，每笔交易的唯一请求号，不可重复。(所有交易以及请求的唯一标识，建议您保存。可用于对应的操作。)

transactionLimit
number(15,2) <bigdecimal>

可交易额度。transactionLimitType值为limited时，不能为空 (需遵循 ISO4217规范)。

transactionLimitType
string(20)
Enum: "limited" "unlimited"

是否限制可交易额度，recharge常规卡、share虚拟共享卡，默认unlimited；实体共享卡必为Limited。

accountId
string(64)

您需要用于转入的币种光子易账户ID号，您可在“光子易账户”接口中进行查询您的账户ID。

arrivalAmount
number(15,2) <bigdecimal>

到账金额，您希望转入到账金额是多少，我们将为您计算出需要扣取您所选光子易账户的金额。转入金额和到账金额择一填写即可 (需遵循 ISO4217规范)。

recipientId
string(64)

收件人 ID，实体卡必填。

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

object (vccCreateCardRespDetail)
msg
string

错误消息

Request samples

Content type
application/json
{
  • "accountId" : "FA-USD1610932589202378752" ,
  • "cardBin" : "111111" ,
  • "cardCurrency" : "USD" ,
  • "cardExpirationDate" : "12" ,
  • "cardScheme" : "Discover" ,
  • "cardType" : "recharge" ,
  • "cardFormFactor" : "virtual_card" ,
  • "rechargeAmount" : "30" ,
  • "requestId" : "20230504153817" ,
  • "transactionLimitType" : "unlimited"
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : {
    } ,
  • "msg" : "succeed"
}

post 批量开实体卡

批量申请实体卡，每次请求单张卡片，每日根据收件人信息进行分批制卡和寄送。

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
memberId
String(64)

请求所指向的会员号，如不传则默认为token下的会员；若涉及matrix产品，可传入指定的连接会员号。

matrixAccount
string(64)

如果你想在matrix下申请卡，请填写matrix账号。如果不填，就在会员下默认创建。

cardBin
required
string(6)

您需要填入你想开卡的卡bin信息，目前支持的卡bin信息可在卡bin接口中查询。

cardCurrency
required
string(3)
Enum: "USD" "EUR" "GBP"

卡本币

cardExpirationDate
int

卡有效期。您可填写此卡的有效期，以月为计数单位。如：您需要卡的有效期为1年，则输入“12”即可。如不上传，则由系统自动分配卡有效期。（最小12个月，最大35个月）

cardScheme
string(20)
Enum: "MasterCard" "Discover"

卡组织

cardType
required
string(20)
Enum: "share" "recharge"

卡类型。share： 共享卡； recharge： 常规卡。

cardholderId
string(64)

填入用卡人id后，卡将属于此用卡人。如不填则默认使用默认持卡人信息进行开卡；

cardDesignId
string(64)

自定义卡面ID。如不传，使用默认卡面。

cardLogoId
string(64)

自定义卡logoID。如不传则不打印logo。

maxOnDaily
number <integer>

日交易限额。为空时不做限制，非空时大于1。默认最高限额为20000USD，如有需要请联系业务人员申请。

maxOnMonthly
number <integer>

月交易限额。为空时不做限制，非空时大于1。默认最高限额为20000USD，如有需要请联系业务人员申请。

maxOnPercent
number <integer>

单笔交易最大金额。为空时不做限制，非空时大于1。默认最高限额为20000USD，如有需要请联系业务人员申请。

rechargeAmount
number(15,2) <bigdecimal>

转入金额，您想从币种光子易账户金额往卡里转入的资金。我们将为计算出最后实际到卡内的金额。转入金额和到账金额择一填写即可 (需遵循 ISO4217规范)。

requestId
required
String(64)

商户请求流水号，每笔交易的唯一请求号，不可重复。(所有交易以及请求的唯一标识，建议您保存。可用于对应的操作。)

transactionLimit
number(15,2) <bigdecimal>

可交易额度。transactionLimitType值为limited时，不能为空 (需遵循 ISO4217规范)。

transactionLimitType
string(20)
Enum: "limited" "unlimited"

是否限制可交易额度，recharge常规卡默认unlimited；实体共享卡必为Limited。

accountId
string(64)

您需要用于转入的币种光子易账户ID号，您可在“光子易账户”接口中进行查询您的账户ID。

arrivalAmount
number(15,2) <bigdecimal>

到账金额，您希望转入到账金额是多少，我们将为您计算出需要扣取您所选光子易账户的金额。转入金额和到账金额择一填写即可 (需遵循 ISO4217规范)。

recipientId
string(64)

收件人 ID，实体卡必填。

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

object (vccBatchCreateCardRespDetail)
msg
string

错误消息

Request samples

Content type
application/json
{
  • "accountId" : "FA-USD1610932589202378752" ,
  • "cardBin" : "111111" ,
  • "cardCurrency" : "USD" ,
  • "cardExpirationDate" : "12" ,
  • "cardScheme" : "Discover" ,
  • "cardType" : "recharge" ,
  • "rechargeAmount" : "30" ,
  • "requestId" : "20230504153817" ,
  • "transactionLimitType" : "unlimited"
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : {
    } ,
  • "msg" : "succeed"
}

post 卡片激活

激活实体卡以进行卡支付授权。

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
cardId
required
string(64)

卡ID。

expirationDate
required
string(11)

卡有效期，MM/YY，请输入有效期信息。

cvv
required
string(8)

CVV。请输入CVV信息。

pin
required
string(8)

卡片交易密码。

pinConfirm
required
string(8)

请再次输入卡交易密码。

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

object (vccActivateCardRespDetail)
msg
string

错误消息

Request samples

Content type
application/json
{
  • "cardId" : "XR1654027662378799104" ,
  • "expirationDate" : "05/24" ,
  • "cvv" : "123" ,
  • "pin" : "1234" ,
  • "pinConfirm" : "1234"
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : {
    } ,
  • "msg" : "succeed"
}

post 重置密码

重置实体卡交易密码。用户需先输入卡片cvv进行验证，验证通过后即可重置密码。

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
cardId
required
string(64)

卡ID。

newPin
required
string(11)

新的交易密码，请设置4位数字密码。

confirmPin
required
string(8)

请再次输入卡交易密码。

cvv
required
string(8)

请输入卡片CVV验证。

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

msg
string

错误消息

Request samples

Content type
application/json
{
  • "cardId" : "XR1654027662378799104" ,
  • "newPin" : "1234" ,
  • "confirmPin" : "1234" ,
  • "cvv" : "124"
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "msg" : "succeed"
}

post 更换密码

修改实体卡交易密码。用户需先输入当前交易密码进行验证，验证通过后即可设置新密码。

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
cardId
required
string(64)

卡ID。

currentPin
required
string(8)

当前交易密码，请输入当前交易密码。

newPin
required
string(8)

新的交易密码，请设置4位数字密码。

confirmPin
required
string(8)

确认交易密码。

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

msg
string

错误消息

Request samples

Content type
application/json
{
  • "cardId" : "XR1654027662378799104" ,
  • "currentPin" : "1234" ,
  • "newPin" : "1234" ,
  • "confirmPin" : "1234"
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "msg" : "succeed"
}

post 续卡

实体卡同卡号续卡，支持未到期提前续卡。

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
requestId
required
String(64)

商户请求流水号，每笔交易的唯一请求号，不可重复。(所有交易以及请求的唯一标识，建议您保存。可用于对应的操作。)

cardId
required
string(64)

卡ID。

cardDesignId
string(64)

自定义卡面ID。如不传，使用默认卡面。

cardLogoId
string(64)

自定义卡logoID。如不传则不打印logo。

recipientId
required
string(64)

收件人 ID。

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

object (vccRenewCardRespDetail)
msg
string

错误消息

Request samples

Content type
application/json
{
  • "cardId" : "XR1654027662378799104" ,
  • "recipientId" : "RI1654040500572917760" ,
  • "cardDesignId" : "A1" ,
  • "cardLogoId" : 1
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : {
    } ,
  • "msg" : "succeed"
}

post 补卡

申请补发新卡。仅实体卡支持补卡。

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
requestId
required
string(64)

商户请求流水号，每笔交易的唯一请求号，不可重复。(所有交易以及请求的唯一标识，建议您保存。可用于对应的操作。)

cardId
required
string(64)

需要补卡的卡片 ID。

replaceCardReason
required
string(8)
Enum: "001-卡信息泄露" "002-卡发生欺诈" "003-卡损坏了" "004-卡丢失了" "999-其他"

补卡原因。

cardDesignId
string(64)

自定义卡面ID。如不传，使用默认卡面。

cardLogoId
string(64)

自定义卡logoID。如不传则不打印logo。

rechargeAmount
bigDecimal

转入金额，您想从币种光子易账户金额往卡里转入的资金。我们将为计算出最后实际到卡内的金额。转入金额和到账金额择一填写即可 (需遵循 ISO4217规范)。

arrivalAmount
bigDecimal

到账金额，您希望转入到账金额是多少，我们将为您计算出需要扣取您所选光子易账户的金额。转入金额和到账金额择一填写即可 (需遵循 ISO4217规范)。

accountId
string(64)

您需要用于转入的币种光子易账户ID号，您可在“光子易账户”接口中进行查询您的账户ID。

transactionLimit
bigDecimal

可交易额度，卡类型为共享卡时不能为空 (需遵循 ISO4217规范)；

recipientId
required
string(64)

收件人 ID。

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

object (vccReplaceCardRespDetail)
msg
string

错误消息

Request samples

Content type
application/json
{
  • "requestId" : "20230504143411" ,
  • "cardId" : "XR1654027662378799104" ,
  • "replaceCardReason" : "001" ,
  • "cardDesignId" : "A1" ,
  • "cardLogoId" : 1 ,
  • "recipientId" : "RI1654040500572917760"
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : {
    } ,
  • "msg" : "succeed"
}

post 虚拟卡升级实体卡

虚拟卡升级为实体卡，保留原卡号及属性。升级后需通过重置密码接口设置实体卡PIN码。

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
requestId
required
string(64)

商户请求流水号，每笔交易的唯一请求号，不可重复。(所有交易以及请求的唯一标识，建议您保存。可用于对应的操作。)

cardId
required
string(64)

需要升级的卡片 ID。若为共享卡，是否限制交易额度transactionLimitType必为Limited。

cardDesignId
string(64)

自定义卡面ID。如不传，使用默认卡面。

cardLogoId
string(64)

自定义卡logoID。如不传则不打印logo。

recipientId
required
string(64)

收件人 ID。

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

object (vccUpgradeCardPlasticRespDetail)
msg
string

错误消息

Request samples

Content type
application/json
{
  • "requestId" : "20230504143411" ,
  • "cardId" : "XR1654027662378799104" ,
  • "cardDesignId" : "A1" ,
  • "cardLogoId" : "001" ,
  • "recipientId" : "RI1654040500572917760"
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : {
    } ,
  • "msg" : "succeed"
}

get 请求结果查询

当开卡请求没有同步返回请求结果时，您可以使用此接口查询开卡结果

query Parameters
memberId
string

请求所指向的会员号，如不传则默认为token下的会员；若涉及matrix产品，可传入指定的连接会员号。

requestId
required
string

请求流水号

type
string
Enum: "apply_card" "card_update" "card_freeze"

请求类型。为空时，默认查询开卡结果。

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

object (vccCreateCardRespDetail)
msg
string

错误消息

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : {
    } ,
  • "msg" : "succeed"
}

get 卡信息查询

查询卡片详细信息

query Parameters
cardId
required
string

卡ID

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

object (vccCardInfo)

卡对象

msg
string

错误消息

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : {
    } ,
  • "msg" : "succeed"
}

get CVV查询

查询卡片的CVV信息

query Parameters
cardId
required
string

卡ID

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

object (vccCvvInfo)

卡cvv对象

msg
string

错误消息

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : {
    } ,
  • "msg" : "succeed"
}

get 卡列表

查询卡列表。

query Parameters
pageIndex
integer <int64>

当前页/默认第一页

pageSize
integer <int64>

分页大小

memberId
string

查询所指向的会员号，如不传则默认为token下的会员；如涉及matrix产品，如不传则指向会员和连接会员所有信息查询，或传入指定会员查询。

matrixAccount
string

Matrix账户ID。

cardBin
string

卡bin。您可输入卡bin进行筛选。如需筛选多个卡bin，每个卡bin之间逗号分隔即可。

createdAtStart
string
Example: createdAtStart=2022-03-18T08:43:28

起始时间

createdAtEnd
string
Example: createdAtEnd=2022-03-18T08:43:28

结束时间

cardType
string
Enum: "share" "recharge"

卡类型。share： 共享卡； recharge： 常规卡。

cardFormFactor
string
Enum: "virtual_card" "physical_card"

卡介质。值： virtual_card虚拟卡，physical_card实体卡。

cardStatus
string
Enum: "normal" "pending_recharge" "freezing" "frozen" "risk_frozen" "system_frozen" "unfreezing" "expired" "canceling" "cancelled" "unactivated" "renewing" "replacing" "lost" "stolen" "pin_lost"

卡状态，具体中文描述可以查看 发卡状态

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

Array of objects (OpenApiPageCardResp)

返回的对象

method
string

错误时, 返回的请求http method

msg
string

错误消息

numbers
integer <int32>

当前页记录数

pageIndex
integer <int64>

当前页/默认第一页

pageSize
integer <int64>

分页大小

path
string

错误时,返回的path 对象

total
integer <int64>

总记录数

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : [
    ] ,
  • "msg" : "succeed" ,
  • "pageIndex" : 1 ,
  • "pageSize" : 10 ,
  • "total" : 1
}

post 卡更新

更新卡配置

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
cardId
required
string

卡ID。

cardFormFactor
string(20)
Enum: "virtual_card" "physical_card"

卡介质。值： virtual_card虚拟卡；physical_card实体卡。不填默认虚拟卡。

requestId
required
string

商户请求流水号，每笔交易的唯一请求号。若因超时未收到响应结果，可用此ID查询设置结果。 (所有交易以及请求的唯一标识，建议您保存。可用于对应的操作。)

maxOnDaily
number <integer>

日交易限额，为空时不更新。已销的卡无法调整此限额。

maxOnMonthly
number <integer>

月交易限额，为空时不更新。已销的卡无法调整此限额。

maxOnPercent
number <integer>

单笔交易最大金额，为空时不更新。已销的卡无法调整此限额。

nickname
string

昵称，为空时不更新。

transactionLimit
number <bigdecimal>

可交易额度变动金额，为空时不更新 (需遵循 ISO4217规范)。

transactionLimitChangeType
string
Enum: "increase" "decrease"

可交易额度变动类型，销卡后不可再操作调增，可以调减。

transactionLimitType
string(20)
Enum: "limited" "unlimited"

是否限制可交易额度，为空时不更新，实体共享卡必为Limited。

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

object (vccUpdateCardRespDetail)

卡对象

msg
string

错误消息

Request samples

Content type
application/json
{
  • "cardId" : "XR1654027662378799104" ,
  • "nickname" : "new nickname" ,
  • "requestId" : "20230504154629" ,
  • "cardFormFactor" : "virtual_card"
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "msg" : "succeed" ,
  • "data" : {
    }
}

post 更新账单地址

更新账单地址

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
cardId
required
string

卡ID

billingAddress
string

账单地址信息中的详细地址，建议填写账单地址。

billingCity
string

账单地址信息中的市，建议填写账单地址所在城市。

billingCountry
string(2)

账单地址信息中的国家二字码，建议填写账单地址国家码二字码。

billingPostalCode
string(10)

账单地址信息中的邮编，建议填写账单地址所属邮编。

billingState
string

账单地址信息中的省/州，建议填写账单地州省。

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

data
object

返回的对象

msg
string

错误消息

Request samples

Content type
application/json
{
  • "billingAddress" : "维多利亚港" ,
  • "billingCity" : "香港" ,
  • "billingCountry" : "HK" ,
  • "billingPostalCode" : "000000" ,
  • "billingState" : "中国" ,
  • "cardId" : "XR1654027662378799104"
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "msg" : "succeed"
}

post 冻结

冻结、解冻卡片。此操作成功，卡状态将通过 webhook 进行通知。

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
cardId
required
string

卡ID

requestId
required
string

商户请求流水号，每笔交易的唯一请求号。若因超时未收到响应结果，可用此ID查询设置结果。(所有交易以及请求的唯一标识，建议您保存。可用于对应的操作。)

status
required
string(20)
Enum: "freeze" "unfreeze"

freeze：冻结卡； unfreeze：解冻卡。

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

data
object

返回的对象

msg
string

错误消息

Request samples

Content type
application/json
{
  • "cardId" : "XR1654027662378799104" ,
  • "requestId" : "20230504155903" ,
  • "status" : "freeze"
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "msg" : "succeed"
}

post 销卡

可进行卡片的销卡操作。此操作成功，卡状态将通过 webhook 进行通知。

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
cardId
required
string

卡ID

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

data
object

返回的对象

msg
string

错误消息

Request samples

Content type
application/json
{
  • "cardId" : "XR1654027662378799104"
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "msg" : "succeed"
}

post 挂失/盗卡

对实体卡进行挂失或盗卡处理。此操作成功，卡状态将通过 webhook 进行通知。

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
cardId
required
string

卡ID

requestId
required
string

商户请求流水号，每笔交易的唯一请求号。若因超时未收到响应结果，可用此ID查询设置结果。(所有交易以及请求的唯一标识，建议您保存。可用于对应的操作。)

cardStatus
required
string(20)
Enum: "lost" "stolen"

lost: 挂失；stolen：盗卡。

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

data
object

返回的对象

msg
string

错误消息

Request samples

Content type
application/json
{
  • "cardId" : "XR1654027662378799104" ,
  • "requestId" : "20230504155903" ,
  • "status" : "lost"
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "msg" : "succeed"
}

get 绑卡记录

用于查询卡片在钱包中的绑定记录，目前仅支持查询Google钱包的绑定信息。

query Parameters
pageIndex
integer <int64>

当前页/默认第一页

pageSize
integer <int64>

分页大小

memberId
string

查询所指向的会员号，如不传则默认为token下的会员；如涉及matrix产品，如不传则指向会员和连接会员所有信息查询，或传入指定会员查询。

matrixAccount
string

Matrix账户ID。

tokenId
string

支付令牌ID。

cardId
string

卡ID。

createdAtStart
string
Example: createdAtStart=2022-03-18T08:43:28

起始时间

createdAtEnd
string
Example: createdAtEnd=2022-03-18T08:43:28

结束时间

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

Array of objects (OpenApiBindCardHistoryResp)

返回的对象

msg
string

错误消息

pageIndex
integer <int64>

当前页/默认第一页

pageSize
integer <int64>

分页大小

total
integer <int64>

总记录数

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : [
    ] ,
  • "msg" : "succeed" ,
  • "pageIndex" : 1 ,
  • "pageSize" : 10 ,
  • "total" : 1
}

post 实体卡用卡人换绑

用于已发行实体卡的一次性用卡人更换。仅支持实体卡，不支持虚拟卡。

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
cardId
required
string

卡 ID。需为已存在的实体卡。

cardholderId
required
string

新的用卡人 ID。换绑成功后，卡的持卡人将更新为该 ID 对应的用卡人。

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

data
object

返回的对象

msg
string

错误消息

Request samples

Content type
application/json
{
  • "cardId" : "XR1654027662378799104" ,
  • "cardholderId" : "CH1654040500572917760"
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "msg" : "succeed"
}

常规卡管理

您可通过接口为您的虚拟常规卡进行资金转入，以保证您的卡内资金充足。
请按以下步骤完成转入：
第一步：您需要调用“换汇询价”接口获取您的汇率，并且记录下这笔的请求ID。
第二步：将汇率询价的“请求ID”在有效时间内填入“转入下单”接口，完成转入即可。

get 换汇询价

您需要先在此 API 中将您的转入信息填入，并确认汇率后保存返回的请求ID，将此ID填入“转入下单”接口完成转入。
注：汇率有时效性，超时将失效，还请尽快使用完成转入。

query Parameters
memberId
string

请求所指向的会员号，如不传则默认为token下的会员；若涉及matrix产品，可传入指定的连接会员号。

requestId
required
string

商户请求流水号，每笔交易的唯一请求号，不可重复。(所有交易以及请求的唯一标识，建议您保存。可用于对应的操作。)

accountId
required
string

每个账户的唯一ID号。您可在光子易账户接口中进行查询您的账户ID。

cardId
required
string

卡ID

rechargeAmount
bigDecimal

转入金额，您想从币种光子易账户金额往卡里转入的资金。我们将为您计算出最后实际到卡内的金额。转入金额和到账金额择一填写即可 (需遵循 ISO4217规范)。

arrivalAmount
bigDecimal

到账金额，您希望转入到账金额是多少，我们将为您计算出需要扣取您所选光子易账户的金额。转入金额和到账金额择一填写即可 (需遵循 ISO4217规范)。

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

object (preRechargeRespData)

换汇查询返回数据

msg
string

错误消息

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : {
    } ,
  • "msg" : "succeed"
}

post 转入下单

将汇率询价接口的“请求ID”在有效时效内填入，我们将按此费率对您指定的卡完成转入操作

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
memberId
string

请求所指向的会员号，如不传则默认为token下的会员；若涉及matrix产品，可传入指定的连接会员号。

requestId
required
string

请输入您换汇询价的请求ID (所有交易以及请求的唯一标识，建议您保存。可用于对应的操作。)

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

object (rechargeRespData)

转入返回数据

msg
string

错误消息

Request samples

Content type
application/json
{
  • "requestId" : "20230504162436"
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : {
    } ,
  • "msg" : "succeed"
}

post 卡金额退还

您可将卡内剩余的金额退还至您卡本币对应的光子易账户可用金额中。

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
cardId
required
string

卡ID

requestId
required
string

商户请求流水号，每笔交易的唯一请求号，不可重复。(所有交易以及请求的唯一标识，建议您保存。可用于对应的操作。)

returnAmount
required
bigDecimal

退回金额 (需遵循 ISO4217规范)

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

object (rechargeReturnRespData)

转入退回返回数据

msg
string

错误消息

Request samples

Content type
application/json
{
  • "cardId" : "XR1611545267990040576" ,
  • "requestId" : "20230504162641" ,
  • "returnAmount" : "20"
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : {
    } ,
  • "msg" : "succeed"
}

用卡人

您可使用这部分接口创建和管理您用于开卡的用卡人，创建用卡人之后，您可用于开卡时指定每一张卡对应的用卡人。

post 添加用卡人

用于添加用卡人，开卡时使用用卡人开卡。

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
memberId
string(64)

请求所指向的会员号，如不传则默认为token下的会员；若涉及matrix产品，可传入指定的连接会员号。

matrixAccount
string(64)

如需在matrix下添加用卡人请填写matrix账户号 ,如不填写默认添加在member下。

firstName
required
string(40)

名不能包含特殊字符。

lastName
required
string(40)

姓不能包含特殊字符。

cardholderNameAbbreviation
string(40)

用卡人姓名缩写,作为实体卡卡面上用卡人姓名，申请实体卡时必填

格式：（First Name/Last Name-名/姓）

长度：最多26个字符，包括一个“/ ”

要求：全大写字母。

email
required
string(40)

邮箱。

mobile
required
string(11)

手机号。

mobilePrefix
required
string(8)

手机号前缀（包括区号），前面加 符号和1-4位的国家呼叫代码。不要包括连字符、空格或括号。

dateOfBirth
required
string(10) <yyyy-MM-dd>

出生日期。

certType
string(40)
Enum: "id_card" "passport" "resident_permit"

必填，身份证件类型。id_card：身份证，passport：护照，resident_permit：居留许可证(永居、绿卡、工作签证）。

portrait
string

必填，身份证件信息正面：请提供身份证件正面或护照首页照片。

仅限一张照片；PNG，JPG；单个文件最大6M

调用 文件上传 接口获取文件 key。 businessKey 传

issuing_cardholder_identity_certificate

reverseSide
string

必填，身份证件信息反面：请提供身份证件反面照片。

仅限一张照片；PNG，JPG；单个文件最大6M。

调用 文件上传 接口获取文件 key。 businessKey 传

issuing_cardholder_identity_certificate

nationalityCountryCode
required
string(2)

国籍国家码二字码。

residentialAddress
string(100)

必填，账单地址。建议填写账单地址。

residentialCity
string(50)

必填，账单地城市。建议填写账单地址所在城市。

residentialCountryCode
string(2)

必填，账单地国家码二字码。建议填写账单地址国家码二字码。

residentialPostalCode
string(10)

必填，账单地邮编。建议填写账单地址所属邮编。

residentialState
string(50)

必填，账单地州省。建议填写账单地州省。

certCountryCode
string(2)

必填，证件签发国国家二字码。

certId
string(64)

必填，证件号。

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

object (vccAddCardholderRespDetail)
msg
string

错误消息

Request samples

Content type
application/json
{
  • "dateOfBirth" : "2000-01-01" ,
  • "email" : "demo@qq.com" ,
  • "firstName" : "yun" ,
  • "lastName" : "Xu" ,
  • "matrixAccount" : "MI1612373367288107008" ,
  • "mobile" : "18800768999" ,
  • "mobilePrefix" : "86" ,
  • "nationalityCountryCode" : "HK"
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : {
    } ,
  • "msg" : "succeed"
}

post 用卡人更新

用于更新用卡人。

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
cardholderId
required
string(64)

用卡人ID。

firstName
string(40)

名不能包含特殊字符；用卡人审核状态为通过时，不可修改。

lastName
string(40)

姓不能包含特殊字符；用卡人审核状态为通过时，不可修改。

dateOfBirth
string(10) <yyyy-MM-dd>

出生日期。

certType
string(40)
Enum: "id_card" "passport" "resident_permit"

身份证件类型。id_card：身份证，passport：护照，resident_permit：居留许可证(永居、绿卡、工作签证）。

portrait
string

身份证件信息正面：请提供身份证件正面或护照首页照片。

仅限一张照片；PNG，JPG；单个文件最大6M

调用 文件上传 接口获取文件 key。 businessKey 传

issuing_cardholder_identity_certificate

reverseSide
string

身份证件信息反面：请提供身份证件反面照片。

仅限一张照片；PNG，JPG；单个文件最大6M。

调用 文件上传 接口获取文件 key。 businessKey 传

issuing_cardholder_identity_certificate

email
string(40)

邮件。

cardholderNameAbbreviation
string(40)

用卡人姓名缩写,作为实体卡卡面上用卡人姓名，申请实体卡时必填

格式：（First Name/Last Name-名/姓）

长度：最多26个字符，包括一个“/ ”

要求：全大写字母。

mobile
string(11)

手机号。

mobilePrefix
string(8)

用卡人的电话号码（包括区号），前面加 符号和1-4位的国家呼叫代码。不要包括连字符、空格或括号。

nationalityCountryCode
string(2)

国籍国家二字码

residentialAddress
string(100)

账单地址。建议填写账单地址。

residentialCity
string(50)

账单地城市。建议填写账单地址所在城市。

residentialCountryCode
string(2)

账单地国家码二字码。建议填写账单地址国家码二字码。

residentialPostalCode
string(10)

账单地邮编。建议填写账单地址所属邮编。

residentialState
string(50)

账单地州省。建议填写账单地州省。

certCountryCode
string(2)

证件签发国国家二字码。

certId
string(64)

证件号。

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

object (vccEditCardholderRespDetail)
msg
string

错误消息

Request samples

Content type
application/json
{
  • "cardholderId" : "CH1654040500572917760" ,
  • "firstName" : "lei" ,
  • "lastName" : "Sun" ,
  • "dateOfBirth" : "1999-01-01" ,
  • "email" : "dev@qq.com" ,
  • "cardholderNameAbbreviation" : "lei/Sun" ,
  • "mobile" : "18800768999" ,
  • "mobilePrefix" : "86" ,
  • "nationalityCountryCode" : "HK"
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : {
    } ,
  • "msg" : "succeed"
}

get 用卡人查询

用于查询用卡人列表。

query Parameters
pageIndex
integer <int64>

当前页/默认第一页

pageSize
integer <int64>

分页大小

memberId
string

查询所指向的会员号，如不传则默认为token下的会员；如涉及matrix产品，如不传则指向会员和连接会员所有信息查询，或传入指定会员查询。

matrixAccount
string

Matrix账户ID

createdAtStart
string
Example: createdAtStart=2022-03-18T08:43:28

起始时间

createdAtEnd
string
Example: createdAtEnd=2022-03-18T08:43:28

结束时间

cardholderId
string

用卡人ID

status
string
Enum: "normal" "disabled" "pending" "modify" "rejected"

用卡人状态。normal - 可用，disabled - 系统禁用，pending - 审核中，modify - 待完善，rejected - 审核拒绝。

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

Array of objects (cardCardholderResp)

返回的对象

method
string

错误时, 返回的请求http method

msg
string

错误消息

numbers
integer <int32>

当前页记录数

pageIndex
integer <int64>

当前页/默认第一页

pageSize
integer <int64>

分页大小

path
string

错误时,返回的path 对象

total
integer <int64>

总记录数

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : [
    ] ,
  • "msg" : "succeed" ,
  • "pageIndex" : 1 ,
  • "pageSize" : 10 ,
  • "total" : 1
}

收件人

您可使用这部分接口创建、查询和管理您用以接收实体卡片的收件人信息。

post 添加收件人

添加实体卡卡片收件人信息，用以接收实体卡片。

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
memberId
string(64)

请求所指向的会员号，如不传则默认为token下的会员；若涉及matrix产品，可传入指定的连接会员号。

matrixAccount
string(64)

如需在matrix下添加用卡人请填写matrix账户号 ,如不填写默认添加在member下。

recipientFirstName
required
string(40)

收件人名字，不能包含特殊字符。

recipientLastName
required
string(40)

收件人姓氏，不能包含特殊字符。

mobilePrefix
required
string(8)

手机号前缀（包括区号），前面加 符号和1-4位的国家呼叫代码。不要包括连字符、空格或括号。

mobile
required
string(11)

手机号。

country
required
string(2)

国籍国家码二字码。

state
required
string(50)

省份/州。

city
required
string(50)

城市。

addressLine1
required
string(50)

详细地址第一行地址（在信封上展示）长度最多50。

addressLine2
string(50)

第二行地址（在信封上展示）长度最多50。

addressLine3
string(50)

街道 第三行地址（在信封上展示）长度最多50。

addressLine4
string(50)

区 第四行地址（在信封上展示）长度最多50。

postalCode
required
string(12)

邮政编码。

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

object (vccAddRecipientsRespDetail)
msg
string

错误消息

Request samples

Content type
application/json
{
  • "recipientFirstName" : "testname" ,
  • "recipientLastName" : "testname" ,
  • "mobilePrefix" : "86" ,
  • "mobile" : "13121212123" ,
  • "country" : "IR" ,
  • "state" : "shanghai" ,
  • "city" : "shanghai" ,
  • "addressLine1" : "Lou Lan street" ,
  • "addressLine2" : "Lou Lan street 21" ,
  • "postalCode" : "10001"
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : {
    } ,
  • "msg" : "succeed"
}

post 收件人更新

用以更新收件人信息。

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
recipientId
required
string(64)

收件人ID。

recipientFirstName
required
string(40)

收件人名字，不能包含特殊字符。

recipientLastName
required
string(40)

收件人姓氏，不能包含特殊字符。

mobilePrefix
required
string(8)

手机号前缀（包括区号），前面加 符号和1-4位的国家呼叫代码。不要包括连字符、空格或括号。

mobile
required
string(11)

手机号。

country
required
string(2)

国籍国家码二字码。

state
required
string(50)

省份/州。

city
required
string(50)

城市。

addressLine1
required
string(50)

详细地址第一行地址（在信封上展示）长度最多50。

addressLine2
string(50)

第二行地址（在信封上展示）长度最多50。

addressLine3
string(50)

街道 第三行地址（在信封上展示）长度最多50。

addressLine4
string(50)

区 第四行地址（在信封上展示）长度最多50。

postalCode
required
string(12)

邮政编码。

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

object (vccEditRecipientsRespDetail)
msg
string

错误消息

Request samples

Content type
application/json
{
  • "recipientId" : "RI1654040500572917760" ,
  • "recipientFirstName" : "testname" ,
  • "recipientLastName" : "testname" ,
  • "mobilePrefix" : "86" ,
  • "mobile" : "13121212123" ,
  • "country" : "IR" ,
  • "state" : "shanghai" ,
  • "city" : "shanghai" ,
  • "addressLine1" : "Lou Lan street" ,
  • "addressLine2" : "Lou Lan street 21" ,
  • "postalCode" : "10001"
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : {
    } ,
  • "msg" : "succeed"
}

get 收件人查询

用于查询收件人列表。

query Parameters
pageIndex
integer <int64>

当前页/默认第一页

pageSize
integer <int64>

分页大小

memberId
string

查询所指向的会员号，如不传则默认为token下的会员；如涉及matrix产品，如不传则指向会员和连接会员所有信息查询，或传入指定会员查询。

matrixAccount
string

Matrix账户ID

createdAtStart
string
Example: createdAtStart=2022-03-18T08:43:28

起始时间

createdAtEnd
string
Example: createdAtEnd=2022-03-18T08:43:28

结束时间

recipientId
string

收件人ID

recipientStatus
string
Value: "normal:可用"

收件人状态。

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

Array of objects (cardRecipientsResp)

返回的对象

method
string

错误时, 返回的请求http method

msg
string

错误消息

numbers
integer <int32>

当前页记录数

pageIndex
integer <int64>

当前页/默认第一页

pageSize
integer <int64>

分页大小

path
string

错误时,返回的path 对象

total
integer <int64>

总记录数

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : [
    ] ,
  • "msg" : "succeed" ,
  • "pageIndex" : 1 ,
  • "pageSize" : 10 ,
  • "total" : 1
}

交易明细

所有卡片发起的相关的订单信息及状态明细查询。

get 卡历史明细

查询卡片开卡销卡的收费记录明细。

query Parameters
pageIndex
integer <int64>

当前页/默认第一页

pageSize
integer <int64>

分页大小

memberId
string

查询所指向的会员号，如不传则默认为token下的会员；如涉及matrix产品，如不传则指向会员和连接会员所有信息查询，或传入指定会员查询。

matrixAccount
string

Matrix账户ID

createdAtStart
string
Example: createdAtStart=2022-03-18T08:43:28

起始时间

createdAtEnd
string
Example: createdAtEnd=2022-03-18T08:43:28

结束时间

cardId
string

卡ID

cardFormFactor
string

卡介质。

值： virtual_card虚拟卡；

physical_card实体卡。

可为空。若为空，则查询结果显示所有虚拟卡及实体卡卡介质。

status
string
Enum: "pending" "succeed" "failed"

状态

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

Array of objects (cardIssuingHistoryResp)

返回的对象

method
string

错误时, 返回的请求http method

msg
string

错误消息

numbers
integer <int32>

当前页记录数

pageIndex
integer <int64>

当前页/默认第一页

pageSize
integer <int64>

分页大小

path
string

错误时,返回的path 对象

total
integer <int64>

总记录数

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : [
    ] ,
  • "msg" : "succeed" ,
  • "pageIndex" : 1 ,
  • "pageSize" : 10 ,
  • "total" : 1
}

get 常规卡资金明细

查看常规卡的每一笔交易资金变动明细。

query Parameters
pageIndex
integer <int64>

当前页/默认第一页

pageSize
integer <int64>

分页大小

memberId
string

查询所指向的会员号，如不传则默认为token下的会员；如涉及matrix产品，如不传则指向会员和连接会员所有信息查询，或传入指定会员查询。

matrixAccount
string

Matrix账户ID

createdAtStart
string
Example: createdAtStart=2022-03-18T08:43:28

起始时间

createdAtEnd
string
Example: createdAtEnd=2022-03-18T08:43:28

结束时间

transactionId
string

交易ID

cardId
string

卡ID

cardFormFactor
string

卡介质。

值： virtual_card虚拟卡；

physical_card实体卡。

可为空。若为空，则查询结果显示所有虚拟卡及实体卡卡介质。

transactionType
string
Enum: "auth" "verification" "auth_failed_return" "void" "refund" "refund_reversal" "corrective_auth" "corrective_refund" "corrective_refund_void" "recharge" "recharge_return" "discard_recharge_return" "service_fee" "fund_in" "settlement_spread" "atm_inquiry" "atm_withdrawals" "atm_inquiry_failed_return" "atm_withdrawals_failed_return"

交易类型，具体交易类型中文说明可以查看 发卡交易类型枚举值

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

Array of objects (rechargeCardFundsDetailResp)

返回的对象

method
string

错误时, 返回的请求http method

msg
string

错误消息

numbers
integer <int32>

当前页记录数

pageIndex
integer <int64>

当前页/默认第一页

pageSize
integer <int64>

分页大小

path
string

错误时,返回的path 对象

total
integer <int64>

总记录数

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : [
    ] ,
  • "msg" : "succeed" ,
  • "pageIndex" : 1 ,
  • "pageSize" : 10 ,
  • "total" : 1
}

get 共享卡交易额度明细

查看共享卡的每一笔交易限额变动明细。

query Parameters
pageIndex
integer <int64>

当前页/默认第一页

pageSize
integer <int64>

分页大小

memberId
string

查询所指向的会员号，如不传则默认为token下的会员；如涉及matrix产品，如不传则指向会员和连接会员所有信息查询，或传入指定会员查询。

matrixAccount
string

Matrix账户ID

createdAtStart
string
Example: createdAtStart=2022-03-18T08:43:28

起始时间

createdAtEnd
string
Example: createdAtEnd=2022-03-18T08:43:28

结束时间

transactionId
string

交易ID

cardId
string

卡ID

cardFormFactor
string

卡介质。

值： virtual_card虚拟卡；

physical_card实体卡。

可为空。若为空，则查询结果显示所有虚拟卡及实体卡卡介质。

transactionType
string
Enum: "auth" "verification" "auth_failed_return" "void" "refund" "refund_reversal" "corrective_auth" "corrective_refund" "corrective_refund_void" "limit_adjustment" "service_fee" "fund_in" "settlement_spread" "atm_inquiry" "atm_withdrawals" "atm_inquiry_failed_return" "atm_withdrawals_failed_return"

交易类型

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

Array of objects (shareCardLimitDetailResp)

返回的对象

method
string

错误时, 返回的请求http method

msg
string

错误消息

numbers
integer <int32>

当前页记录数

pageIndex
integer <int64>

当前页/默认第一页

pageSize
integer <int64>

分页大小

path
string

错误时,返回的path 对象

total
integer <int64>

总记录数

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : [
    ] ,
  • "msg" : "succeed" ,
  • "pageIndex" : 1 ,
  • "pageSize" : 10 ,
  • "total" : 1
}

get 交易明细

查询卡片交易明细。

query Parameters
pageIndex
integer <int64>

当前页/默认第一页

pageSize
integer <int64>

分页大小

memberId
string

查询所指向的会员号，如不传则默认为token下的会员；如涉及matrix产品，如不传则指向会员和连接会员所有信息查询，或传入指定会员查询。

matrixAccount
string

Matrix账户ID

createdAtStart
string
Example: createdAtStart=2022-03-18T08:43:28

起始时间

createdAtEnd
string
Example: createdAtEnd=2022-03-18T08:43:28

结束时间

cardId
string

卡ID

cardType
string

卡类型。值: share 或 recharge 可为空。如为空，则查询结果将显示所有类型的卡。

cardFormFactor
string

卡介质。

值： virtual_card虚拟卡；

physical_card实体卡。

可为空。若为空，则查询结果显示所有虚拟卡及实体卡卡介质。

requestId
string

商户请求流水号，每笔交易的唯一请求号，不可重复。

transactionId
string

交易ID

transactionType
string

您可对交易类型进行筛选，多个交易类型用逗号分隔。

status
string

您可对交易状态进行筛选，多个交易状态用逗号分隔。

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

Array of objects (vccTradeOrderResp)

返回的对象

method
string

错误时, 返回的请求http method

msg
string

错误消息

numbers
integer <int32>

当前页记录数

pageIndex
integer <int64>

当前页/默认第一页

pageSize
integer <int64>

分页大小

path
string

错误时,返回的path 对象

total
integer <int64>

总记录数

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : [
    ] ,
  • "msg" : "succeed" ,
  • "pageIndex" : 1 ,
  • "pageSize" : 10 ,
  • "total" : 1
}

自主风控

您可在此对每张卡的消费场景进行自主的限制

post 添加交易白名单

您可用此接口对您每张卡的可交易场景进行单个或多个的白名单配置。配置后此卡只能在您允许的场景下进行消费。

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
cardId
required
string

每张卡的唯一ID。

merchantNameList
Array of strings

请填写精准的merchant name以供判断。[0 ..10 ]characters[0 ..10]

mccList
Array of strings

MCC。[0 ..10 ]characters[0 ..10]

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

data
object

返回的对象

msg
string

错误消息

Request samples

Content type
application/json
{
  • "cardId" : "XR1654027662378799104" ,
  • "merchantNameList" : [
    ] ,
  • "mccList" : [
    ]
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "msg" : "succeed"
}

post 更新交易白名单

您可用此接口对您每张卡的可交易场景进行单个或多个的白名单进行更改。配置后此卡只能在您允许的场景下进行消费。

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
cardId
required
string

每张卡的唯一ID。

type
required
string
Enum: "add" "delete" "update"

add-追加，在原本基础上新增;delete-选择删除，在原本基础上删除;update-全量更新，则按你输入的“merchant name”或者“MCC”全量更新

merchantNameList
Array of strings

请填写精准的merchant name以供判断。[0 ..10 ]characters[0 ..10]

mccList
Array of strings

MCC。[0 ..10 ]characters[0 ..10]

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

data
object

返回的对象

msg
string

错误消息

Request samples

Content type
application/json
{
  • "cardId" : "XR1654027662378799104" ,
  • "type" : "add" ,
  • "merchantNameList" : [
    ] ,
  • "mccList" : [
    ]
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "msg" : "succeed"
}

get 白名单配置查询

您可用此接口查询您每张卡的白名单配置详情。

query Parameters
cardId
string

每张卡的唯一ID

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

object (whiteListResp)
msg
string

错误消息

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : [
    ] ,
  • "msg" : "succeed"
}

测试

post 交易模拟

您可以通过此接口在我们的沙箱环境中模拟发起各种类型的交易。

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
requestId
required
string(64)

商户请求流水号。

cardID
required
string(64)

每张卡的唯一 ID 号。

cvv
required
string(4)

CVV。

expirationDate
required
string(11)
Value: "MM/YY"

卡的有效期。

originTransactionId
string(64)

当交易类型为 void 或 refund 时要填写。

txnCurrency
required
string(11)

ISO 4217 货币代码。

txnAmount
required
bigDecimal

交易金额，请根据币种填写正确的金额。

txnType
required
string(11)
Enum: "auth" "void" "refund"

请根据您的使用场景填入响应的交易类型。

mcc
required
string(11)

MCC。

merchantName
required
string(50)
Value: "Amazon"
merchantCountry
required
string(2)
Value: "US"

国家二字码。

merchantCity
required
string(100)
Value: "Newyork"

国家对应的城市。

merchantPostcode
required
string(11)
Value: "10001"

邮编。

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

msg
string

错误消息

Request samples

Content type
application/json
{
  • "requestId" : "20230504153817" ,
  • "cardID" : "XR1671059882138275840" ,
  • "cvv" : "123" ,
  • "expirationDate" : "12/24" ,
  • "originTransactionId" : "" ,
  • "txnCurrency" : "USD" ,
  • "txnAmount" : 10 ,
  • "txnType" : "auth" ,
  • "mcc" : "1234" ,
  • "merchantName" : "test" ,
  • "merchantCountry" : "US" ,
  • "merchantCity" : "test" ,
  • "merchantPostcode" : "12345"
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "msg" : "succeed"
}

发卡附录

发卡交易类型

交易类型
描述
auth 消费
corrective_auth 纠正授权
verification 验证
void 撤销
refund 退款
corrective_refund 校正退款
recharge 转入
recharge_return 卡金额退还
discard_recharge_return 销卡退回
service_fee 服务费
refund_reversal 退款撤销
fund_in 汇入
atm_inquiry ATM查询
atm_withdrawals ATM提现
atm_inquiry_failed_return ATM查询失败退回
atm_withdrawals_failed_return ATM提提现失败退回

发卡状态

卡状态
描述
normal 可用
pending_recharge 待转入
unactivated 未激活
freezing 冻结中
frozen 冻结
risk_frozen 风控冻结
system_frozen 系统冻结
unfreezing 解冻中
expired 过期
canceling 销卡中
cancelled 销卡
renewing 续卡中
replacing 补卡中
lost 挂失
stolen 盗卡
pin_lost 密码锁定

响应码

编码
描述
0000 成功
9999 系统异常
VCC1010 交易金额超出您设置的单笔限额
VCC1011 交易金额超出您设置的日可用限额
VCC1012 交易金额超出您设置的月可用限额
VCC1013 此卡的可用交易限额不足，请先设置后再次发起交易
VCC1014 风险拒绝
VCC1015 可用金额不足，交易失败
VCC1025 您的光子易账户不可用，请联系你的客户经理了解详情。
VCC1027 渠道拦截
VCC1028 交易超时
VCC1039 无效参数
VCC1050 交易拒绝
VCC1054 此卡为不可用状态，您不可进行此操作，请确认后重试。
VCC1092 命中自主风控-交易白名单，交易拦截。
VCC1100 失败终态确认
VCC9999 系统错误，请重试
VCC2001 卡的有效期错误
VCC2002 卡的 CVV 错误
VCC2003 不支持此类型的交易
VCC2004 交易国不被允许
VCC2005 卡交易异常，请检查后再试
VCC2006 卡已失效，交易拒绝
VCC2007 交易超限制
VCC2008 卡处于不可用状态
VCC2009 可用金额不足，请稍后再试
VCC2010 未知错误
VCC2011 请勿重复发起交易，请稍后再试
VCC2012 交易超时
VCC2013 交易被拒绝
VCC2014 交易可能存在风险，交易拒绝。
VCC2015 系统错误
VCC2016 卡信息有误，请确认后重试
VCC2017 交易信息有误，交易被拒绝
VCC2018 无效请求，交易拒绝
VCC2019 原始交易不存在，交易失败
VCC2020 AVS验证失败
VCC2021 交易金额无效
VCC2022 网络错误
VCC3001 系统错误，请重试。
VCC3002 用卡人手机号异常，请检查后重试。
VCC3003 请求频繁，请稍后再试。
VCC3004 开卡失败，请联系商户服务人员了解详情。
VCC3005 用卡人姓名有误，请检查后重试。
VCC3006 创建卡失败，请在 5-10 分钟后再次尝试创建此卡。
VCC3007 无法创建卡，请联系商户服务人员了解详情。
VCC3008 请求受限，请联系商户服务人员了解详情。
VCC3009 用卡人的账单地址中的详细地址有误，请检查后重试。
VCC3010 用卡人的账单地址中的邮编有误，请检查后重试。
VCC3011 用卡人的账单地址中的国家有误，请检查后重试。
VCC3012 用卡人的账单地址中的城市有误，请检查后重试。
VCC3013 您设置的币种账户可用金额不足无法开卡，请先转入后开卡。
VCC3014 用卡人身份信息待更新，请更新后重试。
VCC3015 用卡人状态异常，请检查。
VCC3016 当前用卡人审核状态暂不支持该操作。
VCC3017 卡片状态异常，激活失败，请确认后重试。
VCC3018 您的卡信息输入有误，激活失败。
VCC3019 您的卡信息验证有误，重置密码失败。
VCC3021 用卡人信息填写不完整，请检查。
VCC3022 该卡片已激活，请勿重复操作。
VCC3023 该卡片与您的账户不匹配，激活失败，请确认后重试。
VCC3024 当前会员暂不支持申请实体卡，如需申请，请联系我们。
VCC3025 实体卡信息仅在激活后可查看，请先激活卡片。
VCC3026 实体卡暂不支持修改交易限额类型。
VCC3027 卡信息验证失败次数超限，激活失败，请于24小时后重试。
VCC3028 卡信息验证失败次数超限，重置密码失败，请于24小时后重试。
VCC3029 卡信息验证失败次数超限，更换密码失败，请于24小时后重试。
VCC3030 虚拟卡不支持挂失或盗卡操作。
VCC3031 您的卡片暂不支持激活，请联系您的客户经理。
VCC3032 升级失败。请先设置虚拟共享卡交易限额后再升级实体卡。
VCC3033 卡面姓名格式有误，请联系您的客户经理
VCC3034 您的卡信息验证有误，更换密码失败。
VCC3035 当前暂不支持重置密码，请联系您的客户经理
VCC3036 当前暂不支持实体卡续卡，请联系您的客户经理
VCC3037 用卡人开卡申请超单日失败上限，请明日再试。
VCC3038 您暂无权限调用，请联系您的业务人员了解详情。
VCC3039 您的开卡数量已达上限。
VCC3040 由于您提交信息未能通过我们的风险合规审核，本次开卡失败。
VCC3041 您无法修改用卡人信息，您可修改您的账单信息。
VCC3042 审核中，不支持此操作。
VCC3043 你所述的国家暂不支持
VCC3044 请完善用卡人材料和信息
VCC3045 不支持此操作。
VCC3046 换绑失败，无效的卡ID或用卡人ID。
VCC3047 批量开卡换绑成功前不允许激活卡。
VCC1042 今日取现金额已达上限，请明天再试。
VCC1043 本月取现金额已达上限，请下月再试
VCC1044 单笔取现金额超出限制，请检查。
VCC1045 今日取现次数已达上限，请明天再试。

光子易账户

光子易账户信息查询

可查询账户光子易账户中不同账户类型的实时金额情况及每个币种光子易账户下的各个账户的资金变动流水。

get 实时金额查询

可查询账户光子易账户中不同账户类型及不同币种的实时金额。

query Parameters
currency
required
string

币种[ISO4217]

accountNo
string

账户编号，系统内部唯一。如传入此参数，则精确查询，忽略currency、accountType、matrixAccount传值

memberId
string

请求所指向的会员号，如不传则默认为token下的会员；若涉及matrix产品，可传入指定的连接会员号。

accountType
string

账户类型: FT10001 可用金额; FT10002 冻结金额; FT10003 待结算金额; FT10004 保证金金额; 默认为 FT10001

matrixAccount
string

matrix账户号

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

object (accountResp)

返回的对象

method
string

错误时, 返回的请求http method

msg
string

错误消息

path
string

错误时,返回的path 对象

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : {
    } ,
  • "msg" : "succeed"
}

get 光子易账户账单查询

可根据日期范围，查询账户光子易账户内的所有流水记录信息。

query Parameters
transactedAtStart
required
string
Example: transactedAtStart=2023-12-13T15:30:00

起始动账日期

transactedAtEnd
required
string
Example: transactedAtEnd=2023-12-13T15:30:00

截止动账日期

memberId
string

请求所指向的会员号，如不传则默认为token下的会员；若涉及matrix产品，可传入指定的连接会员号。

accountTransactionId
string

业务订单产生的账户交易ID，包含交易凭证号和交易批次号均可查询

currency
string

币种[ISO4217]

accountType
string

账户类型: FT10001 可用金额; FT10002 冻结金额; FT10003 待结算金额; FT10004 保证金金额; 默认为 FT10001

matrixAccount
string

matrix账户号

accountNo
string

账户编号，系统内部唯一

txnType
Array of strings

账户交易类型，详情可看光子易账户附录账户交易类型

pageSize
integer <int64>

分页大小

pageIndex
integer <int64>

当前页/默认第一页

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

Array of objects (accountHistoryResp)

返回的对象

method
string

错误时, 返回的请求http method

msg
string

错误消息

numbers
integer <int32>

当前页记录数

pageIndex
integer <int64>

当前页/默认第一页

pageSize
integer <int64>

分页大小

path
string

错误时,返回的path 对象

total
integer <int64>

总记录数

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : [
    ] ,
  • "msg" : "succeed" ,
  • "numbers" : 1 ,
  • "pageIndex" : 1 ,
  • "pageSize" : 10 ,
  • "total" : 1
}

get 金额账户列表查询

查询所有的金额账户

query Parameters
ownerType
string
Enum: "member" "matrix" "issuing"

账户拥有者类型

memberId
string

查询所指向的会员号，如不传则默认为token下的会员；如涉及matrix产品，如不传则指向会员和连接会员所有信息查询，或传入指定会员查询。

matrixAccount
string

matrix账户号

pageIndex
integer <int64>

当前页/默认第一页

pageSize
integer <int64>

分页大小

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

Array of objects (accountListResp)

返回的对象

method
string

错误时, 返回的请求http method

msg
string

错误消息

numbers
integer <int32>

当前页记录数

pageIndex
integer <int64>

当前页/默认第一页

pageSize
integer <int64>

分页大小

path
string

错误时,返回的path 对象

total
integer <int64>

总记录数

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : [
    ] ,
  • "msg" : "succeed" ,
  • "numbers" : 1 ,
  • "pageIndex" : 1 ,
  • "pageSize" : 10 ,
  • "total" : 1
}

收款人

创建可用于全球供应商付款的收款人。您需要在光子易账户中创建收款人并绑定他们的银行帐户。在 PhotonPay 审核通过后，您可以进行付款。

post 新增收款人前置接口

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
accountType
required
string
Enum: "individual" "enterprise"

收款人主体类型，枚举：个人-individual、企业-enterprise。

bankLocation
required
string

银行所在地 2位国家码

currency
string

币种三字码，长度限制为3字符

memberId
string

请求所指向的会员号，如不传则默认为token下的会员；若涉及matrix产品，可传入指定的连接会员号。

paymentType
string
Enum: "PTA" "PTW"

收款人支付方式；
PTA-付款到银行账户，默认值
PTW-付款到电子钱包

digitalWalletOperator
string
Value: "PayPal"

如果收款人支付方式为PTW时，该字段必传，枚举值：PayPal

localPaymentType
string
Enum: "YES" "NO"

是否需要支持本地支付，枚举：YES-支持、NO-不支持
现阶段仅适用于巴西地区 BRL 币种付款场景

paymentMethod
string
Enum: "PIX KEY" "ACCOUNT"

本地支付类型，PIX KEY-使用PIX KEY付款，ACCOUNT-使用银行账号付款
现阶段仅适用于巴西地区 BRL 币种付款场景，当localPaymentType为YES时，必填

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

Array of objects (OpenV4RecipientFrontEndResp)

返回的对象

method
string

错误时, 返回的请求http method

msg
string

错误消息

path
string

错误时,返回的path 对象

Request samples

Content type
application/json
{
  • "accountType" : "individual" ,
  • "bankLocation" : "US" ,
  • "currency" : "USD" ,
  • "memberId" : 202400001001
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : [
    ] ,
  • "msg" : "succeed"
}

post 编辑收款人

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
memberId
string

请求所指向的会员号，如不传则默认为token下的会员；若涉及matrix产品，可传入指定的连接会员号。

contactName
string

收款人昵称，便于客户对收款人进行管理和识别，200个字符内

id
required
integer <int64>

银行卡ID

recipientAddress
string

收款人地址；200个字符内

requestNo
required
string

请求流水号，最长64个字符

reservedPhoneNumber
string

银行预留手机号，例如：86-13866668888；需要填入区号前缀，如不填区号则默认为中国地区86，86-中国大陆，852-中国香港，853-澳门，886-台湾，81-日本，1-美国，44-英国，39-意大利，34-西班牙，33-法国，1-加拿大，62-印度尼西亚等通用国家，8-32个字符内

recipientLocation
string

收款人国家，2位国家码，2个字符，参见[ 国家地区列表 ]
参考 ISO 3166-1:2020 https://www.iso.org/standard/72482.html

recipientProvince
string

收款人所在地区或者省份，最长255个字符，如果字典表中省或者地区缺失，则不传值，参考国家字典表

recipientCity
string

收款人所在城市名称，最长255个字符，参考国家字典表，如果字典表中城市缺失，则不传值

postCode
string

邮编，最长16个字符

dateOfBirth
string

生日，格式YYYYMMDD。当添加PayPal 和 Venmo 收款人时必填，其他场景选填

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

object (OpenV4RecipientEditResp)

返回的对象

method
string

错误时, 返回的请求http method

msg
string

错误消息

path
string

错误时,返回的path 对象

Request samples

Content type
application/json
{
  • "memberId" : "20230504170555" ,
  • "contactName" : "Fancy.Chen" ,
  • "id" : 6826 ,
  • "requestNo" : "20230504171522" ,
  • "contact" : "张三" ,
  • "supplementaryMaterials" : [
    ]
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : {
    } ,
  • "msg" : "succeed"
}

post 新增收款人

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
memberId
string

请求所指向的会员号，如不传则默认为token下的会员；若涉及matrix产品，可传入指定的连接会员号。

accountType
required
string
Enum: "individual" "enterprise"

收款人主体类型，枚举：个人-individual、企业-enterprise。

bankAccountNumber
string

银行卡号（银行所在地为欧洲时无需填写银行卡号，填写IBAN即可），32个字符内

bankLocation
required
string

银行所在地，2位国家码，2个字符
参考 ISO 3166-1:2020 https://www.iso.org/standard/72482.html

bankName
required
string

银行名称，参见[ 付款支持银行列表 ]，128个字符内

cardHolder
string

持卡人企业名称，120个字符内

cardHolderIdCard
string

持卡人身份证号，20个字符内

contactName
required
string

收款人昵称，便于客户对收款人进行管理和识别，200个字符内

currency
required
string

币种三字码，多个币种用【,】分割，长度限制为3-64字符
参考 ISO 4217:2015 https://www.iso.org/standard/64758.html

enterpriseRegistrationNumber
string

企业注册编号，例如营业执照编号，32个字符内

firstName
string

持卡人名字，60个字符内

ibanNumber
string

iban账户号码，在银行所在地=欧洲时，必填，46个字符内

interBankNumber
string

联行号，32个字符内

lastName
string

持卡人姓氏，60个字符内

recipientAddress
string

收款人地址；200个字符内

requestNo
required
string

请求流水号，最长64个字符

reservedPhoneNumber
string

银行预留手机号，例如：86-13866668888；需要填入区号前缀，如不填区号则默认为中国地区86，86-中国大陆，852-中国香港，853-澳门，886-台湾，81-日本，1-美国，44-英国，39-意大利，34-西班牙，33-法国，1-加拿大，62-印度尼西亚等通用国家，8-32个字符内

swiftCode
string

国际银行代码(swiftCode)，8或者11个字符
当localPaymentType选择YES时，此字段非必填

recipientLocation
string

收款人国家，2位国家码，2个字符，参见[ 国家地区列表 ]
参考 ISO 3166-1:2020 https://www.iso.org/standard/72482.html

recipientProvince
string

收款人所在地区或者省份，最长255个字符，如果字典表中省或者地区缺失，则不传值，参考国家字典表

recipientCity
string

收款人所在城市名称，最长255个字符，参考国家字典表，如果字典表中城市缺失，则不传值

postCode
string

邮编，最长16个字符；收款人付款方式为PTA，该字段为必填

contact
string

联系人，其个人/企业负责人（联系人）姓名，50个字符内

Array of objects

新增收款人需要补充材料，通过 [文件上传] 接口上传文件，文件细节查看 [光子易账户附录-文件说明]

paymentType
string
Enum: "PTA" "PTW"

收款人支付方式；
PTA-付款到银行账户，默认值
PTW-付款到电子钱包

digitalWalletOperator
string
Value: "PayPal"

电子钱包运营商
PayPal

email
string

用户常用电子邮箱，具体场景查看 [新增收款人前置接口]

digitalWalletAccountId
string

电子钱包账户

dateOfBirth
string

生日，格式YYYYMMDD。当添加PayPal 和 Venmo 收款人时必填，其他场景选填

creditorState
string

受益人所在地区，50个字符，电子钱包收款人使用

creditorCity
string

受益人所在城市，50个字符，电子钱包收款人使用

localPaymentType
string
Enum: "YES" "NO"

是否需要支持本地支付，枚举：YES-支持、NO-不支持
现阶段仅适用于巴西地区 BRL 币种付款场景

paymentMethod
string
Enum: "PIX KEY" "ACCOUNT"

本地支付类型，PIX KEY-使用PIX KEY付款，ACCOUNT-使用银行账号付款
现阶段仅适用于巴西地区 BRL 币种付款场景，当localPaymentType为YES时，必填

pixKeyType
string
Enum: "EVP" "EMAIL" "PHONE" "CPF" "CNPJ"

PIX KEY类型，枚举：EVP-UUID、EMAIL-邮箱、PHONE-电话、CPF-个人身份税号（收款方为个人账户）、CNPJ-企业法人税号（收款方为企业账户）
现阶段仅适用于巴西地区 BRL 币种付款场景，当paymentMethod为PIX KEY时，必填

pixKey
string

PIX KEY
请根据所选择的PIX Key类型，输入对应的PIX Key；
如果PIX Key类型为“EVP”时，请基于PIX规则输入正确的随机字符PIX Key；如果PIX KEY类型为“EMAIL”时，请输入正确的邮箱；如果PIX Key类型为“PHONE”时，请输入11位数字的电话号码，无需填写区号（+55）；如果PIX Key类型为“CPF”时，请输入11位数字的CPF；如果PIX Key类型为“CNPJ”时，请输入14位数字的CNPJ
现阶段仅适用于巴西地区 BRL 币种付款场景，当paymentMethod为PIX KEY时，必填

localBankCode
string

Bank Code
3位数字
现阶段仅适用于巴西地区 BRL 币种付款场景，当paymentMethod为ACCOUNT时，必填

branchNumber
string

Branch Code
4-7 位，可包含数字、字母、.或-
现阶段仅适用于巴西地区 BRL 币种付款场景，当paymentMethod为ACCOUNT时，必填

ispbCode
string

ISPB Code
8位数字
现阶段仅适用于巴西地区 BRL 币种付款场景，当paymentMethod为ACCOUNT时，必填

accountCategory
string
Enum: "Checking Account" "Salary Account" "Savings Account" "Transaction Account"

收款人账号类型，枚举：Checking Account-支票账户、Salary Account-工资账户、Savings Account-储蓄账户、Transaction Account-交易账户
现阶段仅适用于巴西地区 BRL 币种付款场景，当paymentMethod为ACCOUNT时，必填

identificationNo
string

收款人证件号
如果收款方为企业账户请输入14位数字的CNPJ，如果收款方为个人账户请输入11位数字的CPF
现阶段仅适用于巴西地区 BRL 币种付款场景，当paymentMethod为ACCOUNT时，必填

taxId
string

Tax Id
收款银行所在地为阿根廷(AR)时填入CUIT号码，11位数字，须与银行记录一致
收款银行所在地为智利(CL)时填入RUT号码，8-9位数字或字母，须与银行记录一致
收款银行所在地为秘鲁(PE)且收款人类型是企业且币种包含PEN时填入RUC号码，非中文且字符长度小于等于 64 位

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

object (OpenV4RecipientInsertResp)

返回的对象

method
string

错误时, 返回的请求http method

msg
string

错误消息

path
string

错误时,返回的path 对象

Request samples

Content type
application/json
{
  • "memberId" : "20230504170555" ,
  • "accountType" : "enterprise" ,
  • "bankAccountNumber" : "47417766731" ,
  • "bankLocation" : "US" ,
  • "bankName" : "STANDARD CHARTERED BANK (HONG KONG) LIMITED" ,
  • "cardHolder" : "Bren" ,
  • "contactName" : "Bren.Qiu" ,
  • "currency" : "USD" ,
  • "ibanNumber" : "SCBLHKHHMAC" ,
  • "recipientAddress" : "test recipientAddress" ,
  • "requestNo" : "20230504170555" ,
  • "reservedPhoneNumber" : "18300000000" ,
  • "swiftCode" : "SCBLHKHHMAC" ,
  • "contact" : "张三" ,
  • "supplementaryMaterials" : [
    ]
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : {
    } ,
  • "msg" : "succeed"
}

post 删除收款人

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
contactId
required
long

收款人ID

memberId
string

请求所指向的会员号，如不传则默认为token下的会员；如涉及matrix产品，如不传则指向会员和连接会员所有信息查询，或传入指定会员查询。

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

method
string

错误时, 返回的请求http method

msg
string

错误消息

path
string

错误时,返回的path 对象

Request samples

Content type
application/json
{
  • "contactId" : 4527 ,
  • "memberId" : "202400001001"
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "msg" : "succeed"
}

get 收款人列表

query Parameters
accountType
string
Enum: "individual" "enterprise"

账户类型:个人-individual,企业-enterprise

memberId
string

请求所指向的会员号，如不传则默认为token下的会员；如涉及matrix产品，如不传则指向会员和连接会员所有信息查询，或传入指定会员查询。

bankAccountNumber
string

银行卡号，46个字符内

contactName
string

收款人名称

pageIndex
integer <int64>

当前页/默认第一页

pageSize
integer <int64>

分页大小

requestNo
required
string

请求流水号，最长64个字符

status
string
Enum: "not activated" "activating" "failed" "init" "approved" "rejected" "modify" "incompleted" "required"

收款人聚合状态 枚举值包含 not activated（网商银行账户未开通），activating（网商银行账户开通中），failed（网商银行账户开通失败），init（网商银行账户开通成功或收款人创建成功，风控审核中），approved（风控返回通过对应的状态），rejected（风控返回未通过对应的状态），modify（风控返回待修改的状态），incompleted（待完善），required（需要跳转补充材料）

paymentType
string
Enum: "PTA" "PTW"

收款人支付方式；
PTA-付款到银行账户，默认值
PTW-付款到电子钱包

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

Array of objects (OpenV4RecipientDetailResp)

返回的对象

method
string

错误时, 返回的请求http method

msg
string

错误消息

numbers
integer <int32>

当前页记录数

pageIndex
integer <int64>

当前页/默认第一页

pageSize
integer <int64>

分页大小

path
string

错误时,返回的path 对象

total
integer <int64>

总记录数

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : [
    ] ,
  • "msg" : "succeed" ,
  • "numbers" : 1 ,
  • "pageIndex" : 1 ,
  • "pageSize" : 10 ,
  • "total" : 1
}

post 文件上传

文件上传接口，businessKey值为Payout。参考 (文件上传)

付款

使用光子易付款能力，您可以将资金支付到收款人的银行卡中。在进行付款之前，请先新增 收款人 。

get 交易订单列表

查询付款交易列表

query Parameters
memberId
string

请求所指向的会员号，如不传则默认为token下的会员；如涉及matrix产品，如不传则指向会员和连接会员所有信息查询，或传入指定会员查询。

createdAtStart
string <date-time>
Example: createdAtStart=2023-12-07T12:52:08

交易起始时间

createdAtEnd
string <date-time>
Example: createdAtEnd=2023-12-07T12:52:08

交易结束时间

pageIndex
integer <int64>

当前页/默认第一页

pageSize
integer <int64>

分页大小

payoutCurrencyList
Array of strings [ 0 .. 10 ] characters [ 0 .. 10 ]

付款币种,支持多个,最多10个

payoutOrderNo
string

付款流水号-payouts ID，最长32位字符

payoutRequestNo
string

下单时的请求流水号，当与payoutOrderNo同时存在时，以该字段为准，最长64个字符

requestNo
required
string

请求流水号，最长64个字符

status
string
Enum: "Processing" "Success" "Fail" "Improved" "Reversal" "Refund" "Unclaimed" "Cancel"

交易状态：Processing-处理中，Success-交易成功，Fail-交易失败，Improved-待补充资料，Reversal-已撤销，Refund-已退款，Unclaimed-待领取，Cancel-退回中

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

Array of objects (OpenApiV4OrderListResp)

返回的对象

method
string

错误时, 返回的请求http method

msg
string

错误消息

numbers
integer <int32>

当前页记录数

pageIndex
integer <int64>

当前页/默认第一页

pageSize
integer <int64>

分页大小

path
string

错误时,返回的path 对象

total
integer <int64>

总记录数

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : [
    ] ,
  • "msg" : "succeed" ,
  • "pageIndex" : 1 ,
  • "pageSize" : 10 ,
  • "total" : 2
}

post 创建交易

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
required
object (OpenApiV4PayoutBeneficiaryInfo)

受益人信息

object (OpenApiV4PayoutPayerInfo)

付款人信息

requestNo
required
string

请求流水号，最长64个字符

memberId
string

请求所指向的会员号，如不传则默认为token下的会员；若涉及matrix产品，可传入指定的连接会员号。

required
object (OpenApiV4PayoutTradeInfo)

交易信息

Responses (200)

Response Schema: application/json
code
string

响应码参见 付款响应码

object (OpenApiV4PayoutResp)

返回的对象

method
string

错误时, 返回的请求http method

msg
string

错误消息

path
string

错误时,返回的path 对象

Request samples

Content type
application/json
{
  • "beneficiaryInfo" : {
    } ,
  • "payerInfo" : {
    } ,
  • "requestNo" : "20230504172030" ,
  • "memberId" : "20230504170555" ,
  • "tradeInfo" : {
    }
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : {
    } ,
  • "msg" : "succeed"
}

post 订单撤销

订单撤销

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
requestNo
required
string

请求流水号，最长64个字符

memberId
string

请求所指向的会员号，如不传则默认为token下的会员；若涉及matrix产品，可传入指定的连接会员号。

payoutOrderNo
required
string

付款流水号-payouts ID，最长32位字符

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

method
string

错误时, 返回的请求http method

msg
string

错误消息

path
string

错误时,返回的path 对象

Request samples

Content type
application/json
{
  • "requestNo" : "1717146419042" ,
  • "memberId" : "20230504170555" ,
  • "payoutOrderNo" : "pay1889245281036292096"
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "msg" : "succeed"
}

post 文件上传

文件上传接口，businessKey值为Payout。参考 (文件上传)

get 查询会员可结汇额度

query Parameters
requestNo
required
string

请求流水号

memberId
string

请求所指向的会员号，如不传则默认为token下的会员；若涉及matrix产品，可传入指定的连接会员号。

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

object (OpenApiV4SettlementAmountResp)

返回的对象

method
string

错误时, 返回的请求http method

msg
string

错误消息

path
string

错误时,返回的path 对象

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : {
    } ,
  • "msg" : "succeed"
}

post 生态服务商支付链接

获取新的支付链接

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
requestNo
required
string

服务商系统请求唯一id，获取付款结果需要通过该id来查询，最长64个字符

cashierLink
string

服务商收银台地址；填写后，如果支付链接过期，我们将展示收银台给客户进行跳转；如果不填写，则需要用户自行返回收银台；最长255个字符

receivedAmount
required
number <bigdecimal>

到账金额

receivedCurrency
required
string

到账币种

payoutUrlExpiration
integer <int64>

支付链接过期时间，单位分钟，默认24小时，1440分钟

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

object (OpenApiV4EsPayoutUrlObtainResp)

返回的对象

method
string

错误时, 返回的请求http method

msg
string

错误消息

path
string

错误时,返回的path 对象

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

get 生态服务商支付链接查询

query Parameters
requestNo
required
string

获取支付链接时的请求流水号，最长64个字符

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

object (OpenApiV4EsPayoutUrlObtainResp)

返回的对象

method
string

错误时, 返回的请求http method

msg
string

错误消息

path
string

错误时,返回的path 对象

Response samples

Content type
application/json
{ }

get 查询订单需要补充信息

查询Payout订单需要补充信息

query Parameters
memberId
string

请求所指向的会员号，如不传则默认为token下的会员；若涉及matrix产品，可传入指定的连接会员号。

requestNo
required
string

请求流水号，最长64个字符

payoutOrderNo
required
string

交易流水号-payouts ID

paymentPurpose
string
Enum: "supplier" "logistics_freight" "advertising_expense" "vat_self" "service_commission/salary" "service_charge" "other_payout" "withdraw"

付款用途，非必填，不填则默认获取该交易所有可修改的付款用途以及需要的交易材料内容。如果填写，则返回特定场景的交易材料，枚举值查看 [光子易账户附录-付款用途] ；供应商付款:supplier,物流运费:logistics_freight,广告费:advertising_expense,VAT缴税:vat_self,劳务佣金/薪酬:service_commission/salary,服务费:service_charge,其他付款:other_payout,提现:withdraw

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

object (OpenApiV4GetSupplementaryResp)

返回的对象

method
string

错误时, 返回的请求http method

msg
string

错误消息

path
string

错误时,返回的path 对象

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "msg" : "成功" ,
  • "data" : {
    }
}

post 上传订单需要补充信息

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
memberId
string

请求所指向的会员号，如不传则默认为token下的会员；若涉及matrix产品，可传入指定的连接会员号。

paymentPurpose
string
Enum: "supplier" "logistics_freight" "advertising_expense" "vat_self" "service_commission/salary" "service_charge" "other_payout" "withdraw"

付款用途，非必填，不填则默认为当前交易信息付款用途；枚举值查看 [光子易账户附录-付款用途] ；供应商付款:supplier,物流运费:logistics_freight,广告费:advertising_expense,VAT缴税:vat_self,劳务佣金/薪酬:service_commission/salary,服务费:service_charge,其他付款:other_payout,提现:withdraw

payoutOrderNo
required
string

交易流水号-payouts ID

requestNo
required
string

请求流水号，最长64个字符

required
Array of objects (PayoutOrderSupplementaryInfoDTO)

补充文件信息,文件上传场景请使用：payouts_attachment

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

object (OpenApiV4UploadSupplementaryResp)

返回的对象

method
string

错误时, 返回的请求http method

msg
string

错误消息

path
string

错误时,返回的path 对象

Request samples

Content type
application/json
{
  • "payoutOrderNo" : "pay1858691802605953024" ,
  • "paymentPurpose" : "supplier" ,
  • "supplementaryInfos" : [
    ]
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : {
    } ,
  • "msg" : "succeed"
}

换汇

PhotonPay提供了基于全面API的全球FX平台，为希望在各种市场中持有货币的外汇经纪人提供出色灵活的汇率管理产品，降低外汇风险，可以在世界各地随时随地进行外汇交易。

get 换汇历史

所有换汇订单信息及状态明细查询。

query Parameters
requestNo
required
string

请求流水号

memberId
string

请求所指向的会员号，如不传则默认为token下的会员；如涉及matrix产品，如不传则指向会员和连接会员所有信息查询，或传入指定会员查询。

createdAtStart
required
string <date-time>
Example: createdAtStart=2023-12-07T12:52:08

起始时间

createdAtEnd
required
string <date-time>
Example: createdAtEnd=2023-12-07T12:52:08

截止时间

pageIndex
integer <int64>

当前页/默认第一页

pageSize
integer <int64>

分页大小

tradeStatus
string
Enum: "Processing" "Success" "Fail"

交易状态:Processing-处理中,Success-交易成功,Fail-交易失败

currencyPair
string

货币对:卖出币种/买入币种,如USD/EUR, ISO4217 币种的字母码 eg. USD,EUR,GBP等等；所支持的换汇币种为光子易账户已开通币种

businessNo
string

换汇订单号

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

Array of objects (换汇历史详情)

换汇历史明细

msg
string

错误消息

numbers
integer <int32>

当前页记录数

pageIndex
integer <int64>

当前页/默认第一页

pageSize
integer <int64>

分页大小

path
string

错误时,返回的path 对象

total
integer <int64>

总记录数

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : [
    ] ,
  • "msg" : "succeed" ,
  • "numbers" : 1 ,
  • "pageIndex" : 1 ,
  • "pageSize" : 10 ,
  • "total" : 1
}

post 换汇询价

换汇交易发起时，需先根据此接口查询获取汇率报价，及报价合约ID

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
requestNo
required
string

请求流水号

memberId
string

请求所指向的会员号，如不传则默认为token下的会员；若涉及matrix产品，可传入指定的连接会员号。

amount
required
number <bigdecimal>

交易金额,JPY币种精度为1,非JPY币种精度为0.01

buyCurrency
required
string

买入币种, ISO4217 币种的字母码 eg. USD,EUR,GBP等等；所支持的换汇币种为光子易账户已开通币种

deliveryDate
required
string

交割日期,yyyy-MM-dd格式

sellCurrency
required
string

卖出币种, ISO4217 币种的字母码 eg. USD,EUR,GBP等等；所支持的换汇币种为光子易账户已开通币种

side
required
string
Enum: "sell" "buy"

交易方向:sell-卖出,buy-买入

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

object (exchangeQuoteResp)

返回的对象

method
string

错误时, 返回的请求http method

msg
string

错误消息

path
string

错误时,返回的path 对象

Request samples

Content type
application/json
{
  • "memberId" : "2022122256879107" ,
  • "amount" : "50" ,
  • "buyCurrency" : "CNH" ,
  • "deliveryDate" : "2023-05-04" ,
  • "requestNo" : "20230504182517" ,
  • "sellCurrency" : "USD" ,
  • "side" : "sell"
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : {
    } ,
  • "msg" : "succeed"
}

get 实时汇率

实时汇率查询

query Parameters
requestNo
required
string

请求流水号

memberId
string

请求所指向的会员号，如不传则默认为token下的会员；若涉及matrix产品，可传入指定的连接会员号。

currencyPair
required
string

货币对:卖出币种/买入币种,如USD/EUR, ISO4217 币种的字母码 eg. USD,EUR,GBP等等；所支持的换汇币种为光子易账户已开通币种

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

object (exchangeRateResp)

返回的对象

method
string

错误时, 返回的请求http method

msg
string

错误消息

path
string

错误时,返回的path 对象

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : {
    } ,
  • "msg" : "succeed"
}

post 换汇下单

根据汇率查询接口获取汇率报价后，可根据报价合约ID创建换汇订单

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
requestNo
required
string

请求流水号

memberId
string

请求所指向的会员号，如不传则默认为token下的会员；若涉及matrix产品，可传入指定的连接会员号。

inquiryOrderNo
required
string

换汇询价ID

orderModel
string
Enum: "prefund" "postfund"

TO 模式下有效，非T0不传该字段；下单模式 prefund-实时下单/postfund-额度下单,默认实时下单（根据换汇询价接口返回的参数supportPostFund来判断，如果返回Y则可以在T0选择额度下单）

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

object (exchangeSubmitResp)

返回的对象

method
string

错误时, 返回的请求http method

msg
string

错误消息

path
string

错误时,返回的path 对象

Request samples

Content type
application/json
{
  • "memberId" : "2022122256879107" ,
  • "inquiryOrderNo" : "8424f8b611206b0ffec7fe9ba789d2ad" ,
  • "orderModel" : "prefund" ,
  • "requestNo" : "20230504182918"
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : {
    } ,
  • "msg" : "succeed"
}

get 交割假期查询

交割假期查询

query Parameters
buyCurrency
required
string

买入币种

deliveryDate
required
string

此参数传“D0到30”的日期（均为自然日）:yyyy-MM-dd格式

requestNo
required
string

请求流水号

sellCurrency
required
string

卖出币种

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

object (exchangeDeliveryDateResp)

返回的对象

method
string

错误时, 返回的请求http method

msg
string

错误消息

path
string

错误时,返回的path 对象

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : {
    } ,
  • "msg" : "succeed"
}

get postfund额度查询

postfund额度查询

query Parameters
requestNo
required
string

请求流水号

memberId
string

请求所指向的会员号，如不传则默认为token下的会员；若涉及matrix产品，可传入指定的连接会员号。

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

object (exchangePostFundAmountResp)

返回的对象

method
string

错误时, 返回的请求http method

msg
string

错误消息

path
string

错误时,返回的path 对象

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : {
    } ,
  • "msg" : "succeed"
}

光子易账户附录

账户交易类型

编码
描述
settle 结算
payin 入账
chargeback_amount_freeze 拒付金额冻结
chargeback_amount_return 拒付金额返回
chargeback_arbitration_fee_freeze 拒付仲裁费用冻结
chargeback_arbitration_fee_return 拒付仲裁费用返还
chargeback_fee 拒付手续费
payout 付款
payout_fee 付款手续费
payout_refund 付款返还
payout_fee_refund 付款手续费返还
deposit_return 保证金返还
refund 退款
refund_fee 退款手续费
clear 清算
deposit 保证金
mdr_fee 比例手续费
fixed_fee 固定手续费
3d_fee 3DS手续费
refund_clearing 退款清算
refund_deposit_return 退款保证金返回
refund_mdr_return 退款比例费返回
chargeback_amount_deduction 拒付金额扣除
chargeback_arbitration_fee_deduction 拒付仲裁费用扣除
internal_transition 平账
automatic_settlement_revenue 系统自动平账-收入
automatic_settlement_outlay 系统自动平账-支出
custom_fee 定制化费用
other_disburse 其他扣款
other_income 其他入账
recharge 转入
recharge_fee 转入手续费
app_exchange 换汇
app_exchange_return 换汇返还
exchange 汇兑
exchange_return 汇兑返还
payout_exchange_income payout换汇收益
payout_exchange_income_return payout换汇收益回款
settlement_amount 收款结算
settlement_fee 收款结算手续费
issuing_auth 卡授权交易
issuing_refund 卡退款
issuing_refund_fee 退款手续费
issuing_void 撤销
issuing_fee 交易手续费
issuing_apply_card_fee 开卡手续费
issuing_apply_card_fee_return 开卡手续费返还
issuing_cancel_fee 销卡手续费
issuing_cross_board_fee 跨境手续费
issuing_cross_board_fee_return 跨境手续费返还
issuing_fee_return 交易手续费返还
issuing_conversion_fee 汇率转换费
issuing_conversion_fee_return 汇率转换费返还
migrate_curr_in 币种账户-金额转入
vcc_recharge 卡转入
vcc_recharge_return 卡转入退回
fx_swap_penalty_margin 换汇-违约保证金扣除
fx_swap_penalty_margin_return 换汇-违约保证金返还
equity_card_buy 权益卡-购买
equity_card_buy_return 权益卡-购买返还
transfer 转账
transfer_return 转账返还
sub_account_transfer 子账户转账
sub_account_transfer_return 子账户转账返还
payout_transfer 付款-转账
payout_transfer_return 付款-转账返还
issuing_recharge_fee 卡转入手续费
issuing_return 卡金额退还
issuing_return_fee 卡金额退还手续费
issuing_cancel_return 销卡金额退回
issuing_cancel_return_fee 销卡金额退回手续费
issuing_recharge_fee_return 卡转入手续费退回
global_account_opening_fee 全球账户开户手续费
global_account_opening_fee_refund 全球账户开户手续费退款
global_account_account_management_fee 全球账户账户管理费
global_account_settlement 全球账户结算
global_account_settlement_fee 全球账户结算手续费
collection_account_management_fee 收款账户管理费
funds_freeze 资金冻结
funds_release 资金解冻
issuing_gateway_fee 网关手续费
issuing_gateway_fee_return 网关手续费返还
issuing_auth_failed_fee 授权交易失败费用
issuing_service_fee 虚拟卡服务费
chargeback_alert_refund 拒付预警退款
chargeback_alert_refund_reversal 拒付预警退款撤销
chargeback_alert_refund_fee 拒付预警退款手续费
chargeback_alert_refund_clearing 拒付预警退款清算
chargeback_alert_refund_reversal_clearing 拒付预警退款撤销清算
other_disburse 其他扣款
other_income 其他入账
fx_entrusted_debit 换汇委托资金扣款
fx_entrusted_refund 换汇委托资金返回
issuing_batch_card_recharge 批量卡转入
refund_fee_return 退款手续费返还
issuing_refund_void 卡退款撤销
token_create_fee Token创建手续费
token_fee Token支付手续费
npt_token_create_fee NPT Token创建手续费
npt_token_fee NPT Token支付手续费
mit_create_fee MIT创建手续费
mit_fee MIT支付手续费
fund_return 资金退回
disputes_amount_freeze 争议金额冻结
disputes_amount_return 争议金额返还
disputes_fee 争议处理费用
funds_pooling 资金归集
pooling_fee 归集手续费
funds_pooling_freeze 归集冻结
pooling_unfreeze 归集解冻
connect_fee 绑定费
connect_fee_return 绑定费返还
matrix_transfer matrix-转账
matrix_transfer_fee matrix-转账手续费
withdraw 提现
withdraw_refund 提现返还
issuing_fund_in 发卡汇入
issuing_fund_in_fee 发卡汇入手续费
issuing_settlement_spread 发卡结算价差

文件说明

businessKey
补充材料的文件类型
文件说明
Payout recipient_business_license 营业执照（可上传 PNG,JPG,JPEG 类型文件，单个文件最大10MB，至多上传1个图片，如提交复印件或者扫描件，需要加盖企业公章）
Payout recipient_id_card_face 身份证头像页（可上传 PNG,JPG,JPEG 类型文件，单个文件最大10MB，至多上传1个图片，如提交复印件或者扫描件，需要加盖企业公章）
Payout recipient_id_card_overleaf 身份证国徽页（可上传 PNG,JPG,JPEG 类型文件，单个文件最大10MB，至多上传1个图片，如提交复印件或者扫描件，需要加盖企业公章）
Payout payout_contract 合同（可上传txt,pdf,jpg,jpeg,docx,png,bmp,rtf,xls,xlsx 类型文件，单个文件最大8M，至多上传3个图片，文件名称不超过64字符，只能以英文或者数字组成，不可添加符号）
Payout payout_invoice 发票（可上传txt,pdf,jpg,jpeg,docx,png,bmp,rtf,xls,xlsx 类型文件，单个文件最大8M，至多上传3个图片，文件名称不超过64字符，只能以英文或者数字组成，不可添加符号）
Payout payout_logistics_order 物流单（可上传txt,pdf,jpg,jpeg,docx,png,bmp,rtf,xls,xlsx 类型文件，单个文件最大8M，至多上传3个图片，文件名称不超过64字符，只能以英文或者数字组成，不可添加符号）
Payout payout_customs_declaration_form 报关单（可上传txt,pdf,jpg,jpeg,docx,png,bmp,rtf,xls,xlsx 类型文件，单个文件最大8M，至多上传3个图片，文件名称不超过64字符，只能以英文或者数字组成，不可添加符号）
Payout payout_tax_payment_receipt 缴税凭证（可上传txt,pdf,jpg,jpeg,docx,png,bmp,rtf,xls,xlsx 类型文件，单个文件最大8M，至多上传3个图片，文件名称不超过64字符，只能以英文或者数字组成，不可添加符号）
Payout payout_store_screenshots 店铺截图（可上传txt,pdf,jpg,jpeg,docx,png,bmp,rtf,xls,xlsx 类型文件，单个文件最大8M，至多上传3个图片，文件名称不超过64字符，只能以英文或者数字组成，不可添加符号）
Payout payout_waybill_bill_of_lading 运单/提单（可上传txt,pdf,jpg,jpeg,docx,png,bmp,rtf,xls,xlsx 类型文件，单个文件最大8M，至多上传3个图片，文件名称不超过64字符，只能以英文或者数字组成，不可添加符号）
Payout payout_promotion_revenue_screenshot 推广收益截图（可上传txt,pdf,jpg,jpeg,docx,png,bmp,rtf,xls,xlsx 类型文件，单个文件最大8M，至多上传3个图片，文件名称不超过64字符，只能以英文或者数字组成，不可添加符号）
Payout payout_advertisement_screenshots 广告投放截图（可上传txt,pdf,jpg,jpeg,docx,png,bmp,rtf,xls,xlsx 类型文件，单个文件最大8M，至多上传3个图片，文件名称不超过64字符，只能以英文或者数字组成，不可添加符号）
Payout payout_labor_contract 劳务合同（可上传txt,pdf,jpg,jpeg,docx,png,bmp,rtf,xls,xlsx 类型文件，单个文件最大8M，至多上传3个图片，文件名称不超过64字符，只能以英文或者数字组成，不可添加符号）
Payout payout_payroll_payment_voucher 工资单打款凭证（可上传txt,pdf,jpg,jpeg,docx,png,bmp,rtf,xls,xlsx 类型文件，单个文件最大8M，至多上传3个图片，文件名称不超过64字符，只能以英文或者数字组成，不可添加符号）
Payout payout_id_card 收款人身份证（可上传txt,pdf,jpg,jpeg,docx,png,bmp,rtf,xls,xlsx 类型文件，单个文件最大8M，至多上传3个图片，文件名称不超过64字符，只能以英文或者数字组成，不可添加符号）
Payout payout_proof_of_delivery 交付证明（可上传txt,pdf,jpg,jpeg,docx,png,bmp,rtf,xls,xlsx 类型文件，单个文件最大8M，至多上传3个图片，文件名称不超过64字符，只能以英文或者数字组成，不可添加符号）
Payout payout_proof_of_transaction_completion 交易完成证明（可上传txt,pdf,jpg,jpeg,docx,png,bmp,rtf,xls,xlsx 类型文件，单个文件最大8M，至多上传3个图片，文件名称不超过64字符，只能以英文或者数字组成，不可添加符号）

付款用途

付款用途枚举编码
描述
supplier 供应商付款
logistics_freight 物流费
advertising_expense 广告费
vat_self VAT 缴税
service_commission/salary 劳务佣金/薪酬
service_charge 软件服务费
other_payout 其他用途
withdraw 提现

付款响应码

code编码
错误msg
说明
0000 创建订单成功 正常接受到请求，并创建订单成功
gateway_error_01 The interface timed out. Please try again later. 接口超时，需要主动查询创建订单结果并关注webhook通知
15000 下单异常，请主动查询订单 队列处理中，查询订单状态确定最终态
16999 system error 需要主动查询创建订单结果并关注webhook通知
其他错误码 参数校验不通过 其他响应码参见 响应码

Matrix

账户

post 创建matrix账户

单一会员下创建matrix账户

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
matrixAccountName
required
String(64)
Value: "xxx"

matrix账户昵称

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

object (createMatrixAccountRespDetail)
msg
string

错误消息

Request samples

Content type
application/json
{
  • "matrixAccountName" : "test"
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : {
    } ,
  • "msg" : "succeed"
}

post matrix账户信息编辑

编辑matrix账户信息

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
matrixAccount
required
String(64)
Value: "MI123456xxxx"

matrix账户id

matrixAccountName
required
String(64)
Value: "张三"

matrix账户昵称

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

msg
String

错误消息

object

Request samples

Content type
application/json
{
  • "matrixAccount" : "MIXXXX" ,
  • "matrixAccountName" : "test"
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : {
    } ,
  • "msg" : "succeed"
}

get matrix账户信息查询

通过身份信息中的会员号查询所有matrix账户信息，分页返回

query Parameters
pageIndex
required
integer <int64>

当前页

pageSize
required
integer <int64>

分页大小

matrixAccount
string

Matrix账户ID

createdAtStart
string
Example: createdAtStart=2022-03-18T08:43:28

起始时间

createdAtEnd
string
Example: createdAtEnd=2022-03-18T08:43:28

结束时间

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

Array of objects (pageMatrixAccountInfoRespDetail)

返回的对象

msg
string

错误消息

pageIndex
integer <int64>

当前页

pageSize
integer <int64>

分页大小

total
integer <int64>

总记录数

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : [
    ] ,
  • "msg" : "succeed" ,
  • "pageIndex" : 1 ,
  • "pageSize" : 10 ,
  • "total" : 1
}

转账

post 资金扣除

通过 memberId 与 matrixAccount 实现会员账户与 matrix 账户之间的资金划转和扣除

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
currency
required
String(3)
Value: "USD"

转账币种

matrixAccount
required
String(64)
Value: "xxx"
transferAmount
required
number(13) <bigdecimal>
Value: "123"

转账金额

transferType
required
String(64)
Enum: "transfer_in" "transfer_out"

'transfer_in'代表资金从会员转入matrix账户，'transfer_out'代表资金从matrix账户转入会员

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

msg
string

错误消息

Request samples

Content type
application/json
{
  • "currency" : "USD" ,
  • "matrixAccount" : "MI1612373367288107008" ,
  • "transferAmount" : "100" ,
  • "transferType" : "transfer_in"
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : "转账成功" ,
  • "msg" : "succeed"
}

post 资金调拨

仅应用于matrix-连接会员模式，在同一个matrix体系内，支持会员和连接会员之间进行资金调拨划转。

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
requestNo
required
String(64)

请求流水号

memberId
required
String(64)

连接会员ID

currency
required
String(3)

交易币种 ISO4217

direction
required
byte
Enum: 0 1

交易方向，0：连接会员转入，1：连接会员转出

payoutAmount
number <bigdecimal>

付款金额；与到账金额二选一填入；付款金额-手续费金额=到账金额

receivedAmount
number <bigdecimal>

到账金额；与付账金额二选一填入；付款金额-手续费金额=到账金额

Responses (200)

Response Schema: application/json
code
String

响应的code 0000代表成功

msg
String

错误消息

object (fundTransferRespData)

Request samples

Content type
application/json
{
  • "requestNo" : "RN12345678910" ,
  • "memberId" : "CM100001" ,
  • "currency" : "USD" ,
  • "direction" : 0 ,
  • "payoutAmount" : 100
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : {
    } ,
  • "msg" : "succeed"
}

get 资金调拨明细

您可通过此API查询您与连接会员的资金调拨划转的明细。

query Parameters
pageIndex
integer <int64>

当前页/默认第一页

pageSize
integer <int64>

分页大小

createdAtStart
string
Example: createdAtStart=2023-12-03T11:52:00

交易创建时间查询开始

createdAtEnd
string
Example: createdAtEnd=2023-12-06T11:52:00

交易创建时间查询结束

completedAtStart
string
Example: completedAtStart=2023-12-03T11:52:00

交易完成时间查询开始

completedAtEnd
string
Example: completedAtEnd=2023-12-06T11:52:00

交易完成时间查询结束

status
string

交易结果状态

requestNo
string

请求流水号

transactionId
string

交易唯一流水号

direction
string

交易方向，0：连接会员转入，1：连接会员转出

memberId
byte

连接会员ID

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

Array of objects (fundTransferListQueryResp)
msg
string

错误消息

pageIndex
integer <int64>

当前页

pageSize
integer <int64>

分页大小

total
integer <int64>

总记录数

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : [
    ] ,
  • "msg" : "succeed" ,
  • "pageIndex" : 1 ,
  • "pageSize" : 10 ,
  • "total" : 1
}

发卡

开始使用Matrix发卡解决方案

以下是创建和管理您自己的卡片所需的步骤指南

  • 第一步 - 创建一个Matrix账户

    如果您准备好使用Matrix和发卡，您需要先创建一个Matrix账户。

  • 第二步 - 创建用卡人

    您需要创建您的用卡人，当您打开卡片时，您可以将卡片分配给一个指定的用卡人，交易需要的短信验证码将发送到此用卡人的手机或电子邮件。

  • 第三步 - 创建您的第一张卡

    帐户全部整理完毕后，您现在可以使用应用卡终端创建您的第一张卡了。

  • 第四步 - 卡转入

    如果您开通的是常规卡，则您需要转入后保证卡内有资金方可使用。您需要通过“换汇询价”和“转入下单”接口完成对卡的转入。

用卡人

开卡时，您可以选择卡对应的用卡人进行开卡，此卡将属于您选定的用卡人，之后如用此卡进行消费，所需的验证码将发送至用卡人的手机或邮箱中。创建用卡人后，将获得用卡人ID，此用卡人ID将是唯一识别号。 (点击链接： 添加用卡人) 。
您可以通过 API 查询用卡人ID。 (点击链接： 查询用卡人) 。

开卡

开始创建卡片，当您创建完您的Matrix账户后，您现在就可以进行开卡了。您可以在申请卡的API中选择ID类型为：Matrix ID，并填写您刚刚申请的Matrix账户ID，从而创建一张新卡。 (点击链接： 开卡) 。 然后您可以在开卡的响应中看到您所有的卡信息：卡号，到期日，CVV等。该卡将属于您的这个Matrix账户。当然，您也可以用您的会员ID来开卡，只要选择 'ID类型' 为会员ID并填写其ID号码即可。
您可以在开卡时直接设置一些限额，如：单笔交易限额、日交易限额、月交易限额、可交易限额（可交易限额：指此卡可用于交易的最高金额，当其为0时，进行交易将失败)。
您也可以使用 API 随时更新您的卡片限额。 (点击链接： 卡更新) 。

注意：您可以使用 (点击链接： 卡bin查询) 来检查可用于开卡的卡bin。

请求结果查询

您可以使用这个接口来查询您的卡片信息和卡片相关的配置信息。 (点击链接： 请求结果查询) 。

卡信息查询

您可以实时调取此接口查询您的卡信息，包括卡号、有效期、CVV、卡限额等，您可以通过查询及时调整您对于卡的限额配置，以避免失败交易的产生。 (点击链接： 卡信息查询) 。

换汇询价

如您使用的是常规卡，这是进行卡内金额转入的第一步：
您需要先在此API中将您的转入信息填入 (点击链接： 换汇询价) ，并确认汇率后保存这笔的请求ID，将此ID填入“转入下单”接口去完成转入。
注：汇率有时效性，超时将失效，还请尽快使用完成转入。

转入下单

这是您进行卡内金额转入的第二步：
将汇率询价接口的“请求ID”在有效时效内填入此API中 (点击链接： 转入) ，我们将按此费率对您指定的卡完成转入操作。

卡金额退还

您可将常规卡卡内剩余的金额退还至您卡本币对应的光子易账户可用金额中。 (点击链接： 卡金额退还) 。

销卡

您可以通过此接口将您无需使用的卡进行注销的操作。此操作不可逆转，一经注销，此卡将永久不可使用，且不能恢复，请谨慎操作。如是常规卡，销卡后卡内资金将自动帮您退还至卡本币对应的币种光子易账户中。 ( 点击链接： 销卡) 。

卡历史明细

您可用此接口实时查询您的开卡以及销卡记录，其中包含开卡或销卡的状态以及每笔的手续费等信息。 (点击链接： 卡历史明细) 。

交易明细

您可以使用交易查询接口实时查询您所有的交易明细和交易状态，包括：交易时间、交易币种、交易金额、交易状态等交易信息。您也可以使用交易ID号向我们查询单笔，了解此笔交易结果和交易细节。 (点击链接： 交易明细) 。

常规卡资金明细

您可在此接口中查询常规卡每笔交易的资金变动明细。 (点击链接： 常规卡资金明细) 。

连接会员

您可以通过以下步骤来创建您的连接会员。并灵活使用连接会员服务来为您解决业务以及资金的自定义管理。

第一步：您需要联系与您对接的PhotonPay业务负责人或在线客服申请开通“连接会员”服务。

如您需要使用或者想要了解Matrix Connect Member功能及服务，请先联系为您服务的PhotonPay业务负责人或在线客服了解详情或申请开通此服务。

第二步：当您申请开通连接会员成功后，您可以对接我们“连接会员”API接口。

您线下申请审核通过之后，您可对接我们连接会员的API接口。

第三步：创建您的第一个连接会员并激活这个会员。

您需要先通过“ 创建连接会员 ”API来创建一个连接会员，并通过“ 激活连接会员 ”完成此连接会员的KYC审核，KYC审核通过即激活连接会员，您可使用PhotonPay提供的收款、发卡、光子易账户、付款等功能。

第四步：使用业务线功能

如您的连接会员有需要使用收款或发卡业务的需求，你可以通过对接“ 收款 ”和“ 发卡 ”的接口让你的连接会员发起使用。 您需要在这两个业务接口中的“member id”字段中填入您已激活的连接会员唯一的会员id即可。

第五步：对连接会员进行资金配置。

如您的业务场景需要，您可以通过“ 连接会员配置 ”对其资金进行管理。

第六步：开始为您的连接会员建立第一笔交易。

您可以开始用你的连接会员发起交易了。

post 创建连接会员

您可以在此接口中创建你的连接会员。

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
requestId
required
string(64)

唯一请求号，不可重复。(请求的唯一标识，建议您保存，可用于对应的操作。)

connectMemberName
required
string

连接会员昵称(会员名)

object (CustomerAgreements)

商户协议详情

Responses (200)

Response Schema: application/json
code
string

响应码

msg
string

消息

Request samples

Content type
application/json
{
  • "requestId" : "202401104332848256897008" ,
  • "connectMemberName" : "your connectMemberName" ,
  • "customerAgreements" : {
    }
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "msg" : "succeed"
}

post 激活连接会员

您可以通过此接口提交会员激活申请信息。申请通过后可使用PhotonPay收款、光子易账户、如为个人连接会员，无法使用发卡业务线，请使用企业会员。

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
memberId
required
string

传入需要进行激活申请的连接会员号。

memberShip
required
string
Enum: "enterprise" "individual"

连接会员的主体类型。

object (Agreement)

协议相关信息

object (Enterprise)

企业相关信息：仅当 memberShip 为 enterprise 时传递

object (IndividualInfo)

个人基础信息：仅当 memberShip 为 individual 时传递

Responses (200)

Response Schema: application/json
code
string

响应码

msg
string

消息

object

响应数据

Request samples

Content type
application/json
{
  • "memberId" : "CM232848201603" ,
  • "memberShip" : "enterprise" ,
  • "agreement" : { } ,
  • "enterprise" : {
    } ,
  • "individualInfo" : {
    }
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "msg" : "succeed" ,
  • "data" : {
    }
}

post B2B问卷

您可以通过此接口提交开通外贸收款业务的申请资料。

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
memberId
required
string

传入需要进行激活B2B业务线申请的连接会员号

dataId
required
string

数据块ID，每个数据项的唯一ID。推荐使用 UUID

industry
required
string

企业所属行业。支持以下枚举：

  • retail_wholesale : 零售/批发

  • advertising_marketing_v2 : 广告与营销服务

  • entertainment_gaming_v2 : 娱乐与游戏

  • software_it_services_v2 : 软件与IT服务

  • logistics_transportation_v2 : 物流运输

  • consulting_services_v2 : 咨询服务

  • online_travel_agency_v2 : 航旅OTA

  • others : 其他

mainProductCategory
required
string

主营产品类别 code。参考 主营产品类别

businessModel
required
string

业务和物流模式描述：请简要说明您的业务和物流模式，如主要出口何种货物、货物来源为自有生产或采购、采用何种跨境物流方式等

website
required
Array of arrays

公司网站：请尽量补充提交，未提交可能会影响到后续个别功能使用。

支持提交多个，最多支持5个网址信息。

officePhoto
Array of strings <= 10 items

办公室照片(含公司logo)：请提供包含公司logo的办公场所照片。

  1. 最多可上传10个文件，类型可以是JPG, JPEG, PNG, HEIC, PDF，最大10MB

调用 文件上传 接口获取文件 key。 businessKey 传 matrix_member_kyc

businessLocations
required
Array of arrays

营业分布点：请输入与您业务有最密切直接或间接关联的国家或地区名称。最多支持5个国家地区。

monthlyTurnover
required
string

请按以下梯度范围，输入您的月营业额。

  • lt_50000 : Less than 50,000 USD

  • bt_50000_100000 : 50,000 to 100,000 USD

  • bt_100000_250000 : 100,000 to 250,000 USD

  • bt_250000_500000 : 250,000 to 500,000 USD

  • bt_500000_1000000 : 500,000 to 1,000,000 USD

  • bt_1000000_5000000 : 1,000,000 to 5,000,000 USD

  • gt_5000000 : Over 5,000,000 USD

needForexSettlement
required
string
Enum: "Y" "N"

您是否需要外贸结汇？

object (IndustryQualifications)

当 mainProductCategory 选择了以下行业后必须传材料：

Responses (200)

Response Schema: application/json
code
string

响应码

msg
string

消息

object

响应数据

Request samples

Content type
application/json
{
  • "memberId" : "CM231277888603" ,
  • "dataId" : "123e4567-e89b-990d-a456-426614174000" ,
  • "industry" : "retail_wholesale" ,
  • "mainProductCategory" : "120008" ,
  • "businessModel" : "业务和物流模式描述内容" ,
  • "website" : [ ] ,
  • "officePhoto" : [
    ] ,
  • "businessLocations" : [ ] ,
  • "monthlyTurnover" : "bt_250000_500000" ,
  • "needForexSettlement" : "Y" ,
  • "industryQualifications" : {
    }
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "msg" : "succeed" ,
  • "data" : {
    }
}

post 更新连接会员资料

如果您的激活申请被打回，您可以通过此接口重新提交被打回信息进行连接会员的再次激活申请。

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
memberId
required
string

传入需要更新资料的连接会员号

required
Array of objects (ReSubmitDataItem)

重新提交的资料项 Array

Responses (200)

Response Schema: application/json
code
string

响应码

msg
string

消息

object

响应数据

Request samples

Content type
application/json
{
  • "memberId" : "CM234565228603" ,
  • "reSubmitData" : [
    ]
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "msg" : "succeed" ,
  • "data" : {
    }
}

post 关闭连接会员

当会员状态为: init -初始、 activation_failed -激活失败的情况下可以 通过此接口将会员关闭，会员关闭后将释放会员数。

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
requestId
required
string

请求ID

memberId
required
string

你需要关闭的连接会员ID

Responses (200)

Response Schema: application/json
result
required
string

操作结果： succeed , failed

reason
required
string

针对操作结果的原因

Request samples

Content type
application/json
{
  • "requestId" : "123e4567-e89b-990d-a456-426614174000" ,
  • "memberId" : "CM231277888603"
}

Response samples

Content type
application/json
{
  • "result" : "succeed" ,
  • "reason" : "当前状态连接会员不可被关闭"
}

post 自动归集设置

您可以通过此API对您的连接会员设置或更新资金自动归集功能，甚至可以分别为不同的业务类型的资金设置您是否需要归集。

header Parameters
X-PD-TOKEN
required
String

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
memberId
required
String(32)

连接会员号

required
object (ConnectMemberSetReq)

您可以在此配置您连接会员的收款入账资金是否需要自动归集。

Responses (200)

Response Schema: application/json
code
String

响应的code 0000代表成功

data
String

响应data 成功:success

msg
String

错误消息

Request samples

Content type
application/json
{
  • "memberId" : "CM23120817909136" ,
  • "collection" : {
    }
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : "success" ,
  • "msg" : "succeed"
}

get 费用明细

您可在此api中查询您连接会员的扣费明细。

query Parameters
memberId
String
Example: memberId=CM23120817909136

查询所指向的会员号，如不传则默认为token下的会员；如涉及matrix产品，如不传则指向会员和连接会员所有信息查询，或传入指定会员查询。

feeType
String
Enum: "connectFee" "connectFeeReturn"
Example: feeType=connectFee

绑定费类型

createdAtStart
String
Example: createdAtStart=2024-02-14T10:45:00

创建开始时间

createdAtEnd
String
Example: createdAtEnd=2024-02-15T10:45:00

创建结束时间

pageIndex
required
integer <int64>
Example: pageIndex=1

当前页

pageSize
required
integer <int64>
Example: pageSize=20

分页大小

header Parameters
X-PD-TOKEN
required
String

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
String

响应的code 0000代表成功

Array of objects (ConnectMemberFeeDetail)
msg
String

错误消息

pageIndex
integer <int64>

当前页

pageSize
integer <int64>

分页大小

total
integer <int64>

总记录数

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : [
    ] ,
  • "msg" : "succeed" ,
  • "total" : "20," ,
  • "pageSize" : "10," ,
  • "pageIndex" : 1
}

get 资金归集明细

您可通过此API查询您连接会员的资金归集的明细。

query Parameters
memberId
string
Example: memberId=CM23120821531912

查询所指向的会员号，如不传则默认为token下的会员；如涉及matrix产品，如不传则指向会员和连接会员所有信息查询，或传入指定会员查询

createdAtStart
string
Example: createdAtStart=2023-12-03T11:52:00

交易创建时间查询开始

createdAtEnd
string
Example: createdAtEnd=2023-12-06T11:52:00

交易创建时间查询结束

transactionId
string

每笔资金归集交易的唯一ID

businessType
string
Enum: "collection" "account_transfer"
Example: businessType=collection

业务类型（account transfer暂不支持）

pageIndex
required
integer <int64>

当前页

pageSize
required
integer <int64>

分页大小

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

Array of objects (poolingDetailQueryResp)
msg
string

错误消息

pageIndex
integer <int64>

当前页

pageSize
integer <int64>

分页大小

total
integer <int64>

总记录数

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : [
    ] ,
  • "msg" : "succeed" ,
  • "pageIndex" : 1 ,
  • "pageSize" : 10 ,
  • "total" : 1
}

get 连接会员状态查询

你可以通过此api查询您某个连接会员的状态

path Parameters
memberId
required
string
Example: CM23120821531912

连接会员号

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
string

响应码

msg
string

消息

object

响应数据

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "msg" : "succeed" ,
  • "data" : {
    }
}

get 连接会员资料审核状态查询

你可以通过此api查询指定连接会员的资料审核状态。

query Parameters
memberId
required
string
Example: memberId=CM23120821531912

连接会员号

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
string

响应码

msg
string

消息

object

响应数据

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "msg" : "succeed" ,
  • "data" : {
    }
}

get 连接会员列表

你可以通过此api查询您目前所有创建的连接会员信息。

query Parameters
createdAtStart
string
Example: createdAtStart=2023-12-06T12:52:08

会员创建时间-开始

createdAtEnd
string
Example: createdAtEnd=2023-12-07T12:52:08

会员创建时间-结束

status
string
Example: status=init

Enum: "init" "activating" "activation_failed" "normal" "closed" "suspend" "terminated"

会员状态

pageIndex
required
string
Example: pageIndex=1

页码

pageSize
required
string
Example: pageSize=5

每页大小（不超过20）

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

Array of objects (ConnectMemberPageQueryRespDetail)
msg
String

错误消息

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : [
    ] ,
  • "msg" : "succeed"
}

get 连接会员配置历史

您可以通过这个API来查询您对每个连接会员的配置历史。

query Parameters
memberId
required
String
Example: memberId=CM23120817909136

查询所指向的会员号，如不传则默认为token下的会员；如涉及matrix产品，如不传则指向会员和连接会员所有信息查询，或传入指定会员查询。

pageIndex
required
integer <int64>
Example: pageIndex=1

当前页

pageSize
required
integer <int64>
Example: pageSize=20

分页大小

header Parameters
X-PD-TOKEN
required
String

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

Array of objects (ConnectMemberSetHistoryQueryRespDetail)
msg
String

错误消息

pageIndex
integer <int64>

当前页

pageSize
integer <int64>

分页大小

total
integer <int64>

总记录数

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : [
    ] ,
  • "msg" : "succeed" ,
  • "total" : "20," ,
  • "pageSize" : "10," ,
  • "pageIndex" : 1
}

get 可创建连接会员数

您可在这个API中可查询您剩余还可以创建的连接会员的数量。

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
String

响应的code 0000代表成功

data
Integer

您剩余还可以创建的连接会员的数量

msg
String

错误消息

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : 15 ,
  • "msg" : "succeed"
}

post 过期证件更新

您可以通过此接口更新连接会员的到期证件，证件更新后方可正常使用Photonpay提供的各项服务。

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
memberId
required
string

传入需要更新证件的连接会员号

required
object

证件过期信息map集合（可传多个不同的processInstanceId（支持批量修改过期证件，一种/个证件过期事件，对应一个processInstanceId））

Responses (200)

Response Schema: application/json
code
string

响应码

msg
string

消息

data
object

响应数据

Request samples

Content type
application/json
{
  • "memberId" : "CM234565228603" ,
  • "items" : {
    }
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "msg" : "succeed"
}

Matrix附录

主营产品类别

零售/批发(retail_wholesale)

Name Code
服装和配饰 120004
电子产品 120028
家用电器 120029
家居用品 120014
家具 120010
母婴用品 120017
美容和化妆品 120003
乐器 120018
办公和学校用品 120019
宠物用品 120021
玩具 120025
汽车零部件及配件 120001
汽车经销商 120002
成人用品 120000
眼镜和其他光学商品 120007
鲜花 120008
食品和饮料 120009
珠宝、宝石和贵金属 120015
园艺 120011
医疗器械 120016
医药保健品 120006
电子烟及相关产品 120026
机械设备 120030
纸制品 120031
其他 120027

广告与营销服务(advertising_marketing_v2)

Name Code
广告联盟 300000
广告代理与投放 300001
搜索引擎SEO营销 300002
电子邮件与短信营销 300003
社交媒体营销 300004
其他 300005

娱乐与游戏(entertainment_gaming_v2)

Name Code
短剧出海 310000
游戏 310001
社交媒体 310002
直播 310003
票务 310004
其他 310005

软件与IT服务(software_it_services_v2)

Name Code
软件开发服务 320000
SaaS平台 320001
AI与数据服务 320002
云服务 320003
其他 320004

物流运输(logistics_transportation_v2)

Name Code
跨境物流与运输 330000
货代与清关服务 330001
海运仓储 330002
空运仓储 330003
其他 330004

咨询服务(consulting_services_v2)

Name Code
人力资源解决方案 340000
技术和安全咨询 340001
市场准入和战略咨询 340002
法律咨询 340003
税务咨询服务 340004
其他 340005

航旅OTA(online_travel_agency_v2)

Name Code
海外酒店、机票、出行等 350000
其他 350001

其他(others)

Name Code
其他 220000

企业类型的连接会员支持的国家/地区列表

Name Code
香港 HK
中国 CN
英国 GB
奥地利 AT
比利时 BE
保加利亚 BG
塞浦路斯 CY
捷克共和国 CZ
克罗地亚 HR
丹麦 DK
爱沙尼亚 EE
芬兰 FI
法国 FR
德国 DE
希腊 GR
爱尔兰 IE
意大利 IT
拉脱维亚 LV
匈牙利 HU
立陶宛 LT
卢森堡 LU
马耳他 MT
荷兰 NL
波兰 PL
葡萄牙 PT
罗马尼亚 RO
斯洛伐克 SK
斯洛文尼亚 SI
西班牙 ES
瑞典 SE
美国 US
加拿大 CA
新加坡 SG
马来西亚 MY
泰国 TH
越南 VN
菲律宾 PH
韩国 KR
日本 JP
澳大利亚 AU
巴西 BR
墨西哥 MX
沙特阿拉伯 SA
阿拉伯联合酋长国 AE
卡塔尔 QA
科威特 KW
阿曼 OM
巴林 BH
埃及 EG
利比亚 LY
突尼斯 TN
阿尔及利亚 DZ
摩洛哥 MA
毛里塔尼亚 MR

协议

续签

post 协议续签

您可以通过此接口来续签协议或拒绝续签协议，如果 3 天内您未回复我们将默认认为您同意续签。

header Parameters
X-PD-SIGN
required
string

加签字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
memberIds
String[]

连接会员号，不填则默认表示主会员下所有的连接会员号

agreementId
required
string(64)

协议唯一标识

renewal
required
boolean

是否续签

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

msg
string

错误消息

data
boolean

操作结果

Request samples

Content type
application/json
{
  • "memberIds" : [
    ] ,
  • "agreementId" : "20230318100602008" ,
  • "renewal" : true
}

Response samples

Content type
application/json
{
  • "code" : "string" ,
  • "msg" : "string" ,
  • "data" : true
}

其它

文件

post 文件上传

文件上传接口，上传成功后，返回文件key。

path Parameters
businessKey
required
string

业务key。文件的业务类型，见业务接口说明。

query Parameters
memberId
string
Example: memberId=CM23120821531912

Matrix 连接会员 ID. 当文件用于连接会员相关 API 时必传，如， businessKey=matrix_member_kyc 。

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: multipart/form-data
file
required
File

要上传的文件

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

data
string

文件key

msg
string

错误消息

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : "c8lusdifTinsYw" ,
  • "msg" : "succeed"
}

通知订阅

Webhook 管理

Webhook 管理 提供一系列 API 便于您管理 Webhook 通知订阅。

查询 Webhook 订阅通知

查询所有您已订阅或可选择订阅的事件信息。Webhook类目，由一个或多个事件组成。其中，每个事件将支持一个或多个通知版本和模版。您将基于该查询接口返回的信息，选择订阅或者取消订阅 Webhook 通知。具体详情请查看返回报文。

订阅 Webhook 通知

订阅您需要的事件和模版。传入通过查询接口获得的 topicCode （事件的唯一标识）和其对应的 templateCode (模版唯一标识) 进行 Webhook 事件订阅。订阅成功后，您在商户端配置的 Webhook 地址将会接收到实时推送的通知信息。

如果您填写的 topicCode 错误，或者您填写的 templateCode 不属于当前事件，接口会返回错误信息，具体请看 响应码 。

您可根据实际需求，选择订阅您需要的事件和对应的模版。您也可以在后续迁移到更新的模版中，以获得更丰富的通知信息。

取消订阅 Webhook 通知

取消您的通知订阅。传入通过查询接口获得的 topicCode （事件的唯一标识）和其对应的 templateCode (模版唯一标识) 进行 Webhook 事件取消订阅。取消订阅后，您所配置的 Webhook 地址将不会收到后续的通知信息。

如果您填写的 topicCode 错误，或者您填写的 templateCode 不属于当前事件，接口会返回错误信息，具体请看 响应码 。

升级 Webhook 模版

如果您目前已订阅某一事件的其中一个模版，例如， 'TEMPLATE_CODE_1' ，而您希望迁移到该事件的另一模版，例如， 'TEMPLATE_CODE_2' 。您可直接使用 订阅 Webhook 通知 接口，尝试订阅同一个 topicCode ，但 templateCode 为 'TEMPLATE_CODE_2' 。系统会自动将您使用的模版从 'TEMPLATE_CODE_1' 变更为 'TEMPLATE_CODE_2' 。

get 查询 Webhook 订阅通知

查询所有可订阅或已订阅的 Webhook 通知信息

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
string

关于错误编码, 请查看总附录

object (Webhook 通知信息)

返回数据

msg
string

错误信息

Response samples

Content type
application/json
{
  • "code" : "string" ,
  • "data" : {
    } ,
  • "msg" : "string"
}

put 订阅 Webhook 通知

订阅 Webhook 通知

header Parameters
X-PD-SIGN
required
string

签名字段，参考 加签 步骤生成签名

X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
Array of objects (Webhook 通知订阅对象)

订阅对象数组

Responses (200)

Response Schema: application/json
code
string

关于错误编码, 请查看总附录

msg
string

错误信息

Request samples

Content type
application/json
{
  • "subscriptions" : [
    ]
}

Response samples

Content type
application/json
{
  • "code" : "string" ,
  • "msg" : "string"
}

del 取消订阅 Webhook 通知

取消 Webhook 通知订阅

query Parameters
topicCode
required
string

将要取消订阅的 Webhook 通知 Topic Code

templateCode
required
string

将要取消订阅的 Webhook 通知 Template Code

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
string

关于错误编码, 请查看总附录

msg
string

错误信息

Response samples

Content type
application/json
{
  • "code" : "string" ,
  • "msg" : "string"
}

SFTP 管理

SFTP 管理 提供一系列 API 便于您管理SFTP报表订阅。SFTP是PhotonPay可以提供的报表类下载。您可以在PhotonPay的VIP商户端，先进行SFTP账号申请、填写白名单地址。然后使用API发送请求，得到您想要的SFTP报表。成功接收的SFTP报表，可以在31天内进行下载。

查询SFTP可订阅报表

查询所有您可选择订阅的SFTP报表。您将基于该查询接口返回的信息，选择订阅或者取消订阅 SFTP报表。具体详情请查看返回报文。

查询SFTP已订阅报表

查询所有您已订阅的SFTP报表。您将基于该查询接口返回的信息，选择订阅或者取消订阅 SFTP报表。具体详情请查看返回报文。

订阅SFTP报表

订阅您需要的SFTP报表。传入通过查询接口获得的 topicCode （事件的唯一标识）进行 SFTP 报表订阅。订阅成功后，您在商户端配置的 SFTP白名单地址，将会接收到报表推送信息。

如果您填写的 topicCode 错误，接口会返回错误信息，具体请看 响应码 。

您可根据实际需求，选择订阅您需要的SFTP报表。

取消订阅SFTP报表

取消您的SFTP报表订阅。传入通过查询接口获得的 topicCode （事件的唯一标识）取消 SFTP 报表订阅。取消订阅后，您所配置的SFTP地址将不会收到后续的通知信息。

如果您填写的 topicCode 错误，接口会返回错误信息，具体请看 响应码 。

post 订阅SFTP报表

订阅SFTP报表

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
topicCodes
Array of strings (报表订阅/解除请求参数)

请求对象

Responses (200)

Response Schema: application/json
code
string

报表订阅/解除响应结果

data
boolean (报表订阅/解除响应结果)

响应结果（true/false）

msg
string

错误信息

Request samples

Content type
application/json
{
  • "topicCodes" : [
    ]
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : "true/false" ,
  • "msg" : "succeed"
}

post 取消订阅SFTP报表

取消订阅SFTP报表

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Request Body schema: application/json
topicCodes
Array of strings (报表订阅/解除请求参数)

请求对象

Responses (200)

Response Schema: application/json
code
string

报表订阅/解除响应结果

data
boolean (报表订阅/解除响应结果)

响应结果（true/false）

msg
string

错误信息

Request samples

Content type
application/json
{
  • "topicCodes" : [
    ]
}

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : "true/false" ,
  • "msg" : "succeed"
}

get 查询SFTP可订阅报表

查询SFTP可订阅报表

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

Array of objects (报表订阅响应结果)

响应结果

msg
string

错误信息

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : [
    ] ,
  • "msg" : "succeed"
}

get 查询SFTP已订阅报表

查询SFTP已订阅报表

header Parameters
X-PD-TOKEN
required
string

访问令牌，参考 Generate Token 获取访问令牌

Responses (200)

Response Schema: application/json
code
string

响应的code 0000代表成功

Array of objects (报表订阅响应结果)

响应结果

msg
string

错误信息

Response samples

Content type
application/json
{
  • "code" : "0000" ,
  • "data" : [
    ] ,
  • "msg" : "succeed"
}

收单通知

收单交易通知 Webhook

当交易有最终结果或者挂起后,通过交易的notifyUrl,和开发者webhook配置,开发平台会发送交易通知给商户,当接受不成功或者发送失败时, 交易会发8次, 时间间隔为5s,20s,1m,5m,30m,2h,24h

header Parameters
X-PD-NOTIFICATION-CATAGORY
required
string
Enum: "Payment" "Account" "issuing"
Example: Payment

通知种类

X-PD-NOTIFICATION-TYPE
required
string
Enum: "sale" "auth" "capture" "refund" "void" "mit"
Example: sale

通知子类

X-PD-SIGN
required
string

使用平台私钥对requestBody做了加签, 请使用平台公钥对requestBody做签名验证

Request Body schema: application/json
agreementNo
string

mit签约返回的凭证号

code
string
expiredAt
string
Value: "2022-03-18T08:43:27"

过期时间

invoiceDesc
string

票据号描述/还款指引

invoiceNo
string

票据号/还款码

issuerCountry
string

卡国家

maskCardNo
string

信用卡支付返回的卡号

memberNo
string

商户ID

msg
string

系统的交易结果描述

originReqId
string

原始请求号

payMethod
string

卡组

remark
string

请求的remark参数，原文返回

reqId
string

请求订单号

secure3d
string
Enum: "N" "Y"

是否3D支付

siteId
string

店铺号

status
string
Enum: "cancelled" "expired" "failed" "pending" "succeed" "suspend"

订单的状态

tokenExpiration
string
Value: "2025-06-01"

token快捷支付令牌过期时间

tokenization
string

创建token快捷支付返回的令牌

userLoginId
string

第三方用户登录账号

transactionId
string

交易订单号

amount
string

金额

currency
string

币种

Responses (200)

Response Schema: application/json
roger
required
boolean

Request samples

Content type
application/json
{
  • "code" : "0000" ,
  • "issuerCountry" : "US" ,
  • "maskCardNo" : "444433******1111" ,
  • "memberNo" : "2023010558663764" ,
  • "msg" : "succeed" ,
  • "payMethod" : "Discover" ,
  • "remark" : "remark" ,
  • "reqId" : "20230505103120" ,
  • "secure3d" : "N" ,
  • "siteId" : "20230105586637641001" ,
  • "status" : "succeed" ,
  • "transactionId" : "TR1654312800723537920" ,
  • "amount" : "90.37" ,
  • "currency" : "EUR"
}

Response samples

Content type
application/json
{
  • "roger" : true
}

拒付预警退款通知 Webhook

当收到拒付预警相关交易后，将通过notifyURL和开发者webhook配置，开发平台发送交易通知给客户，当接受不成功或者发送失败时, 交易会发8次, 时间间隔为5s,20s,1m,5m,30m,2h,24h

header Parameters
X-PD-NOTIFICATION-CATAGORY
required
string
Value: "Payment"
Example: Payment

通知种类

X-PD-NOTIFICATION-TYPE
required
string
Enum: "chargeback_alert_refund" "chargeback_alert_refund_reversal"
Example: chargeback_alert_refund

通知子类

X-PD-SIGN
required
string

使用平台私钥对requestBody做了加签, 请使用平台公钥对requestBody做签名验证

Request Body schema: application/json
chargebackAlertRefundAmount
BigDecimal

拒付预警退款金额

chargebackAlertRefundCurrency
string

拒付预警退款币种

chargebackAlertRefundReversalAmount
BigDecimal

拒付预警退款撤销金额

chargebackAlertRefundReversalCurrency
string

拒付预警退款撤销币种

code
string
maskCardNo
string

信用卡支付返回的卡号

memberNo
string

商户ID

msg
string

系统的交易结果描述

originTransactionId
string

原始交易订单号

originTransactionAmount
BigDecimal

原始交易金额

originTransactionArn
string

原始订单arn

originTransactionCurrency
string

原始交易币种

originTransactedAt
string
Value: "2022-03-18T08:43:28"

原始交易时间

originReqId
string

原始请求号

siteId
string

店铺号

status
string
Enum: "cancelled" "expired" "failed" "pending" "succeed" "suspend"

订单的状态

transactionId
string

交易订单号

Responses (200)

Response Schema: application/json
roger
required
boolean

Request samples

Content type
application/json
{
  • "chargebackAlertRefundAmount" : "88.980000" ,
  • "chargebackAlertRefundCurrency" : "USD" ,
  • "code" : "0000" ,
  • "maskCardNo" : "444433******1111" ,
  • "memberNo" : "2023032296079087" ,
  • "msg" : "succeed" ,
  • "originTransactionAmount" : "88.980000" ,
  • "originTransactionArn" : "84298253093910007090001" ,
  • "originTransactionCurrency" : "USD" ,
  • "originTransactedAt" : "2023-04-02T14:46:01.710" ,
  • "originReqId" : "221172023040255554810001" ,
  • "siteId" : "20230322960790871003" ,
  • "status" : "succeed" ,
  • "transactionId" : "TR1642538877166161921"
}

Response samples

Content type
application/json
{
  • "roger" : true
}

拒付预警通知 Webhook

当收到拒付预警相关交易后，将通过notifyURL和开发者webhook配置，开发平台发送交易通知给客户，当接受不成功或者发送失败时, 交易会发8次, 时间间隔为5s,20s,1m,5m,30m,2h,24h

header Parameters
X-PD-NOTIFICATION-CATAGORY
required
string
Value: "Payment"
Example: Payment

通知种类

X-PD-NOTIFICATION-TYPE
required
string
Value: "chargeback_alert"
Example: chargeback_alert

通知子类

X-PD-SIGN
required
string

使用平台私钥对requestBody做了加签, 请使用平台公钥对requestBody做签名验证

Request Body schema: application/json
chargebackAlertAmount
BigDecimal

拒付预警金额

chargebackAlertCurrency
string

拒付预警币种

chargebackAlertAt
string
Value: "2022-03-18T08:43:28"

拒付预警发生时间

maskCardNo
string

卡号

memberNo
string

商户ID

originTransactionAmount
BigDecimal

原始交易金额

originTransactionId
string

原始订单ID

originTransactionArn
string

原始订单arn

originTransactionCurrency
string

原始交易币种

originTransactedAt
string
Value: "2022-03-18T08:43:28"

原始交易时间

originReqId
string

原始请求号

reasonCode
string

原因码

siteId
string

店铺号

status
string
Enum: "Accepted" "Decline"

状态，Accepted表示已退款 ，Decline 表示争议处理

caseId
string

拒付预警ID

Responses (200)

Response Schema: application/json
roger
required
boolean

Request samples

Content type
application/json
{
  • "chargebackAlertAmount" : 66.89 ,
  • "chargebackAlertCurrency" : "USD" ,
  • "chargebackAlertAt" : "2023-05-18T20:06:42" ,
  • "maskCardNo" : "414740******51xx" ,
  • "memberNo" : "2022072539xxxxxx" ,
  • "originTransactionArn" : "74298253106910001xxxxxx" ,
  • "originReqId" : "VAR2211720230416555255xxxxxx" ,
  • "originTransactionAmount" : 66.89 ,
  • "originTransactionCurrency" : "USD" ,
  • "originTransactedAt" : "2023-04-15T20:30:47.693" ,
  • "originTransactionId" : "TR1647336690429xxxxxx" ,
  • "reasonCode" : "13.3" ,
  • "siteId" : "20220725394293xxxxxx" ,
  • "status" : "Accepted"
}

Response samples

Content type
application/json
{
  • "roger" : true
}

拒付通知 Webhook

当收到拒付交易后，将通过notifyURL和开发者webhook配置，开发平台发送交易通知给客户，当接受不成功或者发送失败时, 交易会发8次, 时间间隔为5s,20s,1m,5m,30m,2h,24h

header Parameters
X-PD-NOTIFICATION-CATAGORY
required
string
Value: "Payment"
Example: Payment

通知种类

X-PD-NOTIFICATION-TYPE
required
string
Value: "chargeback"
Example: chargeback

通知子类

X-PD-SIGN
required
string

使用平台私钥对requestBody做了加签, 请使用平台公钥对requestBody做签名验证

Request Body schema: application/json
memberNo
string

商户ID

siteId
string

店铺号

originReqId
string

原始商户请求号

originTransactionId
string

原始交易订单号

chargebackId
string

拒付订单号

chargebackAmount
string

拒付金额

chargebackCurrency
string

拒付币种

postDate
string
Value: "2022-01-15"

拒付发生日期

deadLine
string
Value: "2022-01-15"

最后期限

category
string
Enum: "retrieval" "fraud" "authorization" "processing_errors" "consumer_disputes" "check_restraint" "others"

拒付原因类别。retrieval表示调单，fraud表示欺诈，authorization表示授权，processing_errors表示处理错误，consumer_disputes表示消费争议，check_restraint表示查复约束，others表示其他。

chargebackType
string
Enum: "retrieval" "1st_chargeback" "chargeback_reversal" "pre_arbitration" "arbitration"

拒付类型。retrieval表示调单，1st_chargeback表示一次拒付，chargeback_reversal表示拒付撤销，pre_arbitration表示预仲裁，arbitration表示仲裁。

status
string
Enum: "refunded" "pending" "processed" "modifyed" "cancelled" "waive_expired" "waived" "succeed" "failed"

拒付状态。refunded表示已退款，pending表示待处理，processed表示已处理，modifyed表示待修改，cancelled表示已撤诉，waive_expired表示申诉过期，waived表示放弃申诉，succeed表示成功，failed表示失败。

reasonCode
string

原因码

originTransactionArn
string

原始订单arn

Responses (200)

Response Schema: application/json
roger
required
boolean

Request samples

Content type
application/json
{
  • "memberNo" : "2021051887390407" ,
  • "siteId" : "2022011443592264001" ,
  • "originReqId" : "1482310077061931008" ,
  • "originTransactionId" : "TR1482310077061931008" ,
  • "chargebackId" : "CBZ1482310077061931008" ,
  • "chargebackAmount" : "91.38" ,
  • "chargebackCurrency" : "EUR" ,
  • "postDate" : "2022-01-15" ,
  • "deadLine" : "2022-02-01" ,
  • "category" : "retrieval" ,
  • "chargebackType" : "1st_chargeback" ,
  • "status" : "processed" ,
  • "reasonCode" : "6322" ,
  • "originTransactionArn" : "75313218976763237890681"
}

Response samples

Content type
application/json
{
  • "roger" : true
}

资金退回通知 Webhook

当收到资金退回交易后，将通过notifyURL和开发者webhook配置，开发平台发送交易通知给客户，当接受不成功或者发送失败时, 交易会发8次, 时间间隔为5s,20s,1m,5m,30m,2h,24h

header Parameters
X-PD-NOTIFICATION-CATAGORY
required
string
Value: "Payment"
Example: Payment

通知种类

X-PD-NOTIFICATION-TYPE
required
string
Value: "fund_return"
Example: fund_return

通知子类

X-PD-SIGN
required
string

使用平台私钥对requestBody做了加签, 请使用平台公钥对requestBody做签名验证

Request Body schema: application/json
memberNo
string

商户ID

siteId
string

店铺号

originReqId
string

原始商户请求号

originTransactionId
string

原始交易订单号

transactionId
string

交易订单号

amount
string

金额

currency
string

币种

status
string
Value: "succeed"

订单的状态

code
string
msg
string

系统的交易结果描述

Responses (200)

Response Schema: application/json
roger
required
boolean

Request samples

Content type
application/json
{
  • "memberNo" : "2021051887390407" ,
  • "siteId" : "2022011443592264001" ,
  • "originReqId" : "1482310077061931008" ,
  • "originTransactionId" : "TR1482310077061931008" ,
  • "transactionId" : "TR1596232018756092156" ,
  • "amount" : "91.38" ,
  • "currency" : "EUR" ,
  • "status" : "succeed" ,
  • "code" : "0000" ,
  • "msg" : "succeed"
}

Response samples

Content type
application/json
{
  • "roger" : true
}

token解绑通知 Webhook

当光子易账户通知令牌已删除后，将通过开发者webhook配置，开发平台发送通知给客户，当接受不成功或者发送失败时, 通知会发8次, 时间间隔为5s,20s,1m,5m,30m,2h,24h

header Parameters
X-PD-NOTIFICATION-CATAGORY
required
string
Value: "Payment"
Example: Payment

通知种类

X-PD-NOTIFICATION-TYPE
required
string
Value: "tokenization"
Example: tokenization

通知子类

X-PD-SIGN
required
string

使用平台私钥对requestBody做了加签, 请使用平台公钥对requestBody做签名验证

Request Body schema: application/json
memberNo
string

商户ID

tokenization
string

令牌信息

status
string
Value: "deleted"

删除状态

userLoginId
string

第三方用户登录账号

Responses (200)

Response Schema: application/json
roger
required
boolean

Request samples

Content type
application/json
{
  • "memberNo" : "2021051887390407" ,
  • "tokenization" : "d7ehlmazueEKio" ,
  • "status" : "deleted" ,
  • "userLoginId" : "62-***5156"
}

Response samples

Content type
application/json
{
  • "roger" : true
}

Mit解约通知 Webhook

当收到MIT解约后，将通过开发者webhook配置，开发平台发送MIT解约通知给客户，当接收不成功或者发送失败时, 通知会发8次, 时间间隔为5s,20s,1m,5m,30m,2h,24h

header Parameters
X-PD-NOTIFICATION-CATAGORY
required
string
Value: "Payment"
Example: Payment

通知种类

X-PD-NOTIFICATION-TYPE
required
string
Value: "mit"
Example: mit

通知子类

X-PD-SIGN
required
string

使用平台私钥对requestBody做了加签, 请使用平台公钥对requestBody做签名验证

Request Body schema: application/json
memberNo
string

商户ID

agreementNo
string

签约协议号

status
string
Value: "deleted"

状态

Responses (200)

Response Schema: application/json
roger
required
boolean

Request samples

Content type
application/json
{
  • "memberNo" : "2021051887390407" ,
  • "agreementNo" : "cjCawph0qJgpog" ,
  • "status" : "deleted"
}

Response samples

Content type
application/json
{
  • "roger" : true
}

订阅通知 Webhook

订阅通知，当接受不成功或者发送失败时, 会重发8次, 时间间隔为5s,20s,1m,5m,30m,2h,24h

header Parameters
X-PD-NOTIFICATION-CATAGORY
required
string
Value: "Subscription"
Example: Subscription

通知种类

X-PD-NOTIFICATION-TYPE
required
string
Enum: "subscription.created" "subscription.canceled" "subscription.paused" "subscription.updated"
Example: subscription.created

通知子类

X-PD-SIGN
required
string

使用平台私钥对requestBody做了加签, 请使用平台公钥对requestBody做签名验证

Request Body schema: application/json
subscriptionId
string

订阅ID

status
string
Enum: "trialing" "active" "paused" "past_due" "cancelled" "terminated"

订阅状态

shopperId
string

客户ID

priceId
string

价格计划ID

productId
string

产品ID

amount
string

金额

currency
string

币种

currentPeriodStart
string

当前计费周期开始

currentPeriodEnd
string

当前计费周期结束

trialStart
string

试用开始时间

trialEnd
string

试用结束时间

cancelledAt
string

订阅取消时间

pauseStart
string

暂停生效时间

pauseResumesAt
string

计划恢复时间

terminatedAt
string

订阅终止时间

pauseReason
string

暂停原因

remainingPauseDays
integer

剩余暂停天数

metadata
string

商户上传的自定义数据

Responses (200)

Response Schema: application/json
roger
required
boolean

Request samples

Content type
application/json
{
  • "subscriptionId" : "sub_20250808123456" ,
  • "status" : "active" ,
  • "shopperId" : "" ,
  • "productId" : "" ,
  • "priceId" : "" ,
  • "amount" : "998.00" ,
  • "currency" : "USD" ,
  • "currentPeriodStart" : "" ,
  • "currentPeriodEnd" : "" ,
  • "trialStart" : "" ,
  • "trialEnd" : "" ,
  • "cancelledAt" : "" ,
  • "pauseStart" : "" ,
  • "pauseResumesAt" : "" ,
  • "pauseReason" : "" ,
  • "remainingPauseDays" : "" ,
  • "resumed_at" : "" ,
  • "metadata" : ""
}

Response samples

Content type
application/json
{
  • "roger" : true
}

订阅账单通知 Webhook

订阅账单通知，当接受不成功或者发送失败时, 会重发8次, 时间间隔为5s,20s,1m,5m,30m,2h,24h

header Parameters
X-PD-NOTIFICATION-CATAGORY
required
string
Value: "SubscriptionInvoice"
Example: SubscriptionInvoice

通知种类

X-PD-NOTIFICATION-TYPE
required
string
Enum: "invoice.paid" "invoice.failed" "invoice.past_due" "invoice.voided"
Example: invoice.paid

通知子类

X-PD-SIGN
required
string

使用平台私钥对requestBody做了加签, 请使用平台公钥对requestBody做签名验证

Request Body schema: application/json
subscriptionId
string

订阅ID

invoiceId
string

账单ID

status
string
Enum: "paid" "failed" "pending" "past_due" "voided"

支付状态

productId
string

产品ID

productName
string

产品名称

priceId
string

价格ID

amount
string

账单金额

currency
string

币种

attemptCount
integer

支付重试次数

updatedAt
string

账单状态更新时间

periodStart
string

订阅周期开始时间

periodEnd
string

订阅周期结束时间

failureReason
string

支付失败原因

Responses (200)

Response Schema: application/json
roger
required
boolean

Request samples

Content type
application/json
{
  • "subscriptionId" : "sub_20250808123456" ,
  • "invoiceId" : "" ,
  • "status" : "paid" ,
  • "productName" : "" ,
  • "productId" : "" ,
  • "priceId" : "" ,
  • "currentPeriodEnd" : "" ,
  • "amount" : "998.00" ,
  • "attemptCount" : 0 ,
  • "updatedAt" : "" ,
  • "periodStart" : "" ,
  • "periodEnd" : "" ,
  • "failureReason" : "system error"
}

Response samples

Content type
application/json
{
  • "roger" : true
}

收款通知

全球账户入账通知 Webhook

当全球账户入账流水成功入账，通过开发者webhook配置，开发平台会发送入账成功通知给商户，当接受不成功或者发送失败时, 会重发8次, 时间间隔为5s,20s,1m,5m,30m,2h,24h

header Parameters
X-PD-NOTIFICATION-CATAGORY
required
string
Value: "GlobalAccount"
Example: GlobalAccount

通知种类

X-PD-NOTIFICATION-TYPE
required
string
Value: "settle"
Example: settle

通知子类

X-PD-SIGN
required
string

使用平台私钥对requestBody做了加签, 请使用平台公钥对requestBody做签名验证

Request Body schema: application/json
memberId
string

会员ID；如涉及matrix产品，返回对应的会员或连接会员信息。

certificationDocumentStatus
string
Enum: "dd" "dd_pending" "rejected"

证明文件状态，有待提交、审核中、审核不通过

createdAt
string
Value: "2023-03-17T08:43:27"

交易时间

creditAmount
number

入账金额

creditCurrency
string

入账币种 ISO4217

discountAmount
number

手续费优惠金额，当结算状态为success时才返回。

discountCurrency
string

手续费优惠币种，当结算状态为success时才返回。 ISO4217

feeAmount
number

手续费金额，当结算状态为success时才返回。

feeCurrency
string

手续费币种，当结算状态为success时才返回。 ISO4217

globalAccountNo
string

全球账户编号

payerAccount
string

付款方账户

payerName
string

付款方名称

paymentReference
string

付款附言

settlementAmount
number

结算金额，指入账金额扣除手续费和优惠金额后的金额，当结算状态为success时才返回。

settlementCurrency
string

结算币种，当结算状态为success时才返回。 ISO4217

settlementNo
string

结算单号

settlementStatus
string
Enum: "processing" "success" "rejected"

结算状态

settlementAt
string
Value: "2023-03-18T08:43:27"

结算时间，订单未到终态不返回

Responses (200)

Response Schema: application/json
roger
required
boolean

Request samples

Content type
application/json
{
  • "memberId" : "2022122256879107" ,
  • "certificationDocumentStatus" : "" ,
  • "createdAt" : "2023-03-17T08:43:27" ,
  • "creditAmount" : 10000 ,
  • "creditCurrency" : "USD" ,
  • "discountAmount" : 0 ,
  • "discountCurrency" : "" ,
  • "feeAmount" : 122 ,
  • "feeCurrency" : "USD" ,
  • "globalAccountNo" : "20230115105124" ,
  • "payerAccount" : "20230115105124" ,
  • "payerName" : "AMZ" ,
  • "paymentReference" : "" ,
  • "settlementAmount" : 9878 ,
  • "settlementCurrency" : "USD" ,
  • "settlementNo" : "GDO1654329077441630208" ,
  • "settlementStatus" : "success" ,
  • "settlementAt" : "2023-03-18T08:43:27"
}

Response samples

Content type
application/json
{
  • "roger" : true
}

全球账户申请通知 Webhook

当申请GA有最终结果，通过开发者webhook配置，开发平台会发送申请结果通知给商户，当接受不成功或者发送失败时, 会重发8次, 时间间隔为5s,20s,1m,5m,30m,2h,24h

header Parameters
X-PD-NOTIFICATION-CATAGORY
required
string
Value: "GlobalAccount"
Example: GlobalAccount

通知种类

X-PD-NOTIFICATION-TYPE
required
string
Value: "apply"
Example: apply

通知子类

X-PD-SIGN
required
string

使用平台私钥对requestBody做了加签, 请使用平台公钥对requestBody做签名验证

Request Body schema: application/json
memberId
string

会员ID；如涉及matrix产品，返回对应的会员或连接会员信息。

object (gaApplyAccInfoRespDataAccInfoData)

账户信息

applicationId
string

平台生成的申请单号

applicationStatus
string
Enum: "allocating" "success" "fail"

全球账户申请状态，有分配中、成功、失败

applicationType
string
Enum: "free" "offline_purchase" "online_purchase"

全球账户申请的类型，有免费/线下购买/线上购买

applyCurrency
string

申请币种 ISO4217

useTypeCode
string

全球账户的用途，详情可看全球账户附录

payableObjects
string

当申请类型为线上购买时返回，返回付费会员编号

Responses (200)

Response Schema: application/json
roger
required
boolean

Request samples

Content type
application/json
{
  • "accountInfo" : {
    } ,
  • "applicationId" : "AN1654328340720521216" ,
  • "applicationStatus" : "success" ,
  • "applicationType" : "free" ,
  • "applyCurrency" : "USD" ,
  • "useTypeCode" : "UT202205051026295894" ,
  • "memberId" : 2022122256879107 ,
  • "payableObjects" : 2022122256879107
}

Response samples

Content type
application/json
{
  • "roger" : true
}

全球账户注销通知 Webhook

全球账户注销成功结果通知。当GA注销成功时，通过开发者webhook配置，开发平台会发送注销成功结果通知给商户，当接受不成功或者发送失败时, 会重发8次, 时间间隔为5s,20s,1m,5m,30m,2h,24h

header Parameters
X-PD-NOTIFICATION-CATAGORY
required
string
Value: "GlobalAccount"
Example: GlobalAccount

通知种类

X-PD-NOTIFICATION-TYPE
required
string
Value: "close"
Example: close

通知子类

X-PD-SIGN
required
string

使用平台私钥对requestBody做了加签, 请使用平台公钥对requestBody做签名验证

Request Body schema: application/json
memberId
string

会员ID；如涉及matrix产品，返回对应的会员或连接会员信息。

globalAccountNo
string

全球账户编号

accountCurrency
string

币种 ISO4217

status
string
Value: "success"

注销处理状态，成功

accountStatus
string
Value: "closed"

全球账户状态，已注销

Responses (200)

Response Schema: application/json
roger
required
boolean

Request samples

Content type
application/json
{
  • "memberId" : "2022122256879107" ,
  • "globalAccountNo" : "123456" ,
  • "accountCurrency" : "USD" ,
  • "status" : "success" ,
  • "accountStatus" : "closed"
}

Response samples

Content type
application/json
{
  • "roger" : true
}

提交入账凭证通知 Webhook

提交入账凭证通知。当一笔结算订单被风控DD打回时，通过开发者webhook配置，开发平台会发送提交入账凭证通知给商户，当接受不成功或者发送失败时, 会重发8次, 时间间隔为5s,20s,1m,5m,30m,2h,24h。

当certificationDocumentStatus返回dd_order时，说明结算交易需要新增入账凭证，具体原因请看orderReason。调用流程：
1、请求“新增入账凭证”接口，根据不同的入账凭证类型提交对应材料（注意：不同凭证类型，提交的字段不一样）；
2、请求“确认或取消关联入账凭证”接口；
当certificationDocumentStatus返回dd时，说明结算交易关联的入账凭证需要修改，具体原因请看modifyCertificateList。
1、请求“修改入账凭证”接口，针对需要修改字段请求；
2、请求“确认或取消关联入账凭证”接口。

header Parameters
X-PD-NOTIFICATION-CATAGORY
required
string
Value: "GlobalAccount"
Example: GlobalAccount

通知种类

X-PD-NOTIFICATION-TYPE
required
string
Value: "submitCertificate"
Example: submitCertificate

通知子类

X-PD-SIGN
required
string

使用平台私钥对requestBody做了加签, 请使用平台公钥对requestBody做签名验证

Request Body schema: application/json
memberId
string

会员ID；如涉及matrix产品，返回对应的会员或连接会员信息。

globalAccountNo
string

全球账户编号

createdAt
string
Value: "2023-03-17T08:43:27"

交易时间

settlementNo
string

结算单号

creditAmount
number

到账金额

creditCurrency
string

到账币种 ISO4217

settlementAmount
number

结算金额，指入账金额扣除手续费和优惠金额后的金额，当结算状态为success时才返回。

settlementCurrency
string

结算币种 ISO4217 ，当结算状态为success时才返回。

settlementStatus
string
Enum: "processing" "success" "rejected"

结算状态，待结算、结算成功、拒绝结算

settlementAt
string
Value: "2023-03-18T08:43:27"

结算时间，当结算状态为success时才返回。

feeAmount
number

手续费金额，当结算状态为success时才返回。

feeCurrency
string

手续费币种 ISO4217 ，当结算状态为success时才返回。

payerName
string

付款方名称

payerAccount
string

付款方账户

discountAmount
number

手续费优惠金额，当结算状态为success时才返回。

discountCurrency
string

手续费优惠币种 ISO4217 ，当结算状态为success时才返回。

paymentReference
string

付款附言

certificationDocumentStatus
string
Enum: "dd" "dd_order" "dd_pending" "rejected"

证明文件状态，dd指需要修改入账凭证、dd_order指该笔交易需要提交入账凭证，dd_pending指审核中、rejected指审核不通过

orderReason
string

订单异常原因，当证明文件状态是dd_order时返回。

entryVoucherType
String(64)
Enum: "b2b" "commerce" "webapp" "same_recharge" "e_wallet" "other"

入账凭证类型，详情可看全球账户附录中的入账凭证类型。

Array of objects (webhookGaSubmitCertificateRespCertificateInfo)

待完善的入账凭证

Responses (200)

Response Schema: application/json
roger
required
boolean

Request samples

Content type
application/json
{
  • "memberId" : "2022122256879107" ,
  • "globalAccountNo" : "123456" ,
  • "createdAt" : "2023-03-17T08:43:27" ,
  • "settlementNo" : "GDO1686996472291266560" ,
  • "creditAmount" : 100 ,
  • "creditCurrency" : "USD" ,
  • "settlementAmount" : 90 ,
  • "settlementCurrency" : "USD" ,
  • "settlementStatus" : "success/rejected/processing" ,
  • "settlementAt" : "2023-03-18T08:43:27" ,
  • "feeAmount" : 10 ,
  • "feeCurrency" : "USD" ,
  • "payerName" : "zhangsan" ,
  • "payerAccount" : "123" ,
  • "discountAmount" : 0 ,
  • "discountCurrency" : "USD" ,
  • "paymentReference" : "abcd" ,
  • "certificationDocumentStatus" : "dd/dd_order/dd_pending/rejected" ,
  • "orderReason" : "aaabbb" ,
  • "entryVoucherType" : "b2b" ,
  • "modifyCertificateList" : [
    ]
}

Response samples

Content type
application/json
{
  • "roger" : true
}

发卡通知

发卡交易通知 Webhook

当卡片发生交易之后，每笔交易我们都将通过此接口实时发送通知给商户，可以通过此接口来记录每笔交易。当接受不成功或者发送失败时, 会重发8次, 时间间隔为5s,20s,1m,5m,30m,2h,24h。

header Parameters
X-PD-NOTIFICATION-CATAGORY
required
string
Value: "issuing"
Example: issuing

通知种类

X-PD-NOTIFICATION-TYPE
required
string
Enum: "auth" "corrective_auth" "verification" "void" "refund" "corrective_refund" "corrective_refund_void" "recharge" "recharge_return" "discard_recharge_return" "service_fee" "refund_reversal" "fund_in" "atm_inquiry" "atm_withdrawals"
Example: auth

通知子类

X-PD-SIGN
required
string

使用平台私钥对requestBody做了加签, 请使用平台公钥对requestBody做签名验证

Request Body schema: application/json
memberId
string

会员号

matrixAccount
string(64)

matrix账户号

createdAt
string
Value: "2022-03-18T08:43:28"

创建时间

updatedAt
string
Value: "2022-03-18T08:43:28"

更新时间

cardId
string

卡ID

cardType
string
Enum: "share" "recharge"

卡类型。share： 共享卡； recharge： 常规卡。

transactionId
string

交易ID

originTransactionId
string

原始交易ID

requestId
string

商户请求ID

transactionType
string
Enum: "auth" "corrective_auth" "verification" "void" "refund" "corrective_refund" "corrective_refund_void" "recharge" "recharge_return" "discard_recharge_return" "service_fee" "refund_reversal" "fund_in" "atm_inquiry" "atm_withdrawals"

交易类型，具体交易类型中文说明可以查看 发卡交易类型枚举值

status
string
Enum: "pending" "authorized" "succeed" "failed" "void" "processing"

状态

code
string

状态码

msg
string

状态描述

mcc
string

商户类别码

authCode
string

授权码

transactionAmount
number

交易金额

transactionCurrency
string

交易币种

txnPrincipalChangeAccount
string
Enum: "member" "matrix" "card"

交易本金变动账户。member：会员光子易账户；matrix：Matrix账户；card：常规卡账户

txnPrincipalChangeAmount
number

交易本金预授权金额

txnPrincipalChangeCurrency
string

交易本金变动币种

feeDeductionAccount
string
Enum: "member" "matrix" "card"

手续费扣费账户。member：会员光子易账户；matrix：Matrix账户；card：常规卡账户

feeDeductionAmount
number

手续费扣费金额

feeDeductionCurrency
string

手续费扣费币种

feeDetailJson
json

手续费扣费金额明细。transactionFeeAmount：交易手续费金额；crossBroadFeeAmount：跨境手续费金额；conversionFeeAmount：汇率转换费金额；refundFeeAmount：退款手续费金额；voidFeeAmount：撤销手续费金额；gatewayFeeAmount：网关手续费金额；authFailedFeeAmount：失败交易手续费金额；fundInFeeAmount：汇入手续费金额；applePayCostFeeAmount：apply支付成本金额

feeReturnAccount
string
Enum: "member" "matrix" "card"

手续费返还账户。member：会员光子易账户；matrix：Matrix账户；card：常规卡账户

feeReturnAmount
number

手续费返还金额

feeReturnCurrency
string

手续费返还币种

feeReturnDetailJson
json

手续费返还金额明细。transactionFeeReturnAmount：交易手续费退回金额；crossBroadFeeReturnAmount：跨境手续费退回金额；conversionFeeReturnAmount：汇率转换费退回金额；gatewayFeeReturnAmount：网关手续费返还金额；refundFeeReturnAmount：退款手续费返还金额；applePayCostFeeReturnAmount：apply支付成本返还金额

arrivalAccount
string
Enum: "member" "matrix" "card"

到账账户。member：会员光子易账户；matrix：Matrix账户；card：常规卡账户

arrivalAmount
number

到账金额

merchantNameLocation
string

商户名称

merchantLocation
string

商户所在国家

cardBalance
number

常规卡金额

availableTransactionLimit
number

共享卡可交易额度

Responses (200)

Response Schema: application/json
roger
required
boolean

Request samples

Content type
application/json
{
  • "arrivalAccount" : "card" ,
  • "arrivalAmount" : "28.000000" ,
  • "cardId" : "XR1654317402873270272" ,
  • "code" : "0000" ,
  • "createdAt" : "2021-06-01T09:55:04" ,
  • "updatedAt" : "2021-06-01T09:55:04" ,
  • "feeDeductionAccount" : "card" ,
  • "feeDeductionAmount" : "-2.000000" ,
  • "feeDeductionCurrency" : "USD" ,
  • "feeDetailJson" : {
    } ,
  • "feeReturnAccount" : "" ,
  • "feeReturnAmount" : "0" ,
  • "feeReturnCurrency" : "" ,
  • "feeReturnDetailJson" : { } ,
  • "matrixAccount" : "" ,
  • "memberId" : "2023010558663764" ,
  • "merchantNameLocation" : "" ,
  • "merchantLocation" : "" ,
  • "msg" : "succeed" ,
  • "mcc" : 1234 ,
  • "authCode" : 123456 ,
  • "originTransactionId" : "" ,
  • "requestId" : "20230505104936" ,
  • "status" : "succeed" ,
  • "transactionAmount" : "30" ,
  • "transactionCurrency" : "USD" ,
  • "transactionId" : "IT1654317408736907264" ,
  • "transactionType" : "recharge" ,
  • "txnPrincipalChangeAccount" : "member" ,
  • "txnPrincipalChangeAmount" : "-30.000000" ,
  • "txnPrincipalChangeCurrency" : "USD"
}

Response samples

Content type
application/json
{
  • "roger" : true
}

发卡交易结算通知 Webhook

当卡片发生交易结算之后，每笔交易结算我们都将通过此接口实时发送通知给商户，可以通过此接口来记录每笔交易结算。当接受不成功或者发送失败时, 会重发8次, 时间间隔为5s,20s,1m,5m,30m,2h,24h。

header Parameters
X-PD-NOTIFICATION-CATAGORY
required
string
Value: "issuing_settlement"
Example: issuing_settlement

通知种类

X-PD-NOTIFICATION-TYPE
required
string
Enum: "auth" "verification" "refund" "fund_in"
Example: auth

通知子类

X-PD-SIGN
required
string

使用平台私钥对requestBody做了加签, 请使用平台公钥对requestBody做签名验证

Request Body schema: application/json
transactionId
string

交易ID

originTransactionId
string

原始交易ID

cardId
string

卡ID

transactionType
string
Enum: "auth" "verification" "refund" "fund_in"

交易类型

transactionStatus
string
Value: "succeed"

交易状态

transactionHappenedAt
string
Value: "2022-03-18T08:43:28"

交易发生时间

transactionAmount
number

交易金额

transactionCurrency
string

交易币种

mcc
string

商户类别码

merchantName
string

商户名

transactionCountry
string

交易国

authCode
string

授权码

settleAmount
number

结算金额

settleCurrency
string

结算币种

Responses (200)

Response Schema: application/json
roger
required
boolean

Request samples

Content type
application/json
{
  • "transactionId" : "IT1654317408736907264" ,
  • "originTransactionId" : "" ,
  • "transactionType" : "auth" ,
  • "cardId" : "XR1654317402873270272" ,
  • "transactionStatus" : "succeed" ,
  • "transactionHappenedAt" : "2024-06-01T09:55:04" ,
  • "transactionAmount" : "2.000000" ,
  • "transactionCurrency" : "USD" ,
  • "mcc" : 1234 ,
  • "merchantName" : "" ,
  • "transactionCountry" : "HK" ,
  • "authCode" : 123456 ,
  • "settleAmount" : "-2.000000" ,
  • "settleCurrency" : "USD"
}

Response samples

Content type
application/json
{
  • "roger" : true
}

卡状态通知 Webhook

当卡状态发生变更，将通过此api进行通知。将通过notifyURL和开发者webhook配置，开发平台发送交易通知给客户，当接受不成功或者发送失败时, 交易会发8次, 时间间隔为5s,20s,1m,5m,30m,2h,24h

header Parameters
X-PD-NOTIFICATION-CATAGORY
required
string
Value: "issuing_card"
Example: issuing_card

通知种类

X-PD-NOTIFICATION-TYPE
required
string
Value: "card_status_update"
Example: card_status_update

通知子类

X-PD-SIGN
required
string

使用平台私钥对requestBody做了加签, 请使用平台公钥对requestBody做签名验证

Request Body schema: application/json
memberId
string

会员ID

matrixAccount
string

Matrix账户ID

cardId
string

卡ID

cardNumber
string

卡号（掩码）

cardholderId
string

用卡人id

cardStatus
string

卡状态

produceStatus
string
Enum: "pending:处理中" "produced:制卡完成"

制卡状态

trackingNumber
string

物流单号

updatedAt
string
Value: "2022-03-18T08:43:28"

更新时间

Responses (200)

Response Schema: application/json
roger
required
boolean

Request samples

Content type
application/json
{
  • "memberId" : "2022180487046522" ,
  • "matrixAccount" : "MI1523959315646517248" ,
  • "cardId" : "XR1392717647736606720" ,
  • "cardNumber" : "658796****1233" ,
  • "cardholderId" : "CH1654040500572917760" ,
  • "cardStatus" : "cancelled" ,
  • "produceStatus" : "pending" ,
  • "trackingNumber" : "TN123578203799" ,
  • "updatedAt" : "2022-03-18T08:43:27"
}

Response samples

Content type
application/json
{
  • "roger" : true
}

用卡人审核状态变更通知 Webhook

当用卡人身份审核状态变更时，通过此接口实时发送通知给商户。当接收不成功或者发送失败时, 会重发8次, 时间间隔为5s,20s,1m,5m,30m,2h,24h。

header Parameters
X-PD-NOTIFICATION-CATAGORY
required
string
Value: "issuing"
Example: issuing

通知种类

X-PD-NOTIFICATION-TYPE
required
string
Value: "cardholder_status_update"
Example: cardholder_status_update

通知子类

X-PD-SIGN
required
string

使用平台私钥对requestBody做了加签, 请使用平台公钥对requestBody做签名验证

Request Body schema: application/json
memberId
string

会员ID

matrixAccount
string

Matrix账户ID

cardholderId
string

用卡人ID

status
string
Enum: "normal" "disabled" "pending" "modify" "rejected"

用卡人状态。normal - 可用，disabled - 系统禁用，pending - 审核中，modify - 待完善，rejected - 审核拒绝。

cardholderReviewStatus
string
Enum: "pending" "modify" "approved" "rejected"

用卡人信息审核状态。pending - 审核中，modify - 待修改，approved - 审核通过，rejected - 审核拒绝。

reason
string

原因

updatedAt
string
Value: "2022-03-18T08:43:28"

更新时间

Responses (200)

Response Schema: application/json
roger
required
boolean

Request samples

Content type
application/json
{
  • "memberId" : "2022180487046522" ,
  • "matrixAccount" : "MI1523959315646517248" ,
  • "cardholderId" : "CH1392717647736606720" ,
  • "status" : "normal" ,
  • "cardholderReviewStatus" : "approved" ,
  • "reason" : "XXXXXXXXXXX" ,
  • "updatedAt" : "2022-03-18T08:43:27"
}

Response samples

Content type
application/json
{
  • "roger" : true
}

光子易账户通知

付款通知 Webhook

当Payout订单有最终结果，通过开发者webhook配置，开发平台会发送到账成功通知给商户，当接受不成功或者发送失败时, 会重发8次, 时间间隔为5s,20s,1m,5m,30m,2h,24h

header Parameters
X-PD-NOTIFICATION-CATAGORY
required
string
Value: "Payout"
Example: Payout

通知种类

X-PD-NOTIFICATION-TYPE
required
string
Value: "order"
Example: order

通知子类

X-PD-SIGN
required
string

使用平台私钥对requestBody做了加签, 请使用平台公钥对requestBody做签名验证

Request Body schema: application/json
clearingNetworkName
string

支付方式，当前订单指向的付款清算网络

completedAt
string
Value: "2023-12-08T06:04:31"

完成时间

object (OpenApiV4OrderContactInfo)

订单收款人信息

createdAt
string
Value: "2023-12-08T06:04:31"

创建时间

entryDeclarationMode
string
Enum: "B2C" "B2B"

结汇方式，B2C 或 B2B 或者 空，仅在收款人为大陆境内，需要结汇的场景下为必传，用于校验可结汇额度和路由

feeAmount
number <bigdecimal>

手续费金额

feeBorneType
string
Enum: "SHARE" "OUR"

费用承担方，SHARE 和 OUR

feeCurrency
string

手续费币种

intermediarySwiftCode
string

指定中间行

paymentCredential
string

付款备注

paymentPurpose
string
Enum: "supplier" "logistics_freight" "advertising_expense" "vat_self" "service_commission/salary" "service_charge" "other_payout"

付款用途，非必填：非同名付款时可选填，不填则默认“供应商付款”；供应商付款:supplier,物流运费:logistics_freight,广告费:advertising_expense,VAT缴税:vat_self,劳务佣金/薪酬:service_commission/salary,服务费:service_charge,其他付款:other_payout

payoutAmount
number <bigdecimal>

付款金额- amount

payoutCurrency
string

付款币种

payoutDate
string

出款日期，一般这个日期出款

payoutOrderNo
string

交易流水号-payouts ID

receivedAmount
number <bigdecimal>

到账金额-amount received

receivedCurrency
string

到账币种

requestNo
string

请求流水号

memberId
string

会员ID；如涉及matrix产品，返回对应的会员或连接会员信息。

status
string
Enum: "Success" "Fail" "Reversal" "Refund"

交易状态：Success-交易成功，Fail-交易失败，Reversal-已撤销，Refund-已退款

tradeRate
number <bigdecimal>

交易汇率

usePobo
string
Enum: "N" "Y"

N: 非pobo付款, Y: pobo付款

vatCertificateFile
string

文件主键-fileKey;

vatTaxNo
string

vat税号

orderDescription
string

仅在付款订单结果为失败的情况下有可能返回

refundAmount
number <bigdecimal>

发生退款后，退款到账的金额

refundCurrency
string

退款的币种

refundRemark
string

退款展示的原因

cancelStatus
string
Enum: "cancelable" "uncancelable"

订单是否可以撤销状态：cancelable - 可以取消，uncancelable - 不可取消

cancelProgress
string
Enum: "canceling" "failed" "success"

订单撤销流程

Responses (200)

Response Schema: application/json
roger
required
boolean

Request samples

Content type
application/json
{
  • "clearingNetworkName" : "SWIFT" ,
  • "completedAt" : "2023-12-03T11:15:30" ,
  • "contactInfo" : {
    } ,
  • "createdAt" : "2023-12-03T10:15:30" ,
  • "entryDeclarationMode" : "" ,
  • "feeAmount" : "15.00" ,
  • "feeBorneType" : "SHARE" ,
  • "feeCurrency" : "USD" ,
  • "intermediarySwiftCode" : "" ,
  • "payoutAmount" : "16.00" ,
  • "payoutCurrency" : "USD" ,
  • "payoutDate" : "2023-05-05" ,
  • "payoutOrderNo" : "pay1654319491154317312" ,
  • "receivedAmount" : "1.00" ,
  • "receivedCurrency" : "USD" ,
  • "requestNo" : "20230505105756" ,
  • "memberId" : "2022122256879107" ,
  • "status" : "Success" ,
  • "tradeRate" : "1.00000000" ,
  • "usePobo" : "N" ,
  • "orderDescription" : ""
}

Response samples

Content type
application/json
{
  • "roger" : true
}

MATRIX 通知

协议更新及续签通知 Webhook

我们将会通过此API将最新的协议通知给您并希望您能响应您是否同意续签， 如果 3 天内您未回复我们将默认认为您同意续签。（建议商户对接此 api） 协议续签

header Parameters
X-PD-NOTIFICATION-CATAGORY
required
string
Enum: "Payment" "Matrix" "Collection" "Issuing" "User" "Member"
Example: Matrix

通知种类

X-PD-NOTIFICATION-TYPE
required
string
Value: "agreement"
Example: agreement

通知子类

X-PD-SIGN
required
string

使用平台私钥对requestBody做了加签, 请使用平台公钥对requestBody做签名验证

Request Body schema: application/json
memberNo
string

商户ID

agreementId
string

协议唯一标识

agreementName
string

协议名称

agreementLink
string

协议链接

version
string

版本号

updatedAt
string
Value: "2022-03-18T08:43:27"

更新时间

Responses (200)

Response Schema: application/json
roger
required
boolean

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "roger" : true
}

资金调拨结果通知 Webhook

资金调拨结果通知。通过开发者webhook配置，当接受不成功或者发送失败时, 会重发8次, 时间间隔为5s,20s,1m,5m,30m,2h,24h

header Parameters
X-PD-NOTIFICATION-CATAGORY
required
string
Value: "Matrix"
Example: Matrix

通知种类

X-PD-NOTIFICATION-TYPE
required
string
Value: "fundTransfer"
Example: fundTransfer

通知子类

X-PD-SIGN
required
string

使用平台私钥对requestBody做了加签, 请使用平台公钥对requestBody做签名验证

Request Body schema: application/json
transactionId
String(64)

交易唯一流水号

status
String(16)
Enum: "success" "failure"

交易结果状态

errorCode
String(32)
Enum: "01" "02" "03"

错误码，仅交易结果失败时返回，01：未知错误，02：金额不足，03：扣除手续费金额后的交易金额小于0

object (fundTransferRespDataTransactionDetail)

Responses (200)

Response Schema: application/json
roger
required
boolean

Request samples

Content type
application/json
{
  • "transactionId" : "FT12345678910" ,
  • "status" : "succeed" ,
  • "errorCode" : "01" ,
  • "transactionDetail" : {
    }
}

Response samples

Content type
application/json
{
  • "roger" : true
}

连接会员资金归集通知 Webhook

当资金归集后，将通过开发者webhook配置，开发平台发送资金归集通知给客户，当接受不成功或者发送失败时, 通知会发8次, 时间间隔为5s,20s,1m,5m,30m,2h,24h

header Parameters
X-PD-NOTIFICATION-CATAGORY
required
string
Value: "Matrix"
Example: Matrix

通知种类

X-PD-NOTIFICATION-TYPE
required
string
Enum: "funds_pooling" "pooling_reversal"
Example: funds_pooling

通知子类

X-PD-SIGN
required
string

使用平台私钥对requestBody做了加签, 请使用平台公钥对requestBody做签名验证

Request Body schema: application/json
memberId
String

连接会员号

transactionId
String

交易号

businessType
String
Enum: "collection" "account_transfer"

业务类型（account transfer暂不支持）

transactionType
String
Enum: "funds_pooling（资金归集）" "pooling_reversal（归集冲正）"

交易类型

status
String
Enum: "pending（处理中）" "frozen（冻结中）" "completed（已完成）"

状态

txnCurrency
String

币种

initAmount
String

初始金额

txnAmount
String

预计需要被归集的资金金额

expectAmount
String

实际被归集的金额

targetAccount
String

资金最终将被归集至会员的这个光子易账户

poolingFee
String

归集手续费

arrivalAmount
String

最终归集到账的资金

arrivedAt
String
Value: "2023-12-03T11:54:05"

实际归集资金到账时间

Responses (200)

Response Schema: application/json
roger
required
boolean

Request samples

Content type
application/json
{
  • "memberId" : "CM231239424656" ,
  • "transactionId" : "MR123456" ,
  • "businessType" : "collection" ,
  • "transactionType" : "funds_pooling" ,
  • "status" : "pending" ,
  • "txnCurrency" : "USD" ,
  • "initAmount" : 1000 ,
  • "txnAmount" : 1000 ,
  • "expectAmount" : 1000 ,
  • "targetAccount" : "string" ,
  • "poolingFee" : 10 ,
  • "ArrivalAmount" : 990 ,
  • "arrivedAt" : "2023-10-13T01:00:00"
}

Response samples

Content type
application/json
{
  • "roger" : true
}

连接会员资料审核结果通知 Webhook

当连接会员资料审核状态发生变更时，将通过此api进行通知。将通过开发者webhook配置，开发平台发送交易通知给客户。当接受不成功或者发送失败时, 交易会发8次, 时间间隔为5s,20s,1m,5m,30m,2h,24h

header Parameters
X-PD-NOTIFICATION-CATAGORY
required
string
Value: "MatrixKyc"
Example: MatrixKyc

通知种类

X-PD-NOTIFICATION-TYPE
required
string
Enum: "aml" "b2b"
Example: aml

通知子类

X-PD-SIGN
required
string

使用平台私钥对requestBody做了加签, 请使用平台公钥对requestBody做签名验证

Request Body schema: application/json
memberId
string

连接会员id

status
string
Enum: "approved" "modify" "reject"

连接会员资料审核状态

Array of objects (item项)

表示连接会员审核资料被打回的项，如连接会员的审核状态为“modify”时，会通知您连接会员资料被打回的项。(后续版本可能废弃，建议使用 itemListObj)

Array of objects (item项)

表示连接会员审核资料被打回的项，如连接会员的审核状态为“modify”时，会通知您连接会员资料被打回的项。

comment
string

资料审核备注信息

Responses (200)

Response Schema: application/json
roger
required
boolean

Request samples

Content type
application/json
{
  • "memberId" : "CM2023121239362799" ,
  • "status" : "modify" ,
  • "itemList" : [
    ] ,
  • "itemListObj" : [
    ]
}

Response samples

Content type
application/json
{
  • "roger" : true
}

连接会员证件过期状态变更通知 Webhook

当连接会员证件状态发生变更时，将通过此 api 进行通知。通过开发者 webhook 配置，开发平台发送通知给客户。

证件过期或即将过期时，状态为：expire，分别将在以下时间通知：

  1. 即将过期 （提前2个月、1个月、7天）：请及时通过接口更新证件，避免影响会员正常业务。
  2. 到期当天 ：请立即更新证件，通知内容会提醒客户缓冲期后将暂停交易。
  3. 超过缓冲期未更新 ：我们将暂时关闭光子易账户及光子卡交易，建议立即更新证件以恢复服务。缓冲期一般为 15天。

请在收到该通知后及时通过 过期证件更新 接口更新过期证件，以免影响关联会员的正常业务。

当接受不成功或者发送失败时会尝试重发, 时间间隔为5s,20s,1m,5m,30m,2h,24h

header Parameters
X-PD-NOTIFICATION-CATAGORY
required
string
Value: "MatrixCertificate"
Example: MatrixCertificate

通知种类

X-PD-NOTIFICATION-TYPE
required
string
Enum: "approved" "modify" "expire"
Example: expire

通知子类

X-PD-SIGN
required
string

使用平台私钥对requestBody做了加签, 请使用平台公钥对requestBody做签名验证

Request Body schema: application/json
memberId
string

连接会员id

processInstanceId
string

当前证件状态的流程id

daysToExpire
integer

距离证件过期的天数，已超期时为负数。

expireDate
string

证件过期时间。格式为：yyyy-MM-dd

Array of objects (item项)

更新证件被打回需要修改的项。(后续版本可能废弃，建议使用 itemListObj)

Array of objects (item项)

更新证件被打回需要修改的项。

comment
string

备注

Responses (200)

Response Schema: application/json
roger
required
boolean

Request samples

Content type
application/json
{
  • "memberId" : "CM2023121239362799" ,
  • "processInstanceId" : 12233344444 ,
  • "status" : "modify" ,
  • "itemList" : [
    ] ,
  • "itemListObj" : [
    ]
}

Response samples

Content type
application/json
{
  • "roger" : true
}

会员创建状态变更通知 Webhook

会员状态的变动将通过此接口进行通知。

header Parameters
X-PD-NOTIFICATION-CATAGORY
required
string
Value: "MatrixConnectMember"
Example: MatrixConnectMember

通知种类

X-PD-NOTIFICATION-TYPE
required
string
Value: "status_changed_notify"
Example: status_changed_notify

通知子类

X-PD-SIGN
required
string

使用平台私钥对requestBody做了加签, 请使用平台公钥对requestBody做签名验证

Request Body schema: application/json
requestId
string

请求ID

memberId
string

会员ID

status
string
Enum: "init" "activating" "activation_failed" "normal" "closed" "suspend" "terminated"

连接会员状态，分别为 init(即为创建成功的初始状态)，activating(激活中)， activation_failed(激活失败)，normal(正常)，closed(关闭)， suspend(暂停)，terminated(终止)。
当创建会员失败时，您也会收到通知，状态为 failed。

updateTime
String

更新时间

reason
string

原因

Responses (200)

Response Schema: application/json
roger
required
boolean

Request samples

Content type
application/json
{
  • "requestId" : "" ,
  • "memberId" : "CM2023121239362799" ,
  • "updateTime" : "2022-03-18T08:43:27" ,
  • "status" : "init" ,
  • "reason" : ""
}

Response samples

Content type
application/json
{
  • "roger" : true
}

附录

总附录

响应码

code
msg
status
0000 交易成功 succeed
1000 无效参数 failed
1001 无效加签 failed
1002 无效token failed
1003 payInfoJson格式错误 failed
1004 通知错误 failed
1005 请重试 failed
2001 重复订单 failed
2002 原始订单未成功 failed
2003 原始订单不存在 failed
2004 金额不足 failed
2005 订单已发生预授权完成 failed
2006 订单已发生拒付 failed
2007 无效siteId failed
2008 交易被禁止 failed
2009 不支持的支付方式 failed
2010 不支持的币种 failed
2011 已经不在退款的有效期 failed
2012 已经不在预授权完成的有效期 failed
2013 原始订单已经被审核 failed
2014 交易请求ID无效 failed
2015 未找到有效的二级商户号 failed
2016 未找到系统映射码 suspend
2017 未找到有效的通道 failed
2018 不支持3D交易 failed
2019 不支持多次交易 failed
2020 商户的账单信息不全 failed
2021 交易已过期 failed
2022 不允许发起交易 failed
2023 不允许发起退款 failed
2024 未找到产品配置 failed
2025 交易不存在 failed
2026 交易已结算 failed
2027 店铺授权无效 failed
2028 令牌已存在 failed
2029 mit协议已存在 failed
2030 令牌不存在 failed
2031 支付链修改失败 failed
2032 退款总额超过账户总额，交易失败 failed
3001 挂起订单等待审核 suspend
3002 挂起待处理 pending
3003 处理中 pending
4000 风控拒绝 failed
5001 联系发卡行 failed
5002 发卡行不予承兑 failed
5003 终端不允许交易 failed
5004 发卡行/收单行超时 failed
5005 无原始交易 failed
5006 无效银行卡/发卡行/收单行 failed
5007 无效金额 failed
5008 无效卡号 failed
5009 预授权已过期 failed
5010 系统错误，请重试 failed
5011 不可信账户 failed
5012 交易失败 failed
5013 挂失卡 failed
5014 交易拒绝，请联系发卡行 failed
5015 金额不足 failed
5016 过期卡 failed
5017 密码错误，请重新输入 failed
5018 不允许该卡交易 failed
5019 超过金额限制 failed
5020 受限制卡 failed
5021 超过频次限制 failed
5022 超过收单行限次/限额 failed
5023 结果响应超时 failed
5024 超过密码尝试次数 failed
5025 无效账户 failed
5026 发卡行不能提供该服务 failed
5027 不能识别该密码 failed
5028 无效验证码 failed
5029 无效的交易周期 failed
5030 不安全交易 failed
5031 发卡行不可用 failed
5032 无效发卡行 failed
5033 交易不可完成 failed
5034 系统异常 failed
5035 重复退款 failed
5036 重复交易 failed
5037 CVV错误 failed
5038 3ds验证失败 failed
5039 不允许退款 failed
5040 发卡行不能执行3ds验证 failed
5041 该笔交易已经过期
12001 账户不存在 failed
13021 请输入请求流水号 failed
13022 请输入起始时间 failed
13023 请输入截止时间 failed
13030 店铺编号有误 failed
13031 该店铺已授权 failed
13032 authCode不能为空 failed
13033 该店铺不属于速卖通平台 failed
13034 订单明细不能为空 failed
14001 您填写的法人姓名和激活账户时的法人姓名不符,请核实。 failed
14002 未找到对应交易类型配置，请联系客户经理进行处理。 failed
14003 该交易类型不存在，请联系客户经理进行处理。 failed
14004 银行卡不属于该当前登录会员。 failed
14005 该银行卡不存在 failed
14006 请至少选择一个币种 failed
14007 收款人已经有相同的银行卡 failed
14008 银行卡号不能存在中文 failed
14009 银行卡号不能低于12位 failed
14010 银行卡号长度错误 failed
14011 个人银行卡银行所在地目前只支持选择中国大陆 failed
14012 请选择银行所在地 failed
14013 请输入银行名称 failed
14014 币种不能为空 failed
14015 请输入银行卡号 failed
14016 请选择个人或企业 failed
14017 请输入用卡人 failed
14018 请输入姓名 failed
14019 用卡人姓名长度超过限制 failed
14020 银行预留号码区号不能为空 failed
14021 银行预留手机号不能为空 failed
14022 Swift码的长度不能超过11位 failed
14023 中国大陆的银行卡必须都是数字 failed
14024 中国大陆的银行卡只支持人民币 failed
14025 请输入联行号 failed
14026 请输入用卡人所在国家 failed
14027 请输入用卡人所在城市 failed
14028 请输入用卡人所在的州/省 failed
14029 请输入用卡人邮编 failed
14030 银行卡四要素认证失败,原因:%s failed
14031 请输入收款人名称 failed
14032 会员实体名称为空（企业会员则是法人名称为空）,请联系客户经理进行处理 failed
14033 企业会员不能添加个人类型的香港银行卡 failed
14040 请选择收款人类型 failed
14041 请选择付款类型 failed
14042 请选择付款币种 failed
14043 请输入付款金额 failed
14044 请输入合同开始日期 failed
14045 请输入合同截止日期 failed
14046 只允许企业账户 failed
14047 银行证明不能为空，请上传证明文件 failed
14048 请输入国际银行帐户号码 failed
14049 请选择BankCode failed
14050 请输入IFSCode failed
14051 请输入银行地址 failed
14052 请输入用卡人地址 failed
14053 该收款人不存在 failed
14054 该收款人已存在并被拒绝，请先删除 failed
14055 已存在该类型的同名收款人 failed
14056 只允许供应商类型的收款人重新上报合同信息 failed
14057 不合法的收款人类型 failed
14058 请选择SwiftCode failed
14059 请输入企业注册编号 failed
14060 请输入公司英文名称 failed
14061 请选择公司注册时间 failed
14062 银行地址不能超过100位 failed
14063 银行卡信息已通过风控审核 failed
14064 收款人信息已通过风控审核 failed
14065 1688跨境宝收款人银行卡的银行所在地目前不支持选择中国大陆 failed
14066 个人主体不支持添加企业类型的提现收款人 failed
14067 用卡人身份证号不能为空 failed
14068 用卡人身份证号格式有误 failed
14089 输入的银行卡币种和va账户支持币种不符 failed
14090 va账户未激活 failed
14091 va账户未绑定会员 failed
14092 联系电话或者座机号码必须全部为数字 failed
14095 该收款人卡号不允许被添加 failed
14096 当前收款人类型已存在相同卡号的收款人。 failed
14097 请输入8或者11位的swiftCode。 failed
14100 请选择正确的手机号国家编码。 failed
14101 请选择正确的证件类型。 failed
14102 护照号不能为空。 failed
14103 模板错误，请更换模板。 failed
14104 文件大小超过限制。 failed
14105 文件类型错误。 failed
14106 电话号码错误。 failed
14107 用卡人输入错误，银行所在地为中国，币种只有CNY时，用卡人名称支持中文。 failed
14108 vatCertificate参数非法。 failed
14109 alipayBusinessAccountId参数非法。 failed
14110 vatCertificateFile参数非法。 failed
14111 bankCertificateFile参数超过限制个数。 failed
14112 vatCertificateFile参数超过限制个数。 failed
14113 当前收款人不可编辑。 failed
14114 contractFile参数非法。 failed
14115 bankCertificateFile参数非法。 failed
14116 银行所在地不存在。 failed
14118 文件不存在。 failed
14119 vat不支持该银行所在地。 failed
14120 contractFile参数超过限制个数。 failed
14121 该类型收款人不支持修改银行所在地。 failed
14122 vatCertificateFile参数不能为空。 failed
14123 银行卡信息有误，卡号与银行所在地不匹配。 failed
14124 选择的地区不支持该币种。 failed
14125 收款人昵称存在重复。 failed
14126 请填写收款人地址。 failed
14127 请正确填写中国大陆手机号码。 failed
14128 联系人类型不支持1688跨境宝 failed
14129 银行预留手机号不能为空 failed
14130 iban长度必须大于等于14位 failed
14131 Swiftcode所属国家与银行所在地不匹配，请确认后修正。 failed
14132 当前设置收款人身份证号码所在地区不支持添加 failed
14133 银行卡号所属的主体类型与实际不符，请核对后重新输入 failed
14134 银行卡号所属的用卡人名称与实际不符，请核对后重新输入 failed
14135 仅接受FTN或NAR账户境外付款的离岸人民币 failed
14205 收款人昵称已存在 failed
14206 尊敬的客户，该收款人无法被创建，如有问题，请联系您的客户经理，感谢您的理解。 failed
14301 收款人主体类型不能为空 failed
14302 银行所在地不能为空 failed
14304 收款人国家不能为空 failed
14310 收款人所在地区或者省份不能为空 failed
14311 收款人所在城市名称不能为空 failed
14401 收款人主体类型填写值不在范围内 failed
14402 银行所在地填写值不符合规范 failed
14403 币种填写值不符合规范 failed
14404 收款人所在地填写值不符合规范 failed
14407 名字只支持英文数字/ - () . , ' + failed
14408 姓氏只支持英文数字/ - () . , ' + failed
14409 持卡人名称只支持英文数字/ - () . , ' + failed
14410 收款人所在地区或者省份填写格式不正确，可参考国家字典表 failed
14411 收款人所在城市名称填写格式不正确，可参考国家字典表 failed
14502 银行所在地暂不支持 failed
14503 币种暂不支持 failed
14604 收款人所在地格式不正确，可参考国家字典表 failed
14606 无法向该收款人付款，收款人需要补充额外信息后，再次发起 failed
14607 您的银行所在地为中国大陆，名字请输入中文 failed
14608 您的银行所在地为中国大陆，姓氏请输入中文 failed
14609 您的银行所在地为中国大陆，持卡人企业名称请输入中文 failed
15501 系统服务忙，请稍后再试 failed
15502 系统服务异常，请稍后再试 failed
15503 系统服务未知错误，请稍后再试 failed
15531 请输入请求流水号 failed
15532 请输入卖出币种 failed
15533 请输入买入币种 failed
15534 请输入汇入币种 failed
15535 请输入货币对 failed
15536 货币对输入错误 failed
15537 币种输入错误 failed
15538 请输入起始时间 failed
15539 请输入截止时间 failed
15540 请输入交易方向 failed
15541 交易方向输入错误 failed
15542 请输入交易金额 failed
15543 交易金额输入错误 failed
15544 请输入交割日期 failed
15545 交割日期输入格式错误 failed
15546 交割日期不能早于当前日期 failed
15547 交割日期无效 failed
15548 请输入询价目的 failed
15549 询价目的输入错误 failed
15550 询价目的为payout时，银行卡ID不可为空 failed
15551 请输入换汇询价ID failed
15552 请输入卖出账户号 failed
15553 请输入买入账户号 failed
15554 换汇询价ID不存在或已过期 failed
15555 卖出账户号不存在或账户币种不匹配 failed
15556 买入账户号不存在或账户币种不匹配 failed
15557 卖出币种账户金额不足 failed
15558 违约金扣款币种账户金额不足 failed
15559 换汇下单失败 failed
15560 汇入账号不存在 failed
15561 汇入账号状态异常 failed
15562 卖出币种与买入币种不可相同 failed
15563 卖出账户号与买入账户号不可相同 failed
15564 当前货币对不在可交易时间内 failed
15565 交易金额精度错误 failed
15566 交割日期不能查询30天之后的日期 failed
15567 下单模式错误 failed
15568 当前您的保证金下单额度已超过上限，可选择其他方式下单，如有疑问请联系在线客服。 failed
15569 未找到保证金下单额度配置，请联系在线客服。 failed
15575 requestNo已存在，请勿重复请求。 failed
15576 收款人不存在。 failed
15577 ACH和FedWire付款不支持ABANumber为空。 failed
15578 FPS付款不支持fpsBankId为空。 failed
15579 SEPA付款不支持sortCode为空。 failed
15580 收款人银行所在地为印度时ifsCode不能为空。 failed
15581 VAT收款人税号不能为空。 failed
15582 银行卡状态有误,请稍后重试。 failed
15582 付款币种未开通。 failed
16601 到账金额、付款金额 请二选一 failed
16602 到账金额、付款金额 不能小于等于0 failed
16603 汇率过期，请获取汇率后重新下单 failed
16604 付款地区不支持所选的币种 failed
16605 不支持的交易类型 failed
16606 该交易方式，配置未开启 failed
16607 风控拦截，不可出款 failed
16608 账户权限问题，可能被冻结或者关闭 failed
16609 付款金额小于最低限额 failed
16610 出金账户金额不足 failed
16611 系统异常，发起交易失败，请联系客服经理处理 failed
16612 结汇额度不足，无法发起资金入境 failed
16615 暂无可用通道。 failed
16616 到账金额超过限额，请参考“付款限额”，调整到账金额或付款金额。 failed
16998 参数校验异常 failed
16999 系统异常 failed
17000 未知系统错误 failed
17001 订单已过期，请重新下单 failed
17002 错误的付款账号 failed
17003 参数不合法 failed
17004 注销全球账户失败 failed
17005 修改全球账户昵称失败 failed
17006 生成全球账户银行流水证明文件失败，请稍后再试 failed
17007 全球账户关联店铺或应用失败 failed
17008 全球账户更换关联店铺或应用失败 failed
17009 保存入账凭证失败 failed
17010 修改入账凭证失败 failed
17011 结算订单关联入账凭证失败 failed
17012 当前用户没有开通B2B业务线 failed
18001 当前金额不足，无法继续透支，请尽快补充光子易账户资金。 failed
19001 Topic code 不合法 failed
19002 Topic code 与 template code 组合不合法 failed
9999 系统异常 failed
VCC1010 交易金额超出您设置的单笔限额 failed
VCC1011 交易金额超出您设置的日可用限额 failed
VCC1012 交易金额超出您设置的月可用限额 failed
VCC1013 此卡的可用交易限额不足，请先设置后再次发起交易 failed
VCC1014 风险拒绝 failed
VCC1015 可用金额不足，交易失败 failed
VCC1025 您的光子易账户不可用，请联系你的客户经理了解详情。 failed
VCC1027 渠道拦截 failed
VCC1028 交易超时 failed
VCC1039 无效参数 failed
VCC1050 交易拒绝 failed
VCC1054 此卡为不可用状态，您不可进行此操作，请确认后重试。 failed
VCC1092 命中自主风控-交易白名单，交易拦截。 failed
VCC1100 失败终态确认 failed
VCC9999 系统错误，请重试 failed
VCC2001 卡的有效期错误 failed
VCC2002 卡的 CVV 错误 failed
VCC2003 不支持此类型的交易 failed
VCC2004 交易国不被允许 failed
VCC2005 卡交易异常，请检查后再试 failed
VCC2006 卡已失效，交易拒绝 failed
VCC2007 交易超限制 failed
VCC2008 卡处于不可用状态 failed
VCC2009 可用金额不足，请稍后再试 failed
VCC2010 未知错误 failed
VCC2011 请勿重复发起交易，请稍后再试 failed
VCC2012 交易超时 failed
VCC2013 交易被拒绝 failed
VCC2014 交易可能存在风险，交易拒绝。 failed
VCC2015 系统错误 failed
VCC2016 卡信息有误，请确认后重试 failed
VCC2017 交易信息有误，交易被拒绝 failed
VCC2018 无效请求，交易拒绝 failed
VCC2019 原始交易不存在，交易失败 failed
VCC2020 AVS验证失败 failed
VCC2021 交易金额无效 failed
VCC2022 网络错误 failed
VCC3001 系统错误，请重试。 failed
VCC3002 用卡人手机号异常，请检查后重试。 failed
VCC3003 请求频繁，请稍后再试。 failed
VCC3004 开卡失败，请联系商户服务人员了解详情。 failed
VCC3005 用卡人姓名有误，请检查后重试。 failed
VCC3006 创建卡失败，请在 5-10 分钟后再次尝试创建此卡。 failed
VCC3007 无法创建卡，请联系商户服务人员了解详情。 failed
VCC3008 请求受限，请联系商户服务人员了解详情。 failed
VCC3009 用卡人的账单地址中的详细地址有误，请检查后重试。 failed
VCC3010 用卡人的账单地址中的邮编有误，请检查后重试。 failed
VCC3011 用卡人的账单地址中的国家有误，请检查后重试。 failed
VCC3012 用卡人的账单地址中的城市有误，请检查后重试。 failed
VCC3013 您设置的币种账户可用金额不足无法开卡，请先转入后开卡。 failed
VCC3014 用卡人身份信息待更新，请更新后重试。 failed
VCC3015 用卡人状态异常，请检查。 failed
VCC3016 当前用卡人审核状态暂不支持该操作。 failed
VCC3017 卡片状态异常，激活失败，请确认后重试。 failed
VCC3018 您的卡信息输入有误，激活失败。 failed
VCC3019 您的卡信息验证有误，重置密码失败。 failed
VCC3021 用卡人信息填写不完整，请检查。 failed
VCC3022 该卡片已激活，请勿重复操作。 failed
VCC3023 该卡片与您的账户不匹配，激活失败，请确认后重试。 failed
VCC3024 当前会员暂不支持申请实体卡，如需申请，请联系我们。 failed
VCC3025 实体卡信息仅在激活后可查看，请先激活卡片。 failed
VCC3026 实体卡暂不支持修改交易限额类型。 failed
VCC3027 卡信息验证失败次数超限，激活失败，请于24小时后重试。 failed
VCC3028 卡信息验证失败次数超限，重置密码失败，请于24小时后重试。 failed
VCC3029 卡信息验证失败次数超限，更换密码失败，请于24小时后重试。 failed
VCC3030 虚拟卡不支持挂失或盗卡操作。 failed
VCC3031 您的卡片暂不支持激活，请联系您的客户经理。 failed
VCC3032 升级失败。请先设置虚拟共享卡交易限额后再升级实体卡。 failed
VCC3033 卡面姓名格式有误，请联系您的客户经理 failed
VCC3034 您的卡信息验证有误，更换密码失败。 failed
VCC3035 当前暂不支持重置密码，请联系您的客户经理 failed
VCC3036 当前暂不支持实体卡续卡，请联系您的客户经理 failed
VCC3037 用卡人开卡申请超单日失败上限，请明日再试。 failed
VCC3038 您暂无权限调用，请联系您的业务人员了解详情。 failed
VCC3039 您的开卡数量已达上限。 failed
VCC3040 由于您提交信息未能通过我们的风险合规审核，本次开卡失败。 failed
VCC3041 您无法修改用卡人信息，您可修改您的账单信息。 failed
VCC3042 审核中，不支持此操作。 failed
VCC3043 你所述的国家暂不支持 failed
VCC3044 请完善用卡人材料和信息 failed
VCC3045 不支持此操作。 failed
VCC3046 换绑失败，无效的卡ID或用卡人ID。 failed
VCC3047 批量开卡换绑成功前不允许激活卡。 failed
VCC1042 今日取现金额已达上限，请明天再试。 failed
VCC1043 本月取现金额已达上限，请下月再试。 failed
VCC1044 单笔取现金额超出限制，请检查。 failed
VCC1045 今日取现次数已达上限，请明天再试。 failed
ACH01001 产品无有效价格！ failed
ACH01002 产品名重复，请重新命名。 failed
ACH01003 不能删除已经使用的产品或者价格计划。 failed
ACH01004 按币种设置特殊价格列表不能为空 failed
ACH01005 在此周期下已经有该币种的价格，请更换币种或者周期。 failed
ACH01006 价格名重复，请重新命名。 failed
ACH01007 产品描述不能超过100个字符 failed
ACH01008 产品名称不能超过50个字符 failed
ACH01009 产品名称不能为空。 failed
ACH01010 当前产品不可用，无法编辑产品信息 failed
ACH11001 订阅ID不存在。 failed
ACH11002 一次性价格计划不支持取消。 failed
ACH11003 该状态下不能取消。 failed
ACH11004 站点未审核通过。 failed
ACH11005 该产品在此站点不可用。 failed
ACH11006 产品风控状态被禁用。 failed
ACH11007 产品未激活或不存在。 failed
ACH11008 价格未激活或不存在。 failed
ACH11009 价格与产品不匹配。 failed
ACH11010 提供的支付方式与价格的计费方式不匹配。 failed
ACH11011 协议URL已存在。 failed
ACH11012 该价格不支持指定的币种。 failed
ACH11013 试用订阅的金额必须为零。 failed
ACH11014 提供的金额与预期价格不匹配。 failed
ACH11015 会员订阅开关已关闭，订阅不可用。 failed
ACH11016 站点订阅开关已关闭，订阅不可用。 failed

更新日志

更新日志

记录PhotonPay的每次更改。

此更新日志按时间顺序列出了PhotonPay API的所有添加、更新和删除。 如果您有其他问题或疑虑，请联系我们的支持团队。

2025-11-13

为提高光子易Matrix的KYC对接能力：

  • 增加对美国、加拿大主体的地区支持。
  • 行业类型新增。
  • 增加非中国大陆企业下的董事/法人、受益人的护照证件采集。

2025-05-14

为提高光子易Matrix的KYC能力：

  • 更新Matrix的连接会员，特别是激活连接会员的材料。相应的，“更新连接会员”和“过期证件更新材料”接口，也会对应调整。
  • 另外，补开B2B接口，更新调整为“B2B问卷”。

2025-01-16

为提高光子易的发卡能力：

  • 发卡-卡管理，新增：钱包绑卡记录，支持查询卡片在Google钱包中的绑卡记录和支付令牌状态。
    • 查询接口： Query Parameters。
    • 响应接口：Response Schema。

2024-11-28

完善光子易收款人&付款API接口功能：

收款人-新增：

  • 新增收款人前置接口
    • 根据收款人使用场景，返回新增收款人时必填字段以及格式

收款人-修改：

  • 新增收款人
    • 结汇场景需要额外收集联系人字段，该字段选填
    • 错误码更新
  • 编辑收款人
    • 减少编辑收款人可编辑字段

付款-新增：

  • 待补充材料查询接口
    • 当订单处在improved状态时，需要补充相关贸易材料，调用该接口查询需要的材料列表
  • 补充贸易材料接口
    • 当订单处在improved状态时，使用文件上传接口后，通过该接口补充订单的资料

2024-06-06

为完善光子易生态服务商API接口功能：

付款-新增：

  • 生态服务商支付链接接口
    • 新增接口返回支付链接，由 EcoSP 重定向后提供给用户进行支付
  • 生态服务商支付链接查询接口
    • 新增接口查询支付链接的状态

通知订阅-修改:

  • Webhook-付款通知
    • 付款通知仅会通知发起付款方

2024-05-16

为完善光子易文件上传API接口功能：

更新：

  • 文件上传接口新增 memberId 参数，用于填写 Matrix Connect Member ID，填写后文件将归属于指定的连接会员。

为提高光子易的发卡能力：

发卡-更新：

  • 常规卡和共享卡，新增交易类型：汇入，汇入手续费。
  • 错误响应码更新。

账户-更新：

  • 资金流转，增加发卡来源：发卡汇入、发卡汇入手续费 。

为提高光子易的收单能力：

收单-新增：

  • AlipayHK钱包。
  • 支付方式AlipayHK的s2s接口，cashier接口的说明信息。

2024-05-09

为提高光子易的发卡能力：

发卡-更新：

  • 发卡附录，新增错误响应码。

2024-04-09

为提高光子易的发卡能力：

发卡-新增：

  • “卡更新”接口中的响应增加卡明细字段：如果成功则响应中会展示新增相应卡明细字段。
  • “开卡”接口中的响应增加：“常规卡金额”字段。
  • “卡金额退还”接口中的响应增加：“常规卡金额”字段。
  • “发卡交易通知”的 webhook 中增加“Update at”，即交易变动的最新时间。

2024-02-29

为完善光子易的Matrix解决方案的能力以及API接口的时间格式规范：

新增：

  • 收款、发卡以及光子易账户模块的请求和查询接口，均新增 member ID 参数和描述。可供会员根据其不同的业务场景，对本会员或旗下的连接会员做各项业务操作。
  • Matrix连接会员功能模块：在Matrix解决方案体系中新增Matrix 连接会员功能模块，功能包含：创建连接会员、激活、配置、查看等功能。
  • Matrix会员协议续签。

更新：

  • 所有接口中的时间格式统一更新为ISO标准时间格式。
    • 涉及时间接口字段名称、描述和举例优化。

2024-02-01

为提高光子易的发卡和收单能力：

发卡-新增：

  • 调用批量操作：销卡，冻结，解冻时，增加操作成功返回响应。
    • 此操作成功后，操作结果卡状态将通过 webhook 进行通知。

收单-新增：

  • MIT解约通知。
  • 部分本地化支付方式支持MIT签约和扣款：
    • TrueMoney PhotonPay Account、TNG eWallet、GCash、DANA、Kakao Pay、Rabbit LINE Pay、Boost、Grabpay支付方式支持MIT签约和扣款。

2024-01-04

为提高光子易的发卡和收单能力：

  • 发卡-新增：发卡-错误返回代码。
  • 发卡-更新：接口描述。
  • 卡详情和开卡：
    • 更新卡接口中的单笔、日、月限额为整数类型。
  • Request ID提示更新。
  • 接口币种增加ISO4217规范描述。

收单东南亚部分支付方式升级，支持令牌支付产品。

  • 收单-新增：消费接口以及交易通知字段uerLoginId。
  • 收单-新增：解绑令牌通知。
    • 支持令牌的东南亚支付方式：Grabpay、GCash、DANA、Kakao Pay、True Money、Rabbit LINE Pay、Touch 'n Go eWallet、Boost

2023-12-21

为提高光子易收单支付能力：

  • 新增：印尼本地化支付方式。
    • 新增支付方式：ShopeePay和QRIS的s2s接口的说明信息。

2023-11-30

为提高光子易的发卡统计能力：

新增：

  • 剩余可开卡数。
    • 新增“卡bin查询”接口响应，此卡BIN当前剩余可开卡的数量。
  • 可用卡数量。
    • 新增“卡bin查询”接口响应，此卡BIN 已开卡并可用的卡数量（不包含销卡及过期）。
  • Webhook虚拟卡状态通知。
    • 新增Webhook虚拟卡状态通知，当卡状态发生变更，将通过此api进行通知。

更新：

  • 发卡-卡更新，销卡接口描述更新。
    • 销卡状态时，不可调整“maxOnDaily 、maxOnMonthly、maxOnPercent”限额。
    • transactionLimitChangeType：销卡后不可再操作调增，可以调减。

2023-11-16

为提高光子易收单支付能力：
  • 新增：东南亚本地化支付方式。
    • 新增支付方式：Kakao Pay、Rabbit LINE Pay、TrueMoney PhotonPay Account、Touch 'n Go eWallet、Boost、OVO和LinkAja的s2s接口的说明信息。

2023-10-20

为提高光子易收单支付能力：
  • 新增：东南亚本地化支付方式。
    • 新增支付方式-DANA,Gcash,BPI的s2s接口的说明信息。

2023-10-12

这是光子易API 初始的版本。

支持

支持

如果您需要更多帮助，请联系技术支持： tech-support@photonpay.com