ID一览

权限ID

参数名 说明
51 主面板
52 交易管理
5201 交易查询
5202 交易明细下载
5203 申请退款
5204 退款复核
53 结算管理
5301 结算管理
5302 结算汇总
54 账户管理
5401 账户明细
5402 提现明细
55 基础设置
5501 密码管理
5502 操作员管理
5503 证书管理
5504 邮件通知
5505 店铺二维码
56 EasyPay交易
5601 新建交易
5602 交易列表
5603 自定义交易列表 
根据登录后返回的用户登录权限List中的id给出相应的页面展示和操作

1. 登录

1.1 图形验证码

请求URL：

  • http://devapptms.aurfy.cn:8007/out/captchaCode/{token}

请求方式：

  • GET

1.2 用户登录接口

请求URL：

  • http://devapptms.aurfy.cn:8007/out/login2

请求方式：

  • POST

参数：

参数名 必选 类型 说明
username 是 string 用户名
password 是 string 密码
validateCode 是 string 图形验证码
validateCodeToken 是 string 时间戳

返回示例 

  {
    "data": {
        "merCode": "M001100001",
        "token": "87e09c0e686d39a7e9f70767e0ef8157a20678715967df2c5afba36a5776ef77",
        "txnToken": "1be62e0a0ab2c331918091734200e89bf03777c6e88c66864da25889921ad9f4",
        "userEmail": "develop@nihaopay.com",
        "subMerCode": null,
        "userRole": "Admin",
        "merName": "nihaopay",
        "currency": "USD,HKD,JPY,EUR,GBP,CAD"
    },
    "isSuccess": true,
    "message": "Operation was successful\t",
    "success": true
}
返回参数说明

参数名 类型 说明
merCode String 商户号
token String token
txnToken String txtToken
userEmail String 商户email
subMerCode String 子商户号
userRole String 商户权限
merName String 商户名称
currency String 币种

备注

  • 更多返回错误代码请看首页的错误代码描述

1.3 (忘记密码)发送Email接口

请求URL：

  • http://devapptms.aurfy.cn:8007/out/user/sendRecoveryEmail

请求方式：

  • POST

参数：

参数名 必选 类型 说明
username 是 string 用户名
validateCode 是 string 图形验证码
validateCodeToken 是 string 时间戳

返回示例 

{
    "data": null,
    "isSuccess": true,
    "message": "Operation was successful\t",
    "success": true
}
返回参数说明 

判断isSuccess是否成功

备注

  • 更多返回错误代码请看首页的错误代码描述

1.3 (忘记密码)Email回调验证接口

请求URL：

  • http://devapptms.aurfy.cn:8007/out/user/validateAuthKey

请求方式：

  • POST

参数：

参数名 必选 类型 说明
username 是 string 用户名
validateCode 是 string authKey

返回示例 

{
    "data": null,
    "isSuccess": true,
    "message": "Operation was successful\t",
    "success": true
}
返回参数说明 

判断isSuccess是否成功

备注

  • 更多返回错误代码请看首页的错误代码描述

2. 主面板

2.1 获取主面板接口

请求URL：

  • http://devapptms.aurfy.cn:8007/out/index/chart

请求方式：

  • GET

参数：

  • 请求header + authorization

返回示例

 {
    "data": {
        "chartData": [
            {
                "y": "2019-02-26",
                "usd": 0,
                "jpy": 0,
                "eur": 0,
                "cad": 0,
                "hkd": 0,
                "gbp": 0
            },
            {
                "y": "2019-02-27",
                "usd": 0,
                "jpy": 0,
                "eur": 0,
                "cad": 0,
                "hkd": 0,
                "gbp": 0
            },
            {
                "y": "2019-02-28",
                "usd": 0,
                "jpy": 0,
                "eur": 0,
                "cad": 0,
                "hkd": 0,
                "gbp": 0
            },
            {
                "y": "2019-03-01",
                "usd": 0,
                "jpy": 0,
                "eur": 0,
                "cad": 0,
                "hkd": 0,
                "gbp": 0
            },
            {
                "y": "2019-03-02",
                "usd": 0,
                "jpy": 0,
                "eur": 0,
                "cad": 0,
                "hkd": 0,
                "gbp": 0
            },
            {
                "y": "2019-03-03",
                "usd": 0,
                "jpy": 0,
                "eur": 0,
                "cad": 0,
                "hkd": 0,
                "gbp": 0
            },
            {
                "y": "2019-03-04",
                "usd": 0,
                "jpy": 0,
                "eur": 0,
                "cad": 0,
                "hkd": 0,
                "gbp": 0
            },
            {
                "y": "2019-03-05",
                "usd": 0,
                "jpy": 0,
                "eur": 0,
                "cad": 0,
                "hkd": 0,
                "gbp": 0
            },
            {
                "y": "2019-03-06",
                "usd": 0,
                "jpy": 0,
                "eur": 0,
                "cad": 0,
                "hkd": 0,
                "gbp": 0
            },
            {
                "y": "2019-03-07",
                "usd": 0,
                "jpy": 0,
                "eur": 0,
                "cad": 0,
                "hkd": 0,
                "gbp": 0
            },
            {
                "y": "2019-03-08",
                "usd": 0,
                "jpy": 0,
                "eur": 0,
                "cad": 0,
                "hkd": 0,
                "gbp": 0
            },
            {
                "y": "2019-03-09",
                "usd": 0,
                "jpy": 0,
                "eur": 0,
                "cad": 0,
                "hkd": 0,
                "gbp": 0
            },
            {
                "y": "2019-03-10",
                "usd": 0,
                "jpy": 0,
                "eur": 0,
                "cad": 0,
                "hkd": 0,
                "gbp": 0
            },
            {
                "y": "2019-03-11",
                "usd": 47.96,
                "jpy": 0,
                "eur": 0,
                "cad": 0,
                "hkd": 0,
                "gbp": 0
            },
            {
                "y": "2019-03-12",
                "usd": 0,
                "jpy": 0,
                "eur": 0,
                "cad": 0,
                "hkd": 0,
                "gbp": 0
            }
        ],
        "reportData": [
            {
                "currency": "USD",
                "dailyAmount": 0,
                "weeklyAmount": 47.96,
                "monthlyAmount": 47.96,
                "dailyNum": 0,
                "weeklyNum": 18,
                "monthlyNum": 18
            }
        ]
    },
    "isSuccess": true,
    "message": "operation success",
    "success": true
}
}
返回参数说明

参数名 类型 说明
chartData String 图表信息
reportData.currency String 币种
reportData.dailyAmount String 前一天金额
reportData.dailyNum String 前一天笔数
reportData.weeklyAmount String 前7天金额
reportData.weeklyNum String 前7天笔数
reportData.monthlyAmount String 前30天金额
reportData.monthlyNum String 前30天笔数

备注

  • 更多返回错误代码请看首页的错误代码描述

3. 交易管理

3.1 交易查询接口

请求URL：

  • http://devapptms.aurfy.cn:8007/out/txn/search

请求方式：

  • POST

参数：

参数名 必选 类型 说明
txnType 否 string 交易类型
txnStatus 否 string 交易状态
subMerCode 否 string 子商户号
startDate 是 string 开始时间
endDate 是 string 结束时间
pageNum 是 string 起始页
pageSize 是 string 一页请求数
orderId 否 string 订单号
id 否 string 交易流水号
cardOrg 否 string 付款方式
receiveBankTraceNo 否 string 银行追踪号
note 否 string 备注
description 否 string 商品描述

返回示例

  {
    "data": {
        "pagination": {
            "totalRows": 667,
            "pageSize": 10,
            "currPageNum": 1,
            "totalPages": 67,
            "startRow": 0,
            "endRow": 10,
            "pageData": [
                {
                    "createDate": null,
                    "updateDate": null,
                    "txnDate": "2018-12-24 21:14:48",
                    "merCode": "M001100001",
                    "subMerCode": null,
                    "txnType": "Purchase",
                    "bizCode": "Show QRCode",
                    "orderId": "20181224131437906649",
                    "amount": 0.02,
                    "txnStatus": "pending",
                    "originTxnId": null,
                    "txnFinishDate": null,
                    "paymentRefundAmount": null,
                    "countTxnStatus": null,
                    "amountVO": "0.02",
                    "cardOrg": "alipay",
                    "startTxnDate": null,
                    "endTxnDate": null,
                    "branchId": "a2532b43-cd01-46bf-bbdb-57c3bd16dcb2",
                    "orderDescriptionVO": null,
                    "merCodes": null,
                    "clientIpVO": null,
                    "merPrivate1VO": null,
                    "maxAmount": null,
                    "minAmount": null,
                    "cancellationFlag": "INITIAL",
                    "cutoffStatus": "INITIAL_STATE",
                    "merOrderCurrency": null,
                    "merOrderAmount": null,
                    "merName": null,
                    "currencyName": "USD",
                    "id": "20181224131447000032"
                }
            ],
            "totalAmount": 587585.33,
            "totalFee": null
        }
    },
    "isSuccess": true,
    "message": "operation success",
    "success": true
}
返回参数说明

