China UnionPay

Overview

Introduction

China UnionPay is a payment method which allows you to process payments in different currencies by using payment cards in different countries. This method supports purchases and refunds.

This article provides information about working with the China UnionPay method: general insights are presented in the Overview section, while information about the actions required to process payments and perform other actions is presented in the sections that follow.

General information

Payment method type bank payments
Payment instruments payments cards
Countries and regions AE, AG, AT, AU, AZ, BD, BE, BN, BY, CA, CN, DE, ES, FI, FR, GB, GE, HK, HU, ID, IE, IT, JP, KE, KG, KH, KR, KZ, LB, LI, LK, LT, LU, MG, MN, MO, MT, MU, MX, MY, NL, NP, NZ, PA, PF, PH, PT, SC, SG, SI, SK, SR, TH, TJ, TZ, US, VN *
Payment currencies AUD, CAD, CHF, CNY, EUR, GBP, HKD, JPY, NZD, SGD, USD, THB *
Currency conversion –
One-time purchases +
Credential-on-file purchases –
Full refunds +
Partial refunds +
Payouts –
Chargebacks –
Notes –
Onboarding and access fee refer to your ecommpay key account manager; additional information is available in ecommshop
Note: * For more information refer to your ecommpay key account manager.

Interaction diagram

Payment processing by using the China UnionPay method involves the merchant's web service, one of ecommpay interfaces, the ecommpay payment platform, and technical facilities of the China UnionPay service.



Operations support

Various platform interfaces can be used to process payments and perform operations using the China UnionPay method. Purchases can be processed by using Payment Page, Gate and Dashboard (using payment links), refunds—by using Gate and Dashboard. At the same time, regardless of the interfaces used, the following properties and limitations are applicable.

Processing scenarios

To perform a purchase by using the China UnionPay method, you need to redirect the customer to the China UnionPay service, while to make a refund, you need to receive a request from the customer and notify the customer about the result of the refund via the web service.

Figure: Purchase by using Payment Page



Figure: Purchase by using Gate



Figure: Refund by using Gate



Purchases by using Payment Page

General information

To process a purchase through Payment Page by using the China UnionPay method, the merchant's web service is required to send a request with all required parameters and signature to the ecommpay URL and receive a callback with the result. The full sequence and special aspects of purchase processing are provided below.



Figure: Purchase processing by using Payment Page: step-by-step description

  1. A customer initiates a purchase in the web service.
  2. The web service sends the request for opening Payment Page to the specified ecommpay URL.
  3. The request for opening Payment Page is sent to the payment platform.
  4. The payment platform receives the request and validates the required parameters and signature.
  5. Payment Page is generated based on the project and request parameters.
  6. Payment Page is displayed to the customer.
  7. The customer selects the China UnionPay method.
  8. The payment platform receives the request for processing the payment by using the China UnionPay method.
  9. The payment platform processes the request and sends it to the China UnionPay service.
  10. The request is processed on the China UnionPay service side.
  11. The data for redirecting the customer to the China UnionPay service is sent from the China UnionPay service to the payment platform.
  12. The data for redirecting the customer is sent from the payment platform to Payment Page.
  13. The customer is redirected to the China UnionPay service.
  14. The customer completes all required payment steps.
  15. The purchase is processed in the China UnionPay service.
  16. The result information is displayed to the customer in the China UnionPay service.
  17. The customer is redirected to Payment Page.
  18. The China UnionPay service sends a notification about the result to the payment platform.
  19. The payment platform sends the payment result callback to the web service.
  20. The payment platform sends the result information to Payment Page.
  21. The result information is displayed to the customer on Payment Page.

Information about the formats of requests and callbacks used for processing payments by using the China UnionPay method via Payment Page is presented further in this section; general information about working with the Payment Page API is presented in Interaction concepts.

Request format

