亿邦留学支付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/order/query/list
根据订单号、支付单号及客户ID查询相关订单,也支持合作方查询在Ebon下单的全量支付单数据。每次请求最多返回1000条,默认返回100条。

请求参数

Header 参数

Body 参数application/json

示例
{
    "caseIds": [
        "string"
    ],
    "current": 0,
    "customerIds": [
        "string"
    ],
    "orderIds": [
        "string"
    ],
    "pageSize": 0
}

请求示例代码

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/order/query/list' \
--header 'ebfs-key: apiKey' \
--header 'ebfs-key: apiKey' \
--header 'ebfs-timestamp: timestamp' \
--header 'ebfs-timestamp: timestamp' \
--header 'ebfs-nonce;' \
--header 'ebfs-nonce;' \
--header 'ebfs-signature;' \
--header 'ebfs-signature;' \
--header 'x-token: {{x-token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "caseIds": [
        "string"
    ],
    "current": 0,
    "customerIds": [
        "string"
    ],
    "orderIds": [
        "string"
    ],
    "pageSize": 0
}'

返回响应

🟢200OK
application/json
Body

示例
{
    "code": "string",
    "data": {
        "current": 0,
        "list": [
            {
                "orderId": "string",
                "customerId": "string",
                "firstName": "string",
                "lastName": "string",
                "customerChineseName": "string",
                "payableAmount": 0,
                "payableCurrency": "string",
                "status": 0,
                "createTime": 0,
                "expiredTime": 0,
                "updateTime": 0
            }
        ],
        "pageSize": 0,
        "total": 0
    },
    "errorArgs": [
        {}
    ],
    "message": "string"
}
🟢201Created
🟠401Unauthorized
🟠403Forbidden
🟠404Not Found
修改于 2024-09-06 08:13:55
上一页
取消支付单
下一页
查询支付单详情
Built with