参数名 类型 说明
txnDate String 订单日期
id String 交易流水号
subMerCode String 子商户号
userEmail String 商户email
cardOrg String 付款方式
txnType String 交易类型
orderId String 订单号
currencyName String 币种
amount String 金额
txnStatus String 交易状态

备注

  • 更多返回错误代码请看首页的错误代码描述

3.2 交易详情接口

请求URL：

  • http://devapptms.aurfy.cn:8007/out/txn/detail/{id}

请求方式：

  • GET

参数：

  • 拼接id

返回示例 

  {
    "data": {
        "merTxn": {
            "createDate": null,
            "updateDate": null,
            "txnDate": "2018-12-24",
            "merCode": "M001100001",
            "subMerCode": null,
            "txnType": "Purchase",
            "bizCode": "Show QRCode",
            "orderId": "20181224131437906649",
            "currency": {
                "name": "USD",
                "code": "840",
                "precision": 2,
                "symbol": "$",
                "description": "United States dollar"
            },
            "amount": 0.02,
            "txnStatus": "pending",
            "originTxnId": null,
            "txnFinishDate": null,
            "paymentRefundAmount": null,
            "countTxnStatus": null,
            "amountVO": "0.02",
            "cardOrg": "alipay",
            "startTxnDate": null,
            "endTxnDate": null,
            "branchId": "a2532b43-cd01-46bf-bbdb-57c3bd16dcb2",
            "orderDescriptionVO": null,
            "merCodes": null,
            "clientIpVO": null,
            "merPrivate1VO": null,
            "maxAmount": null,
            "minAmount": null,
            "cancellationFlag": null,
            "cutoffStatus": null,
            "merOrderCurrency": null,
            "merOrderAmount": null,
            "merName": "nihaopay",
            "id": "20181224131447000032"
        },
        "merTxnSale": {
            "createDate": "2018-12-24",
            "updateDate": null,
            "txnDate": "2018-12-24",
            "version": "1.2",
            "charset": null,
            "language": "English",
            "txnType": "Purchase",
            "merCode": "M001100001",
            "subMerCode": null,
            "merOrderId": "20181224131437906649",
            "merOrderDate": "20181224",
            "merOrderTime": "131447",
            "merOrderCurrency": {
                "name": "USD",
                "code": "840",
                "precision": 2,
                "symbol": "$",
                "description": "United States dollar"
            },
            "merOrderAmount": 0.02,
            "bizCode": "Show QRCode",
            "txnCurrency": {
                "name": "USD",
                "code": "840",
                "precision": 2,
                "symbol": "$",
                "description": "United States dollar"
            },
            "txnAmount": 0.02,
            "exchangeRate": 1,
            "txnStatus": "pending",
            "merPrivate1": null,
            "merPrivate2": null,
            "merReserved": null,
            "originalTxnId": null,
            "accessURL": null,
            "paySite": null,
            "clientIP": "180.167.25.154",
            "merOrderDescription": null,
            "browserReturnURL": "http://nihaopay.com",
            "serverNotifyURL": "http://demo.aurfy.cn:8007/ipn",
            "deliveryAddressId": null,
            "orderTimeZone": "CN",
            "orderTimeOut": "30",
            "signMethod": {
                "name": "MD5",
                "cipherAlgorithm": "MD5"
            },
            "signature": "nosignature",
            "branchId": "a2532b43-cd01-46bf-bbdb-57c3bd16dcb2",
            "saleId": "006654d3ca984d91b856da738d818d8b",
            "agentId": "a3d5edca8760466bb9952af5e592f11d",
            "pspId": "95675e4198b14390863d12b6fad86113",
            "cardOrg": "alipay",
            "receiveBankTraceNo": null,
            "sendBankOrderId": null,
            "startTxnDate": null,
            "endTxnDate": null,
            "countIp": null,
            "sumAmount": null,
            "txnFinishDate": null,
            "rmbAmount": null,
            "mappedRespCode": null,
            "merCodes": null,
            "maxAmount": null,
            "minAmount": null,
            "goodsAmount": 0,
            "platformAmount": 0,
            "cancellationFlag": null,
            "paymentRefundAmount": null,
            "cutoffStatus": null,
            "bizCategory": null,
            "storeNo": null,
            "storeName": null,
            "terminalID": "QR",
            "id": "20181224131447000032"
        },
        "txnSale": {
            "createDate": null,
            "updateDate": null,
            "txnDate": "2018-12-24",
            "txnType": "Purchase",
            "txnCurrency": {
                "name": "USD",
                "code": "840",
                "precision": 2,
                "symbol": "$",
                "description": "United States dollar"
            },
            "txnAmount": 0.02,
            "cardOrg": "alipay",
            "cardType": null,
            "maskCardNo": null,
            "encriptCardNo": null,
            "encriptCardCVV": null,
            "cardExpiryDate": null,
            "cardHolderFullName": null,
            "cardHolderFirstName": null,
            "cardHolderMiddleName": null,
            "cardHolderLastName": null,
            "receiveBankTraceNo": null,
            "sendBankOrderId": null,
            "billingAddressId": null,
            "channelId": "aea0ddf078e348a79fbcb7dd2d1592dc",
            "channelProviderId": "17001872d05c46dfb0c428d6c5284c55",
            "bankCode": null,
            "txnStatus": "pending",
            "txnFailedReason": null,
            "txnSuccTime": null,
            "riskResult": "ACCEPT",
            "riskCode": "00",
            "riskMsg": "success",
            "bgwSalePaymentId": null,
            "bgwRespCode": null,
            "bgwRespMsg": null,
            "reconciliationStatus": "MISMATCH",
            "reconciliationDate": null,
            "cancellationFlag": "INITIAL",
            "cancellationDate": null,
            "refundFlag": "INITIAL",
            "refundAmount": 0,
            "chargebackAmount": 0,
            "cutoffBatchId": null,
            "startTxnDate": null,
            "endTxnDate": null,
            "buyerIdentityCode": null,
            "curoffStatus": "INITIAL_STATE",
            "id": "20181224131447000032"
        }
    },
    "isSuccess": true,
    "message": "operation success",
    "success": true
}

返回参数说明

  • 交易详情>交易信息 merTxn
参数名 必选 说明
merCode string 商户号
subMerCode string 子商户号
orderId string 订单号
originTxnId string 关联订单号
bizCode + cardOrg string 业务类型
id string 交易流水号
receiveBankTraceNo（2） string 银行流水号
txnType string 交易类型
txnStatus string 交易状态
currencyName string 币种
amount string 金额
txnDate string 交易时间（UTC）
txnFinishDate string 交易完成时间（UTC） 
receiveBankTraceNo（2）： merTxnSale.receiveBankTraceNo
  • 交易详情>订单信息 merTxnSale
参数名 必选 说明
merCode string 商户号
subMerCode string 子商户号
txnType string 交易类型
merOrderId string 订单号
txnStatus string 交易状态
txnCurrencyName string 币种
txnAmount string 金额
exchangeRate string 换算汇率
txnDate string 交易时间
clientIP string 客户IP
merOrderDate string 订单日期
merOrderTime string 订单时间
merOrderDescription string 订单描述
merPrivate1 string 备注

备注

  • 更多返回错误代码请看首页的错误代码描述

3.3 交易日期可下载查询接口

请求URL：

  • http://devapptms.aurfy.cn:8007/out/txn/initCalendar

请求方式：

  • POST

参数：

参数名 必选 类型 说明
month 是 string 月份(UTC)
year 是 string 年份(UTC)

返回示例

{
    "data": {
        "date": [
            "2019/01/04",
            "2019/01/05",
            "2019/01/07",
            "2019/01/08",
            "2019/01/09",
        ]
    },
    "isSuccess": true,
    "message": "operation success",
    "success": true
}
返回参数说明 

返回参数的日期为可下载的日期

3.4 交易单日下载接口

请求URL：

  • http://devapptms.aurfy.cn:8007/out/txn/download/{date}

请求方式：

  • GET

参数： 

参数说明: date 2019-01-01

返回参数说明 

axios二进制返回的Excel

3.5 交易区间下载接口

请求URL：

  • http://devapptms.aurfy.cn:8007/out/txn/downloads

请求方式：

  • POST

参数：

参数名 必选 类型 说明
startDate 是 string 开始时间(UTC)
endDate 是 string 结束时间(UTC) 
区间时间不能超过1个月(30天)

返回参数说明 

axios二进制返回的Excel

3.6 申请退款查询接口

请求URL：

  • http://devapptms.aurfy.cn:8007/out/txn/searcForRefund

请求方式：

  • POST

参数：

参数名 必选 类型 说明
txnType 否 string 交易类型
txnStatus 否 string 交易状态
subMerCode 否 string 子商户号
startDate 是 string 开始时间
endDate 是 string 结束时间
pageNum 是 string 起始页
pageSize 是 string 一页请求数
orderId 否 string 订单号
id 否 string 交易流水号
cardOrg 否 string 付款方式
receiveBankTraceNo 否 string 银行追踪号
note 否 string 备注
description 否 string 商品描述

