Last updated: 26 June 2026 | Change log

China UnionPay

China UnionPay (also known as UnionPay) is a payment institution operating in China.

Note

Make yourself familiar with our API principles to ensure a resilient integration.

Product overview

Feature summary

Payment type	Recurring	Reversals	Partial reversals	Disputes	Auth and settlement (sale)
Local scheme	❌	Refund - yes Cancel - no	Partial refund - yes Partial cancel - no	❌	✅

Acceptance countries

China
Hong Kong
Indonesia
Japan
Macau
Philippines
Singapore
South Korea
Thailand

Acceptance currencies

Settlement currencies

Minimum transaction value: N/A
Maximum transaction value: Card issuer/bank dependent - the amount is the customer's card limit.
The limit is 5,000 USD for restricted MCC (Merchant Category Codes). Check with your Worldpay Relationship Manager for further details.

Get started

Use our API reference and set your headers.

Request

POST https://try.access.worldpay.com/apmPayments

Example requests

Collect the APM details and send an API request with these details to create a payment.

application/json

{
  "transactionReference": "Memory265-13/08/1876",
  "orderReference": "apm-order-12345",
  "merchant": {
    "entity": "default"
  },
  "instruction": {
    "method": "unionpay",
    "narrative": {
      "line1": "Hack The Planet LTD"
    },
    "value": {
      "amount": 12,
      "currency": "CNY"
    },
    "paymentInstrument": {
      "type": "direct",
      "language": "en"
    },
    "resultUrls": {
      "success": "https://worldpay.com/success",
      "pending": "https://worldpay.com/pending",
      "failure": "https://worldpay.com/failure"
    }
  }
}

Parameters

