Super Gateway(Pages)

SwaggerUI

Parameter description

Request

name type required desc example
param JSONObject YES
─epayAccount string YES Merchant Epay Account test2020@epay.com
─version string YES Version Number V2.0.0
─senderEpayAccount string NO Mandatory sender Epay account sender@epay.com
─merchantName string YES Merchant name ali BANK
─merchantOrderNo string YES Merchant order number A092201
─amount string YES Amount 10
─paymentCurrency string NO Payment currency USD
─checkOutType string NO Specify the checkout mode via parameters (0: display all payment channels configured for the merchant account; 1: legal currency channels; 2: other currency channels) 0
─channelCode string NO Channel code (specifies the payment channel, determines the payment methods displayed in the fixed cashier interface) 12
─currency string YES Currency EUR
─notifyUrl string YES Callback address http://localhost/paymentApi/channel/send.do
─successUrl string NO Successful forward to page http://localhost/paymentApi/channel/success.html
─failUrl string NO Failure forward to page http://localhost/paymentApi/channel/fail.html
─successUrlMethod string NO Successful forward method:POST/GET POST
─failUrlMethod string NO Failure forward method:POST/GET POST
─remark string NO Remark remark
─extendFields JSONObject NO Merchant extension field { "test": "test" }
─language string NO Default language CN
sign string YES Signature

Response

name type required desc example
sign string YES Signature
epayAccount string YES Merchant Epay Account test2020@epay.com
version string YES Version Number V2.0.0
code integer YES Response code 1 : Success 1
message string YES Message Info success
data JSONObject YES
─merchantName string YES Merchant name ali BANK
─senderEpayAccount string YES Sender Epay account sender@epay.com
─merchantOrderNo string YES Merchant order number A092201
─epayOrderNo string YES Epay order numbe 201141428590792305594368
─paymentCurrency string NO Payment currency USD
─checkOutType string NO Cashier payment type 0
─channelCode string NO Channel Code 12
─status string YES Epay order status 0
─amount string YES Amount 10.0
─fee string YES Fees 0.1
─currency string YES Currency EUR
─notifyUrl string YES Callback address http://localhost/paymentApi/channel/send.do
─successUrl string YES Successful forward to page http://localhost/paymentApi/channel/success.html
─failUrl string YES Failure forward to page http://localhost/paymentApi/channel/fail.html
─epayUrl string YES Payment page http://web.epaydev.xyz/epayapi/paymentApi/merReceive?tid=566ad0e017082dc2b3a93b0b8bbad33b7b2d6
─remark string YES Remark remark
─extendFields string YES Merchant extension field

Parameter example

RequestExample ResponseExample 
curl --location --request POST 'http://29597375fx.epaydev.xyz/capi/openapi/gateway/sendTransaction' \
--header 'Content-Type: application/json' \
--data-raw '{
    "sign": "{{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",
        "paymentCurrency":"USD",
        "checkOutType":"0",
        "channelCode":"12",
        "remark": "remark",
        "senderEpayAccount": "",
        "language": "CN",
        "version": "V2.0.0",
        "extendFields": {
            "test": "test"
        }
    }
}'

RequestExample

curl --location --request POST 'http://29597375fx.epaydev.xyz/capi/openapi/gateway/sendTransaction' \
--header 'Content-Type: application/json' \
--data-raw '{
    "sign": "{{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",
        "paymentCurrency":"USD",
        "checkOutType":"0",
        "channelCode":"12",
        "remark": "remark",
        "senderEpayAccount": "",
        "language": "CN",
        "version": "V2.0.0",
        "extendFields": {
            "test": "test"
        }
    }
}'

ResponseExample

{
  "sign": "2F707ACCAC69E2E5FC20916AF840466B20D1BE03B68A491F0791339C43BDA410",
  "epayAccount": "test2020@epay.com",
  "version": "V2.0.0",
  "code": 1,
  "message": "success",
  "data": {
    "merchantName": "ali BANK",
    "senderEpayAccount": "",
    "merchantOrderNo": "T08121001111",
    "epayOrderNo": "201141428590792305594368",
    "status": "0",
    "fields": "",
    "amount": "10.0",
    "fee": "0.1",
    "currency": "EUR",
    "paymentCurrency":"USD",
    "checkOutType":"0",
    "channelCode":"12",
    "notifyUrl": "http://localhost/paymentApi/channel/send.do",
    "successUrl": "http://localhost/paymentApi/channel/send.do",
    "failUrl": "http://localhost/paymentApi/channel/send.do",
    "epayUrl": "http://web.epaydev.xyz/epayapi/paymentApi/merReceive?tid=566ad0e017082dc2b3a93b0b8bbad33b7b2d62a770356e64f7d702a24ab2ab42&language=ZH_CN",
    "remark": "remark"
  }
}

results matching ""

    No results matching ""