返回示例

  {
    "data": {
        "pagination": {
            "totalRows": 667,
            "pageSize": 10,
            "currPageNum": 1,
            "totalPages": 67,
            "startRow": 0,
            "endRow": 10,
            "pageData": [
                {
                    "createDate": null,
                    "updateDate": null,
                    "txnDate": "2018-12-24 21:14:48",
                    "merCode": "M001100001",
                    "subMerCode": null,
                    "txnType": "Purchase",
                    "bizCode": "Show QRCode",
                    "orderId": "20181224131437906649",
                    "amount": 0.02,
                    "txnStatus": "pending",
                    "originTxnId": null,
                    "txnFinishDate": null,
                    "paymentRefundAmount": null,
                    "countTxnStatus": null,
                    "amountVO": "0.02",
                    "cardOrg": "alipay",
                    "startTxnDate": null,
                    "endTxnDate": null,
                    "branchId": "a2532b43-cd01-46bf-bbdb-57c3bd16dcb2",
                    "orderDescriptionVO": null,
                    "merCodes": null,
                    "clientIpVO": null,
                    "merPrivate1VO": null,
                    "maxAmount": null,
                    "minAmount": null,
                    "cancellationFlag": "INITIAL",
                    "cutoffStatus": "INITIAL_STATE",
                    "merOrderCurrency": null,
                    "merOrderAmount": null,
                    "merName": null,
                    "currencyName": "USD",
                    "id": "20181224131447000032"
                }
            ],
            "totalAmount": 587585.33,
            "totalFee": null
        }
    },
    "isSuccess": true,
    "message": "operation success",
    "success": true
}
返回参数说明

参数名 类型 说明
txnDate String 订单日期
id String 交易流水号
txnType String 交易类型
orderId String 订单号
currencyName String 币种
amount String 金额
txnStatus String 交易状态
paymentRefundAmount String 已退款金额 
判断paymentRefundAmount和amount是否相等,相等则可操作退款,反之不能

备注

  • 更多返回错误代码请看首页的错误代码描述

3.7 申请退款详情接口

请求URL：

  • http://devapptms.aurfy.cn:8007/out/txn/searcForRefund

请求方式：

  • GET

参数：

  • 拼接id

返回示例

  {
    "data": {
        "merTxn": {
            "createDate": null,
            "updateDate": "2018-02-26",
            "txnDate": "2018-02-26 12:17:55",
            "merCode": "M001100001",
            "subMerCode": null,
            "bizCode": "SecurePay",
            "orderId": "20180226041747472601",
            "amount": 0.02,
            "originTxnId": null,
            "txnFinishDate": "2018-02-26 12:50:51",
            "paymentRefundAmount": "0.00",
            "countTxnStatus": null,
            "amountVO": "0.02",
            "cardOrg": "alipay",
            "startTxnDate": null,
            "endTxnDate": null,
            "branchId": "a2532b43-cd01-46bf-bbdb-57c3bd16dcb2",
            "orderDescriptionVO": null,
            "merCodes": null,
            "clientIpVO": null,
            "merPrivate1VO": null,
            "maxAmount": null,
            "minAmount": null,
            "cancellationFlag": null,
            "cutoffStatus": null,
            "merOrderAmount": 0.02,
            "merName": null,
            "txnTypeVO": "Purchase",
            "currencyName": "USD",
            "txnStatusVO": "closed",
            "id": "20180226041754105973"
        },
        "rmbRefundTotalBefore": 0
    },
    "isSuccess": true,
    "message": "operation success",
    "success": true
}
返回参数说明

参数名 类型 说明
merCode String 商户号
subMerCode String 子商户号
orderId String 订单号
未知 String 关联订单号
bizCode + cardOrg String 业务类型
id String 交易流水号
txnTypeVO String 交易类型
txnStatusVO String 交易状态
amount String 标价金额
merOrderAmount String 订单金额
txnDate String 交易时间
txnFinishDate String 交易完成时间
paymentRefundAmount String 已退款金额 
退款金额为paymentRefundAmount ( rmbRefundTotalBefore)

A(B) ; A单位:currencyName;B单位:merOrderCurrencyName

备注

  • 更多返回错误代码请看首页的错误代码描述

3.8 申请退款接口

请求URL：

  • http://devapptms.aurfy.cn:8007/out/txn/refundApply

请求方式：

  • POST

参数：

参数名 必选 类型 说明
txnId 是 string id
refundAmount 是 string 申请退款金额
refundReason 否 string 申请退款原因

返回示例

  {
    "data": null,
    "isSuccess": true,
    "message": "operation success",
    "success": true
}
返回参数说明

  • 判断isSuccess

备注

  • 更多返回错误代码请看首页的错误代码描述

3.9 退款复核查询接口

请求URL：

  • http://devapptms.aurfy.cn:8007/out/txn/searchRefund

请求方式：

  • POST

参数：

参数名 必选 类型 说明
id 否 string 交易流水号
orderId 否 string 订单号
startDate 是 string 开始时间
endDate 是 string 结束时间
pageNum 是 string 起始页
pageSize 是 string 一页请求数
txnStatus 否 string 交易状态
subMerCode 否 string 子商户号
txnType 否 string 交易类型

返回示例

 {
    "data": {
        "pagination": {
            "totalRows": 1,
            "pageSize": 1,
            "currPageNum": 1,
            "totalPages": 1,
            "startRow": 0,
            "endRow": 1,
            "pageData": [
                {
                    "createDate": "2018-02-26",
                    "updateDate": null,
                    "merCode": "M001100001",
                    "subMerCode": null,
                    "origOrderId": "20180226041747472601",
                    "refundAmount": 0.02,
                    "refundReason": "",
                    "origTxnID": "20180226041754105973",
                    "origTxnType": "Purchase",
                    "txnType": "Purchase Cancellation",
                    "origTxnDate": "2018-02-26",
                    "origTxnAmount": 0.02,
                    "cardOrg": "alipay",
                    "txnRefundAmount": 0.02,
                    "exchangeRate": 1,
                    "refundFee": 0,
                    "refundStatus": "Apply",
                    "memo": null,
                    "channelID": "31bc61f2efd7487fa169afbd8f3a715f",
                    "providerID": "a03e9ef101834c9fb0df9b82da591ddd",
                    "bgwSalePaymentID": null,
                    "bgwRefundID": null,
                    "applyID": "M001100001",
                    "approveID": null,
                    "merCodes": null,
                    "goodsAmount": 0,
                    "platformAmount": 0,
                    "merReserved": null,
                    "refundCurrencyName": "USD",
                    "originTxnCurrencyName": "USD",
                    "id": "20180226121939001007"
                }
            ],
            "totalAmount": 0,
            "totalFee": null
        }
    },
    "isSuccess": true,
    "message": "operation success",
    "success": true
}
返回参数说明

参数名 类型 说明
createDate String 订单日期
id String 交易流水号
subMerCode String 子商户号
txnType String 交易类型
origOrderId String 订单号
refundCurrencyName String 币种
txnRefundAmount String 金额
refundStatus String 交易状态 
操作 复核,撤销

备注

  • 更多返回错误代码请看首页的错误代码描述

3.10 退款复核详情接口

请求URL：

  • http://devapptms.aurfy.cn:8007/out/txn/toCheckRefund/{id}

请求方式：

  • GET

参数：

  • 拼接id

返回示例

{
    "data": {
        "createDate": "2019-03-18",
        "updateDate": null,
        "merCode": "M001100001",
        "subMerCode": null,
        "origOrderId": "20190318092028743086",
        "refundAmount": 1,
        "refundReason": "sss",
        "origTxnID": "20190318092148000144",
        "origTxnType": "Purchase",
        "txnType": "Refund Purchase",
        "origTxnDate": "2019-03-18",
        "origTxnAmount": 0.02,
        "cardOrg": "wechatpay",
        "txnRefundAmount": 1,
        "exchangeRate": 1,
        "refundFee": 0,
        "refundStatus": "Apply",
        "memo": null,
        "channelID": "f6a8a682988545fbb95037387e4d6a27",
        "providerID": "31115e995aef4f6b8f0ce131d4243222",
        "bgwSalePaymentID": "7f3f0ce3e1034778a45cadcaf7b9a412",
        "bgwRefundID": null,
        "applyID": "5e6c41e365ad480f9f4588d23d356ab0",
        "approveID": null,
        "merCodes": null,
        "goodsAmount": 0,
        "platformAmount": 0,
        "merReserved": null,
        "refundCurrencyName": "USD",
        "originTxnCurrencyName": "USD",
        "id": "20190318091838001095"
    },
    "isSuccess": true,
    "message": "operation success",
    "success": true
}
返回参数说明