transactionReferencestring[ 1 .. 64 ] characters^[a-zA-Z0-9\-_/!@#$%()*=.:;?\[\]{}~+]*$required

For Bizum transactions, please follow this extra regex [a-zA-Z0-9]{4,12}

orderReferencestring[ 1 .. 64 ] characters^[a-zA-Z0-9\-_/!@#$%()*=.:;?\[\]{}~+]*$

A reference that you can apply to one or more payments according to your business needs. You may reuse the same reference across multiple payments, for example where:

the total amount for a single order is split across multiple payments
you use a single reference for each payment in a recurring agreement or split shipment scenario

merchantobject(MerchantV2)required

merchant.entitystring[ 3 .. 32 ] characters^([a-zA-Z0-9\- ]*)$required

Used to route the request in Access Worldpay, created as part of on-boarding.

Example: "default"

instructionobject(InstructionV2)required

Object that contains the payment type and details.

instruction.methodstringrequired

Type of payment method

Value"ach"

Discriminator

instruction.valueobject(Value)required

The value of the payment.

instruction.value.amountinteger(int64)[ 1 .. 2147483647 ]required

The amount in the lowest denomination of the currency e.g. pennies for GBP, cents for USD.

Example: 12

instruction.value.currencystringrequired

The supported ISO 4217 currency codes.

Enum"AED""AFN""ANG""AOA""ARS""AUD""AWG""AZN""BAM""BBD"

instruction.narrativeobject(NarrativeBase)required

instruction.narrative.line1string[ 1 .. 24 ] characters^[a-zA-Z0-9-., ]*$required

The description shown on your customer's bank statement for the payment.

Example: "MindPalace"

instruction.paymentInstrumentobject(AchEftPaymentInstrumentV2)required

instruction.paymentInstrument.typestringrequired

The type of instrument.

Enum"direct""checkout"

instruction.paymentInstrument.sessionHrefstring(uri)

URL of the session in which customer fields can be saved via Components SDK.

Note: This field is required when making requests where the type is checkout.

instruction.paymentInstrument.accountTypestringrequired

Account type.

Enum"checking""savings""corporate""corporateSavings"

Example: "checking"

instruction.paymentInstrument.accountNumberstring[ 1 .. 17 ] characters^[0-9]*$required

Account number of direct debit account.

Example: "123456789"

instruction.paymentInstrument.routingNumberstring= 9 characters^[0-9]*$required

Routing number of direct debit account.

Example: "123456789"

instruction.paymentInstrument.checkNumberstring[ 1 .. 15 ] characters^[0-9]*$

Check number of the direct debit account.

Example: "123456789"

instruction.paymentInstrument.companyNamestring[ 1 .. 40 ] characters^([a-zA-Z0-9 ]*)$

Company name if a corporate account.

Example: "123456789"

instruction.paymentInstrument.billingAddressobject(AchEftBillingAddress)required

instruction.paymentInstrument.billingAddress.address1string[ 1 .. 80 ] characters

instruction.paymentInstrument.billingAddress.address2string[ 1 .. 80 ] characters

instruction.paymentInstrument.billingAddress.address3string[ 1 .. 80 ] characters

instruction.paymentInstrument.billingAddress.citystring[ 1 .. 50 ] characters

City.

instruction.paymentInstrument.billingAddress.countryCodestring

The supported ISO 3166-1 alpha-2 country codes.

Enum"AD""AE""AF""AG""AI""AL""AM""AN""AO""AQ"

instruction.paymentInstrument.billingAddress.postalCodestring[ 1 .. 15 ] characters

Postal code.

instruction.paymentInstrument.billingAddress.statestring[ 1 .. 30 ] characters

State code of the billing address in ISO 3166-2 format.

Example: "US-OH"

instruction.customerobject(CustomerDetailsAch)required

instruction.customer.firstNamestring[ 1 .. 22 ] charactersrequired

Your customer's first name.

instruction.customer.lastNamestring[ 1 .. 22 ] charactersrequired

Your customer's last name.

instruction.customer.customerIdstring<= 15 characters^[a-zA-Z0-9]*$

Your unique reference for your customer so that the 'pay faster next time' function can be used during checkout. This allows your customer's chosen bank to be stored for their next payment.

Example: "44528abcd"

instruction.customer.emailstring

Your customer's e-mail address.

Example: "customer@worldpay.com"

Response

Example response

{
  "paymentInstrument": {
    "method": "unionpay",
    "type": "direct"
  },
  "paymentId": "eyJrIjoiYXBtLXNlcnZpY2UtZGVmYXVsdCIsImxpbmtWZXJzaW9uIjoiNi4wLjAifQ==.BnnxxcMle38OazhwbF8J+4rtJi8CAq:Y3zUOn1dw6VWfvx:PHL5L0S+5ara5vz6ouV5yBmVUQCiSwQjs+1x5qJIJxAKWMWc2Mlb1doricEYlzsZIRIGCflvnYu1Ns8g1S0+66n6wCELiB9OHfX7cdDZM8QaH19DiFbmMAchPSTzojxnTb6gzLpYifu+gD3nPAaFT9PiiV:KsP+z2Cdr9oxuSfqYOtdVF0OwjHRCY6fWf5XZUPFYfD4fs2JzaCZKV3L7DQm7JfXl6rjXA0ubX6hJpY5kUX4Djm9+PFFKUS69z2nX5zwzYPSSVDUYtLDOZ6R0m0fuRrvkt3IoyOFqIWhKM2Ks:rlczHJ2DGe1:xPRqjBWEQYSfjhGO0ig5hWkDRl9fGV4F+Ts5DIzFBZXwnIUMyUbZMpJ0fOD9XAPga+EJnSR3UaE8kYYgR1TxL5XUxKsWCP0oxXTQ26dg1mH8uA==",
  "lastEvent": "pending",
  "_links": {
    "self": {
      "href": "https://try.access.worldpay.com/apmPayments/eyJrIjoiYXBtLXNlcnZpY2UtZGVmYXVsdCIsImxpbmtWZXJzaW9uIjoiNi4wLjAifQ==.BnnxxcMle38OazhwbF8J+4rtJi8CAq:Y3zUOn1dw6VWfvx:PHL5L0S+5ara5vz6ouV5yBmVUQCiSwQjs+1x5qJIJxAKWMWc2Mlb1doricEYlzsZIRIGCflvnYu1Ns8g1S0+66n6wCELiB9OHfX7cdDZM8QaH19DiFbmMAchPSTzojxnTb6gzLpYifu+gD3nPAaFT9PiiV:KsP+z2Cdr9oxuSfqYOtdVF0OwjHRCY6fWf5XZUPFYfD4fs2JzaCZKV3L7DQm7JfXl6rjXA0ubX6hJpY5kUX4Djm9+PFFKUS69z2nX5zwzYPSSVDUYtLDOZ6R0m0fuRrvkt3IoyOFqIWhKM2Ks:rlczHJ2DGe1:xPRqjBWEQYSfjhGO0ig5hWkDRl9fGV4F+Ts5DIzFBZXwnIUMyUbZMpJ0fOD9XAPga+EJnSR3UaE8kYYgR1TxL5XUxKsWCP0oxXTQ26dg1mH8uA=="
    }
  },
  "_actions": {},
  "redirect": "http://secure-test.worldpay.com/redirect?tokenId=62a8645c-f481-4880-9ed8-e80d67153ae2",
  "commandId": "cmdmZ4I3ZW19OhrjDrGs7vpG0"
}

Schema

paymentIdstring

The identifier of the payment resource.

lastEventstring

Enum"authorized""cancelFailed""cancelled""cancelRequested""sentForSettlement""sentForAuthorization""settlementFailed""chargebackReversed""chargedBack""disputeExpired"

_linksobject(Links)

Links to resources related to the request.

_actionsobject(Actions)

redirectstring

The URL to redirect your customer to, or a QR code in Base64 to show to your customer, in order to complete the transaction.

paymentInstrumentobject(PaymentInstrumentResponse)

commandIdstring

An action ID generated by us identifying a single merchant interaction

Example: "cmdYNdIHBPJwbkjLiykzTx0"

transactionCodestring

For Pix payments - display to your customer for them to copy and paste in the Pix app.

For Swish payments - use this value as the {token} in the custom URL scheme: swish://paymentrequest?token={token}&callbackurl={callbackURL}. This will prompt the app to open, allowing your customer to complete their payment.

Example: "IZQ3iUfePwiWiwldJlipl8NGVA7w5IUg"

Errors

Check out our API reference for more responses or error codes.

Simulation

Simulate payment outcomes and trigger webhooks in our Try environment by sending a request.

Upon sending a payment request, you receive the payment status pending. Follow the redirect link to our simulator where you can choose between different payment outcomes.

Simulator outcome option	Payment status	Description
Pending	`pending`	Pending payment response.
Authorised	`authorized`	Payment authorized successfully.
Refused	`refused`	Unsuccessful payment - failure response from the provider.

Query the payment to receive the desired payment status.

To simulate a refund, first select the "authorised" simulator outcome. The payment is automatically captured - with the status sentForSettlement. Query the payment and call the next action reversal link to receive the status sentForRefund.

Next steps

Manage your China UnionPay payment

China UnionPay

Feature summary

Acceptance countries

Acceptance currencies

Settlement currencies

Get started

Request

Example requests

Parameters

Response

Example response

Schema

Errors

Simulation

Do you like our page?