Open API >Online Payments >UnionPay SRC API ( SRC - DCF)
UnionPay SRC API ( SRC - DCF)
Online Payments
The API is the introduction document of the interface between 3rd party wallet (DCF) and UnionPay SRC.
API Introduction
API Introduction
What is it?

The API provides a basic introduction of UnionPay SRC (Click to Pay) business as well as the transaction processing and messages of the interfaces between 3rd party wallet (DCF) and UnionPay SRC.

Key Features

Frictionless checkout flow

Improved user experience

EMVCo standard compliance

No PCI pressure

Support 3rd party wallet (DCF)


When to Use it?

UnionPay SRC can initiate SRC related flow to 3rd  party wallets (DCF) via this API when consumers select Union Pay SRC (Click to Pay) to pay.

Who Use it?
3rd party wallet (DCF) developers
Where to Use it?
Global Markets
Flow Chart
Flow Chart

SRC示意流程图.png

API Reference
API Reference
  • DCF SRC Checkout
  • DCF Card Enrollment
  • DCF Delete Card
Interface description
After the cardholder selects a specific DCF or a card belongs to a specific DCF to checkout, the UP SRC System sends CHECKOUT request to the corresponding DCF and pulls up the DCF user interface.
Request Method
HTTP POST
Request Parameter
Field name Identifier Type Length Request Default value Note
Checkout Request checkoutRequestJws Object M:Mandatory JWS signature
Masked Card maskedCard C:Conditional This field is present in the request message if a specific card of the DCF is selected in SRCi page for checkout. 
Encrypted Card  encryptedCard Object C:Conditional This field is present in the request message if a specific card of the DCF is selected in SRCi page for checkout.
Masked Consumer  maskedConsumer Object C:Conditional It is present if it exists in UnionPay SRC system.
Masked Shipping Addresses  maskedShippingAddresses array O:Optional Array of masked shipping addresses
ID Token idToken S M:Mandatory It is the JSON Web Token, generated and signed by SRC Systems. Used to identify associated consumer account profile, and attest that the requester is authorised to access this data.
Synchronous Response parameters
Filed name Identifier Type Length Request Default value Note
ID Token idToken S R:Returned It is the JSON Web Token, generated and signed by SRC Systems. Used to identify associated consumer account profile, and attest that the requester is authorised to access this data.
Checkout Response checkoutResponseJws Object M:Mandatory
Action action S M:Mandatory Valid values: “COMPLETE”, “ERROR”, “CANCEL”, “ADD_CARD”
Error error S C:Conditional It is returned if the action=”ERROR”.
Error Description errorDescription S C:Conditional It is returned if the action=”ERROR”.
  • Contact Us
  • If you have any further questions, please register and submit order in your user center.