参数名 类型 说明
merCode String 商户号
subMerCode String 子商户号
origOrderId String 原交易订单号
id String 原交易流水号
origTxnType String 原交易类型
originTxnCurrencyName String 原交易币种
origTxnAmount String 原交易金额
createDate String 申请退款时间
txnRefundAmount String 退款金额
origTxnDate String 原交易时间
refundReason String 退款原因

备注

  • 更多返回错误代码请看首页的错误代码描述

3.11 同意退款接口

请求URL：

  • http://devapptms.aurfy.cn:8007/out/txn/refundApprove

请求方式：

  • POST

参数：

参数名 必选 类型 说明
txnId 是 string id
approveReason 否 string 退款原因

返回示例

{
    "data": null,
    "isSuccess": false,
    "message": "Refund failed. Refund amount exceeds original transaction amount or refundable amount.",
    "success": false
}
返回参数说明

  • 判断isSuccess

备注

  • 更多返回错误代码请看首页的错误代码描述

3.12 取消退款接口

请求URL：

  • http://devapptms.aurfy.cn:8007/out/txn/refundCancel

请求方式：

  • POST

参数：

参数名 必选 类型 说明
txnId 是 string id

返回示例

{
    "data": null,
    "isSuccess": true,
    "message": "operation success"
}
返回参数说明

  • 判断isSuccess

备注

  • 更多返回错误代码请看首页的错误代码描述

3.13 小费报表接口

请求URL：

  • http://devapptms.aurfy.cn:8007/api/transactions/reportOneDay

请求方式：

  • POST

参数：

参数名 必选 类型 说明
starting_after 是 string 开始时间
ending_before 是 string 结束时间 
例:今天是北京时间2019-05-23 ;
那么开始时间为2019-05-22 16:00:00 ;
结束时间为2019-05-23 16:00:00

返回示例

{
    "data":{
        "totalAmount":0,
        "totalOriginAmount":0,
        "totalTipAmount":0,
        "netAmount":0,
        "txnCount":0,
        "merCode":"M001100535",
        "refundCount":0,
        "totalRefundAmount":0
    },
    "isSuccess":true
}

返回参数说明

参数名 类型 说明
totalAmount string 总支付金额
totalOriginAmount string 总订单金额
totalTipAmount string 小费
netAmount string 净结算金额
txnCount string 总交易(汇总)
refundCount string 总交易(退款)
totalRefundAmount string 总退款金额 
小费币种根据登录时返回的currency为准,
如果登录时返回的currency为多个币种的话,
则进入该页面时提示"该用户暂不支持小费报表功能"

备注

  • 更多返回错误代码请看首页的错误代码描述

4. 结算管理

4.1 结算明细查询接口

请求URL：

  • http://devapptms.aurfy.cn:8007/out/settle/search

请求方式：

  • POST

参数：

参数名 必选 类型 说明
id 否 string 交易流水号
orderId 否 string 订单号
pageNum 是 string 起始页
pageSize 是 string 一页请求数
startDate 是 string 开始时间
endDate 是 string 结束时间

返回示例

{
    "data": {
        "pagination": {
            "totalRows": 166,
            "pageSize": 1,
            "currPageNum": 1,
            "totalPages": 166,
            "startRow": 0,
            "endRow": 1,
            "pageData": [
                {
                    "createDate": "2018-12-24 22:57:26",
                    "updateDate": null,
                    "txnId": "20181224131105000031",
                    "txnStartDate": "2018-12-24 21:11:06",
                    "orderId": "20181224131056837243",
                    "originalTxnId": null,
                    "txnType": "Purchase",
                    "txnAmount": 0.02,
                    "txnStatus": "success",
                    "txnFinishDate": "2018-12-24 21:12:15",
                    "stlExchangeRate": 1,
                    "stlExchangeDate": "2018-12-24",
                    "stlAmount": 0.02,
                    "merCode": "M001100001",
                    "subMerCode": null,
                    "branchId": "a2532b43-cd01-46bf-bbdb-57c3bd16dcb2",
                    "branchName": null,
                    "salesId": "006654d3ca984d91b856da738d818d8b",
                    "salesName": null,
                    "pspId": "95675e4198b14390863d12b6fad86113",
                    "pspName": null,
                    "agentId": "a3d5edca8760466bb9952af5e592f11d",
                    "agentName": null,
                    "bizCode": "SecurePay",
                    "cardOrg": "alipay",
                    "terminalId": "ONLINE",
                    "channelId": "31bc61f2efd7487fa169afbd8f3a715f",
                    "acqId": "e9d8e52a12794764bba869382b56bcb2",
                    "acqName": null,
                    "channelProviderId": "a03e9ef101834c9fb0df9b82da591ddd",
                    "channelProviderName": null,
                    "feeConfigId": "d14560db53054a72a262c61bd228f368",
                    "feeRatio": 2,
                    "feeService": 0,
                    "feeAdditional": 0,
                    "marginPolicy": null,
                    "marginRatio": 0,
                    "marginAmount": 0,
                    "expectedReturnDate": null,
                    "marginStatus": null,
                    "marginChargeDate": null,
                    "marginChargeId": null,
                    "marginReturnDate": null,
                    "marginReturnId": null,
                    "clearStatus": "NotRequired",
                    "clearId": "20181224145726002616",
                    "clearDate": "2018-12-24",
                    "settlePolicy": "Cycle",
                    "netSettleAmount": 0.02,
                    "expectedSettleDate": "2018-12-25",
                    "settleStatus": "Settled",
                    "actualSettleDate": "2018-12-25",
                    "settleBatchId": "20181225145730002618",
                    "settleCondition": "T+2",
                    "agentType": "Normal",
                    "agentLevel": "ONE",
                    "agentFeeConfigId": "0e222f6e01b84b6180dc0fe1433ad302",
                    "agentFeeRatio": 1.8,
                    "agentFeeService": 0,
                    "agentFeeRebate": 0,
                    "rateAlgorithm": "Percentage",
                    "queryStartDate": null,
                    "queryEndDate": null,
                    "txnAmountVO": "0.02",
                    "merName": "nihaopay",
                    "agentSettleAmountVO": null,
                    "withdrawalId": null,
                    "txnCurrencyName": "USD",
                    "stlCurrencyName": "USD",
                    "id": null
                }
            ],
            "totalAmount": 558653.78,
            "totalFee": null
        }
    },
    "isSuccess": true,
    "message": "operation success",
    "success": true
}
返回参数说明

参数名 类型 说明
txnId string 交易流水号
orderId string 订单号
txnType string 交易类型
txnFinishDate string 结算日期
stlCurrencyName string 币种
stlAmount string 金额
feeService string 交易手续费
netSettleAmount string 净结算金额
cardOrg string 付款方式

备注

  • 更多返回错误代码请看首页的错误代码描述

4.2 结算明细下载接口

请求URL：

  • http://devapptms.aurfy.cn:8007/out/settle/download

请求方式：

  • POST

参数：

参数名 必选 类型 说明
id 否 string 交易流水号
orderId 否 string 订单号
startDate 是 string 开始时间
endDate 是 string 结束时间

返回参数说明

  • axios二进制流导出excel

备注

  • 更多返回错误代码请看首页的错误代码描述

4.3 结算汇总查询接口

请求URL：

  • http://devapptms.aurfy.cn:8007/out/settle/searchSummary

请求方式：

  • POST

参数：

参数名 必选 类型 说明
pageNum 是 string 起始页
pageSize 是 string 一页请求数
startDate 是 string 开始时间
endDate 是 string 结束时间

返回示例

{
    "data": {
        "pagination": {
            "totalRows": 15,
            "pageSize": 1,
            "currPageNum": 1,
            "totalPages": 15,
            "startRow": 0,
            "endRow": 1,
            "pageData": [
                {
                    "createDate": null,
                    "updateDate": null,
                    "settleBatchId": "20190321145745002712",
                    "settleDate": "2019-03-21",
                    "merCode": "M001100001",
                    "settleCurrency": "USD",
                    "paymentCount": 0,
                    "paymentAmount": 0,
                    "paymentFee": 0,
                    "paymentMargin": 0,
                    "paymentNetAmount": 0,
                    "refundCount": 1,
                    "refundAmount": 0.01,
                    "refundFee": 0,
                    "refundNetAmount": 0.01,
                    "chargebackCount": 0,
                    "chargebackAmount": 0,
                    "chargebackFee": 0,
                    "chargebackNetAmount": 0,
                    "marginReturnCount": 0,
                    "marginReturnAmount": 0,
                    "netSettleAmount": -0.01,
                    "queryStartDate": null,
                    "queryEndDate": null,
                    "id": null
                }
            ],
            "totalAmount": null,
            "totalFee": null
        }
    },
    "isSuccess": true,
    "message": "operation success",
    "success": true
}
返回参数说明

参数名 类型 说明
merCode string 商户号
settleDate string 结算日期
paymentCount string 支付笔数
paymentAmount string 支付金额
paymentFee string 付手续费
paymentMargin string 保证金
paymentNetAmount string 支付净额
refundCount string 退款笔数
refundAmount string 退款金额
refundFee string 退手续费
refundNetAmount string 退款净额
netSettleAmount string 结算款总计

