EasyPay API
EasyPay 官网
EasyPay 官网
  1. 付款
  • 文档介绍
    • 调用说明
    • 认证
    • 异常
    • 版本
    • 请求幂等
    • 对接指引
    • API 清单
  • 认证
    • 认证
      POST
  • 账户
    • 创建账户
      POST
    • 查询账户列表
      GET
    • 查询账户
      GET
    • 修改账户实名
      PUT
  • 余额
    • 查询账户余额
      GET
  • 申请收款账户
    • 申请收款账户
      POST
    • 查询申请列表
      GET
    • 查询申请
      GET
  • 收款账户
    • 查询收款账户列表
      GET
    • 查询收款账户
      GET
  • 收单
    • 支付
      • APP 支付
      • 小程序支付
      • 公众号支付
      • H5支付
      • 查询支付单
      • 取消支付单
      • 查询支付单列表
    • 退款
      • 退款
      • 查询退款
      • 查询退款单列表
    • 对账单
      • 查询对账单列表
    • 结算单
      • 查询结算单列表
      • 查询结算单
    • 报关
      • 报关
      • 身份信息校验
      • 报关查询
      • 报关重推
      • 报关信息修改
    • 汇率
      • 查询渠道汇率
  • 入账
    • 查询入账列表
    • 查询入账
    • 入账凭证下载
  • 汇率
    • 查询汇率
  • 换汇
    • 创建换汇订单
    • 查询换汇订单列表
    • 查询换汇订单
    • 更新结汇明细
    • 手动确认交割
  • 付款
    • 付款
      POST
    • 查询付款列表
      GET
    • 查询付款
      GET
    • 补充材料
      POST
    • 付款凭证下载
      GET
  • 转账
    • 转账
    • 查询转账列表
    • 查询转账
  • 流水
    • 查询账户流水
    • 根据 transaction ID 查询
  • 账户实名更新请求
    • 查询实名更新请求列表
    • 提交实名更新
  • 收款人
    • 收款人信息校验
  • 模拟
    • 通过实名
    • 驳回实名
    • 创建实名更新
    • 通过实名更新
    • 拒绝更新请求
    • 收款账户审核通过
    • 收款账户审核驳回
    • 入账
    • 通过付款
    • 拒绝付款
    • 通过换汇
    • 拒绝换汇
    • 通过提现
    • 拒绝提现
    • 收款
  • Webhooks
    • 创建 Webhook
    • 查询 Webhook
    • 修改 Webhook
    • 删除 Webhook
    • 创建 Webhook HMAC Key
  • 通知
    • 账户审核通过
    • 账户审核驳回
    • 实名待更新
    • 实名更新审核通过
    • 实名更新审核驳回
    • 收款账户申请成功
    • 收款账户申请失败
    • 收款账户已下发
    • 收款账户信息变更
    • 收单支付成功通知
    • 收单退款成功通知
    • 收单退款失败通知
    • 入账成功
    • 换汇成功
    • 换汇失败
    • 结汇明细失败
    • 付款成功
    • 付款失败
    • 付款银行退回
    • 转账成功
    • 转账失败
  1. 付款

付款

POST
/v1/payments

请求参数

