亿邦留学支付OpenAPI文档
  1. 订单API
亿邦留学支付OpenAPI文档
  • 接口签名认证
  • 总体流程说明
  • 通用错误码
  • Request Param参数说明
  • 订单API
    • 创建订单
      POST
    • 更新订单支付信息
      POST
    • 获取可用渠道
      POST
    • 取消订单
      POST
    • 查询订单列表
      POST
    • 查询订单详情
      POST
    • 获取学校/机构列表
      POST
  • 支付单API
    • 创建支付单
      POST
    • 取消支付单
      POST
    • 查询支付单列表
      POST
    • 查询支付单详情
      POST
  • 客户API
    • 更新客户信息
      POST
    • 查询客户列表
      POST
    • 查询客户详情
      POST
  • 付款人API
    • 更新付款人信息
      POST
    • 查询付款人列表
      POST
    • 查询付款人详情
      POST
  • WEBHOOK
    • WEBHOOK 验签
    • 备案结果通知
      POST
    • 支付单状态通知
      POST
    • 订单状态通知
      POST
  • 文件操作API
    • 上传文件
    • 文件预览
    • 下载文件
  • 数据模型
    • Schemas
      • JsonResult«List«PayerQueryDetailResponse»»
      • Reference
      • JsonResult«string»
      • OrderDetail
      • JsonResult«null»
      • 打款学校VO
      • CaseQueryStatusResponse
      • FileShowResponse
      • CaseQueryListResponse
      • OrderQueryListResponse
      • UpdateCaseRequest
      • OrderInfo
      • PageResult«CaseQueryListResponse»
      • PageResult«OrderQueryListResponse»
      • JsonResult«List«FileShowResponse»»
      • UpdateCustomerResponse
      • PayerQueryStatusRequest
      • CasePayerInfo
      • FileShowlRequest
      • CasePaymentInfo
      • CaseStatusNodeInfo
      • CaseOrderDetail
      • OrderQueryStatusResponse
      • StudyCaseReference
      • CaseBenecifiaryInfo
      • JsonResult«PayerQueryStatusResponse»
      • PayoutMethodResponse
      • PayeeInfo
      • CaseAccountInfo
      • PayerQueryStatusResponse
      • AccountInfo
      • PayoutDetail0
      • CaseQueryDetailResponse
      • CreateOrderResponse
      • CancelCaseRequest
      • JsonResult«List«PayerQueryStatusResponse»»
      • JsonResult«Void»
      • CreateCaseResponse
      • CustomerUpdateResponse
      • PayerInfo
      • PageResult«CreateCaseResponse»
      • OrderAccountInfo
      • PayerQueryListResponse
      • QueryCaseStatusRequest
      • OrderQueryDetailResponse
      • PageResult«PayerQueryListResponse»
      • ManualRefundRequest
      • JsonResult«List«打款学校VO»»
      • JsonResult«List«int»»
      • ChAddressMetaDataVO
      • QueryPayerStatusRequest
      • CustomerRelation
      • JsonResult«PageResult«OrderQueryListResponse»»
      • JsonResult«List«CustomerQueryDetailResponse»»
      • StudyAccountInfoResponse
      • JsonResult«PageResult«CaseQueryListResponse»»
      • OrderQueryListRequest
      • CustomerQueryListResponse
      • JsonResult«UpdateCustomerResponse»
      • PageResult«CustomerQueryListResponse»
      • UpdateCustomerRequest
      • PayerRelation
      • JsonResult«List«CaseQueryStatusResponse»»
      • JsonResult«CreateCaseResponse»
      • CreateCaseRequest
      • CaseQueryStatusRequest
      • QueryCustomerListRequest
      • CustomerListPayerInfo
      • JsonResult«PageResult«CreateCaseResponse»»
      • JsonResult«CreateOrderResponse»
      • CaseQueryListRequest
      • CreateOrderRequest
      • JsonResult«List«OrderQueryStatusResponse»»
      • OrderQueryStatusRequest
      • JsonResult«PageResult«PayerQueryListResponse»»
      • JsonResult«PayoutMethodResponse»
      • PayerQueryDetailResponse
      • CustomerQueryDetailResponse
      • PageResult«CustomerQueryDetailResponse»
      • JsonResult«CustomerUpdateResponse»
      • CustomerQueryDetailRequest
      • CustomerUpdateRequest
      • PayerReq
      • CustomerQueryListRequest
      • JsonResult«PageResult«CustomerQueryDetailResponse»»
      • JsonResult«PageResult«CustomerQueryListResponse»»
      • JsonResult«List«CaseQueryDetailResponse»»
      • CaseQueryDetailRequest
      • PayerQueryListRequest
      • GetPayoutMethodRequest
      • JsonResult«List«OrderQueryDetailResponse»»
      • GetPayeeListRequest
      • CancelOrderRequest
      • OrderQueryDetailRequest
      • PayerQueryDetailRequest
      • AddressMetaData
      • CustomerReq
      • PayoutDetail
      • ResubmitKycRequest
      • PayerDetail
  1. 订单API