备注

  • 更多返回错误代码请看首页的错误代码描述

4.4 结算汇总下载接口

请求URL：

  • http://devapptms.aurfy.cn:8007/out/settle/downloadSummary/{settleBatchId}

请求方式：

  • GET

参数：

  • 拼接id

返回参数说明

  • axios二进制流导出excel

5. 账户管理

5.1 账户查询接口

请求URL：

  • http://devapptms.aurfy.cn:8007/out/account/search

请求方式：

  • POST

参数：

  • authorization

返回示例

{
    "data": {
        "pagination": {
            "totalRows": 6,
            "pageSize": 100,
            "currPageNum": 1,
            "totalPages": 1,
            "startRow": 0,
            "endRow": 6,
            "pageData": [
                {
                    "createDate": "2018-03-01",
                    "updateDate": "2018-03-01",
                    "merCode": "M001100001",
                    "accCurrency": "CAD",
                    "refConfigId": "80894ba5a84c4c198f267314042e8293",
                    "accBalance": 0,
                    "freezeAmonut": 0,
                    "pendingAmonut": 0,
                    "marginAmonut": 0,
                    "status": "Normal",
                    "ownerId": "10b4cf9f8db6446fb3aad402eb310b70",
                    "branchId": null,
                    "accBalanceVO": "0.00",
                    "antiStatus": null,
                    "agentId": null,
                    "id": "8b801db6d50c497588444205ab4964dd"
                },
                {
                    "createDate": "2017-03-30",
                    "updateDate": "2018-03-01",
                    "merCode": "M001100001",
                    "accCurrency": "EUR",
                    "refConfigId": "80894ba5a84c4c198f267314042e8293",
                    "accBalance": 1.98,
                    "freezeAmonut": 0,
                    "pendingAmonut": 0,
                    "marginAmonut": 0,
                    "status": "Normal",
                    "ownerId": "2c18d62fdece400394baa28483b09242",
                    "branchId": null,
                    "accBalanceVO": "1.98",
                    "antiStatus": null,
                    "agentId": null,
                    "id": "b51725c4f6184999b2d12ffcf5665e9c"
                },
                {
                    "createDate": "2017-03-30",
                    "updateDate": "2018-03-01",
                    "merCode": "M001100001",
                    "accCurrency": "HKD",
                    "refConfigId": "80894ba5a84c4c198f267314042e8293",
                    "accBalance": 0,
                    "freezeAmonut": 0,
                    "pendingAmonut": 0,
                    "marginAmonut": 0,
                    "status": "Normal",
                    "ownerId": "2c18d62fdece400394baa28483b09242",
                    "branchId": null,
                    "accBalanceVO": "0.00",
                    "antiStatus": null,
                    "agentId": null,
                    "id": "fcab255dbcc249a2ab6a88792e3cfd17"
                },
                {
                    "createDate": "2016-12-20",
                    "updateDate": "2018-03-01",
                    "merCode": "M001100001",
                    "accCurrency": "GBP",
                    "refConfigId": "80894ba5a84c4c198f267314042e8293",
                    "accBalance": 0.02,
                    "freezeAmonut": 0,
                    "pendingAmonut": 0,
                    "marginAmonut": 0,
                    "status": "Normal",
                    "ownerId": "2c18d62fdece400394baa28483b09242",
                    "branchId": null,
                    "accBalanceVO": "0.02",
                    "antiStatus": null,
                    "agentId": null,
                    "id": "6b3e53a377eb494da443ab35955a6784"
                },
                {
                    "createDate": "2016-05-14",
                    "updateDate": "2018-03-01",
                    "merCode": "M001100001",
                    "accCurrency": "USD",
                    "refConfigId": "80894ba5a84c4c198f267314042e8293",
                    "accBalance": 21431.66,
                    "freezeAmonut": 2.99,
                    "pendingAmonut": 62294.86,
                    "marginAmonut": 0,
                    "status": "Normal",
                    "ownerId": "d4b4966ca3944e79b40543cbbc060699",
                    "branchId": null,
                    "accBalanceVO": "21431.66",
                    "antiStatus": null,
                    "agentId": null,
                    "id": "6f7cebb89ffd47d7adfcfa0ef76be011"
                },
                {
                    "createDate": "2016-05-14",
                    "updateDate": "2018-03-01",
                    "merCode": "M001100001",
                    "accCurrency": "JPY",
                    "refConfigId": "80894ba5a84c4c198f267314042e8293",
                    "accBalance": 565240.32,
                    "freezeAmonut": 235200,
                    "pendingAmonut": 7530986.4,
                    "marginAmonut": 0,
                    "status": "Normal",
                    "ownerId": "d4b4966ca3944e79b40543cbbc060699",
                    "branchId": null,
                    "accBalanceVO": "565240.32",
                    "antiStatus": null,
                    "agentId": null,
                    "id": "da792ae1e0a74562920cf67aff695cd5"
                }
            ],
            "totalAmount": null,
            "totalFee": null
        }
    },
    "isSuccess": true,
    "message": "operation success",
    "success": true
}
返回参数说明

参数名 类型 说明
merCode string 商户号
accCurrency string 币种
accBalance string 账户余额
pendingAmonut string 待结算金额
status string 状态
createDate string 创建时间
id string settleAccId

备注

  • 更多返回错误代码请看首页的错误代码描述

5.2 账户明细查询接口

请求URL：

  • http://devapptms.aurfy.cn:8007/out/account/searchStatement

请求方式：

  • POST

参数：

参数名 必选 类型 说明
id 是 string 币种id
refId 是 string 参考号
subjectId 是 string 记账科目编号
pageNum 是 string 起始页
pageSize 是 string 一页请求数
startDate 是 string 开始时间
endDate 是 string 结束时间

返回示例

{
    "data": {
        "pagination": {
            "totalRows": 59,
            "pageSize": 1,
            "currPageNum": 1,
            "totalPages": 59,
            "startRow": 0,
            "endRow": 1,
            "pageData": [
                {
                    "createDate": "2018-12-25",
                    "updateDate": null,
                    "settleAccId": "6f7cebb89ffd47d7adfcfa0ef76be011",
                    "merCode": "M001100001",
                    "subjectId": "Settlement",
                    "refId": "20181225145730002618",
                    "refTime": "2018-12-25 23:00:04",
                    "withdrawalAmount": 0,
                    "depositAmount": 0.02,
                    "balance": 20205.35,
                    "subjectIdVO": 0,
                    "currencyName": "USD"
                }
            ],
            "totalAmount": null,
            "totalFee": null
        }
    },
    "isSuccess": true,
    "message": "operation success",
    "success": true
}
返回参数说明

参数名 类型 说明
merCode string 商户号
subjectId enum 记账科目编号
refId string 参考号 ,下载id
refTime string 参考时间
currencyName string 记账币种
withdrawalAmount string 提出金额
depositAmount string 入账金额
balance string 账户余额

备注

  • 更多返回错误代码请看首页的错误代码描述

5.3 账户详情下载接口(4.4)

同结算汇总下载接口一致

5.4 验证交易密码接口#(公用)

请求URL：

  • http://devapptms.aurfy.cn:8007/out/account/verifyPwd

请求方式：

  • POST

参数：

参数名 必选 类型 说明
password 是 string 交易密码

返回示例

{
    "data": null,
    "isSuccess": true,
    "message": ""
}
返回参数说明 

验证isSuccess

备注

  • 更多返回错误代码请看首页的错误代码描述

5.5 增加提款账户接口

请求URL：

  • http://devapptms.aurfy.cn:8007/out/bankAccount/save

请求方式：

  • POST

参数：

参数名 必选 类型 说明
accountType 是 string 账户类型
accountCurrency 是 string 币种
countryName 是 string 银行地址-国家
countryCode 是 string 银行地址-国家
stateName 是 string 银行地址-省份(洲)
stateCode 是 string 银行地址-省份(洲)
cityName 是 string 银行地址-城市
cityCode 是 string 银行地址-城市
streetName1 是 string 银行地址-详细地址
bankName 是 string 银行名称
bankBranch 否 string 开户行分行
accountHolder 是 string 账户名称
accountNumber 是 string 账户
swiftCode 否 string Swift Code
routingNumber 否 string Routing Number
comments 否 string 备注
isDefault 是 string 是否设为默认账户 
isDefault value{0,1} 0,未选中,1选中

INDIVIDUALACCOUNT("Individual"),
COMPANYACCOUNT("Company"),
GROUP("Group");

返回示例

{
    "data": null,
    "isSuccess": true,
    "message": ""
}
返回参数说明 

判断isSuccess

备注

  • 更多返回错误代码请看首页的错误代码描述

5.6 银行账户列表(提现)接口

请求URL：

  • http://devapptms.aurfy.cn:8007/out/account/list

请求方式：

  • POST

参数：

参数名 必选 类型 说明
currency 是 string 币种

返回示例

