# 亿邦留学支付OpenAPI文档

## Docs
- [接口签名认证](https://api-edu.ebonpay.com/doc-4966325.md): 
- [总体流程说明](https://api-edu.ebonpay.com/doc-4995398.md): 
- [通用错误码](https://api-edu.ebonpay.com/doc-4995912.md): 
- [Request Param参数说明](https://api-edu.ebonpay.com/doc-5009433.md): 
- WEBHOOK [WEBHOOK 验签](https://api-edu.ebonpay.com/doc-4966838.md): 

## API Docs
- 订单API [创建订单](https://api-edu.ebonpay.com/api-204131316.md): 合作方提交学生基本信息、付款人基本信息、打款信息等，将用于备案及创建Ebon订单。
- 订单API [更新订单支付信息](https://api-edu.ebonpay.com/api-204878329.md): 当订单还处于已创建状态，支持修改收款学校、打款金额、打款币种。
- 订单API [获取可用渠道](https://api-edu.ebonpay.com/api-204131317.md): 通过订单号，获取当前最新可用渠道。
- 订单API [取消订单](https://api-edu.ebonpay.com/api-204131315.md): 当前订单处于已创建或待支付状态时，支持您直接取消当前订单。 若订单为打款中或已完成状态，代表Ebon已将款项打至您的意向账户，不支持退款。 其余状态，将进入人工退款流程。
- 订单API [查询订单列表](https://api-edu.ebonpay.com/api-204145104.md): 根据订单号及客户ID查询相关订单，也支持合作方查询在Ebon下单的全量订单数据。每次请求最多返回1000条，默认返回100条。
- 订单API [查询订单详情](https://api-edu.ebonpay.com/api-204647707.md): 根据订单号批量查询当前订单详情。
- 订单API [获取学校/机构列表](https://api-edu.ebonpay.com/api-209887186.md): 调用查询收款学校列表，无则代表Ebon将后置维护当前学校收款信息，不阻塞后续接口调用。
- 支付单API [创建支付单](https://api-edu.ebonpay.com/api-204131324.md): 针对订单选定渠道后，创建支付单。 支付单支持重复创建，您可选择订单下其中一个支付单进行付款。 支付单失效时间为您的最终锁汇时间，在有效期外付款，将有Ebon人工介入为您处理后续流程。
- 支付单API [取消支付单](https://api-edu.ebonpay.com/api-204647710.md): 当前订单处于未支付状态时，支持取消。Ebon不会取消您的订单，您可基于订单重新创建支付单。
- 支付单API [查询支付单列表](https://api-edu.ebonpay.com/api-204269098.md): 根据订单号、支付单号及客户ID查询相关订单，也支持合作方查询在Ebon下单的全量支付单数据。每次请求最多返回1000条，默认返回100条。
- 支付单API [查询支付单详情](https://api-edu.ebonpay.com/api-204647711.md): 根据支付单号批量查询当前支付单详情。
- 客户API [更新客户信息](https://api-edu.ebonpay.com/api-204131323.md): 调用更新客户基本信息。
- 客户API [查询客户列表](https://api-edu.ebonpay.com/api-204647709.md): 您可根据订单号及客户ID查询相应客户，也支持合作方查询在Ebon的全量客户数据。每次请求最多返回1000条，默认返回100条。
- 客户API [查询客户详情](https://api-edu.ebonpay.com/api-204647708.md): 根据Ebon客户唯一编码查询在Ebon录入的客户基础信息。
- 付款人API [更新付款人信息](https://api-edu.ebonpay.com/api-204131328.md): 用于更新付款人信息。
- 付款人API [查询付款人列表](https://api-edu.ebonpay.com/api-204145103.md): 根据订单号、客户ID、付款人ID查询相应付款人，也支持合作方查询在Ebon的全量付款人数据。每次请求最多返回1000条，默认返回100条。
- 付款人API [查询付款人详情](https://api-edu.ebonpay.com/api-204647712.md): 根据Ebon付款人唯一编码查询在Ebon录入的付款人基本信息。
- WEBHOOK [备案结果通知](https://api-edu.ebonpay.com/api-204400072.md): 返回订单备案情况，若备案被拒绝，需合作方重新提交付款人信息进行再次备案。
- WEBHOOK [支付单状态通知](https://api-edu.ebonpay.com/api-204410362.md): 通知支付单状态变更
- WEBHOOK [订单状态通知](https://api-edu.ebonpay.com/api-204411466.md): 通知订单状态变更
- 文件操作API [上传文件](https://api-edu.ebonpay.com/api-212264548.md): 
- 文件操作API [文件预览](https://api-edu.ebonpay.com/api-212262135.md): 
- 文件操作API [下载文件](https://api-edu.ebonpay.com/api-206206785.md): 根据文件key，下载文件

## Schemas
- Schemas [JsonResult«List«PayerQueryDetailResponse»»](https://api-edu.ebonpay.com/schema-114250559.md): 
- Schemas [Reference](https://api-edu.ebonpay.com/schema-114589344.md): 
- Schemas [JsonResult«string»](https://api-edu.ebonpay.com/schema-114251790.md): 
- Schemas [OrderDetail](https://api-edu.ebonpay.com/schema-113977927.md): 
- Schemas [JsonResult«null»](https://api-edu.ebonpay.com/schema-115126867.md): 
- Schemas [打款学校VO](https://api-edu.ebonpay.com/schema-113967481.md): 
- Schemas [CaseQueryStatusResponse](https://api-edu.ebonpay.com/schema-114039683.md): 
- Schemas [FileShowResponse](https://api-edu.ebonpay.com/schema-117189921.md): 
- Schemas [CaseQueryListResponse](https://api-edu.ebonpay.com/schema-113977928.md): 
- Schemas [OrderQueryListResponse](https://api-edu.ebonpay.com/schema-113967482.md): 
- Schemas [UpdateCaseRequest](https://api-edu.ebonpay.com/schema-114384411.md): 
- Schemas [OrderInfo](https://api-edu.ebonpay.com/schema-117189922.md): 
- Schemas [PageResult«CaseQueryListResponse»](https://api-edu.ebonpay.com/schema-113977929.md): 
- Schemas [PageResult«OrderQueryListResponse»](https://api-edu.ebonpay.com/schema-113967483.md): 
- Schemas [JsonResult«List«FileShowResponse»»](https://api-edu.ebonpay.com/schema-117189923.md): 
- Schemas [UpdateCustomerResponse](https://api-edu.ebonpay.com/schema-113967484.md): 
- Schemas [PayerQueryStatusRequest](https://api-edu.ebonpay.com/schema-114039684.md): 
- Schemas [CasePayerInfo](https://api-edu.ebonpay.com/schema-114348044.md): 
- Schemas [FileShowlRequest](https://api-edu.ebonpay.com/schema-117189924.md): 
- Schemas [CasePaymentInfo](https://api-edu.ebonpay.com/schema-114250540.md): 
- Schemas [CaseStatusNodeInfo](https://api-edu.ebonpay.com/schema-117189925.md): 
- Schemas [CaseOrderDetail](https://api-edu.ebonpay.com/schema-114250541.md): 
- Schemas [OrderQueryStatusResponse](https://api-edu.ebonpay.com/schema-114039685.md): 
- Schemas [StudyCaseReference](https://api-edu.ebonpay.com/schema-117189926.md): 
- Schemas [CaseBenecifiaryInfo](https://api-edu.ebonpay.com/schema-114250542.md): 
- Schemas [JsonResult«PayerQueryStatusResponse»](https://api-edu.ebonpay.com/schema-113977930.md): 
- Schemas [PayoutMethodResponse](https://api-edu.ebonpay.com/schema-114039686.md): 
- Schemas [PayeeInfo](https://api-edu.ebonpay.com/schema-117189927.md): 
- Schemas [CaseAccountInfo](https://api-edu.ebonpay.com/schema-114250543.md): 
- Schemas [PayerQueryStatusResponse](https://api-edu.ebonpay.com/schema-113977931.md): 
- Schemas [AccountInfo](https://api-edu.ebonpay.com/schema-113967489.md): 
- Schemas [PayoutDetail0](https://api-edu.ebonpay.com/schema-117189928.md): 
- Schemas [CaseQueryDetailResponse](https://api-edu.ebonpay.com/schema-114250544.md): 
- Schemas [CreateOrderResponse](https://api-edu.ebonpay.com/schema-113967490.md): 
- Schemas [CancelCaseRequest](https://api-edu.ebonpay.com/schema-113967491.md): 
- Schemas [JsonResult«List«PayerQueryStatusResponse»»](https://api-edu.ebonpay.com/schema-114039687.md): 
- Schemas [JsonResult«Void»](https://api-edu.ebonpay.com/schema-113967492.md): 
- Schemas [CreateCaseResponse](https://api-edu.ebonpay.com/schema-113967493.md): 
- Schemas [CustomerUpdateResponse](https://api-edu.ebonpay.com/schema-114039688.md): 
- Schemas [PayerInfo](https://api-edu.ebonpay.com/schema-117189929.md): 
- Schemas [PageResult«CreateCaseResponse»](https://api-edu.ebonpay.com/schema-113967494.md): 
- Schemas [OrderAccountInfo](https://api-edu.ebonpay.com/schema-114250545.md): 
- Schemas [PayerQueryListResponse](https://api-edu.ebonpay.com/schema-113977932.md): 
- Schemas [QueryCaseStatusRequest](https://api-edu.ebonpay.com/schema-113967495.md): 
- Schemas [OrderQueryDetailResponse](https://api-edu.ebonpay.com/schema-114250546.md): 
- Schemas [PageResult«PayerQueryListResponse»](https://api-edu.ebonpay.com/schema-113977933.md): 
- Schemas [ManualRefundRequest](https://api-edu.ebonpay.com/schema-113967496.md): 
- Schemas [JsonResult«List«打款学校VO»»](https://api-edu.ebonpay.com/schema-113967497.md): 
- Schemas [JsonResult«List«int»»](https://api-edu.ebonpay.com/schema-113967499.md): 
- Schemas [ChAddressMetaDataVO](https://api-edu.ebonpay.com/schema-117189930.md): 
- Schemas [QueryPayerStatusRequest](https://api-edu.ebonpay.com/schema-113967500.md): 
- Schemas [CustomerRelation](https://api-edu.ebonpay.com/schema-117189931.md): 
- Schemas [JsonResult«PageResult«OrderQueryListResponse»»](https://api-edu.ebonpay.com/schema-113967501.md): 
- Schemas [JsonResult«List«CustomerQueryDetailResponse»»](https://api-edu.ebonpay.com/schema-114348045.md): 
- Schemas [StudyAccountInfoResponse](https://api-edu.ebonpay.com/schema-117189932.md): 
- Schemas [JsonResult«PageResult«CaseQueryListResponse»»](https://api-edu.ebonpay.com/schema-113977934.md): 
- Schemas [OrderQueryListRequest](https://api-edu.ebonpay.com/schema-113967502.md): 
- Schemas [CustomerQueryListResponse](https://api-edu.ebonpay.com/schema-114039689.md): 
- Schemas [JsonResult«UpdateCustomerResponse»](https://api-edu.ebonpay.com/schema-113967503.md): 
- Schemas [PageResult«CustomerQueryListResponse»](https://api-edu.ebonpay.com/schema-114039690.md): 
- Schemas [UpdateCustomerRequest](https://api-edu.ebonpay.com/schema-113967504.md): 
- Schemas [PayerRelation](https://api-edu.ebonpay.com/schema-117189933.md): 
- Schemas [JsonResult«List«CaseQueryStatusResponse»»](https://api-edu.ebonpay.com/schema-114039691.md): 
- Schemas [JsonResult«CreateCaseResponse»](https://api-edu.ebonpay.com/schema-113967505.md): 
- Schemas [CreateCaseRequest](https://api-edu.ebonpay.com/schema-113967506.md): 
- Schemas [CaseQueryStatusRequest](https://api-edu.ebonpay.com/schema-114039692.md): 
- Schemas [QueryCustomerListRequest](https://api-edu.ebonpay.com/schema-113967507.md): 
- Schemas [CustomerListPayerInfo](https://api-edu.ebonpay.com/schema-114250547.md): 
- Schemas [JsonResult«PageResult«CreateCaseResponse»»](https://api-edu.ebonpay.com/schema-113967508.md): 
- Schemas [JsonResult«CreateOrderResponse»](https://api-edu.ebonpay.com/schema-113967509.md): 
- Schemas [CaseQueryListRequest](https://api-edu.ebonpay.com/schema-114039693.md): 
- Schemas [CreateOrderRequest](https://api-edu.ebonpay.com/schema-113967510.md): 
- Schemas [JsonResult«List«OrderQueryStatusResponse»»](https://api-edu.ebonpay.com/schema-114039694.md): 
- Schemas [OrderQueryStatusRequest](https://api-edu.ebonpay.com/schema-114039695.md): 
- Schemas [JsonResult«PageResult«PayerQueryListResponse»»](https://api-edu.ebonpay.com/schema-113977935.md): 
- Schemas [JsonResult«PayoutMethodResponse»](https://api-edu.ebonpay.com/schema-114039696.md): 
- Schemas [PayerQueryDetailResponse](https://api-edu.ebonpay.com/schema-114250548.md): 
- Schemas [CustomerQueryDetailResponse](https://api-edu.ebonpay.com/schema-114250549.md): 
- Schemas [PageResult«CustomerQueryDetailResponse»](https://api-edu.ebonpay.com/schema-114250550.md): 
- Schemas [JsonResult«CustomerUpdateResponse»](https://api-edu.ebonpay.com/schema-114039697.md): 
- Schemas [CustomerQueryDetailRequest](https://api-edu.ebonpay.com/schema-114250551.md): 
- Schemas [CustomerUpdateRequest](https://api-edu.ebonpay.com/schema-114039698.md): 
- Schemas [PayerReq](https://api-edu.ebonpay.com/schema-117189934.md): 
- Schemas [CustomerQueryListRequest](https://api-edu.ebonpay.com/schema-114039699.md): 
- Schemas [JsonResult«PageResult«CustomerQueryDetailResponse»»](https://api-edu.ebonpay.com/schema-114250552.md): 
- Schemas [JsonResult«PageResult«CustomerQueryListResponse»»](https://api-edu.ebonpay.com/schema-114039700.md): 
- Schemas [JsonResult«List«CaseQueryDetailResponse»»](https://api-edu.ebonpay.com/schema-114250553.md): 
- Schemas [CaseQueryDetailRequest](https://api-edu.ebonpay.com/schema-114250554.md): 
- Schemas [PayerQueryListRequest](https://api-edu.ebonpay.com/schema-114039701.md): 
- Schemas [GetPayoutMethodRequest](https://api-edu.ebonpay.com/schema-117189935.md): 
- Schemas [JsonResult«List«OrderQueryDetailResponse»»](https://api-edu.ebonpay.com/schema-114250555.md): 
- Schemas [GetPayeeListRequest](https://api-edu.ebonpay.com/schema-117189936.md): 
- Schemas [CancelOrderRequest](https://api-edu.ebonpay.com/schema-114250556.md): 
- Schemas [OrderQueryDetailRequest](https://api-edu.ebonpay.com/schema-114250557.md): 
- Schemas [PayerQueryDetailRequest](https://api-edu.ebonpay.com/schema-114250558.md): 
- Schemas [AddressMetaData](https://api-edu.ebonpay.com/schema-113967487.md): 
- Schemas [CustomerReq](https://api-edu.ebonpay.com/schema-113967488.md): 
- Schemas [PayoutDetail](https://api-edu.ebonpay.com/schema-113967485.md): 
- Schemas [ResubmitKycRequest](https://api-edu.ebonpay.com/schema-113967498.md): 
- Schemas [PayerDetail](https://api-edu.ebonpay.com/schema-113967486.md):