收银台对接

收银台代收，也叫超级网关代收，指交易过程中，EPAY提供标准的支付页面，您将在EPAY的支付页面完成付款，而无需编写任何支付交互页面的代码。

支付流程

商家后台请求 gateway/sendTransaction 的API接口，传入商家订单号、订单金额、币种等参数，生成epayUrl付款地址，前端跳转到EPAY收银台页面，用户选择支付方式，完成付款操作。

image

流程说明

  1. 用户访问您的页面发起超级网关收款（充值）交易。
  2. 您的后台服务封装请求参数发送调用gateway/sendTransaction交易接口到EPAY超级网关后台服务。
  3. EPAY超级网关后台服务收到请求，创建交易订单，开始处理，此时订单状态为处理中（status=0）。
  4. EPAY超级网关后台服务创建交易订单完成后，返回epayUrl付款地址给您的后台服务。
  5. 您的后台服务收到epayUrl付款地址后，重定向到EPAY_webUI_frontend收银台页面。
  6. 用户在收银台页面选择支付方式，完成支付。此处用户可以选择匿名或实名（登录EPAY账号）支付。
  7. EPAY收银台页面将付款信息请求参数发送到EPAY超级网关后台服务。
  8. EPAY超级网关后台服务处理结果，更新订单状态为成功（status=7）。
  9. EPAY超级网关后台服务发送回调结果给您的后台服务，通知交易订单已完成。
  10. 您的后台服务可以选择调用queryTransaction接口进行信息确认。
  11. EPAY超级网关后台服务响应queryTransaction接口数据。
  12. 您的后台服务更新交易数据，完成订单状态。
  13. 您的后台服务通知用户订单完成状态。

创建订单

商家后台请求 gateway/sendTransaction 的API接口，传入商家订单号、订单金额、币种等参数（具体可查看如下入参说明），创建EPAY网关订单。

注意：此时订单状态为处理中（status=1），可通过查询交易接口 queryTransaction 查看订单详情。

示例代码

java python go shell 
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"sign\": \"\",\n    \"param\": {\n        \"epayAccount\": \"test2020@epay.com\",\n        \"merchantName\": \"ali BANK\",\n        \"amount\": \"10\",\n        \"currency\": \"EUR\",\n        \"merchantOrderNo\": \"A092201\",\n        \"notifyUrl\": \"http://localhost/paymentApi/channel/send.do\",\n        \"successUrl\": \"http://localhost/paymentApi/channel/send.do\",\n        \"failUrl\": \"http://localhost/paymentApi/channel/send.do\",\n        \"remark\": \"remark\",\n        \"senderEpayAccount\": \"\",\n        \"language\": \"CN\",\n        \"version\": \"V2.0.0\",\n        \"extendFields\": {\n            \"test\": \"test\"\n        }\n    }\n}");
Request request = new Request.Builder()
  .url("http://29597375fx.epaydev.xyz/capi/openapi/gateway/sendTransaction")
  .method("POST", body)
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();

java

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"sign\": \"\",\n    \"param\": {\n        \"epayAccount\": \"test2020@epay.com\",\n        \"merchantName\": \"ali BANK\",\n        \"amount\": \"10\",\n        \"currency\": \"EUR\",\n        \"merchantOrderNo\": \"A092201\",\n        \"notifyUrl\": \"http://localhost/paymentApi/channel/send.do\",\n        \"successUrl\": \"http://localhost/paymentApi/channel/send.do\",\n        \"failUrl\": \"http://localhost/paymentApi/channel/send.do\",\n        \"remark\": \"remark\",\n        \"senderEpayAccount\": \"\",\n        \"language\": \"CN\",\n        \"version\": \"V2.0.0\",\n        \"extendFields\": {\n            \"test\": \"test\"\n        }\n    }\n}");
Request request = new Request.Builder()
  .url("http://29597375fx.epaydev.xyz/capi/openapi/gateway/sendTransaction")
  .method("POST", body)
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();

python

import requests
import json

url = "http://29597375fx.epaydev.xyz/capi/openapi/gateway/sendTransaction"