{
    "data": [
        {
            "createDate": "2018-11-28",
            "updateDate": null,
            "bankId": null,
            "bankCode": "000",
            "bankAbbreviation": null,
            "bankName": "test",
            "bankBranch": null,
            "bankURL": null,
            "addressId": "97ad5a7436dd4314a0451c40d0f4f461",
            "accountHolder": "123456",
            "accountNumber": "123456",
            "accountCurrency": "USD",
            "routingTransitNumber": null,
            "swiftCode": null,
            "accountOpenDate": null,
            "comments": null,
            "ownerId": "58e6857c93cd4e2a80df2d816dec81d1",
            "addressBook": null,
            "existBank": null,
            "id": "cfd09ee1e7284744b4e5e034d736cc9c"
        },
        {
            "createDate": "2017-03-30",
            "updateDate": "2018-11-28",
            "bankId": null,
            "bankCode": "000",
            "bankAbbreviation": null,
            "bankName": "test",
            "bankBranch": "test",
            "bankURL": null,
            "addressId": "f33f9bb4a2ce41a3a5d3ac5586fcb630",
            "accountHolder": "test",
            "accountNumber": "12345678",
            "accountCurrency": "USD",
            "routingTransitNumber": null,
            "swiftCode": "8567890",
            "accountOpenDate": null,
            "comments": null,
            "ownerId": "58e6857c93cd4e2a80df2d816dec81d1",
            "addressBook": null,
            "existBank": null,
            "id": "dd9e2986fea94ef5a4b88d3caeb9fad1"
        }
    ],
    "isSuccess": true,
    "message": "operation success",
    "success": true
}
返回参数说明

参数名 类型 说明
bankName string 银行名称
accountNumber string 账户
accountCurrency string 币种
id string 账户id

备注

  • 更多返回错误代码请看首页的错误代码描述

5.7 提现申请接口

请求URL：

  • http://devapptms.aurfy.cn:8007/out/account/withdraw

请求方式：

  • POST

参数：

参数名 必选 类型 说明
amount 是 string 提现金额
balance 是 string 余额
bankAccountId 是 string 银行账户id
settleAccId 是 string 结算账户id

返回示例

{
    "data": null,
    "isSuccess": true,
    "message": "Withdrawal successfully, we'll transfer money to you in 1-3 business days.",
    "success": true
}
返回参数说明 

判断isSuccess,并且showModal message

备注

  • 更多返回错误代码请看首页的错误代码描述

5.8 提现记录查询接口

请求URL：

  • http://devapptms.aurfy.cn:8007/out/withdraw/search

请求方式：

  • POST

参数：

参数名 必选 类型 说明
withdrawalCurrency 是 string 提现币种
startDate 是 string 开始时间
endDate 是 string 结束时间
pageNum 是 string 起始页
pageSize 是 string 一页请求数

返回示例

{
    "pagination": {
        "totalRows": 35,
        "pageSize": 1,
        "currPageNum": 1,
        "totalPages": 35,
        "startRow": 0,
        "endRow": 1,
        "pageData": [
            {
                "createDate": null,
                "updateDate": "2019-03-27 11:35:11",
                "settleAccId": "6f7cebb89ffd47d7adfcfa0ef76be011",
                "merCode": "M001100001",
                "withdrawalAmount": 200,
                "withdrawalCurrency": "USD",
                "withdrawalFee": 0.3,
                "withdrawalMemo": "Withdrawal",
                "status": "Audit",
                "withdrawalResult": "Dealing",
                "payeeType": "Individual",
                "payeeName": "123456",
                "payeeAccountNumber": "123456",
                "payeeBank": "test",
                "payeeBranchBank": null,
                "payeeAddress": "97ad5a7436dd4314a0451c40d0f4f461",
                "payeeRoutingNumber": null,
                "payeeSwiftCode": null,
                "applyId": "5e6c41e365ad480f9f4588d23d356ab0",
                "applyDate": "2019-03-27 11:37:29",
                "approveId": "5e6c41e365ad480f9f4588d23d356ab0",
                "approveDate": "2019-03-27 11:37:29",
                "feePayer": "Merchant",
                "withdrawalFeeCurrency": "USD",
                "startTime": null,
                "endTime": null,
                "agentId": null,
                "branchId": null,
                "fuzzyMerCode": null,
                "pageNum": null,
                "pageSize": null,
                "id": "20190327033511002719"
            }
        ],
        "totalAmount": null,
        "totalFee": null
    }
}
返回参数说明

参数名 类型 说明
id string 提款交易流水号
applyDate string 申请日期
withdrawalAmount string 提现金额
withdrawalCurrency string 提现币种
withdrawalFee string 提现手续费
status string 提现状态
payeeName string 收款人账户名称
payeeAccountNumber string 收款人账户号
payeeBank string 收款人账户所属银行
id string 下载id

备注

  • 更多返回错误代码请看首页的错误代码描述

5.9 提现明细下载接口

请求URL： 

(Csv)
  • http://devapptms.aurfy.cn:8007/out/withdraw/exportReportCSV/{txnId}
(Excel)
  • http://devapptms.aurfy.cn:8007/out/withdraw/exportReport/{txnId}

请求方式：

  • GET

参数：

  • 拼接id

6. 基本设置

6.1 修改密码接口

请求URL：

  • http://devapptms.aurfy.cn:8007/out/user/modifypwd2

请求方式：

  • POST

参数：

参数名 必选 类型 说明
pwdtype 是 string 密码类型
oldpwd 是 string 原密码
newpwd 是 string 新密码 
 登录密码:LOGIN_PWD = "login_pwd";
 交易密码:TRADING_PWD = "trading_pwd";

返回示例

{
    "data": null,
    "isSuccess": true,
    "message": "fse"
}
返回参数说明 

判断isSuccess,false返回message

备注

  • 更多返回错误代码请看首页的错误代码描述

6.2 子用户(list)搜索接口

请求URL：

  • http://devapptms.aurfy.cn:8007/out/users/search

请求方式：

  • POST

参数：

参数名 必选 类型 说明
pageSize 是 string 一页请求数
pageNum 是 string 起始页

返回示例

{
    "data": {
        "pagination": {
            "totalRows": 4,
            "pageSize": 1,
            "currPageNum": 1,
            "totalPages": 4,
            "startRow": 0,
            "endRow": 1,
            "pageData": [
                {
                    "createDate": "2017-03-27",
                    "updateDate": "2017-04-18",
                    "userEmail": "dev1.us@aurfy.com",
                    "userRole": "User",
                    "merCode": "M001100001",
                    "subMerCode": null,
                    "lastLoginIp": "180.167.25.154",
                    "loginPassword": "e3a7d478a123afc4b33644ba60ab92fde69e0a3ffb30ef1c041753ed81a3ae29aa844c4049e676bd6e6b02bea100fdb700b5c089f4477a68191b27d76716fe57",
                    "prevPassword1": null,
                    "prevPassword2": null,
                    "passwdSalt": "hBp9IvNMppeXP9Q1",
                    "pwdLastChangeDate": "2017-03-27",
                    "txnPassword": "5d0fa63957ebe04ef9f7f958129c9d3430ec4a5797a5012a827e3a37c861608146d7c542bb253b35f38771ab70fbae99ba1efc551ed07a81f160ff6f13ff80e3",
                    "lastLoginFailDate": "2017-03-27",
                    "loginFailTimes": 0,
                    "isLockLogin": false,
                    "lockTimeSpan": 0,
                    "lastLoginDate": null,
                    "isFirstLogin": false,
                    "userStatus": "Enable",
                    "machineCode": null,
                    "id": "ac3baf6989784d33b69081a69251c887"
                }
            ],
            "totalAmount": null,
            "totalFee": null
        }
    },
    "isSuccess": true,
    "message": "operation success",
    "success": true
}
返回参数说明

参数名 类型 说明
userEmail string 登录邮箱
subMerCode string 子商户号
userRole string 角色名称
createDate string 创建日期
id string id

备注

  • 更多返回错误代码请看首页的错误代码描述

6.3 子用户新增接口

请求URL：

  • http://devapptms.aurfy.cn:8007/out/users/save

请求方式：

  • POST

参数：

参数名 必选 类型 说明
email 是 string 邮箱
loginPassword 是 string 登录密码
tradePasword 是 string 交易密码

返回示例

{
    "data": null,
    "isSuccess": true,
    "message": "Operation was successful\t",
    "success": true
}
返回参数说明 

判断isSuccess是否成功

备注

  • 更多返回错误代码请看首页的错误代码描述

6.2 证书查询接口

请求URL：

  • http://devapptms.aurfy.cn:8007/out/cert/detail

请求方式：

  • POST

参数：

参数名 必选 类型 说明
password 是 string 交易密码

返回示例

{
    "data": "1be62e0a0ab2c331918091734200e89bf03777c6e88c66864da25889921ad9f4",
    "isSuccess": true,
    "message": "operation success",
    "success": true
}
返回参数说明 

res.data 为证书内容

备注

  • 更多返回错误代码请看首页的错误代码描述

6.3 证书更新接口