Header 参数
Authorization
string 
可选
默认值:
Bearer {{access_token}}
Body 参数application/json
request_id
string 
必需
reference
string 
可选
account_id
string 
账户id
必需
currency
enum<string> 
币种
必需
枚举值:
AUDUSDEURGBPJPYHKDSGDNZDCNHCNYNOK
amount
integer 
金额
必需
payer
object (PaymentPayer) 
付款人信息
可选
name
string 
企业名称/个人姓名
必需
legal_entity_type
string 
必需
类型 PERSON/COMPANY
license_number
string 
营业执照号
可选
cr_number
string 
可选
公司注册书编号(境外企业)
dob
string 
必需
企业成立日期/个人出生日期
industry
string 
可选
【企业必填】所属行业
id_type
string 
可选
个人证件类型 ID_CARD/PASSPORT
id_card_number
string 
身份证号
可选
passport_number
string 
护照号
可选
occupation
string 
【个人必填】职业
可选
psuid
string 
在机构的唯一识别号
必需
address
object 
地址信息
必需
beneficiary
object (Beneficiary) 
收款人信息
必需
legal_entity_type
enum<string> 
账户类型
必需
枚举值:
PERSONCOMPANY
payment_type
enum<string>  | enum<null> 
付款方式
可选
枚举值:
LOCALSWIFT
region
string 
地区
必需
currency
string 
币种
必需
bank_name
string 
银行名称
必需
bank_branch_name
string  | null 
银行支行名称
可选
bank_location
string  | null 
银行地址
可选
account_holder_name
string 
必需
银行账户持有人 (支持填写汉字 英文字母大小写 空格 英文符号 ! # $ % ‘ ( ) * + , - . / : ; ‘= ? @ [ ] ^ _ ` { } ~ 其它均不支持)
account_number
string 
银行账号/IBAN
必需
bic_number
string  | null 
路由号/SWIFT
可选
aba
string  | null 
ABA
可选
sort_code
string  | null 
Sort Code
可选
id_number
string  | null 
收款方证件号
可选
cnaps_code
string 
可选
联行号[企业人民币付款必填]
mobile
string  | null 
收款方联系方式
可选
first_name
string  | null 
可选
收款方 first name
last_name
string  | null 
可选
收款方 last name
state_or_province
string  | null 
收款方所在州或省
可选
city
string  | null 
收款方所在城市
可选
address
string  | null 
可选
收款方所在地址 (支持填写汉字 英文字母大小写 空格 英文符号 ! # $ % ‘ ( ) * + , - . / : ; ‘= ? @ [ ] ^ _ ` { } ~ 其它均不支持)
zip_code
string  | null 
收款方所在地邮编
可选
relationship
enum<string>  | enum<null> 
与收款方关系
可选
枚举值:
Sharehold / DirectorParent Company to holding companySubsidiaryBusiness partnersEmployerRelativesColleague
正则匹配:
[a-zA-Z0-9/\-:.,+\s]+
intermediary_bank_bic_number
string  | null 
可选
指定中转行路由号/SWIFT (2024-12-10生效)
business_nature
string  | null 
主营业务
可选
正则匹配:
[a-zA-Z0-9/\-:.,+\s]+
company_website
string  | null 
公司网址
可选
正则匹配:
[a-zA-Z0-9/\-:.,+\s]+
comment
string 
可选
银行汇款附言(外币付款必填)
purpose
string 
可选
付款原因(外币付款必填)
source_of_funds
string 
可选
资金来源,可填参考 INVESTMENT 投资,SHAREHOLDER 股东,BUSINESS 经营
正则匹配:
[a-zA-Z0-9/\-:.,+\s]+
bank_fee_payer
enum<string>  | enum<null> 
手续费承担方
可选
枚举值:
SHABENOUR
documents
array[string] | null 
可选
补充文件(oss 对应的文件路径)
示例
{
    "request_id": "string",
    "reference": "string",
    "account_id": "string",
    "currency": "AUD",
    "amount": 0,
    "payer": {
        "name": "string",
        "legal_entity_type": "string",
        "license_number": "string",
        "cr_number": "string",
        "dob": "string",
        "industry": "string",
        "id_type": "string",
        "id_card_number": "string",
        "passport_number": "string",
        "occupation": "string",
        "psuid": "string",
        "address": {
            "region": "string",
            "state_or_province": "string",
            "city": "string",
            "street": "string",
            "zip_code": "string"
        }
    },
    "beneficiary": {
        "legal_entity_type": "PERSON",
        "payment_type": "LOCAL",
        "region": "string",
        "currency": "string",
        "bank_name": "string",
        "bank_branch_name": "string",
        "bank_location": "string",
        "account_holder_name": "string",
        "account_number": "string",
        "bic_number": "string",
        "aba": "string",
        "sort_code": "string",
        "id_number": "string",
        "cnaps_code": "string",
        "mobile": "string",
        "first_name": "string",
        "last_name": "string",
        "state_or_province": "string",
        "city": "string",
        "address": "string",
        "zip_code": "string",
        "relationship": "Sharehold / Director",
        "intermediary_bank_bic_number": "string",
        "business_nature": "string",
        "company_website": "string"
    },
    "comment": "string",
    "purpose": "string",
    "source_of_funds": "string",
    "bank_fee_payer": "SHA",
    "documents": [
        "string"
    ]
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://demo-api.easypayx.com/v1/payments' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "request_id": "string",
    "reference": "string",
    "account_id": "string",
    "currency": "AUD",
    "amount": 0,
    "payer": {
        "name": "string",
        "legal_entity_type": "string",
        "license_number": "string",
        "cr_number": "string",
        "dob": "string",
        "industry": "string",
        "id_type": "string",
        "id_card_number": "string",
        "passport_number": "string",
        "occupation": "string",
        "psuid": "string",
        "address": {
            "region": "string",
            "state_or_province": "string",
            "city": "string",
            "street": "string",
            "zip_code": "string"
        }
    },
    "beneficiary": {
        "legal_entity_type": "PERSON",
        "payment_type": "LOCAL",
        "region": "string",
        "currency": "string",
        "bank_name": "string",
        "bank_branch_name": "string",
        "bank_location": "string",
        "account_holder_name": "string",
        "account_number": "string",
        "bic_number": "string",
        "aba": "string",
        "sort_code": "string",
        "id_number": "string",
        "cnaps_code": "string",
        "mobile": "string",
        "first_name": "string",
        "last_name": "string",
        "state_or_province": "string",
        "city": "string",
        "address": "string",
        "zip_code": "string",
        "relationship": "Sharehold / Director",
        "intermediary_bank_bic_number": "string",
        "business_nature": "string",
        "company_website": "string"
    },
    "comment": "string",
    "purpose": "string",
    "source_of_funds": "string",
    "bank_fee_payer": "SHA",
    "documents": [
        "string"
    ]
}'

返回响应

🟢201OK
application/json
Body
data
object (Payment) 
必需
id
string 
订单 ID
可选
order_no
string 
订单号
可选
request_id
string 
可选
reference
string 
可选
account_id
string 
账户 ID
可选
currency
string 
币种
可选
amount
integer 
金额,单位为分
可选
payer
object (PaymentPayer) 
付款人信息
可选
beneficiary
object (Beneficiary) 
收款人信息
可选
exchange_rate
number 
汇率
可选
fee
integer 
手续费
可选
fee_currency
string 
手续费币种
可选
outward_currency
string 
到账币种
可选
outward_amount
integer 
到账金额(换汇后)
可选
comment
string 
银行汇款附言
可选
purpose
string 
付款原因
可选
status
enum<string> 
订单状态
可选
枚举值:
PENDINGSUCCESSFAILED
reason
string 
订单失败原因
可选
source_of_funds 
enum<string> 
资金来源
可选
枚举值:
INVESTMENTSHAREHOLDERBUSINESS
create_time
string 
订单创建时间
可选
update_time
string 
订单最近更新时间
可选
completed_time
string 
订单结束时间
可选
示例
{
    "data": {
        "id": "string",
        "order_no": "string",
        "request_id": "string",
        "reference": "string",
        "account_id": "string",
        "currency": "string",
        "amount": 0,
        "payer": {
            "name": "string",
            "legal_entity_type": "string",
            "license_number": "string",
            "cr_number": "string",
            "dob": "string",
            "industry": "string",
            "id_type": "string",
            "id_card_number": "string",
            "passport_number": "string",
            "occupation": "string",
            "psuid": "string",
            "address": {
                "region": "string",
                "state_or_province": "string",
                "city": "string",
                "street": "string",
                "zip_code": "string"
            }
        },
        "beneficiary": {
            "legal_entity_type": "PERSON",
            "payment_type": "LOCAL",
            "region": "string",
            "currency": "string",
            "bank_name": "string",
            "bank_branch_name": "string",
            "bank_location": "string",
            "account_holder_name": "string",
            "account_number": "string",
            "bic_number": "string",
            "aba": "string",
            "sort_code": "string",
            "id_number": "string",
            "cnaps_code": "string",
            "mobile": "string",
            "first_name": "string",
            "last_name": "string",
            "state_or_province": "string",
            "city": "string",
            "address": "string",
            "zip_code": "string",
            "relationship": "Sharehold / Director",
            "intermediary_bank_bic_number": "string",
            "business_nature": "string",
            "company_website": "string"
        },
        "exchange_rate": 0,
        "fee": 0,
        "fee_currency": "string",
        "outward_currency": "string",
        "outward_amount": 0,
        "comment": "string",
        "purpose": "string",
        "status": "PENDING",
        "reason": "string",
        "source_of_funds ": "INVESTMENT",
        "create_time": "string",
        "update_time": "string",
        "completed_time": "string"
    }
}
修改于 2025-06-16 10:11:12
上一页
手动确认交割
下一页
查询付款列表
Built with