Docking Guide

Overall Interaction Flow Chart

After completing Preparation, merchants can select the corresponding docking method for debugging based on the type of connected business.

Special Note

1. The cashier docking is only used for collection and supports anonymous payment and real-name payment. Both of them indicate whether the merchant's own users need to complete the payment operation after logging in to EPAY.
2. API supports payin and payout. The merchant's own users do not need to register and login to EPAY account.
3. For detailed flow charts, please refer to the process description of the specific business: Gateway Process, Docking Payin, Docking Payout(Banking Payout), Docking Payout(Wallet Payout) , EPAY Balance Transfer .

API Rules

URL Naming

API Specification

The message adopts json specification. The basic message format refers to the following description: message request parameters of the cashier payin api.

{
  "param": {
    "epayAccount": "test2020@epay.com", // Merchant EPAY account
    "merchantName": "ali BANK",// Merchant name
    "amount": "10.05", // Order amount
    "currency": "EUR", // Order currency
    "merchantOrderNo": "A092201", // Merchant order number
    "notifyUrl": "http://localhost/paymentApi/channel/send.do", // Callback address
    "successUrl": "http://localhost/paymentApi/channel/sucess", // Successfully Redirected Page
    "failUrl": "http://localhost/paymentApi/channel/fail", // Failure Redirected Page
    "remark": "remark",  // Order remark
    "senderEpayAccount": "", // Forced payment EPAY account
    "language": "CN", // Default language
    "version": "V2.0.0", // Version number
    "extendFields": { // Other extension field descriptions
      "field": "Merchant extension fields"
    }
  },
  "sign": "sign" // sign value
}

Sign is a data signature to prevent API interface request data from being tampered with.

API Version

API Sign

1. In order to prevent data tampering, the parameters of the merchant's request for the EPAY interface must carry the sign parameter.
2. EPAY will sign the notification sent to the merchant and put the signature value in the callback interface parameter. Merchants should verify the signature to confirm that the request comes from EPAY and not another third party.
3. For the signature verification algorithm, please refer to Development Guidelines-API SIGN

Debugging API Instructions

• Step 1: Get the api key.

Merchants can login to the test environment web page, under the Developer->Development Configuration->My API Key menu or user avatar->API Management->My API Key Under the menu, view API_KEY. For details, please refer to the documentation: Development Guidelines -> API KEY -> Obtain API_KEY.

• Step 2: Encapsulate the interface request input parameters.

• Step 3: Use the api key to generate the request parameter signature sign value.
• Step 4: Request interface parameters and signature value.

Debug API

After you complete the certification process, you can contact EPAY technical support personnel to start debugging the API interface according to Environment and Test Account.

Get API_KEY

Through the EPAY system page Activate API function, apply to obtain the API key and add the whitelist IP to start debugging the API interface.

API In Production

You can connect to the EPAY production environment system through Production Environment Information, EPAY account and ApiKey for formal transactions.