管理后台
供派娜(PayAny)聚合支付SaaS平台用户的员工进行管理合同、商户、终端、订单、退款、争议、运单、提现、报表等。
{platform}为manager。
订单
交易记录;包含测试、正式;包含收款、付款。
列表
以分页形式提供订单筛选的列表。
请求地址:/order/list/{pageIndex}-{pageSize}
请求谓词:GET
请求参数:
名称 | 类型 | 长度 | 必须 | 说明 |
---|---|---|---|---|
pageIndex | 数值 | >=1 | 是 | 分页页码 为URL路径的一部分,非GET参数 |
pageSize | 数值 | 1~100 | 是 | 分页容量,建议20 为URL路径的一部分,非GET参数 |
txnId | 文本 | 否 | 交易号 | |
merchantId | 数值 | 否 | 商户编号 | |
terminalId | 数值 | 否 | 终端编号 | |
gatewayId | 数值 | 否 | 网关编号 | |
source | 文本 | 80 | 否 | 域名/包名 |
orderId | 文本 | 50 | 否 | 订单号 |
cardTypes | 数组 | [限定范围] | 否 | 卡类型 0:无,1:维萨卡,2:万事达卡, 4:JCB卡,8:美国运通卡,16:发现卡, 32:大莱卡,64:银联卡 |
cardNumber | 文本 | 16 | 否 | 令牌化卡号 |
文本 | 100 | 否 | 邮箱 | |
ipAddress | 文本 | 150 | 否 | IP地址 |
originalCurrency | 文本 | 3 | 否 | 原始货币 |
originalAmountMin | 金额 | 否 | 原始最小金额 | |
originalAmountMax | 金额 | 否 | 原始最大金额 | |
settleCurrency | 文本 | 3 | 否 | 结算货币 |
settleAmountMin | 金额 | 否 | 结算最小金额 | |
settleAmountMax | 金额 | 否 | 结算最大金额 | |
billingCountry | 文本 | 2 | 否 | 账单国家 |
shippingCountry | 文本 | 2 | 否 | 收货地址国家 |
hasRefund | 布尔 | 否 | 是否退款 | |
hasChargeback | 布尔 | 否 | 是否拒付 | |
hasCopyRequest | 布尔 | 否 | 是否调单 | |
hasWaybill | 布尔 | 否 | 是否上传运单 | |
test | 布尔 | 否 | 是否为测试订单 | |
status | 数组 | [限定范围] | 否 | 订单状态 0:处理中,1:已授权,2:待审核, 3:已捕获,4:已失败,5:已拒绝, 6:已结算,98:已超时,99:未引用 |
reasonCode | 数值 | [限定范围] | 否 | 原因码 0:其他,1:不予承兑,2:卡号无效, 3:卡片已过期,4:账户没有足够的资金,5:卡片丢失或者被盗, 6:卡片未激活,7:超过账户信用额度限制,8:安全码无效, 9:受限卡,10:发卡行返回超时,11:超过重试次数限制, 12:重复订单,13:无效交易,14:未授权, 15:高风险,16:OTP/3D验证,17:网关处理超时, 18:网关异常,19:托管,99:成功 |
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[].txnId | 文本 | 是 | 交易号 |
items[].merchantId | 数值 | 是 | 商户编号 |
items[].terminalId | 数值 | 是 | 终端编号 |
items[].gatewayId | 数值 | 否 | 网关编号 |
items[].orderId | 文本 | 是 | 订单号 |
items[].email | 文本 | 是 | 邮箱 |
items[].source | 文本 | 是 | 来源 |
items[].iPAddress | 文本 | 是 | IP地址 |
items[].cardType | 数值 | 是 | 卡类型 参考请求处声明 |
items[].cardNumber | 文本 | 否 | 卡号 |
items[].originalCurrency | 文本 | 是 | 原始货币 |
items[].originalAmount | 数值 | 是 | 原始金额 |
items[].transactionCurrency | 文本 | 是 | 交易货币 |
items[].transactionAmount | 数值 | 是 | 交易金额 |
items[].settleCurrency | 文本 | 是 | 结算货币 |
items[].settleAmount | 数值 | 是 | 结算金额 |
items[].billingCountry | 文本 | 否 | 账单国家 |
items[].shippingCountry | 文本 | 否 | 订单国家 |
items[].hasRefund | 布尔 | 是 | 是否退款 |
items[].hasChargeback | 布尔 | 是 | 是否拒付 |
items[].hasCopyRequest | 布尔 | 是 | 是否调单 |
items[].hasWaybill | 布尔 | 是 | 是否上传运单 |
items[].reason | 文本 | 否 | 原因代码 参考请求处声明 |
items[].status | 数值 | 是 | 状态 参考请求处声明 |
items[].test | 布尔 | 是 | 是否测试订单 |
items[].dateSuccess | 时间 | 否 | 成功时间 |
items[].dateCreated | 时间 | 是 | 创建时间 |
items[].dateUpdated | 时间 | 否 | 最后变更时间 |
响应示例:
{ "status":200, "message":"ok", "data":{ "pageIndex":1, "pageSize":20, "totalPageCount":123, "totalItemCount":2450, "items":[ { "txnId":"20080808200808", "merchantId":12345678, "tenantId":123456, "terminalId":79618052, "gatewayId":123, "orderId":"OG08123456", "email":"tester@dev.com", "source":"example.com", "iPAddress":"127.0.0.1", "cardType":1, "cardNumber":"4111111111111111", "originalCurrency":"USD", "originalAmount":100.00, "transactionCurrency":"CNY", "transactionAmount":641.26, "settleCurrency":"CNY", "settleAmount":635.25, "billingCountry":"US", "shippingCountry":"US", "hasRefund":"0", "hasChargeback":"0", "hasCopyRequest":"0", "hasWaybill":"1", "reason":1, "status":3, "test":true, "dateCreated":"2008-08-08T18:18:18", "dateUpdated":null, "dateSuccess":"2008-08-08T18:18:18", }, //.... ] }, "timestamp":1218154088000}
详情
以下共通。
请求谓词:GET
请求参数:
名称 | 类型 | 长度 | 必须 | 说明 |
---|---|---|---|---|
txnId | 文本 | 是 | 交易号 为URL路径的一部分,非GET参数 |
索引
获取指定的订单索引详细信息。
请求地址:/orders/index/{txnId}
响应主体:
名称 | 类型 | 必须 | 说明 |
---|---|---|---|
txnId | 文本 | 是 | 交易号 |
merchantId | 数值 | 是 | 商户编号 |
terminalId | 数值 | 是 | 终端编号 |
gatewayId | 数值 | 否 | 网关编号 |
orderId | 文本 | 是 | 订单号 |
文本 | 是 | 邮箱 | |
source | 文本 | 是 | 来源 |
iPAddress | 文本 | 是 | IP地址 |
cardType | 数值 | 是 | 卡类型 参考请求处声明 |
cardNumber | 文本 | 否 | 卡号 |
originalCurrency | 文本 | 是 | 原始货币 |
originalAmount | 数值 | 是 | 原始金额 |
transactionCurrency | 文本 | 是 | 交易货币 |
transactionAmount | 数值 | 是 | 交易金额 |
settleCurrency | 文本 | 是 | 结算货币 |
settleAmount | 数值 | 是 | 结算金额 |
billingCountry | 文本 | 否 | 账单国家 |
shippingCountry | 文本 | 否 | 订单国家 |
hasRefund | 布尔 | 是 | 是否退款 |
hasChargeback | 布尔 | 是 | 是否拒付 |
hasCopyRequest | 布尔 | 是 | 是否调单 |
hasWaybill | 布尔 | 是 | 是否上传运单 |
reason | 文本 | 否 | 原因代码 参考请求处声明 |
status | 数值 | 是 | 状态 参考请求处声明 |
test | 布尔 | 是 | 是否测试订单 |
dateSuccess | 时间 | 否 | 成功时间 |
dateCreated | 时间 | 是 | 创建时间 |
dateUpdated | 时间 | 否 | 最后变更时间 |
响应示例:
{ "status":200, "message":"ok", "data":{ "txnId":"20080808200808", "merchantId":12345678, "tenantId":123456, "terminalId":79618052, "gatewayId":123, "orderId":"123-123", "email":"tester@168.com", "source":"example.com", "iPAddress":"127.0.0.1", "cardType":1, "cardNumber":"4111111111111111", "originalCurrency":"USD", "originalAmount":100.00, "transactionCurrency":"CNY", "transactionAmount":681.26, "settleCurrency":"CNY", "settleAmount":660.25, "billingCountry":"US", "shippingCountry":"US", "hasRefund":"0", "hasChargeback":"0", "hasCopyRequest":"0", "hasWaybill":"1", "reason":1, "status":3, "test":true, "dateCreated":"2008-08-08T18:18:18", "dateUpdated":null, "dateSuccess":"2008-08-08T18:18:18", }, "timestamp":1218154088000}
基础
获取指定的订单基础详细信息。
请求地址:/orders/base/{txnId}
响应主体:
名称 | 类型 | 必须 | 说明 |
---|---|---|---|
txnId | 文本 | 是 | 交易号 |
test | 布尔 | 是 | 是否测试 |
integrate | 数值 | 是 | 集成模式 0:无,1:直连,2:托管 |
currency | 文本 | 是 | 交易货币 |
amount | 金额 | 是 | 订单金额 |
tax | 金额 | 是 | 税 |
freight | 金额 | 是 | 运费 |
discount | 金额 | 是 | 折扣 |
文本 | 是 | 邮箱 | |
source | 文本 | 是 | 域名/包名 |
iPAddress | 文本 | 是 | IP地址 |
响应示例:
{ "status":200, "message":"ok", "data":{ "txnId":"20080808200808", "test":false, "integrate":1, "currency":"CNY", "amount":1.00, "tax":0.00, "freight":0.00, "discount":0.00, "email":"tester@yaofeng.com", "source":"example.com", "iPAddress":"127.0.0.1", }, "timestamp":1218154088000}
金额
获取指定的订单金额信息。
请求地址:/orders/amount/{txnId}
响应主体:
名称 | 类型 | 必须 | 说明 |
---|---|---|---|
txnId | 文本 | 是 | 交易号 |
originalCurrency | 文本 | 是 | 原始货币 |
originalAmount | 金额 | 是 | 原始金额 |
settleCurrency | 文本 | 是 | 结算货币 |
settleAmount | 金额 | 是 | 结算金额 |
transactionCurrency | 文本 | 是 | 交易货币(预计) |
transactionAmount | 金额 | 是 | 交易金额(预计) |
depositAmount | 金额 | 是 | 押金 |
feeRate | 金额 | 是 | 交易处理费 |
fixedFee | 金额 | 是 | 交易手续费 |
settledAmount | 金额 | 是 | 当前已结算金额 |
thawAmount | 金额 | 是 | 当前押金已解冻额 |
returnRate | 金额 | 是 | 当前已返还汇率差 |
isSettled | 布尔 | 是 | 是否已全额结算 |
isThawed | 布尔 | 是 | 是否全额解冻押金 |
dateUpdated | 时间 | 是 | 最后更新时间 |
响应示例:
{ "status":200, "message":"ok", "data":{ "txnId":"20080808200808", "originalCurrency":"USD", "originalAmount":100.00, "settleCurrency":"CNY", "settleAmount":632.45, "transactionCurrency":CNY, "transactionAmount":645.78, "depositAmount":10, "feeRate":6.46, "fixedFee":3.00, "settledAmount":0, "thawAmount":0, "returnRate":0, "isSettled":0, "isThawed":0, "dateUpdated":"2008-08-08T18:18:18", }, "timestamp":1218154088000}
地址
获取指定的订单的地址详细信息。
请求地址:/orders/address/{txnId}/{type}
请求参数:
名称 | 类型 | 长度 | 必须 | 说明 |
---|---|---|---|---|
type | 数值 | 是 | 类型 0:账单地址,1:收货地址 为URL路径的一部分,非GET参数 |
响应主体:
名称 | 类型 | 必须 | 说明 |
---|---|---|---|
txnId | 文本 | 是 | 交易号 |
type | 数值 | 是 | 类型 |
firstName | 文本 | 是 | 姓 |
lastName | 文本 | 是 | 名 |
address1 | 文本 | 是 | 地址1 |
address2 | 文本 | 否 | 地址2 |
city | 文本 | 是 | 城市 |
state | 文本 | 是 | 州/省 |
country | 文本 | 是 | 国家 |
telephone | 文本 | 是 | 电话 |
zipcode | 文本 | 是 | 邮编 |
响应示例:
{ "status":200, "message":"ok", "data":{ "txnId":"20080808200808", "type":1, "firstName":"feng", "lastName":"yao", "address1":"binjiang xixing street", "address2":"tianheng", "city":"hangzhou", "state":"binjiang", "country":"CN", "telephone":"18890909898", "zipcode":"310000", }, "timestamp":1218154088000}
商品
获取指定的订单商品详细信息。
请求地址:/orders/products/{txnId}
响应主体:
名称 | 类型 | 必须 | 说明 |
---|---|---|---|
[].txnId | 文本 | 是 | 交易号 |
[].sku | 文本 | 是 | SKU |
[].name | 文本 | 是 | 名称 |
[].image | 文本 | 否 | 图片链接 |
[].model | 文本 | 否 | 型号/颜色/尺寸... |
[].quantity | 数值 | 是 | 数量 |
[].price | 金额 | 是 | 单价 |
[].link | 文本 | 否 | 链接 |
响应示例:
{ "status":200, "message":"ok", "data":[ { "txnId":"20080808200808", "sku":"1001", "name":"ihpone 88", "image":null, "model":"1024G", "quantity":1, "price":866.99, "link":"https://shop.example.com/product/1001", }, //.... ], "timestamp":1218154088000}
交互地址
获取指定的订单交互地址详细信息。
请求地址:/orders/url_/{txnId}
响应主体:
名称 | 类型 | 必须 | 说明 |
---|---|---|---|
txnId | 文本 | 是 | 交易号 |
cancel | 文本 | 否 | 取消地址 |
return | 文本 | 是 | 返回地址 |
notify | 文本 | 是 | 通知地址 |
响应示例:
{ "status":200, "message":"ok", "data":{ "txnId":"20080808200808", "cancel":"http://www.test.com/cancel?id=123456", "return":"http://www.test.com/return/123456", "notify":"http://www.test.com/notify", }, "timestamp":1218154088000}
付款卡
获取指定的订单卡详细信息。
请求地址:/orders/card/{txnId}
响应主体:
名称 | 类型 | 必须 | 说明 |
---|---|---|---|
txnId | 文本 | 是 | 交易号 |
type | 数值 | 是 | 类型 参考列表处声明 |
holder | 文本 | 是 | 持卡人 |
issuer | 文本 | 是 | 发卡行 |
number | 文本 | 是 | 令牌化卡号 |
expireMonth | 数值 | 是 | 过期月份 |
expireYear | 数值 | 是 | 过期年份 |
salt | 文本 | 是 | 掩码 |
响应示例:
{ "status":200, "message":"ok", "data":{ "txnId":"20080808200808", "type":1, "holder":"yao feng", "issuer":"china bank", "number":"411111111111111", "expireMonth":8, "expireYear":2008, "salt":"pk8Nc1F" }, "timestamp":1218154088000}
渠道
获取指定的订单渠道详细信息。
请求地址:/orders/channel/{txnId}
响应主体:
名称 | 类型 | 必须 | 说明 |
---|---|---|---|
txnId | 文本 | 是 | 交易号 |
gatewayId | 数值 | 是 | 网关编号 |
channelId | 数值 | 是 | 渠道编号 |
mId | 数值 | 是 | 商户号编号 |
acquirer | 文本 | 是 | 账单名称/描述 |
currency | 文本 | 是 | 渠道交易币种 |
amount | 数值 | 是 | 渠道交易金额 |
dateSuccess | 时间 | 是 | 成功时间 |
响应示例:
{ "status":200, "message":"ok", "data":{ "txnId":"20080808200808", "gatewayId":200, "channelId":100, "mId":300, "acquirer":"YF*SaaS", "currency":"USD", "amount":123.45, "dateSuccess":"2008-08-08T18:18:18" }, "timestamp":1218154088000}
回调
获取指定的订单异步通知详细信息。
请求地址:/orders/notify/{txnId}
响应主体:
名称 | 类型 | 必须 | 说明 |
---|---|---|---|
[].id | 数值 | 是 | 编号 |
[].txnId | 文本 | 是 | 交易号 |
[].type | 数值 | 是 | 类型 0:订单,1:退款,2:调单,3:拒付,4:运单 |
[].referId | 文本 | 是 | 来源编号 |
[].status | 数值 | 是 | 状态 对应类型下的状态 |
[].isSuccess | 布尔 | 是 | 是否通知成功 |
[].requestCount | 数值 | 是 | 通知请求次数 |
[].responseContent | 文本 | 否 | 通知响应内容 |
[].dateCreated | 时间 | 是 | 创建时间 |
[].dateUpdated | 时间 | 否 | 最后修改时间 |
响应示例:
{ "status":200, "message":"ok", "data":[ { "id",100001, "txnId":"20080808200808", "type",0, "referId","20080808200808", "status":2, "isSuccess":false, "requestCount":3, "responseContent":"error sign", "dateCreated":"2008-08-08T18:18:18", "dateUpdated":null }, //.... ], "timestamp":1218154088000}
日志
获取指定的订单日志详细信息。
请求地址:/orders/logs/{txnId}
响应主体:
名称 | 类型 | 必须 | 说明 |
---|---|---|---|
[].id | 数值 | 是 | 编号 |
[].txnId | 文本 | 是 | 交易号 |
[].oldStatus | 数值 | 是 | 旧状态 参考列表处声明 |
[].newStatus | 数值 | 是 | 新状态 参考列表处声明 |
[].content | 文本 | 是 | 说明 |
[].iPAddress | 文本 | 否 | IP地址 |
[].dateCreated | 时间 | 是 | 创建日期 |
响应示例:
{ "status":200, "message":"ok", "data":[ { "id",1, "txnId":"20080808200808", "oldStatus",0, "newStatus",1, "content":"processing in gateway #1", "iPAddress":"127.0.0.1", "dateCreated":"2008-08-08T18:18:18", }, //.... ], "timestamp":1218154088000}