管理后台

供派娜(PayAny)聚合支付SaaS平台用户的员工进行管理合同、商户、终端、订单、退款、争议、运单、提现、报表等。

{platform}manager

coffee with coding...

订单

交易记录;包含测试、正式;包含收款、付款。


列表

以分页形式提供订单筛选的列表。

请求地址:/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令牌化卡号
email文本100邮箱
ipAddress文本150IP地址
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文本订单号
email文本邮箱
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金额折扣
email文本邮箱
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}