枚举值说明
Status 状态
Status
| 状态码 | 描述 | 说明 |
|---|---|---|
| A | 待审核 | 交易已创建,等待审核 |
| CA | 合规审核中 | 交易正在进行合规审核 |
| B | 待检查 | 交易等待系统检查 |
| U | 审核不通过 | 交易未通过人工审核 |
| V | 检查不通过 | 交易未通过系统检查 |
| R | 待出款 | 交易已通过审核,等待出款 |
| P | 出款中 | 交易正在出款处理中 |
| S | 成功 | 交易已成功完成 |
| F | 失败 | 交易处理失败 |
chargeFlag 全额到账标识
chargeFlag
| 状态码 | 描述 | 说明 |
|---|---|---|
| Y | 全额到账 | 收款方收到的金额等于目标金额 |
| N | 非全额到账 | 收款方收到的金额可能少于目标金额 |
feeBearing SWIFT付款手续费承担方式
feeBearing
| 状态码 | 描述 | 说明 |
|---|---|---|
| SHA | 费用分摊 | SWIFT 费用在付款方和收款方之间分摊 |
| OUR | 付款方承担 | 付款方承担所有 SWIFT 相关费用,收款方收到全额 |
transactionPurpose 交易用途
transactionPurpose
| 代码 | 描述 | 说明 |
|---|---|---|
| 0 | 转至本人账户 | 资金转入本人其他账户 |
| 2 | 贷款或信贷偿还 | 用于偿还贷款或信用账单 |
| 4 | 运费 | 支付运输相关费用 |
| 5 | 专业服务/商业服务 | 支付专业或商业服务费用 |
payoutMethod 付款方式
payoutMethod
| 代码 | 描述 | 说明 |
|---|---|---|
| SWIFT | SWIFT付款 | 通过SWIFT网络进行国际转账 |
| BANK_TRANSFER | 银行付款 | 通过本地银行网络转账 |
| E_WALLET | 钱包付款 | 转账至电子钱包账户 |
| CASH_PICKUP | 现金支取 | 收款人可到指定地点提取现金 |
walletType 钱包类型
电子钱包场景下,根据收款方使用的钱包名称及账号类型选择 walletType,将钱包账号填写到 walletPhone。同一钱包有多种账号类型时,请选择与实际账号对应的枚举值。
- 请求字段使用驼峰命名
walletType。 - 添加/编辑收款方及实时收款方信息付款时,钱包信息位于
accountInfomationJSON 字符串内;查询收款方必填字段时,walletType为请求体参数。 walletPhone可以是手机号、邮箱、证件号或钱包平台账号,按下表账号格式填写。walletFormat是格式说明,不是需要新增传入的请求字段。
钱包名称
| 钱包名称 | walletType 枚举值 | 钱包账号格式 |
|---|---|---|
| DANA | DANA | MOBILE |
| GOPAY | GOPAY | MOBILE |
| GRABPAY | GRABPAY | MOBILE |
| LINKAJA | LINKAJA | MOBILE |
| OVO | OVO | MOBILE |
| PAYTREN | PAYTREN | WALLET ID |
| COINS | COINS | MOBILE |
| GCASH | GCASH | MOBILE |
| PAYMAYA | PAYMAYA | MOBILE |
| ALIPAY | ALIPAY | MOBILE |
| WECHAT PAY | WECHAT PAY | MOBILE |
| DCPAY | DCPAY | MOBILE |
| UPI | VPA | VPA |
| PayNow | MOBILE | MOBILE |
| PayNow | UEN | UEN |
| PayNow | NRIC | NRIC |
| PayNow | VPA | VPA |
| DuitNow | NRIC | NRIC |
| DuitNow | PASSPORT | PASSPORT |
| DuitNow | CORPORATE_REGISTRATION_NUMBER | CORPORATE_REGISTRATION_NUMBER |
| DuitNow | MOBILE | MOBILE |
| DuitNow | ARMY_ID | ARMY_ID |
| PIX | MOBILE | MOBILE |
| PIX | ||
| PIX | ID | WALLET ID |
| PIX | RANDOM_KEY | RANDOM_KEY |
| VENMO | VENMO | MOBILE |
| PAYPAL | PAYPAL | |
| PayID | ABN | ABN |
| PayID | ||
| PayID | PHONE NUMBER | MOBILE |
| PayID | CORPORATE ID | CORPORATE ID |
| FPS | MOBILE | MOBILE |
| FPS | ||
| FPS | FPS ID | WALLET ID |
| KE | Airtel | Airtel |
| KE | Equitel | Equitel |
| KE | Mpesa | Mpesa |
| ShopeePay | ShopeePay | MOBILE |
| Momo | Momo | MOBILE |
| VNPT | VNPT | MOBILE |
| ZaloPay | ZaloPay | MOBILE |
| VNPay | VNPay | MOBILE |
| TnG | TnG | Duitnow ID |
| BKASH | BKASH | MOBILE |
| ROCKEY | ROCKEY | WALLET ID |
| NAGAD | NAGAD | MOBILE |
| PAPARA | PAPARA_NUMBER | NUMBER |
| PAPARA | PAPARA_EMAIL | |
| PAPARA | PAPARA_PHONE | MOBILE |
| PAPARA | PAPARA_TURKISH | TURKISH |
| ALFA | ALFA | WALLET ID |
| KONNECT | KONNECT | WALLET ID |
| EASYPAISA | EASYPAISA | WALLET ID |
| FINCA | FINCA | WALLET ID |
| APNA | APNA | WALLET ID |
| UBANK | UBANK | WALLET ID |
| JAZZCASH | JAZZCASH | WALLET ID |
| ADVANS | ADVANS | WALLET ID |
| KHUSHALI | KHUSHALI | WALLET ID |
| NAYAPAY | NAYAPAY | WALLET ID |
| PAYMAX | PAYMAX | WALLET ID |
| SADAPAY | SADAPAY | WALLET ID |
| BYKEA | BYKEA | WALLET ID |
| FINJA | FINJA | WALLET ID |
| TMFB | TMFB | WALLET ID |
| BANKALFA | BANKALFA | MOBILE |
| UPAISA | UPAISA | MOBILE |
| BigPay | BigPay | Duitnow ID |
钱包账户信息示例
以下为请求中的账户信息字段片段;其他必填字段仍按对应接口要求填写。
json
{
"paymentMethod": "E_WALLET",
"accountInfomation": "{\"walletType\":\"PAYPAL\",\"walletPhone\":\"payee@example.com\"}"
}entityType 主体类型
entityType
| 代码 | 描述 | 说明 |
|---|---|---|
| 0 | 公司 | 企业法人账户 |
| 1 | 个人 | 自然人账户 |
currency 币种
currency
| 代码 | 描述 | 说明 |
|---|---|---|
| USD | 美元 | 美利坚合众国法定货币 |
| EUR | 欧元 | 欧盟成员国法定货币 |
| GBP | 英镑 | 英国法定货币 |
| JPY | 日元 | 日本法定货币 |
| PHP | 菲律宾比索 | 菲律宾法定货币 |
| IDR | 印尼盾 | 印度尼西亚法定货币 |
| THB | 泰铢 | 泰国法定货币 |
| MYR | 马来西亚林吉特 | 马来西亚法定货币 |
receiverInfo 收款人信息
receiverInfo
| 参数名 | 类型 | 说明 |
|---|---|---|
| companyName | string(64) | 公司名称 |
| lastName | string(64) | 姓 |
| firstName | string(64) | 名 |
| areaCode | string(32) | 区号 |
| phone | string(16) | 手机号 |
| vatNumber | string(64) | 增值税号 CPF/CNPJ |
| birthDate | string | 出生日期(yyyy-MM-dd) |
| string(32) | 收款人邮箱,条件字段 | |
| identityType | string(32) | 证件类型(例如,SSN等),条件字段 |
address 地址
address 字段说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| state | string(20) | 省/州 |
| city | string(64) | 城市 |
| addressLine1 | string(256) | 地址1 |
| addressLine2 | string(256) | 地址2 |
| addressLine3 | string(256) | 地址3 |
| postalCode | string(32) | 邮编 |
accountInfomation 账户信息
accountInfomation 字段说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| cardNumber | string(20) | 卡号/iban |
| accountType | string(64) | 账户类型 [0:checking, 1:saving, 2:ordinary] |
| swiftCode | string(256) | swift code |
| bankName | string(250) | 银行名称选填,填写以这个为准 |
| sortCode | string(256) | Sort Code/ABA |
| branchCode | string(256) | 分行编号 |
| bankHolderName | string(32) | 银行账户名 |
| walletType | string | 钱包类型枚举,钱包付款时填写 |
| walletPhone | string(64) | 钱包账号,按钱包账号格式填写手机号、邮箱、证件号或钱包平台账号 |
| pickUpBankName | string(256) | 取款机构 |
| pickUpBankBranchName | string(256) | 分支机构 |
| pickUpBankBranchId | string(256) | 分支机构ID |
| pickUpBankBranchAddress | string(32) | 分支机构地址 |
respCode 响应码
respCode
| 代码 | 描述 | 说明 |
|---|---|---|
| 0000 | 成功 | 请求处理成功 |
| 1001 | 参数错误 | 请求参数不符合要求 |
| 1002 | 签名错误 | 请求签名验证失败 |
| 1003 | 余额不足 | 账户余额不足以完成交易 |
| 1004 | 限额超限 | 超过交易限额 |
| 2001 | 系统错误 | 系统内部处理异常 |
| 2002 | 网络超时 | 网络连接超时 |
| 3001 | 账户冻结 | 账户被冻结无法操作 |
| 3002 | 重复请求 | 重复提交的请求 |
说明
- 所有枚举值区分大小写
- 币种代码遵循 ISO 4217 标准
- 响应码仅列出常见状态,详细错误码请参考错误码文档
records 字段说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| payoutId | integer | ID |
| paymentMethod | string | 交易方式 |
| payoutType | string | 出款类型 |
| settleCurrency | string | 结算币种 |
| settleSumAmount | number | 结算单汇总金额 |
| serviceFee | number | 手续费 |
| otherFee | number | 其他费用 |
| frozenAmount | number | 风控冻结金额 |
| settleAmount | number | 实际结算金额 |
| payoutCurrency | string | 出款币种 |
| payoutAmount | number | 出款金额 |
| convRate | number | 转换汇率 |
| merchantNo | integer | 商户号 |
| payeeId | integer | 收款方ID |
| payeeName | string | 收款方名称 |
| payeeBankName | string | 收款方银行名称 |
| payeeBankAddress | string | 收款方银行地址 |
| payeeAccount | string | 收款方账号 |
| payeeAccountCountry | string | 收款账户所在国家 |
| payeeAccountName | string | 收款账户户名 |
| payeeAccountSwiftCode | string | 收款账户 SWIFT CODE |
| payeeAccountLocalCode | string | 收款账户 LOCAL CODE |
| payeeCountry | string | 收款方国家 |
| payeeAddress | string | 收款方地址 |
| mobileNumber | string | 手机号 |
| payoutStatus | string | 出款状态 |
| payoutTips | string | 客户提示 |
| payoutRemark | string | 异常提示 |
| payoutTime | string | 出款时间 |
| distributeStatus | string | 代付状态 |
| distributePs | string | 交易附言 |
| transactionPurpose | string | 交易用途 |
| remark | string | 备注 |
| createTime | string | 创建时间 |
| updateTime | string | 更新时间 |
| payoutMethod | string | 付款方式payoutMethod枚举值 |
| firstName | string | 收款方-名字 |
| lastName | string | 收款方-姓氏 |
| companyName | string | 公司名称 |
payeeStatus 状态说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| WAITING | String | 等待中 |
| PROCESS | String | 处理中 |
| REJECT | String | 已拒绝 |
| PASS | String | 已通过 |
| FAIL | String | 失败 |
| UNNECESSARY | String | 不需要 |
| PENDING_UPDATE | String | 待更新 |