There are several things you need to consider when sending purchase requests by using the China UnionPay method:

  1. The following parameters required for any payment must be specified:
    • project_id—project identifier obtained from ecommpay during integration
    • payment_id—payment identifier unique within the project
    • payment_currency—payment currency code in the ISO-4217 alpha-3 format
    • payment_amount—payment amount in the smallest currency unit
    • customer_id—customer identifier unique within the project
  2. The following parameters required for any payment must be specified: project_id, payment_id, payment_currency, payment_amount, customer_id.
  3. Additionally, depending on the payment processing provider, it can be necessary to specify the last name of the customer in the parameter customer_last_name. If this parameter is missing, the payment form may display the input field for entering the missing value (details are available in Submission of additional payment information).
  4. The currency of payment can be one of the following: AUD, CAD, CHF, CNY, EUR, GBP, HKD, JPY, NZD, SGD, USD, THB. Consult with your ecommpay account manager regarding availability of currencies.
  5. To open Payment Page in the language of the bank group, pass the zh code in the language_code parameter in the request for opening. For more information, see Interface language support.
  6. If you need to have the payment form displayed with the China UnionPay method selected, set the force_payment_method parameter to cup-union.
  7. Additionally, any other parameters available for working with Payment Page can be used (details).
  8. After all target parameters are specified, generate a signature (details).

Thus, a correct request for opening the payment form using the China UnionPay method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer identifier last name, as well as signature.

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 1000,
   "payment_currency": "USD",
   "customer_id": "customer1",
   "customer_last_name": "Johnson",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

Figure: Example of sufficient data in a purchase request

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 1000,
   "payment_currency": "USD",
   "customer_id": "customer1",
   "customer_last_name": "Johnson",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

Callback format

The China UnionPay 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 information about a 10.00 USD purchase made in the 198 project.

Figure: Example of callback data indicating that the purchase has been processed