创建订单

POST
/api/pay/studypay/case/create
合作方提交学生基本信息、付款人基本信息、打款信息等,将用于备案及创建Ebon订单。
学生首次申请付款,需传输全量信息进行客户及付款人创建。再次创建时,您可选择传输Customer ID及Payer ID交互。注意在同一次请求中,您只能选择 ID或Detail交互。
文件请使用上传文件接口获得文件ID后再回传。

请求参数

Header 参数

Body 参数application/json

示例
{"customerDetail":
{"addressMetaData":{"country":"中国","state":"浙江省","city":"杭州市","district":"余杭区","streetName":"仓前街道","streetNumber":"31",
  "unitNumber":"33","postcode":"310021"},
  "customerChineseName":"小希测试","firstName":"xiao","lastName":"xi","dateOfBirth":"2008-05-13","occupation":"学生",
  "nationality":"CN","phone":"13477494289","email":"g.vzrdpuc@qq.com","idType":"00","idNumber":"330124200805130214",
  "certIssueDate":"2010-11-08","certExpireDate":"2025-06-27","certFront":"ebfs/studypay/8bd15004-3944-478e-a3ae-d47f036ef3bf.bmp",
  "certBack":"ebfs/studypay/8bd15004-3944-478e-a3ae-d47f036ef3bf.bmp",
  "studentId":"74123333333333"},"payerDetail":{"address":"宁夏回族自治区台东县分宜县",
  "addressMetaData":{"country":"中国","state":"浙江省","city":"杭州市","district":"余杭区","streetName":"仓前街道",
    "streetNumber":"2","unitNumber":"100","postcode":"24"},"payerName":"小希付款人大大大大","firstName":"ceshi","lastName":"xiaoxi",
  "payerRelation":1,"dateOfBirth":"1995-09-28","idType":"00","idNumber":"330125199509280125",
  "certFront":"ebfs/studypay/8bd15004-3944-478e-a3ae-d47f036ef3bf.bmp","certBack":"ebfs/studypay/8bd15004-3944-478e-a3ae-d47f036ef3bf.bmp",
  "certIssueDate":"2001-02-19",
  "certExpireDate":"2025-11-10","payerNationality":"CN"},"payoutDetails":[{"payItems":["1","2"],
  "payAmount":"8000.00","payCurrency":"AUD","payeeName":"university xiao xi","referenceList":[{"referenceType":"00",
    "referenceValue":"1222322"}],"attachment":["ebfs/studypay/8bd15004-3944-478e-a3ae-d47f036ef3bf.bmp","ebfs/studypay/8bd15004-3944-478e-a3ae-d47f036ef3bf.bmp"]},{"payItems":["1","2"],
  "payAmount":"6000.00","payCurrency":"AUD","payeeName":"university xiao xi","referenceList":[{"referenceType":"00",
    "referenceValue":"12312312"}],"attachment":["ebfs/studypay/8bd15004-3944-478e-a3ae-d47f036ef3bf.bmp",
    "ebfs/studypay/8bd15004-3944-478e-a3ae-d47f036ef3bf.bmp"]}],"requestId":"TEST202409100003"}

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/api/pay/studypay/case/create' \
--header 'x-token: {{x-token}}' \
--header 'ebfs-key: apiKey' \
--header 'ebfs-timestamp: timestamp' \
--header 'ebfs-nonce;' \
--header 'ebfs-signature;' \
--header 'Content-Type: application/json' \
--data-raw '{"customerDetail":
{"addressMetaData":{"country":"中国","state":"浙江省","city":"杭州市","district":"余杭区","streetName":"仓前街道","streetNumber":"31",
  "unitNumber":"33","postcode":"310021"},
  "customerChineseName":"小希测试","firstName":"xiao","lastName":"xi","dateOfBirth":"2008-05-13","occupation":"学生",
  "nationality":"CN","phone":"13477494289","email":"g.vzrdpuc@qq.com","idType":"00","idNumber":"330124200805130214",
  "certIssueDate":"2010-11-08","certExpireDate":"2025-06-27","certFront":"ebfs/studypay/8bd15004-3944-478e-a3ae-d47f036ef3bf.bmp",
  "certBack":"ebfs/studypay/8bd15004-3944-478e-a3ae-d47f036ef3bf.bmp",
  "studentId":"74123333333333"},"payerDetail":{"address":"宁夏回族自治区台东县分宜县",
  "addressMetaData":{"country":"中国","state":"浙江省","city":"杭州市","district":"余杭区","streetName":"仓前街道",
    "streetNumber":"2","unitNumber":"100","postcode":"24"},"payerName":"小希付款人大大大大","firstName":"ceshi","lastName":"xiaoxi",
  "payerRelation":1,"dateOfBirth":"1995-09-28","idType":"00","idNumber":"330125199509280125",
  "certFront":"ebfs/studypay/8bd15004-3944-478e-a3ae-d47f036ef3bf.bmp","certBack":"ebfs/studypay/8bd15004-3944-478e-a3ae-d47f036ef3bf.bmp",
  "certIssueDate":"2001-02-19",
  "certExpireDate":"2025-11-10","payerNationality":"CN"},"payoutDetails":[{"payItems":["1","2"],
  "payAmount":"8000.00","payCurrency":"AUD","payeeName":"university xiao xi","referenceList":[{"referenceType":"00",
    "referenceValue":"1222322"}],"attachment":["ebfs/studypay/8bd15004-3944-478e-a3ae-d47f036ef3bf.bmp","ebfs/studypay/8bd15004-3944-478e-a3ae-d47f036ef3bf.bmp"]},{"payItems":["1","2"],
  "payAmount":"6000.00","payCurrency":"AUD","payeeName":"university xiao xi","referenceList":[{"referenceType":"00",
    "referenceValue":"12312312"}],"attachment":["ebfs/studypay/8bd15004-3944-478e-a3ae-d47f036ef3bf.bmp",
    "ebfs/studypay/8bd15004-3944-478e-a3ae-d47f036ef3bf.bmp"]}],"requestId":"TEST202409100003"}'

返回响应

🟢200OK
application/json
Body

示例
{
    "code": "string",
    "data": {
        "caseId": "string",
        "customerId": "string",
        "payerId": "string",
        "payoutMethod": [
            0
        ]
    },
    "errorArgs": [
        {}
    ],
    "message": "string"
}
🟢201Created
🟠401Unauthorized
🟠403Forbidden
🟠404Not Found
修改于 2024-10-22 01:15:36
上一页
Request Param参数说明
下一页
更新订单支付信息
Built with