CUP Banks

General information

In the CUP Banks method, when processing a purchase by using Payment Page, the merchant web service is required to send a request with all the required parameters and signature to the ecommpay URL and get the callback with the result information from the payment platform. When opening Payment Page, you can either allow your customer to select the CUP Banks method from the list of other payment methods on Payment Page or have Payment Page opened with CUP Banks method selected. For more information about preselecting payment methods, see Preselecting payment methods.

The full sequence and particularities of the purchase process are provided below.

The sections that follow discuss in more details the request format and the Payment Page parameters to use in the CUP Banks payment method and provide the information on the format of callbacks with payment results. For the general information on how to use the API, seePayment Page API Description.

Request format

There are several things you must consider when using the CUP Banks method:

1. You must provide values for the basic minimum of parameters. Listed below are the parameters that are mandatory for any payment method:
   • customer_id—the unique ID of the customer within your project
   • project_id—the project ID obtained from ecommpay
   • payment_id—payment ID unique within the project
   • payment_amount—payment amount in minor units
   • payment_currency—payment currency in ISO-4217 alpha-3 format
2. There are two more mandatory parameters:
   • language_code. In the language_code parameter, you must use zh code.
   • payment_description.
3. If you need to have payment form displayed with the CUP Banks method selected, set the force_payment_method parameter to cup-bank.
4. The currency of payment can only be CNY.
5. If required, you can also add any other additional parameters Payment Page supports.
6. After you specify all the parameters you need, you must create the signature for the request. For instructions on how to sign a payment request, see Signature generation and verification.

Thus, a correct payment request in the CUP Banks method must include project, customer and payment IDs, language code, the currency, amount, and description of a payment, as shown in the following example:

EPayWidget.run(
    { payment_id: 'TEST_154', 
      payment_amount: 50000, 
      payment_currency: 'CNY',
      payment_description: 'test payment', 
      customer_id: '123',
      project_id: 581, 
      language_code: 'zh',
      signature: "xq9k0XaXE0Ig0s%2B4%2BM2gtmkytwe3%2BP1pzXw%2BNPTTGrS%...=="
    }
)

For information about all parameters available in the CUP Banks method, see Parameters for opening payment form.

Callback format

In the CUP Banks method, the callbacks that deliver purchase results use the standard format described in Callbacks.