请求URL：

  • http://devapptms.aurfy.cn:8007/out/cert/update

请求方式：

  • POST

参数：

参数名 必选 类型 说明
password 是 string 交易密码

返回示例

{
    "data": "1be62e0a0ab2c331918091734200e89bf03777c6e88c66864da25889921ad9f4",
    "isSuccess": true,
    "message": "operation success",
    "success": true
}
返回参数说明 

res.data 为证书内容

备注

  • 更多返回错误代码请看首页的错误代码描述

6.4 邮件通知列表接口

请求URL：

  • http://devapptms.aurfy.cn:8007/out/mailSetting/list

请求方式：

  • GET

返回示例

{
    "data": {
        "merCode": "M001100001",
        "mailAddresses": "676931854@qq.com",
        "merMailSettings": [
            {
                "settingID": "3df28fbae0504e40b57d588154233d0b",
                "merMailAddressID": "87143f6722574d9faa071d8b97b1ae2f",
                "acceptEmailType": "SYSTEM_NOTIFY",
                "status": "INACTIVE",
                "createDate": "2017-08-24",
                "updateDate": "2019-01-07"
            },
            {
                "settingID": "76e2288ee09645a08e599c9d12acc7a1",
                "merMailAddressID": "87143f6722574d9faa071d8b97b1ae2f",
                "acceptEmailType": "IPN_NOTIFY_FAIL",
                "status": "INACTIVE",
                "createDate": "2017-08-24",
                "updateDate": "2019-01-07"
            },
            {
                "settingID": "93176deea139485d95ae2c6bada96aa9",
                "merMailAddressID": "87143f6722574d9faa071d8b97b1ae2f",
                "acceptEmailType": "WITHDRAWAL_NOTIFY",
                "status": "INACTIVE",
                "createDate": "2017-08-24",
                "updateDate": "2019-01-07"
            },
            {
                "settingID": "b259512c406c4cdf9dd1d32b127c5b42",
                "merMailAddressID": "87143f6722574d9faa071d8b97b1ae2f",
                "acceptEmailType": "REFUND_SUCCESS",
                "status": "INACTIVE",
                "createDate": "2017-08-24",
                "updateDate": "2019-01-07"
            },
            {
                "settingID": "b56726fa9cbe486cb97d93fde7a418fb",
                "merMailAddressID": "87143f6722574d9faa071d8b97b1ae2f",
                "acceptEmailType": "TRANSACTION_SUCCESS",
                "status": "INACTIVE",
                "createDate": "2017-08-24",
                "updateDate": "2019-01-07"
            }
        ],
        "createDate": "2017-08-24",
        "updateDate": "2019-01-07",
        "id": "87143f6722574d9faa071d8b97b1ae2f"
    },
    "isSuccess": true,
    "message": "operation success",
    "success": true
}
返回参数说明

参数名 类型 说明
id string id
mailAddresses string 邮箱地址
acceptEmailType enum 邮箱通知类型
status string 勾选状态 
mailAddresses如有多个,用逗号分隔开;
如  "mailAddresses" : "123@qq.com","234@qq.com"

备注

  • 更多返回错误代码请看首页的错误代码描述

6.5 邮件通知保存接口

首次添加邮件地址

请求URL：

  • http://devapptms.aurfy.cn:8007/out/mailSetting/save

请求方式：

  • POST

参数：

参数名 必选 类型 说明
mailAddresses 是 string 邮箱地址
merMailSettings 是 string 邮箱状态数组
acceptEmailType 是 string 邮箱通知类型
status 是 string 勾选状态 
status: INACTIVE 为 未勾选 ; ACTIVE 为 勾选

返回示例

{
    "data": null,
    "isSuccess": true,
    "message": "Add Successful Transaction\t",
    "success": true
}
返回参数说明 

判断isSuccess状态

备注

  • 更多返回错误代码请看首页的错误代码描述

6.6 邮件通知更新接口

请求URL：

  • http://devapptms.aurfy.cn:8007/out/mailSetting/update

请求方式：

  • POST

参数：

参数名 必选 类型 说明
mailAddresses 是 string 邮箱地址
merMailSettings 是 string 邮箱状态数组
acceptEmailType 是 string 邮箱通知类型
status 是 string 勾选状态
id 是 string id 
status: INACTIVE 为 未勾选 ; ACTIVE 为 勾选

返回示例

{
    "data": null,
    "isSuccess": true,
    "message": "Add Successful Transaction\t",
    "success": true
}
返回参数说明 

判断isSuccess状态

备注

  • 更多返回错误代码请看首页的错误代码描述

6.7 QRCode列表查询接口

请求URL：

  • http://devapptms.aurfy.cn:8007/out/qrcode/search

请求方式：

  • POST

参数：

参数名 必选 类型 说明
pageSize 是 string 一页请求数
pageNum 是 string 起始页

返回示例

{
    "data": {
        "pagination": {
            "totalRows": 74,
            "pageSize": 1,
            "currPageNum": 1,
            "totalPages": 74,
            "startRow": 0,
            "endRow": 1,
            "pageData": [
                {
                    "createDate": "2018-10-17 09:23:05",
                    "updateDate": null,
                    "merCode": "M001100001",
                    "sellerID": "1001",
                    "sellerName": "早上",
                    "sellerIndustry": "4816",
                    "storeName": "你好",
                    "storeNO": "吃午饭了",
                    "cardOrg": "alipay",
                    "tradeCurrency": "USD",
                    "settleCurrency": "USD",
                    "ipnURL": "http://demo.aurfy.cn:8007/ipn",
                    "channelID": "dbed30e53d734aecb6be2049a927247c",
                    "qrCodeStr": "https://qr.alipay.com/ocx07531udfdhosarjt7i35",
                    "qrCodeURL": "https://mobilecodec.alipay.com/show.htm?code=ocx07531udfdhosarjt7i35",
                    "status": "ACTIVE",
                    "cardOrgSearch": null,
                    "id": "9cbd0306cc9840d98a1084d35c9a6be3"
                }
            ],
            "totalAmount": null,
            "totalFee": null
        }
    },
    "isSuccess": true,
    "message": "operation success",
    "success": true
}
返回参数说明

参数名 类型 说明
sellerName string 卖方名称
storeName string 店铺名称
storeNO string 店铺序号
cardOrg string 支付方式
tradeCurrency string 币种
id string 详情id

备注

  • 更多返回错误代码请看首页的错误代码描述

6.8 QRCode详情接口

请求URL：

  • http://devapptms.aurfy.cn:8007/out/qrcode/detail/{id}

请求方式：

  • POST

参数： 

拼接id

返回示例

{
    "data": {
        "bean": {
            "createDate": "2018-10-17 09:23:05",
            "updateDate": null,
            "merCode": "M001100001",
            "sellerID": "1001",
            "sellerName": "早上",
            "sellerIndustry": "4816",
            "storeName": "你好",
            "storeNO": "吃午饭了",
            "cardOrg": "alipay",
            "tradeCurrency": "USD",
            "settleCurrency": "USD",
            "ipnURL": "http://demo.aurfy.cn:8007/ipn",
            "channelID": "dbed30e53d734aecb6be2049a927247c",
            "qrCodeStr": "https://qr.alipay.com/ocx07531udfdhosarjt7i35",
            "qrCodeURL": "https://mobilecodec.alipay.com/show.htm?code=ocx07531udfdhosarjt7i35",
            "status": "ACTIVE",
            "cardOrgSearch": null,
            "id": "9cbd0306cc9840d98a1084d35c9a6be3"
        }
    },
    "isSuccess": true,
    "message": "operation success",
    "success": true
}
返回参数说明

参数名 类型 说明
cardOrg string 支付方式
sellerName string 卖方名称
storeName string 店铺名称
storeNO string 店铺序号
tradeCurrency string 币种
ipnURL string IPN URL
qrCodeURL string 支付宝官方二维码
qrCodeStr string 店铺二维码

备注

  • 更多返回错误代码请看首页的错误代码描述

7 EasyPay

7.1 easyPay列表查询接口

请求URL：

  • http://devapptms.aurfy.cn:8007/out/easypay/search

请求方式：

  • POST

参数：

参数名 必选 类型 说明
startDate 是 string 开始时间
endDate 是 string 结束时间
pageSize 是 string 一页请求数
pageNum 是 string 起始页
status 否 string 状态

返回示例

{
    "data": {
        "pagination": {
            "totalRows": 151,
            "pageSize": 1,
            "currPageNum": 1,
            "totalPages": 151,
            "startRow": 0,
            "endRow": 1,
            "pageData": [
                {
                    "createDate": "2019-03-05",
                    "updateDate": null,
                    "merCode": "M001100001",
                    "reference": "20190305072741HWR8EYZN",
                    "currency": "USD",
                    "amount": 0.01,
                    "description": "test",
                    "note": null,
                    "callbackURL": null,
                    "status": "Pending",
                    "paymentCode": "YLHZT8YY5E",
                    "customerName": null,
                    "email": null,
                    "timeout": 0,
                    "merchantName": "nihaopay",
                    "id": "8c52d4f2f006427ca75725d4dec0dec3"
                }
            ],
            "totalAmount": null,
            "totalFee": null
        }
    },
    "isSuccess": true,
    "message": "operation success",
    "success": true
}
返回参数说明