"callbackBody": {
        "project_id": 198,
        "payment": {
            "id": "TEST_154402240162030",
            "type": "purchase",
            "status": "success",
            "date": "2018-12-06T13:33:33+0000",
            "method": "unionpay",
            "sum": {
                "amount": 100,
                "currency": "USD"
            },
            "description": "TEST_154402240162930"
        },
        "operation": {
            "id": 7458000002161,
            "type": "sale",
            "status": "success",
            "date": "2018-12-06T13:33:33+0000",
            "created_date": "2018-12-06T13:31:41+0000",
            "request_id": "986be38f02e8fe3fb8-c1990f3e7af3",
            "sum_initial": {
                "amount": 100,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 100,
                "currency": "USD"
            },
            "provider": {
                "id": 410,
                "payment_id": "74580000021610207055371314024366",
                "date": "2018-12-06T13:31:42+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "lci0uOA7aWgJ5nwyImqQjXAfdP+nEzyXwb/t9G1E1U8+5vDkdb...=="
    }

The following is the example of a callback with information about a declined purchase.

Figure: Example of callback data indicating that the purchase has been declined

"callbackBody": {
        "project_id": 198,
        "payment": {
            "id": "TEST_1548340290097231",
            "type": "purchase",
            "status": "decline",
            "date": "2019-01-26T14:36:35+0000",
            "method": "unionpay",
            "sum": {
                "amount": 2000000,
                "currency": "CNY"
            },
            "description": "TEST_1548340290097"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 4723000002794,
            "type": "sale",
            "status": "decline",
            "date": "2019-01-26T14:36:35+0000",
            "created_date": "2019-01-24T14:36:33+0000",
            "request_id": "72b28ec3f95271699dcade",
            "sum_initial": {
                "amount": 2000000,
                "currency": "CNY"
            },
            "sum_converted": {
                "amount": 294684,
                "currency": "USD"
            },
            "provider": {
                "id": 410,
                "payment_id": "47230000027940105280386327826886",
                "date": "2019-01-24T14:36:35+0000",
                "auth_code": ""
            },
            "code": "20000",
            "message": "General decline"
        },
        "signature": "vOpSHO5fMolQhUGItTilgFKcVkbdmBMaf2cD7FsIB...=="
    }

Useful links

The following articles can be useful when implementing purchases via Payment Page:

Purchases by using Gate

General information

To process a purchase through Gate by using the China UnionPay method, the merchant's web service is required to do the following:

  1. Send a request with all the required parameters and signature to the ecommpay URL.
  2. Receive an intermediate callback from the payment platform and redirect the customer to the China UnionPay service.
  3. Receive the final callback from the payment platform.

The full sequence and special aspects of purchase processing are provided below.



Figure: Purchase processing by using Gate: step-by-step description

  1. A customer initiates a purchase by using the China UnionPay method in the web service.
  2. The web service sends the request for processing the purchase by using Gate to the specified ecommpay URL.
  3. The payment platform receives the request.
  4. The payment platform validates the required parameters and signature in the request.
  5. The payment platform sends the response to the web service with information about the receipt of the request and its validity (details).
  6. The payment platform performs further processing of the request (with parameter consistency check) and sends it to the China UnionPay service.
  7. The request is processed on the China UnionPay service side.
  8. The China UnionPay service sends the redirection data to the payment platform.
  9. The payment platform sends the callback with the redirection data to the web service.
  10. The customer is redirected to the China UnionPay service.
  11. The customer completes all required payment steps.
  12. The purchase is processed in the China UnionPay service.
  13. The result is displayed to the customer.
  14. The customer is redirected to the web service.
  15. The China UnionPay service sends the payment result notification to the payment platform.
  16. The payment platform sends the payment result callback to the web service.
  17. The customer receives the payment result information from the web service.

Information about the formats of requests and callbacks used for processing payments by using the China UnionPay method via Gate is presented further in this section. General information about working with the Gate API is presented in Interaction concepts.

Request format

There are several things you need to consider when sending purchase requests by using the China UnionPay method:

  1. To initiate each purchase, send a separate POST request to the /v2/payment/cup/union/sale endpoint.
  2. Each request must include the following objects and parameters:
    • Object general—general purchase information:
      • project_id—project identifier obtained from ecommpay during integration
      • payment_id—payment identifier unique within the project
      • signature—request signature generated after all required parameters are specified (details—in the Signature generation and verification) (details)
    • Object payment—payment information:
      • amount—payment amount in the smallest currency unit
      • currency—payment currency code in the ISO-4217 alpha-3 format
    • customer—object that contains customer information:
      • id—customer identifier unique within the project
      • ip_address—customer IP address relevant for the initiated payment
      • last_name*—last name (to avoid errors during payment processing it is recommended to set the following value length—from 3 to 100 characters). If the parameter is not specified in the request, a callback containing this parameter is sent for additional payment information submission (for more details, see Submission of additional payment information)
    • Object return_url*—contains the URLs to which customer is redirected during or after payment processing:
      • success*—URL for redirecting a customer after a performed purchase
      • return*—URL to return customer to the web service during any step before the payment is completed
    Note: *Consult with your ecommpay account manager for the detailed information what parameters are required.
  3. The currency of payment can be one of the following: AUD, CAD, CHF, CNY, EUR, GBP, HKD, JPY, NZD, SGD, USD, THB. Consult with your ecommpay account manager regarding availability of currencies.
  4. Additionally, any other parameters included in the specification can be used.

Thus, a correct payment request in the China UnionPay method must include general information about request and information about payment and customer. The method may also require a URLs for redirection and the last name of the customer as shown in the following example. For details, refer to your ecommpay account manager.

Thus, a correct purchase request by using the China UnionPay method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer identifier and IP address and signature. The method may also require a URLs for redirection and the last name of the customer as shown in the following example.

{
  "general": {
    "project_id": 198,
    "payment_id": "TEST_15532590003171111",
    "signature": "dMNfpKk0MnZhXWKjAKWTckxgEoNbjNhOYQMh6lB4C9J7gksH...=="
  },
  "customer": {
    "ip_address": "192.0.2.0",
    "last_name": "Johnson"
    "id": "123"
  },
  "payment": {
    "amount": 1000,
    "currency": "USD"
  },
  "return_url": {
    "success": "https://example.com/success",
    "return": "https://example.com/return"
  }
}

Figure: Example of sufficient data in a purchase request

{
  "general": {
    "project_id": 198,
    "payment_id": "TEST_15532590003171111",
    "signature": "dMNfpKk0MnZhXWKjAKWTckxgEoNbjNhOYQMh6lB4C9J7gksH...=="
  },
  "customer": {
    "ip_address": "192.0.2.0",
    "last_name": "Johnson"
    "id": "123"
  },
  "payment": {
    "amount": 1000,
    "currency": "USD"
  },
  "return_url": {
    "success": "https://example.com/success",
    "return": "https://example.com/return"
  }
}

Formats of intermediate callbacks for customer redirection

Each payment made with the China UnionPay method requires redirection of customers from the merchant's web service to the China UnionPay service. To redirect a customer it is necessary to receive an intermediate callback from the payment platform and use the information included in the redirect_data object. The format of such callbacks is standard (details), and the following objects and parameters are included in the redirect_data object:

  • body—object with data to be sent in the request body
  • method—parameter specifying the HTTP method for sending the request (GET or POST)
  • url—parameter containing a link for redirection

Figure: redirect_data example

  "redirect_data": {
    "body": {},
    "method": "GET",
    "url": "https://www.example.com/pay"
  }

Final callback format

The China UnionPay 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 information about a 10.00 USD purchase made in the 198 project.

Figure: Example of callback data indicating that the purchase has been processed

"callbackBody": {
        "project_id": 198,
        "payment": {
            "id": "TEST_154402240162030",
            "type": "purchase",
            "status": "success",
            "date": "2018-12-06T13:33:33+0000",
            "method": "unionpay",
            "sum": {
                "amount": 100,
                "currency": "USD"
            },
            "description": "TEST_154402240162930"
        },
        "operation": {
            "id": 7458000002161,
            "type": "sale",
            "status": "success",
            "date": "2018-12-06T13:33:33+0000",
            "created_date": "2018-12-06T13:31:41+0000",
            "request_id": "986be38f02e8fe3fb8-c1990f3e7af3",
            "sum_initial": {
                "amount": 100,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 100,
                "currency": "USD"
            },
            "provider": {
                "id": 410,
                "payment_id": "74580000021610207055371314024366",
                "date": "2018-12-06T13:31:42+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "lci0uOA7aWgJ5nwyImqQjXAfdP+nEzyXwb/t9G1E1U8+5vDkdb...=="
    }

The following is the example of a callback with information about a declined purchase.

Figure: Example of callback data indicating that the purchase has been declined

"callbackBody": {
        "project_id": 198,
        "payment": {
            "id": "TEST_1548340290097231",
            "type": "purchase",
            "status": "decline",
            "date": "2019-01-26T14:36:35+0000",
            "method": "unionpay",
            "sum": {
                "amount": 2000000,
                "currency": "CNY"
            },
            "description": "TEST_1548340290097"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 4723000002794,
            "type": "sale",
            "status": "decline",
            "date": "2019-01-26T14:36:35+0000",
            "created_date": "2019-01-24T14:36:33+0000",
            "request_id": "72b28ec3f95271699dcade",
            "sum_initial": {
                "amount": 2000000,
                "currency": "CNY"
            },
            "sum_converted": {
                "amount": 294684,
                "currency": "USD"
            },
            "provider": {
                "id": 410,
                "payment_id": "47230000027940105280386327826886",
                "date": "2019-01-24T14:36:35+0000",
                "auth_code": ""
            },
            "code": "20000",
            "message": "General decline"
        },
        "signature": "vOpSHO5fMolQhUGItTilgFKcVkbdmBMaf2cD7FsIB...=="
    }

Useful links

The following articles can be useful when implementing purchases via Gate:

Refunds by using Gate

General information

To perform a refund through Gate by using the China UnionPay method, send a request with all required parameters and signature to the ecommpay URL and receive a callback with the result. For one payment you can perform only one partial refund, then to make additional refunds for this payment you need to contact the technical support of the payment system. The full sequence and special aspects of refund performing are provided below.



Figure: Refund performing by using Gate: step-by-step description

  1. A customer initiates a refund.
  2. The web service sends the request for performing the refund by using Gate to the specified ecommpay URL.
  3. The payment platform receives the request.
  4. The payment platform validates the required parameters and signature in the request.
  5. The payment platform sends the response to the web service with information about the receipt of the request and its validity (details).
  6. The payment platform performs further processing of the request (with parameter consistency check) and sends it to the China UnionPay service.
  7. The refund is processed on the side of the China UnionPay service.
  8. The China UnionPay service sends the result notification to the payment platform.
  9. The payment platform sends the result callback to the web service.
  10. The customer receives the refund result information from the web service.

Information about the formats of requests and callbacks used for performing refunds by using the China UnionPay method via Gate is presented further in this section. General information about working with the Gate API is presented in Interaction concepts.

Request format

There are several things you need to consider when sending refund requests by using the China UnionPay method:

  1. To initiate each refund, send a separate POST request to the /v2/payment/unionpay/refund endpoint.
  2. Each request must include the following objects and parameters:
    • Object general—general refund information:
      • project_id—project identifier obtained from ecommpay during integration
      • payment_id—identifier of the payment that needs to be refundedpayment identifier
      • signature—request signature generated after all required parameters are specified (details—in the Signature generation and verification)
    • Object payment—refund information:
      • description—refund description or comment
      • amount—refund amount in the smallest currency unit (required for a partial refund)
      • currency—refund currency code in the ISO-4217 alpha-3 format (required for a partial refund)
    • Object customer—customer information:
      • ip_address—customer IP address relevant for the initiated refund
  3. Additionally, any other parameters included in the specification can be used.

Thus, a correct refund request by using the China UnionPay method must contain the project and payment identifiers, description of the refund, the customer IP address, signature, and, if necessary, currency code and refund amount.

{
  "general": {
    "project_id": 210,
    "payment_id": "test_payment",
    "signature": "PJkV8ej\/UG0Di8hTng6JvipTv+AWoXW\/9MTO8yJA=="
  },
  "payment": {
    "description": "test refund",
    "amount": 1000,
    "currency": "USD"
  },
  "customer": {
    "ip_address": "192.0.2.0"
  }
}

Figure: Example of sufficient data in a refund request

{
  "general": {
    "project_id": 210,
    "payment_id": "test_payment",
    "signature": "PJkV8ej\/UG0Di8hTng6JvipTv+AWoXW\/9MTO8yJA=="
  },
  "payment": {
    "description": "test refund",
    "amount": 1000,
    "currency": "USD"
  },
  "customer": {
    "ip_address": "192.0.2.0"
  }
}

Callback format

The China UnionPay method uses the standard format for callbacks to deliver refund results. For more information, see Callbacks.

The following is the example of a callback with information about a 10.00 USD refund made in the 198 project.

Figure: Example of callback data indicating that the refund has been processed

"callbackBody": {
        "project_id": 198,
        "payment": {
            "id": "TEST_154402240162030",
            "type": "purchase",
            "status": "refunded",
            "date": "2018-12-06T14:24:08+0000",
            "method": "unionpay",
            "sum": {
                "amount": 1000,
                "currency": "USD"
            },
            "description": "TEST_154402240162930"
        },
        "operation": {
            "id": 7458000002162,
            "type": "refund",
            "status": "success",
            "date": "2018-12-06T14:24:08+0000",
            "created_date": "2018-12-06T14:23:58+0000",
            "request_id": "758cf8a4a495acf7f27eb0c1b",
            "sum_initial": {
                "amount": 1000,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "USD"
            },
            "provider": {
                "id": 410,
                "payment_id": "",
                "date": "2018-12-06T22:24:04+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "pHyB8h89qctuJ3ksW9xsERYpVSi3SDWAAWnknJw4o9f...=="
    }

The following is the example of a callback with information about a declined refund.

Figure: Example of callback data indicating that the refund has been declined

  "callbackBody": {
        "project_id": 198,
        "payment": {
            "id": "TEST_1542789072282111",
            "type": "purchase",
            "status": "partially refunded",
            "date": "2018-11-21T12:33:38+0000",
            "method": "unionpay",
            "sum": {
                "amount": 50,
                "currency": "USD"
            },
            "description": "TEST_1542789072282"
        },
        "customer": {
            "id": "1"
        },
        "errors": [
            {
                "code": "2701",
                "message": "Rules Failed Code",
                "description": "fatal: RULES_FAILED_CODE"
            }
        ],
        "operation": {
            "id": 16115000001979,
            "type": "refund",
            "status": "decline",
            "date": "2018-11-21T12:49:38+0000",
            "created_date": "2018-11-21T12:49:38+0000",
            "request_id": "3abc68c33b2298127",
            "sum_initial": {
                "amount": 50,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 50,
                "currency": "USD"
            },
            "provider": {
                "id": 410,
                "payment_id": ""
            },
            "code": "2701",
            "message": "Rules Failed Code"
        },
        "signature": "hAS3NXs1LmLl0xYtaHqLrRCAANBq1Z+/g26NVka...=="
    }

Useful links

The following articles can be useful when implementing refunds via Gate:

Analysis of payments results

To analyse information about payments made with the China UnionPay method and other methods, you can use:

  • Dashboard interface toolkit with various lists and analytic panels.
  • Reports in CSV file format, available via the Reports section (one-time and periodically).
  • Data in JSON format, sent by program requests to a specified URL available by using the Data API interface.

If you have any questions, refer to the documentation (Dashboard and Using Data API) and ecommpay technical support.