CUP QuickPay

General information

In the CUP QuickPay 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 QuickPay method from the list of other payment methods on Payment Page or have Payment Page opened with CUP QuickPay 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 QuickPay payment method and provide the information on the format of callbacks with payment results. For the general information on how to use the API, see Payment Page API Description.

Request format

There are several things you need to consider when using the CUP QuickPay 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_currency—payment currency in ISO-4217 alpha-3 format
   • payment_amount—payment amount in minor units
2. There is one more mandatory parameter—language_code. In the Payment Page language_code parameter, you must use zh code.
3. There is one more mandatory parameter—payment_description with description or comment to the payment.
4. If you need to have payment form displayed with the CUP QuickPay method selected, set the force_payment_method parameter to cup-quick.
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 QuickPay method must include project, customer and payment IDs, language code, the currency and the amount of a payment in the appropriate currency, as shown in the following example:

EPayWidget.run(
    { payment_id: 'TEST_154', 
      payment_amount: 1000, 
      payment_currency: 'CNY', 
      customer_id: '123',
      project_id: 581, 
      language_code: 'zh',
      payment_description: 'TEST_1557900746307',
      signature: "kq970XaXE0Ig0s%2B4%2BM2gtmkytwe3%2BP1pzXw%2BNPTTG...=="
    }
)

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

Callback format

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

The following is the example of a callback with an information about successful 10.00 CNY purchase made in the 580 project.