参数名 类型 说明
reference string 参考号
currency string 币种
amount string 金额
description string 订单描述
note string 备注
createDate string 创建时间
timeout string 过期时间(天)
status string 状态
callbackURL string 支付链接
id string 发送邮箱id

备注

  • 更多返回错误代码请看首页的错误代码描述

7.2 esayPay新增交易接口

请求URL：

  • http://devapptms.aurfy.cn:8007/out/easypay/save

请求方式：

  • POST

参数：

参数名 必选 类型 说明
merchantName 是 string 商户名称
timeout 是 string 过期时间(天)
reference 是 string 参考号
currency 是 string 币种
amount 是 string 金额
description 是 string 订单描述
note 否 string 备注

返回示例

{
    "data": "http://easypay.aurfy.cn:8007/pay/9KE9LDKALL",
    "isSuccess": true,
    "message": "Add Successful Transaction\t",
    "success": true
}
返回参数说明 

    判断isSuccess是否成功

备注

  • 更多返回错误代码请看首页的错误代码描述

7.3 esayPay发送邮件接口

请求URL：

  • http://devapptms.aurfy.cn:8007/out/easypay/sendEmail

请求方式：

  • POST

参数：

参数名 必选 类型 说明
id 是 string id
customerName 是 string 客户名称
email 是 string 邮箱
note 否 string 备注

返回示例

{
    "data": "http://easypay.aurfy.cn:8007/pay/YE3DZBMPK2",
    "isSuccess": true,
    "message": "Add Successful Transaction\t",
    "success": true
}
返回参数说明 

    判断isSuccess是否成功

备注

  • 更多返回错误代码请看首页的错误代码描述

7.4 自定义easyPay列表查询接口

请求URL：

  • http://devapptms.aurfy.cn:8007/out/customEasypay/search

请求方式：

  • POST

参数：

参数名 必选 类型 说明
pageSize 是 string 一页请求数
pageNum 是 string 起始页

返回示例

{
    "data": {
        "pagination": {
            "totalRows": 3,
            "pageSize": 1,
            "currPageNum": 1,
            "totalPages": 3,
            "startRow": 0,
            "endRow": 1,
            "pageData": [
                {
                    "createDate": "2016-05-27",
                    "updateDate": null,
                    "merCode": "M001100001",
                    "merShowName": "China SF",
                    "merAbbrCode": "ChinaSF",
                    "enable": "Active",
                    "id": "8d67829d20e5463d897c5652c487733b"
                }
            ],
            "totalAmount": null,
            "totalFee": null
        }
    },
    "isSuccess": true,
    "message": "operation success",
    "success": true
}
返回参数说明

参数名 类型 说明
merShowName string 商户名称
merAbbrCode string 简称
paymentUrl string 支付链接
enable string 状态
createDate string 创建时间
id string 操作id

备注

  • 更多返回错误代码请看首页的错误代码描述

7.5 自定义easyPay详情查询接口

请求URL：

  • http://devapptms.aurfy.cn:8007/out/customEasypay/detail/{id}

请求方式：

  • POST

参数： 

拼接id

返回示例

{
    "data": {
        "bean": {
            "createDate": "2019-04-09",
            "updateDate": "2019-04-09",
            "merCode": "M001100001",
            "merShowName": "sasasa",
            "merAbbrCode": "a",
            "enable": "Active",
            "paymentUrl": "http://easypay.aurfy.cn:8007/name/a",
            "id": "8dfdecd0fe404976bdd1ebe4f87bb79e"
        }
    },
    "isSuccess": true,
    "message": "operation success",
    "success": true
}
返回参数说明

参数名 类型 说明
merCode string 商户id
merShowName string 商户名称
merAbbrCode string 简称
enable string 状态

备注

  • 更多返回错误代码请看首页的错误代码描述

7.6 自定义easyPay详情新增接口

请求URL：

  • http://devapptms.aurfy.cn:8007/out/customEasypay/save

请求方式：

  • POST

参数：

参数名 必选 类型 说明
id 是 string 详情id
merShowName 是 string 商户名称
merAbbrCode 是 string 简称 
|enable |是  |string |状态   | 后续观察

返回示例

{
    "data": "http://easypay.aurfy.cn:8007/name/fesfefe",
    "isSuccess": true,
    "message": "Add Successful Transaction\t",
    "success": true
}
返回参数说明 

判断isSuccess是否成功

备注

  • 更多返回错误代码请看首页的错误代码描述

7.7 自定义easyPay详情更新接口

请求URL：

  • http://devapptms.aurfy.cn:8007/out/customEasypay/update

请求方式：

  • POST

参数：

参数名 必选 类型 说明
id 是 string 详情id
merShowName 是 string 商户名称
merAbbrCode 是 string 简称
enable 是 string 状态

返回示例

{
    "data": "http://easypay.aurfy.cn:8007/name/fesfefe",
    "isSuccess": true,
    "message": "Add Successful Transaction\t",
    "success": true
}
返回参数说明 

判断isSuccess是否成功

备注

  • 更多返回错误代码请看首页的错误代码描述

TODO:

7.8 子用户搜索接口

请求URL：

  • http://devapptms.aurfy.cn:8007/out/customEasypay/update

请求方式：

  • POST

参数：

参数名 必选 类型 说明
id 是 string 详情id
merShowName 是 string 商户名称
merAbbrCode 是 string 简称
enable 是 string 状态

返回示例

{
    "data": "http://easypay.aurfy.cn:8007/name/fesfefe",
    "isSuccess": true,
    "message": "Add Successful Transaction\t",
    "success": true
}
返回参数说明 

判断isSuccess是否成功

备注

  • 更多返回错误代码请看首页的错误代码描述

7.9 子用户新增接口

请求URL：

  • http://devapptms.aurfy.cn:8007/out/customEasypay/update

请求方式：

  • POST

参数：

参数名 必选 类型 说明
id 是 string 详情id
merShowName 是 string 商户名称
merAbbrCode 是 string 简称
enable 是 string 状态

返回示例

{
    "data": "http://easypay.aurfy.cn:8007/name/fesfefe",
    "isSuccess": true,
    "message": "Add Successful Transaction\t",
    "success": true
}
返回参数说明 

判断isSuccess是否成功

备注

  • 更多返回错误代码请看首页的错误代码描述

7.10 子用户重置密码接口

请求URL：

  • http://devapptms.aurfy.cn:8007/out/customEasypay/update

请求方式：

  • POST

参数：

参数名 必选 类型 说明
id 是 string 详情id
merShowName 是 string 商户名称
merAbbrCode 是 string 简称
enable 是 string 状态

返回示例

{
    "data": "http://easypay.aurfy.cn:8007/name/fesfefe",
    "isSuccess": true,
    "message": "Add Successful Transaction\t",
    "success": true
}
返回参数说明 

判断isSuccess是否成功

备注

  • 更多返回错误代码请看首页的错误代码描述

7.11 子用户删除接口

请求URL：

  • http://devapptms.aurfy.cn:8007/out/customEasypay/update

请求方式：

  • POST

参数：

参数名 必选 类型 说明
id 是 string 详情id
merShowName 是 string 商户名称
merAbbrCode 是 string 简称
enable 是 string 状态

返回示例

{
    "data": "http://easypay.aurfy.cn:8007/name/fesfefe",
    "isSuccess": true,
    "message": "Add Successful Transaction\t",
    "success": true
}
返回参数说明 

判断isSuccess是否成功

备注

  • 更多返回错误代码请看首页的错误代码描述

7.12 子用户权限获取接口

请求URL：

  • http://devapptms.aurfy.cn:8007/out/customEasypay/update

请求方式：

  • POST

参数：

参数名 必选 类型 说明
id 是 string 详情id
merShowName 是 string 商户名称
merAbbrCode 是 string 简称
enable 是 string 状态

返回示例

{
    "data": "http://easypay.aurfy.cn:8007/name/fesfefe",
    "isSuccess": true,
    "message": "Add Successful Transaction\t",
    "success": true
}
返回参数说明 

判断isSuccess是否成功

备注

  • 更多返回错误代码请看首页的错误代码描述

7.13 子用户权限修改接口

请求URL：

  • http://devapptms.aurfy.cn:8007/out/customEasypay/update

请求方式：

  • POST

参数：

参数名 必选 类型 说明
id 是 string 详情id
merShowName 是 string 商户名称
merAbbrCode 是 string 简称
enable 是 string 状态

返回示例

{
    "data": "http://easypay.aurfy.cn:8007/name/fesfefe",
    "isSuccess": true,
    "message": "Add Successful Transaction\t",
    "success": true
}
返回参数说明 

判断isSuccess是否成功

备注

  • 更多返回错误代码请看首页的错误代码描述