Here is an example of callback with an information about successful 100.00 CNY purchase made by the 1 customer in the 200 project.

 {
        "project_id": 200,
        "payment": {
            "id": "ECT_TEST_15528942647389318",
            "type": "purchase",
            "status": "success",
            "date": "2019-03-19T15:22:05+0000",
            "method": "cup-bank",
            "sum": {
                "amount": 10000,
                "currency": "CNY"
            },
            "description": "ECT_TEST_1552894260335"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 24276000000595,
            "type": "sale",
            "status": "success",
            "date": "2019-03-19T15:22:05+0000",
            "created_date": "2019-03-19T15:18:11+0000",
            "request_id": "6cb000fda4402cabff6b7a4c7f9f301eec3d8d52",
            "sum_initial": {
                "amount": 10000,
                "currency": "CNY"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "CNY"
            },
            "provider": {
                "id": 1129,
                "payment_id": "4RrI6DNXLhRWZuMKnOd4MqFd9yPDw4Yk",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "H9j5S+t+jKeVs717ET765vHJKIISkNb4YdkIemQDjTMKlH
                          eskFU6OjIlIzvgnJCFhJxiKNLstiVoAUrWbDAHSQ=="
    }

The following example of callback is for a payment rejected due to insufficient funds on customer account.

 {
        "project_id": 580,
        "payment": {
            "id": "ECT_TEST_155323309979211",
            "type": "purchase",
            "status": "decline",
            "date": "2019-03-22T09:31:57+0000",
            "method": "cup-bank",
            "sum": {
                "amount": 10000,
                "currency": "CNY"
            },
            "description": "ECT_TEST_155323309979211"
        },
        "operation": {
            "id": 26532000000672,
            "type": "sale",
            "status": "decline",
            "date": "2019-03-22T09:31:57+0000",
            "created_date": "2019-03-22T07:31:24+0000",
            "request_id": "6d9a19b81c63625ea59aa40eb19ac3700516133aabcea87485c3",
            "sum_initial": {
                "amount": 10000,
                "currency": "CNY"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "CNY"
            },
            "provider": {
                "id": 1180,
                "payment_id": "190322153143831000",
                "date": "2019-03-22T16:32:11+0000",
                "auth_code": ""
            },
            "code": "20105",
            "message": "Insufficient funds on customer account"
        },
        "signature": "y0tUj/I/c85dV/9ff47U1KDci68aGhP8Pt+YhWRXYKSFLDl
                         mwMIT5kv/TzmCgQEWwUv1qyo1cdW+xeAoQMZqQbHA=="
    }

Related topics

The following topics might be useful when implementing payments through Payment Page:

• Interaction concepts
• Signature generation and verification
• Payment models and statuses
• Information of operations performing

General information

In the CUP Banks method, when processing a purchase by using Gate, the merchant web service is required to do the following:

1. Send a request with all the required parameters and signature to the ecommpay URL.
2. Perform redirecting customer to the CUP Banks form.
3. Get the callback with the payment result from the payment platform.

The following diagram provides the detailed picture of the payment processing procedure.

The sections that follow discuss in more details the request format and the Gate parameters to use in the CUP Banks payment method and provide the information about formats of the data for redirecting customers and the information about the format of callbacks with payment results.

Request format

1. You send purchase request to /v2/payment/cup/bank/sale by using HTTP method POST.
2. The following objects and parameters must be specified in any request:
   • general—object that contains general request identification information:
     • project_id—the project ID obtained from ecommpay
     • payment_id—payment ID unique within the project
     • signature—signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification.
   • customer—object that contains customer information:
     • id—the unique ID of the customer within your project
     • ip_address—customer IP address
     • first_name—first name in Chinese
     • last_name—last name in Chinese
     • phone—phone number without +,
     • email—email address
     • country—country of residence in the ISO 3166-1 alpha-2 format
     • street—street of residence
     • city—city of residence
     • zip—postal code
   • payment—object that contains purchase information:
     • amount—purchase amount in minor units
     • currency—purchase currency in ISO-4217 alpha-3 format
     • description—description
   • return_url—URL for redirection:
     • success—in case of success
3. The currency of purchase can only be CNY.
4. If required, you can also add any other additional parameters Gate supports.

Thus, a correct payment request in the CUP Banks method must include general information about request, payment, customer and URL for redirection, as shown in the following example:

{
    "general": {
    "project_id": 200,
    "payment_id": "ECT_TEST_1559106834731-9",
    "signature": "yzWwFC70Exu6K5UhylPzyh8/QORz6HjULx87emy3AybWK4...=="
  },
  "customer": {
    "id": "123",
    "ip_address": "111.254.255.479",
    "first_name": "结算",
    "last_name": "结算",
    "street":"street",
    "city": "city",
    "zip": "123045607",
    "country": "CH",
    "phone": "120450780",
    "email": "test@email.com"
    }
  },
  "payment": {
    "amount": 1000,
    "currency": "CNY", 
    "description": "test payment"
  },
  "return_url":{
      "success" : "http://success.com"
  }
}

Formats of the customer redirection data

To redirect a customer from the web service to the bank site, you must receive a callback from the payment platform containing the URL for redirection in the redirect_data.url parameter and data to be sent in the request body in the redirect_data.body parameter, and use these parameters when opening the bank’s HTML page using method specified in the redirect_data.method parameter. The data in redirect_data.body may be differ depending on the payment processing provider.

The following is the callback fragment containing the URL for purchase.

"redirect_data": {
            "method": "GET",
            "body": {
            merchantId: "0004",
            version: "v1",
            inputCharset: "UTF-8",
            merchantTradeId: "dslkjfhslkhfssdusk.jnk.s",
            currency: "CNY",
            payType: "EC",
            issuingBank: "UNIONPAY",
            amountFee: "502",
            deviceType: "WEB",
            goodsTitle: "结算款项",
            returnUrl: "https://www.funtopay.com/hefu/return/",
            notifyUrl: "https://www.funtopay.com/hefu/notify/",
            signType: "RSA",
            sign: "TZUmn8bhp7BO93V06JxJCaf5xi+Sne0eVfVOCt1mi6+YAdnY/IfbEBHC2yPXTRRGmquaKSE3uuiL6AfnOm
            dTtjJznRCw3Wo5jjfSwE0GkG+D25XlC712Et33l0TH+Gcf4QRiba6xOVlvPKpK0OK/svObtPpPr0o/q+8zTX+El6w="
        },
            "encrypted": [],
            "url": "http://payment.qixiqiang.com/payment/v3/unionpayIntGate.html"
        }

Callback format

The CUP Banks method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks.

Here is an example of callback with an information about successful 100.00 CNY purchase made by the 1 customer in the 200 project.

 {
        "project_id": 200,
        "payment": {
            "id": "ECT_TEST_15528942647389318",
            "type": "purchase",
            "status": "success",
            "date": "2019-03-19T15:22:05+0000",
            "method": "cup-bank",
            "sum": {
                "amount": 10000,
                "currency": "CNY"
            },
            "description": "ECT_TEST_1552894260335"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 24276000000595,
            "type": "sale",
            "status": "success",
            "date": "2019-03-19T15:22:05+0000",
            "created_date": "2019-03-19T15:18:11+0000",
            "request_id": "6cb000fda4402cabff6b7a4c7f9f301eec3d8d52",
            "sum_initial": {
                "amount": 10000,
                "currency": "CNY"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "CNY"
            },
            "provider": {
                "id": 1129,
                "payment_id": "4RrI6DNXLhRWZuMKnOd4MqFd9yPDw4Yk",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "H9j5S+t+jKeVs717ET765vHJKIISkNb4YdkIemQDjTMKlH
                          eskFU6OjIlIzvgnJCFhJxiKNLstiVoAUrWbDAHSQ=="
    }

The following example of callback is for a payment rejected due to insufficient funds on customer account.

 {
        "project_id": 580,
        "payment": {
            "id": "ECT_TEST_155323309979211",
            "type": "purchase",
            "status": "decline",
            "date": "2019-03-22T09:31:57+0000",
            "method": "cup-bank",
            "sum": {
                "amount": 10000,
                "currency": "CNY"
            },
            "description": "ECT_TEST_155323309979211"
        },
        "operation": {
            "id": 26532000000672,
            "type": "sale",
            "status": "decline",
            "date": "2019-03-22T09:31:57+0000",
            "created_date": "2019-03-22T07:31:24+0000",
            "request_id": "6d9a19b81c63625ea59aa40eb1954af0516133aabcea87485c3",
            "sum_initial": {
                "amount": 10000,
                "currency": "CNY"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "CNY"
            },
            "provider": {
                "id": 1180,
                "payment_id": "190322153143831000",
                "date": "2019-03-22T16:32:11+0000",
                "auth_code": ""
            },
            "code": "20105",
            "message": "Insufficient funds on customer account"
        },
        "signature": "y0tUj/I/c85dV/9ff47U1KDci68aGhP8Pt+YhWRXYKSFLDlwM
                              IT5kv/TzmCgQEWwUv1qyo1cdW+xeAoQMZqQbHA=="
    }

Related topics

The following topics might be useful when implementing payments through Gate:

• Interaction concepts
• Signature generation and verification
• Payment models and statuses
• Information of operations performing

General information

To perform a payout through the CUP Banks method, merchant's web service sends a request with all the required parameters and signature to ecommpay URL, and receives a callback with the payment result. The full sequence of the payout process is provided below.

The sections that follow discuss in more details the request format and the Gate parameters to use in the CUP Banks payment method and provide the information on the format of callbacks with payout results.

Request format

There are several things you must consider when using payout requests in the CUP Banks method:

1. You perform payouts by sending the request to /v2/payment/chinaunionpay/payout by using HTTP method POST.
2. The following objects and parameters must be specified in any request:
   • general—object that contains general request identification information:
     • project_id—the project ID obtained from ecommpay
     • payment_id—payment ID unique within the project
     • signature—signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification.
   • payment—object that contains purchase information:
     • amount—purchase amount in minor units of the currency
     • currency—purchase currency in ISO-4217 alpha-3 format
     • description—payment description
   • customer—object that contains customer information:
     • id—identifier
     • ip_address—IP address
     • email—email
     • state—province in Chinese
     • city—city in Chinese
     • country—country (pass CN)
     • phone—phone number without +
     • zip—postal code
     • street—address in Chinese
     • first_name—first name in Chinese
     • last_name—last name in Chinese
   • card—object that contains card or account information:
     • pan—card number (for some providers it is necessary to specify the bank account number of the customer, for more information refer to your ecommpay key account manager)
   • account—object that contains customer bank account information:
     • city—bank address city
     • bank_id—bank identifier (for more detailed information about banks and their IDs, see Supported banks)
     • region_id—bank region identifier (for more detailed information about banks and their IDs, see Payout regions)
     • branch—bank branch (abbreviation)
3. Additionally, to increase conversion, specify the customer.identify.doc_number parameter—the number of the identity document.
4. The currency of payout can only be CNY.
5. If required, you can also add any other additional parameters Gate supports.

Thus, a correct payout request in the CUP Banks method must include project and payment IDs, signature, currency and amount of the payout, customer and bank account details, and customer card number:

{
    "general": {
        "project_id": 255,
        "payment_id": "TEST_15392667771145",
        "signature": "Uhka8CiYAlDlc2wRq60vlSmTTCb0Zp0KYV4NF0...=="
    },
    "customer": {
        "id": "127",
        "ip_address": "185.123.193.224",
        "email": "qwe@qw.qw",
        "state": "state",
        "city": "city",
        "country": "CN",
        "phone": "phone",
        "zip": "zip",
        "street": "street",
        "first_name": "伍",
        "last_name": "倩文",
        "identify": {
            "doc_number": "23512361283"
    },
    "payment": {
        "amount": 501,
        "currency": "CNY"
    },
  "card": {
    "pan": "621661******6793"
   },
    "account": {
        "bank_id": "123",
        "branch": "qwert",
        "city": "City",
        "region_id": "region_id"
    }
}

Callback format

The CUP Banks method uses the standard format for callbacks to deliver payout results. For more information, see Callbacks.

Here is an example of callback with an information about successful 215.00 CNY payout made for the 1 customer in the 200 project.

{
        "project_id": 200,
        "payment": {
            "id": "ECT_TEST_1563863519243_test2-gate-4",
            "type": "payout",
            "status": "success",
            "date": "2019-08-28T08:44:51+0000",
            "method": "ChinaUnionPay",
            "sum": {
                "amount": 21500,
                "currency": "CNY"
            },
            "description": "ECT_TEST_1563863519243"
        },
        "account": {
            "number": "621799******3840"
        },
        "customer": {
            "id": "1",
            "phone": "89102345678"
        },
        "operation": {
            "id": 45343000001495,
            "type": "payout",
            "status": "success",
            "date": "2019-08-28T08:44:51+0000",
            "created_date": "2019-08-28T08:42:08+0000",
            "request_id": "c21daec7a134",
            "sum_initial": {
                "amount": 21500,
                "currency": "CNY"
            },
            "sum_converted": {
                "amount": 21500,
                "currency": "CNY"
            },
            "provider": {
                "id": 1321,
                "payment_id": "10019082821621938",
                "date": "2019-08-28T16:42:12+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "aW/oS/l7RTlKabsqCZXs1zile11EIX8mkM3+gJfwddjvtszeiMXcU7...=="
    }

The following example of callback is for a payment rejected due to customer account being no longer available.

 {
        "project_id": 200,
        "payment": {
            "id": "ECT_TEST_12897456238746287",
            "type": "payout",
            "status": "decline",
            "date": "2019-03-25T12:46:51+0000",
            "method": "ChinaUnionPay",
            "sum": {
                "amount": 10000,
                "currency": "CNY"
            },
            "description": ""
        },
        "account": {
            "number": "621661******6993"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 35102000000612,
            "type": "payout",
            "status": "decline",
            "date": "2019-03-25T12:46:51+0000",
            "created_date": "2019-03-20T11:45:09+0000",
            "request_id": "c44aae5ae361b649a6225994e626d6cd",
            "sum_initial": {
                "amount": 10000,
                "currency": "CNY"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "CNY"
            },
            "provider": {
                "id": 1129,
                "payment_id": "NqIy87k9SLcDRmkPa1JfM6cQZ53M",
                "date": "2019-03-25T12:46:49+0000",
                "auth_code": ""
            },
            "code": "20106",
            "message": "Customer account is no longer available"
        },
        "signature": "bSqa2y0QnfV6xc1WdSNiNPKZkj100QeSVqtVDRmJaPP...=="
    }

Related topics

The following topics might be useful when implementing payments through Gate:

• Interaction concepts
• Signature generation and verification
• Payment models and statuses
• Information of operations performing

General information

For the CUP Banks method the testing of purchases by using Payment Page and Gate as well as payouts by using Gate.

Testing can be performed within a test project, to enable and disable the testing availability, contact ecommpay technical support via support@ecommpay.com.

When performing a test payment, take into account that you must specify the identifier of the test project in the requests, the interfaces of the payment forms emulator of Payment Page and CUP Banks differ from the production environment.

Test payments statuses

When testing purchases, the final payment status is determined by the amount specified in the request:

• decline status with 40000 or 40400 amount
• success status with any other amount

When testing payouts, the final payment status is determined by the amount specified in the request:

• decline status with 40000 or 40400 amount
• success status with any other amount

Purchases by using Payment Page

To perform a test purchase by using Payment Page, do the following:

1. Send a correct test request for Payment Page opening to the payment platform.
2. If the cup-bank method was not specified in the request—select the method on the emulator page.
3. Specify the required data in the data entry fields.
4. Click the Success or Decline button (depending on the amount specified in the request).
5. Accept a callback with information about the payment result.

The full information about purchase process by using CUP Banks through Payment Page is provided in the section Purchase by using Payment Page.

Purchases by using Gate

To perform a test purchase by using Gate, do the following:

1. Send a correct test request for purchase to the payment platform.
2. Accept a callback with redirection data.
3. Go to the received URL and click the Success or Decline button (depending on the amount specified in the request).
4. Accept a callback with information about the payment result.

The full information about purchase process by using CUP Banks through Gate is provided in the section Purchase by using Gate.

Payouts by using Gate

To perform a test payout by using Gate, send a correct test request to the payment platform and accept a callback with information about the payment result. The full information about payout process by using CUP Banks through Gate is provided in the section Payout by using Gate.

As with other payment methods ecommpay offers, when using the CUP Banks method, you have several options to analyse the information about payments and operations performed by using the method—alone or in conjunction with other methods.

You can load and analyse all the necessary information in Dashboard, for instance you can use the analytic panels on the Analytics tab to this end.

Also, you can export the information for further analysis by using third party analytical tools. The following options are available:

• Dashboard allows you to download reports in CSV and XLS formats—by using the tools on the Payments tab. You can perform export as a one-time download to your local computer or have payment data regularly exported and delivered to email addresses you specify.
• Data API allows you to have payment information exported in JSON format and delivered to a URL you specify. The payment information is exported by using the /operations/get queries.

If you have any further questions regarding payment data analysis, contact ecommpay technical support.