Integration Types
Other Features
Card Payments
Mobile Wallets
Alternative Payment Methods
Resources
UnionPay International through UnionPay Online Payment (UPOP), a global payment system for e-commerce transactions, offers <<unionPaySecurePay>> as a service that allows payers to shop online using their UPOP SecurePay account on the <<unionPaySecurePay>> website.
<<unionPaySecurePay>> is a supported browser payment method in the <<paymentGateway>>. This page describes integration details specific to <<unionPaySecurePay>>. It's recommended that you read the integration guidelines for browser payments, before building a <<unionPaySecurePay>> integration.
To offer <<unionPaySecurePay>> as a payment method via the <<paymentGateway>>:
With <<checkout>> integrations version 34 and later, <<unionPaySecurePay>> is automatically available when your payment service provider has configured the acquirer link for <<unionPaySecurePay>>.
interaction.timeout
field to limit the time a payer has to complete their order, when the time remaining before the payment expires is less than 840 seconds, the payer will no longer be offered the possibility to select UnionPay SecurePay as a payment method in <<checkout>>. For details, see Browser Payments via <<checkout>> Integration.
Choose <<directPayment>> integration if you want to offer <<unionPaySecurePay>> payment method on your own checkout page.
Make an Initiate Browser Payment
request where sourceOfFunds.type = UNION_PAY
. For other details, see Browser Payments via <<directPayment>> Integration.
The table below shows the transaction response codes for the possible scenarios you may encounter after initiating a <<unionPaySecurePay>> browser payment.
Scenario | Retrieve Transaction/Retrieve Order Response |
---|---|
TRANSACTION SUCCESSFUL | |
The payment is successful. | browserPayment.interaction.status=COMPLETED response.gatewayCode=APPROVED |
TRANSACTION NOT SUCCESSFUL | |
The payment was declined by the acquirer. | browserPayment.interaction.status=COMPLETED response.gatewayCode=DECLINED |
The payment was not successful, as the acquirer was unable to process it. | browserPayment.interaction.status=COMPLETED response.gatewayCode=ACQUIRER_SYSTEM_ERROR |
The <<paymentGateway>> was unable to initiate the <<unionPaySecurePay>> payment successfully. | browserPayment.interaction.status=N/A response.gatewayCode=SYSTEM_ERROR |
The <<paymentGateway>> has received the payer's browser and redirected it to <<unionPaySecurePay>>. No payment has happened within 2 hours. Any redirect requests for this payment are rejected by the <<paymentGateway>>. |
browserPayment.interaction.status=REDIRECTED_TO_PROVIDER response.gatewayCode=DECLINED |
The <<paymentGateway>> did not receive a redirect of the payer's browser from the merchant within 24 hours. No payment has occurred, and any redirect requests for this payment are rejected by the <<paymentGateway>>. |
browserPayment.interaction.status=INITIATED response.gatewayCode=TIMED_OUT |
TRANSACTION RESULT NOT YET KNOWN (IN PROGRESS) | |
The transaction has successfully been initiated in the gateway. The gateway has not yet received the payer's browser from the merchant for redirection to <<unionPaySecurePay>>. No payment has happened yet. | browserPayment.interaction.status=INITIATED response.gatewayCode=SUBMITTED |
The gateway has received the payer's browser and redirected it to <<unionPaySecurePay>>. No payment has happened yet. |
browserPayment.interaction.status=REDIRECTED_TO_PROVIDER response.gatewayCode=SUBMITTED |
The gateway has returned the payer's browser back to the merchant. The gateway is currently attempting to find out about the success or otherwise of the payment. |
browserPayment.interaction.status=RETURNED_TO_MERCHANT response.gatewayCode=SUBMITTED |
The gateway was unable to find out about the success or otherwise of the payment. The gateway may still find out and update the transaction. You can follow up with a Retrieve Transaction request (as the gateway may have found out the result) or use the gateway's webhook notifications (if you have subscribed). |
browserPayment.interaction.status=RETURNED_TO_MERCHANT response.gatewayCode=UNKNOWN |
TRANSACTION STATUS UNKNOWN | |
The gateway was unable to find out about the success or otherwise of the payment. The gateway will no longer attempt to find out. You must contact the acquirer to find out the result. |
browserPayment.interaction.status=N/A response.gatewayCode=UNKNOWN |
You can perform subsequent Captures or Refunds on <<unionPaySecurePay>> orders using <<webServicesIntegration>> Capture/Refund operations or via Merchant Administration.
You can perform Void transactions on <<unionPaySecurePay>> orders using the <<webServicesIntegration>> Void operation or via Merchant Administration. Only Authorize, Capture, and Pay transactions are supported for voids.
The <<paymentGateway>> provides a <<unionPaySecurePay>> Emulator that allows you to test your <<unionPaySecurePay>> integration.
Retrieve Transaction
response?Your merchant account at UPOP can be configured to not return the card number. In this case, you will not see a card number returned in the Retrieve Transaction
response. Contact your payment service provider if you wish to change this configuration at UPOP.
If the <<paymentGateway>> was unable to identify the card scheme and card brand associated with the payer's card then Retrieve Transaction
returns sourceOfFunds.provided.card.scheme=OTHER
and sourceOfFunds.provided.card.brand=UNKNOWN
.