{
        "project_id": 580,
        "payment": {
            "id": "ECT_TEST_15532590003171111",
            "type": "purchase",
            "status": "success",
            "date": "2019-03-25T03:56:01+0000",
            "method": "quick",
            "sum": {
                "amount": 1000,
                "currency": "CNY"
            },
            "description": "ECT_TEST_15532590003171111"
        },
        "operation": {
            "id": 24101000000751,
            "type": "sale",
            "status": "success",
            "date": "2019-03-25T03:56:01+0000",
            "created_date": "2019-03-25T03:54:57+0000",
            "request_id": "gh72ef7c07157e6bde92072a52",
            "sum_initial": {
                "amount": 1000,
                "currency": "CNY"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "CNY"
            },
            "provider": {
                "id": 1198,
                "payment_id": "190325115517201000",
                "date": "2019-03-25T11:55:55+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "j8704ugh4Kt7E+IezTbe96ecupSki6DbyC5e/89/YW6/
                      BbF+Qh8zcud6s/u4C4qA6W58E6LDftzWjKLfwTeG5bQ=="
    }

The following is the example of a callback for a purchase declined due to insufficient funds on customer account.

{
        "project_id": 580,
        "payment": {
            "id": "ECT_TEST_155325900031711",
            "type": "purchase",
            "status": "decline",
            "date": "2019-03-22T14:51:20+0000",
            "method": "quick",
            "sum": {
                "amount": 1000,
                "currency": "CNY"
            },
            "description": "ECT_TEST_155325900031711"
        },
        "operation": {
            "id": 21449000000697,
            "type": "sale",
            "status": "decline",
            "date": "2019-03-22T14:51:20+0000",
            "created_date": "2019-03-22T12:50:43+0000",
            "request_id": "01c9b7a9152b6991b6d22e8c46bedaec5",
            "sum_initial": {
                "amount": 1000,
                "currency": "CNY"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "CNY"
            },
            "provider": {
                "id": 1198,
                "payment_id": "190322205110731000",
                "date": "2019-03-22T21:52:19+0000",
                "auth_code": ""
            },
            "code": "20105",
            "message": "Insufficient funds on customer account"
        },
        "signature": "PFsxBI4v59YN917MCq0vcgiTAjSKo/nGtv7U2+xskpamu1drPF0os
                                        pdxsTZYSqLVCfqqy9HAK19IgF6cxCKctg=="
    }

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 QuickPay 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 QuickPay 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 QuickPay payment method and provide the information on the format of callbacks with purchase results.

Request format

1. You send purchase requests by sending the request to /v2/payment/cup/quick/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—IP address
     • first_name—first name in Chinese
     • last_name—last name in Chinese
     • phone—phone number without +
     • email—customer email
     • zip—postcode
     • country—country of residence in the ISO 3166-1 alpha-2 format
     • city—city of residence in Chinese
     • street—address of residence in Chinese
   • payment—object that contains purchase information:
     • amount—purchase amount in minor units
     • currency—purchase currency in ISO-4217 alpha-3 format
     • description—description or comment to the payment
   • return_url—URL for returning customers from bank site to merchant web service after payment performing:
     • success—URL for returning after performed payment
3. If required, you can also add any other additional parameters Gate supports.

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

{
  "general": {
    "project_id": 200,
    "payment_id": "ECT_TEST_1559134591371-pz-3",
    "signature": "pK1YN6fd7yajGSWAzsbYeJo5nvotVBtOijOzgFvAU5Cc8PB...=="
  },
  "customer": {
    "id": "123",
    "ip_address": "183.57.40.238",
    "first_name": "伍",
    "last_name": "倩文",
    "phone": "13632264147",
    "email": "2524243674@email.com",
    "street":"street",
    "city": "city",
    "zip": "123045607",
    "country": "CH"
    }
  },
  "payment": {
    "amount": 1000,
    "currency": "CNY",    
    "description": "payment"
  },
  "return_url: {
    "success": "http://example.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": {
                "deviceType": "WEB",
                "amountFee": "10.00",
                "sign": "****************",
                "cardType": "D",
                "merchantTradeId": "21449000000697",
                "userName": "",
                "version": "1.0",
                "paymentCard": "",
                "issuingBank": "UNIONPAY",
                "payType": "NC",
                "merchantId": "4245",
                "payIp": "185.123.193.224",
                "signType": "RSA",
                "notifyUrl": "https://site.com/cup/callback",
                "inputCharset": "UTF-8",
                "currency": "CNY",
                "goodsTitle": "ECT_TEST_155325900031711",
                "returnUrl": "https://site.com/gogkjotvmr3hi96gdnd8i1s3",
                "subIssuingBank": ""
            },
            "encrypted": [],
            "url": "http://payment.qixiqiang.com/payment/v3/unionpayIntGate.html"
        }

Callback format

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

The following is the example of a callback with an information about successful 10.00 CNY purchase made in the 580 project.

{
        "project_id": 580,
        "payment": {
            "id": "ECT_TEST_15532590003171111",
            "type": "purchase",
            "status": "success",
            "date": "2019-03-25T03:56:01+0000",
            "method": "quick",
            "sum": {
                "amount": 1000,
                "currency": "CNY"
            },
            "description": "ECT_TEST_15532590003171111"
        },
        "operation": {
            "id": 24101000000751,
            "type": "sale",
            "status": "success",
            "date": "2019-03-25T03:56:01+0000",
            "created_date": "2019-03-25T03:54:57+0000",
            "request_id": "gh72ef7c07157e6bde92072a52",
            "sum_initial": {
                "amount": 1000,
                "currency": "CNY"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "CNY"
            },
            "provider": {
                "id": 1198,
                "payment_id": "190325115517201000",
                "date": "2019-03-25T11:55:55+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "j8704ugh4Kt7E+IezTbe96ecupSki6DbyC5e/89/YW6/
                      BbF+Qh8zcud6s/u4C4qA6W58E6LDftzWjKLfwTeG5bQ=="
    }

The following is the example of a callback for a purchase declined due to insufficient funds on customer account.

{
        "project_id": 580,
        "payment": {
            "id": "ECT_TEST_155325900031711",
            "type": "purchase",
            "status": "decline",
            "date": "2019-03-22T14:51:20+0000",
            "method": "quick",
            "sum": {
                "amount": 1000,
                "currency": "CNY"
            },
            "description": "ECT_TEST_155325900031711"
        },
        "operation": {
            "id": 21449000000697,
            "type": "sale",
            "status": "decline",
            "date": "2019-03-22T14:51:20+0000",
            "created_date": "2019-03-22T12:50:43+0000",
            "request_id": "01c9b7a9152b6991b6d22e8c46bedaec5",
            "sum_initial": {
                "amount": 1000,
                "currency": "CNY"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "CNY"
            },
            "provider": {
                "id": 1198,
                "payment_id": "190322205110731000",
                "date": "2019-03-22T21:52:19+0000",
                "auth_code": ""
            },
            "code": "20105",
            "message": "Insufficient funds on customer account"
        },
        "signature": "PFsxBI4v59YN917MCq0vcgiTAjSKo/nGtv7U2+xskpamu1drPF0os
                                        pdxsTZYSqLVCfqqy9HAK19IgF6cxCKctg=="
    }

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 QuickPay 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.

1. A customer orders a payout through the CUP QuickPay service.
2. Merchant's web service sends the payout request for processing the payout by using Gate to the appropriate ecommpay URL.
3. Gate redirects the request to the ecommpay payment platform.
4. The payment platform performs all the necessary check and processes the request.
5. The reply with the request processing results is sent to the merchant's web service. For more information, see Response format.
6. The payment platform redirects the payout request to the CUP QuickPay service.
7. The payout is processed on the CUP QuickPay side.
8. CUP QuickPay sends the result notification to the payment platform.
9. The payment platform sends a callback with the payment result to the web service.
10. The customer receives the payout result from the web service.

The sections that follow discuss in more details the request format and the Gate parameters to use in the CUP QuickPay 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 QuickPay 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. If required, you can also add any other additional parameters Gate supports.

Thus, a correct payout request in the CUP QuickPay 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 QuickPay 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 485.60 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": 48560,
                "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": 48560,
                "currency": "CNY"
            },
            "sum_converted": {
                "amount": 48560,
                "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_122127637126536125",
            "type": "payout",
            "status": "decline",
            "date": "2019-03-22T14:02:44+0000",
            "method": "cup-card",
            "sum": {
                "amount": 48560,
                "currency": "CNY"
            },
            "description": ""
        },
        "account": {
            "number": "621661******6993"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 32988000000665,
            "type": "payout",
            "status": "decline",
            "date": "2019-03-22T14:02:44+0000",
            "created_date": "2019-03-22T14:02:12+0000",
            "request_id": "b78ffab13002d994a6a572410b943ed110",
            "sum_initial": {
                "amount": 48560,
                "currency": "CNY"
            },
            "sum_converted": {
                "amount": 48560,
                "currency": "CNY"
            },
            "provider": {
                "id": 1191,
                "payment_id": "6UBPgonfNE4kjjPB6HoV5pjTdBo34Lni",
                "date": "2019-03-22T14:02:43+0000",
                "auth_code": ""
            },
            "code": "20106",
            "message": "Customer account is no longer available"
         },
        "signature": "rP/FoxRIdBJtMLKP5KAndJwmJHWQ3HXsDCpcbmaaqq...=="
    }

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

As with other payment methods ecommpay offers, when using the CUP QuickPay 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.