payload = json.dumps({
  "sign": "",
  "param": {
    "epayAccount": "test2020@epay.com",
    "merchantName": "ali BANK",
    "amount": "10",
    "currency": "EUR",
    "merchantOrderNo": "A092201",
    "notifyUrl": "http://localhost/paymentApi/channel/send.do",
    "successUrl": "http://localhost/paymentApi/channel/send.do",
    "failUrl": "http://localhost/paymentApi/channel/send.do",
    "remark": "remark",
    "senderEpayAccount": "",
    "language": "CN",
    "version": "V2.0.0",
    "extendFields": {
      "test": "test"
    }
  }
})
headers = {
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

go

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "http://29597375fx.epaydev.xyz/capi/openapi/gateway/sendTransaction"
  method := "POST"

  payload := strings.NewReader(`{
    "sign": "",
    "param": {
        "epayAccount": "test2020@epay.com",
        "merchantName": "ali BANK",
        "amount": "10",
        "currency": "EUR",
        "merchantOrderNo": "A092201",
        "notifyUrl": "http://localhost/paymentApi/channel/send.do",
        "successUrl": "http://localhost/paymentApi/channel/send.do",
        "failUrl": "http://localhost/paymentApi/channel/send.do",
        "remark": "remark",
        "senderEpayAccount": "",
        "language": "CN",
        "version": "V2.0.0",
        "extendFields": {
            "test": "test"
        }
    }
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

shell

printf '{
    "sign": "",
    "param": {
        "epayAccount": "test2020@epay.com",
        "merchantName": "ali BANK",
        "amount": "10",
        "currency": "EUR",
        "merchantOrderNo": "A092201",
        "notifyUrl": "http://localhost/paymentApi/channel/send.do",
        "successUrl": "http://localhost/paymentApi/channel/send.do",
        "failUrl": "http://localhost/paymentApi/channel/send.do",
        "remark": "remark",
        "senderEpayAccount": "",
        "language": "CN",
        "version": "V2.0.0",
        "extendFields": {
            "test": "test"
        }
    }
}'| http  --follow --timeout 3600 POST 'http://29597375fx.epaydev.xyz/capi/openapi/gateway/sendTransaction' \
 Content-Type:'application/json'

入参说明

参数名称 参数说明
epayAccount 商家开通的EPAY账号
merchantName 商家名称
merchantOrderNo 商家订单号，需保证在商家系统中唯一，最大长度不能超过50个字符
amount 订单金额，要求金额小数位：2
currency 订单币种
notifyUrl 回调地址，用于接收EPAY后台通知的订单结果：成功或失败
successUrl 成功跳转页面，用于返回商家成功订单页面
failUrl 失败跳转页面，用于返回商家失败订单页面
remark 订单备注，最大长度不能超过200个字符
senderEpayAccount 强制付款EPAY账号
language 语言为EN或CN
version 版本号，当前版本号为V2.0.0，兼容版本V1.0.0
extendFields 商户扩展字段，要求JSON格式
paymentCurrency 付款币种
paymentCountry 付款国家/地区

以上为业务参数说明，参数封装结构及sign签名请查看 开发指引>接入指南>接口规则>接口规范 和 开发指引>接口签名 。

另外：paymentCurrency和paymentCountry入参字段，商家在内部系统跳转EPAY收银台时直接展示可用支付渠道。

推荐商家传入该参数，优化交互体验。更多详细说明可查看 API接口说明。

确认订单

商家根据生成epayUrl付款地址，前端跳转到EPAY收银台页面，用户选择支付方式，完成付款操作。

image

查询交易

商家可调用 queryTransaction（交易查询接口），通过商家订单号查询对应订单支付情况。

示例代码

java python go shell 
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n  \"param\": {\n    \"epayAccount\": \"test2020@epay.com\",\n    \"version\": \"V2.0.0\",\n    \"merchantOrderNo\": \"b48916e1-91fb-4ff9-9002-17e8431a5a15\"\n  },\n  \"sign\": \"\"\n}");
Request request = new Request.Builder()
  .url("http://29597375fx.epaydev.xyz/capi/openapi/payoutApi/queryTransaction")
  .method("POST", body)
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();

java

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n  \"param\": {\n    \"epayAccount\": \"test2020@epay.com\",\n    \"version\": \"V2.0.0\",\n    \"merchantOrderNo\": \"b48916e1-91fb-4ff9-9002-17e8431a5a15\"\n  },\n  \"sign\": \"\"\n}");
Request request = new Request.Builder()
  .url("http://29597375fx.epaydev.xyz/capi/openapi/payoutApi/queryTransaction")
  .method("POST", body)
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();

python

import requests
import json

url = "http://29597375fx.epaydev.xyz/capi/openapi/payoutApi/queryTransaction"

payload = json.dumps({
  "param": {
    "epayAccount": "test2020@epay.com",
    "version": "V2.0.0",
    "merchantOrderNo": "b48916e1-91fb-4ff9-9002-17e8431a5a15"
  },
  "sign": ""
})
headers = {
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

go

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "http://29597375fx.epaydev.xyz/capi/openapi/payoutApi/queryTransaction"
  method := "POST"

  payload := strings.NewReader(`{
  "param": {
    "epayAccount": "test2020@epay.com",
    "version": "V2.0.0",
    "merchantOrderNo": "b48916e1-91fb-4ff9-9002-17e8431a5a15"
  },
  "sign": ""
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

shell

printf '{
  "param": {
    "epayAccount": "test2020@epay.com",
    "version": "V2.0.0",
    "merchantOrderNo": "b48916e1-91fb-4ff9-9002-17e8431a5a15"
  },
  "sign": ""
}'| http  --follow --timeout 3600 POST 'http://29597375fx.epaydev.xyz/capi/openapi/payoutApi/queryTransaction' \
 Content-Type:'application/json'

入参说明

参数名称 参数说明
epayAccount 商家开通的EPAY账号
merchantOrderNo 商家订单号
version 版本号，当前版本号为V2.0.0，兼容版本V1.0.0

以上为业务参数说明，参数封装结构及sign签名请查看 开发指引>接入指南>接口规则>接口规范 和 开发指引>接口签名

异步通知

EPAY通过POST 请求的方式（也可以通过创建订单时传入的successUrlMethod或者failUrlMethod字段来设置回调的请求方式）将支付结果作为参数通知到notifyUrl（创建订单时设置的地址），商家收到异步通知后可以对sign签名值做安全性校验，判断消息来源是EPAY后再对自身业务做逻辑处理。具体sign签名方法请查看 开发指引>接口签名。

异步通知示例，请查看 开发指引>异步通知>回调示例

订单状态图

image

API列表

API名称 API描述 操作
gateway/sendTransaction 创建交易 查看文档
queryTransaction 查询交易 查看文档

results matching ""

    No results matching ""