商户后台
供派娜(PayAny)聚合支付SaaS平台用户的商户进行管理终端、订单、退款、争议、运单、提现、报表等。
{platform}为merchant。
订单
商户订单列表。
测试订单
以分页形式提供测试订单的列表或查询结果。
请求地址:/order/list/{pageIndex}-{pageSize}
请求谓词:GET
请求参数:
名称 | 类型 | 长度 | 必须 | 说明 |
---|---|---|---|---|
pageIndex | 数值 | >=1 | 是 | 分页页码 为URL路径的一部分,非GET参数 |
pageSize | 数值 | 1~100 | 是 | 分页容量,建议20 为URL路径的一部分,非GET参数 |
terminalId | 数值 | 8 | 否 | 终端编号 |
source | 网址 | 80 | 否 | 来源 |
orderId | 文本 | 50 | 否 | 订单号 |
cardTypes[] | 数组 | 否 | 卡类型 | |
cardNumber | 数值 | 16 | 否 | 卡号 |
文本 | 100 | 否 | 邮箱 | |
ipAddress | 文本 | 150 | 否 | IP地址 |
status[] | 数组 | 否 | 订单状态:(0:处理中,1:已授权,2:待审核,3:已捕获,4:已失败,5:已拒绝,6:已结算,98:已超时,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 |
响应主体:
名称 | 类型 | 必须 | 说明 |
---|---|---|---|
tenantId | 数值 | 是 | 同开发者帐号 |
txnId | 数值 | 是 | 交易号 |
merchantId | 数值 | 是 | 商户 |
terminalId | 数值 | 是 | 终端编号 |
gatewayId | 数值 | 是 | 网关编号 |
orderId | 文本 | 是 | 订单号 |
文本 | 是 | 邮箱 | |
source | 文本 | 是 | 来源 |
iPAddress | 文本 | 是 | IP地址 |
cardType | 数值 | 是 | 卡类型:(0:无,1:维萨卡,2:万事达卡,4:JCB卡,8:美国运通卡,16:发现卡,32:大莱卡,64:银联卡) |
cardNumber | 文本 | 是 | 卡号 |
originalCurrency | 文本 | 是 | 原始货币 |
originalAmount | 数值 | 是 | 原始金额 |
transactionCurrency | 文本 | 是 | 交易货币 |
transactionAmount | 数值 | 是 | 交易金额 |
settleCurrency | 文本 | 是 | 结算货币 |
settleAmount | 数值 | 是 | 结算金额 |
billingCountry | 文本 | 是 | 账单国家 |
shippingCountry | 文本 | 是 | 订单国家 |
hasRefund | 布尔 | 是 | 是否退款 |
hasChargeback | 布尔 | 是 | 是否拒付 |
hasCopyRequest | 布尔 | 是 | 是否调单 |
hasWaybill | 布尔 | 是 | 是否上传运单 |
reason | 文本 | 是 | 原因 |
status | 数值 | 是 | 订单状态 |
test | 布尔 | 是 | 是否测试 |
dateCreated | 时间 | 是 | 创建时间 |
dateUpdated | 时间 | 否 | 最后变更时间 |
dateSuccess | 时间 | 否 | 成功日期 |
响应示例:
{ "status":200, "message":"ok", "data":{ "pageIndex":1, "pageSize":20, "totalPageCount":123, "totalItemCount":2450, "items":[ { "txnId":2021041416012001, "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":"0", "dateCreated":"2008-08-08T18:18:18", "dateUpdated":null, "dateSuccess":"2008-08-08T18:18:18", }, { "txnId":2021041416012002, "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":"0", "dateCreated":"2008-08-08T18:18:18", "dateUpdated":null, "dateSuccess":"2008-08-08T18:18:18", }, .... ] }, "timestamp":1218154088000}
正式订单
以分页形式提供正式订单的列表或查询结果。
请求地址:/order/list/{pageIndex}-{pageSize}
请求谓词:GET
请求参数:
名称 | 类型 | 长度 | 必须 | 说明 |
---|---|---|---|---|
pageIndex | 数值 | >=1 | 是 | 分页页码 为URL路径的一部分,非GET参数 |
pageSize | 数值 | 1~100 | 是 | 分页容量,建议20 为URL路径的一部分,非GET参数 |
terminalId | 数值 | 8 | 否 | 终端编号 |
source | 网址 | 200 | 否 | 来源 |
orderId | 文本 | 50 | 否 | 订单号 |
cardTypes[] | 数组 | 否 | 卡类型 | |
cardNumber | 数值 | 16 | 否 | 卡号 |
文本 | 100 | 否 | 邮箱 | |
ipAddress | 文本 | 150 | 否 | IP地址 |
originalCurrency | 文本 | 3 | 否 | 原始货币 |
originalAmountMin | 数值 | 否 | 原始最小金额 | |
originalAmountMax | 数值 | 否 | 原始最大金额 | |
settleCurrency | 文本 | 3 | 否 | 结算货币 |
settleAmountMin | 数值 | 否 | 结算最小金额 | |
settleAmountMax | 数值 | >=1 | 否 | 结算最大金额 |
billingCountry | 文本 | 2 | 否 | 账单国家 |
shippingCountry | 数值 | 2 | 否 | 收货地址国家 |
hasRefund | 布尔 | 否 | 是否退款:(true/false) | |
hasChargeback | 布尔 | 否 | 是否拒付:(true/false) | |
hasCopyRequest | 布尔 | 否 | 是否调单:(true/false) | |
hasWaybill | 布尔 | 否 | 是否上传运单:(true/false) | |
test | 布尔 | 否 | 是否为测试订单:(true/false) | |
status[] | 数组 | 否 | 订单状态:(0:处理中,1:已授权,2:待审核,3:已捕获,4:已失败,5:已拒绝,6:已结算,98:已超时,99:未引用) | |
reasonCode | 数值 | 1-2 | 否 | 原因码:(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 |
响应主体:
名称 | 类型 | 必须 | 说明 |
---|---|---|---|
tenantId | 数值 | 是 | 同开发者帐号 |
txnId | 数值 | 是 | 交易号 |
merchantId | 数值 | 是 | 商户 |
terminalId | 数值 | 是 | 终端编号 |
gatewayId | 数值 | 是 | 网关编号 |
orderId | 文本 | 是 | 订单号 |
文本 | 是 | 邮箱 | |
source | 文本 | 是 | 来源 |
iPAddress | 文本 | 是 | IP地址 |
cardType | 数值 | 是 | 卡类型:(0:无,1:维萨卡,2:万事达卡,4:JCB卡,8:美国运通卡,16:发现卡,32:大莱卡,64:银联卡) |
cardNumber | 文本 | 是 | 卡号 |
originalCurrency | 文本 | 是 | 原始货币 |
originalAmount | 数值 | 是 | 原始金额 |
transactionCurrency | 文本 | 是 | 交易货币 |
transactionAmount | 数值 | 是 | 交易金额 |
settleCurrency | 文本 | 是 | 结算货币 |
settleAmount | 数值 | 是 | 结算金额 |
billingCountry | 文本 | 是 | 账单国家 |
shippingCountry | 文本 | 是 | 订单国家 |
hasRefund | 布尔 | 是 | 是否退款 |
hasChargeback | 布尔 | 是 | 是否拒付 |
hasCopyRequest | 布尔 | 是 | 是否调单 |
hasWaybill | 布尔 | 是 | 是否上传运单 |
reason | 文本 | 是 | 原因 |
status | 数值 | 是 | 订单状态 |
test | 布尔 | 是 | 是否测试 |
dateCreated | 时间 | 是 | 创建时间 |
dateUpdated | 时间 | 否 | 最后变更时间 |
dateSuccess | 时间 | 否 | 成功日期 |
响应示例:
{ "status":200, "message":"ok", "data":{ "pageIndex":1, "pageSize":20, "totalPageCount":123, "totalItemCount":2450, "items":[ { "txnId":2021041416012001, "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":"0", "dateCreated":"2008-08-08T18:18:18", "dateUpdated":null, "dateSuccess":"2008-08-08T18:18:18", }, { "txnId":2021041416012002, "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":"0", "dateCreated":"2008-08-08T18:18:18", "dateUpdated":null, "dateSuccess":"2008-08-08T18:18:18", }, .... ] }, "timestamp":1218154088000}