管理后台
供派娜(PayAny)聚合支付SaaS平台用户的员工进行管理合同、商户、终端、订单、退款、争议、运单、提现、报表等。
{platform}为manager。
合同
通常表示一份客户信息。以开户主体(如:公司,实际控制人等)作为独立单位,定义为合同。一个开户主体原则上建议只建立一个合同档案;每个合同下可以有不限制数量的商户。
创建
以相应的开户主体信息新增一个合同。
请求地址:/contract/create
请求谓词:POST
请求主体:
名称 | 类型 | 长度 | 必须 | 说明 |
---|---|---|---|---|
refNo | 文本 | 30 | 是 | 参考号 一般对应纸质合同上的编号 |
name | 文本 | 50 | 是 | 名称 一般为开户主体名称 |
响应主体:
名称 | 类型 | 必须 | 说明 |
---|---|---|---|
数值 | 是 | 当前创建合同的编号 |
响应示例:
{ "status":200, "message":"ok", "data":12345678, "timestamp":1218154088000}
编辑
对指定的合同进行修改。
请求地址:/contract/update/{id}
请求谓词:PUT
请求主体:
名称 | 类型 | 长度 | 必须 | 说明 |
---|---|---|---|---|
id | 数值 | 是 | 合同编号 为URL路径的一部分,非GET参数 | |
refNo | 文本 | 30 | 是 | 参考号 一般对应纸质合同上的编号 |
name | 文本 | 50 | 是 | 名称 一般为开户主体名称 |
响应主体:
名称 | 类型 | 必须 | 说明 |
---|---|---|---|
布尔 | 是 | true表示编辑成功 false表示编辑失败 |
响应示例:
{ "status":200, "message":"ok", "data":true, "timestamp":1218154088000}
详情
获取指定的合同的详细信息。
请求地址:/contract/get/{id}
请求谓词:GET
请求参数:
名称 | 类型 | 长度 | 必须 | 说明 |
---|---|---|---|---|
id | 数值 | 是 | 合同编号 为URL路径的一部分,非GET参数 |
响应主体:
名称 | 类型 | 必须 | 说明 |
---|---|---|---|
id | 数值 | 是 | 编号 |
refNo | 文本 | 是 | 参考号 |
name | 文本 | 是 | 名称 |
dateCreated | 时间 | 是 | 创建时间 |
dateUpdated | 时间 | 否 | 最后变更时间 |
响应示例:
{ "status":200, "message":"ok", "data":{ "id":12345678, "name":"杭州垚锋信息技术有限公司", "refNo":"V20G0001-1", "dateCreated":"2008-08-08T18:18:18", "dateUpdated":null }, "timestamp":1218154088000}
列表
以分页形式提供合同的筛选列表。
请求地址:/contract/list/{pageIndex}-{pageSize}
请求谓词:GET
请求参数:
名称 | 类型 | 长度 | 必须 | 说明 |
---|---|---|---|---|
pageIndex | 数值 | >=1 | 是 | 分页页码 为URL路径的一部分,非GET参数 |
pageSize | 数值 | 1~100 | 是 | 分页容量,建议20 为URL路径的一部分,非GET参数 |
contractId | 数值 | 否 | 合同编号 | |
name | 文本 | 50 | 否 | 合同名称 |
refNo | 文本 | 30 | 否 | 参考号 |
dateStart | 时间 yyyy-mm-dd hh:mm:ss | 否 | 起始时间,包含 如:2008-08-08 08:08:08 | |
dateEnd | 时间 yyyy-mm-dd hh:mm:ss | 否 | 截止时间,包含 如:2018-10-18 18:18:18 |
响应主体:
名称 | 类型 | 必须 | 说明 |
---|---|---|---|
pageIndex | 数值 | 是 | 分页页码 |
pageSize | 数值 | 是 | 分页容量 |
totalPageCount | 数值 | 是 | 总页数 |
totalItemCount | 数值 | 是 | 总记录数 |
items | 集合 | 是 | 对象集合,可以为空 |
items[].id | 数值 | 是 | 编号 |
items[].refNo | 文本 | 是 | 参考号 |
items[].name | 文本 | 是 | 名称 |
items[].dateCreated | 时间 | 是 | 创建时间 |
items[].dateUpdated | 时间 | 否 | 最后变更时间 |
响应示例:
{ "status":200, "message":"ok", "data":{ "pageIndex":1, "pageSize":20, "totalPageCount":123, "totalItemCount":2450, "items":[ { "id":12345678, "name":"杭州垚锋信息技术有限公司", "refNo":"V20G001-1", "dateCreated":"2008-08-08T18:18:18", "dateUpdated":null }, { "id":87654321, "name":"Payment Gateway SaaS System", "refNo":"V20G0002-1", "dateCreated":"2008-08-08T18:18:18", "dateUpdated":null }, //.... ] }, "timestamp":1218154088000}