UnionPay International Developer

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

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

SRC示意流程图.png

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

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	Request	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”.

Interface description

The cardholder selects a specific card to be enrolled in the UPSRC profile, the DCF sends ENROLL CARD Request including card details (PAN + Expiry date) and consumer identifiers (if available) to the UPI SRC system. Once the SRC system receives the enrollment request, the card will be enrolled to the matching SRC Profile. The UPI SRC shall send ENROLL CARD response back to the DCF, while the DCF shall note down specific card identifier. The card identifier may be an SRC Digital Card Identifier.

Request Method

HTTP POST

Request Parameter

Field name	Identifier	Type	Request	Note
SRCi Transaction ID	srciTransactionId		O:Optional	Transaction-unique identifier assigned by the SRCI.
ID Token	idToken	JWT	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.
Encrypted Card	encryptedCard		M:Mandatory
Encrypted Consumer	encryptedConsumer		M:Mandatory
Digital Card Data	digitalCardData	Object	O:Optional
Cardholder Data	cardholderData	Object	O:Optional
Compliance Settings	complianceSettings	Object	O:Optional

Interface description

Once the cardholder chooses to delete a card, the UPI SRC System sends a DELETE CARD notification to the DCF. After the DCF receives the notification, the DCF shall logically delete specific card identifier. The card identifier may be an SRC Digital Card Identifier.

Request Method

HTTP POST

Request Parameter

Field name

Identifier

Type

Length

Request

Default value

Note

Delete Card Request JWS

deleteCardRequestJws

Object

M:Mandatory

SRC Digital Card Reference ID

srcDigitalCardId

1-36

M:Mandatory

It is the reference representing the PAN or Payment Token that uniquely identify the underlying PAN. A single PAN can have one or more SRC Digital Card Reference IDs.

SRC Correlation ID

srcCorrelationId

String

1-256

M:Mandatory

The unique identifier of the SRC checkout transaction generated by UnionPay SRC System.

Encrypted Consumer Identity

encryptedConsumerIdentity

JWE Object

M:Mandatory

Identity Provider	identityProvider	String		O:Optional	Entity or organisation that collected and verified the identity. Valid value: “SRC”
Consumer Identity Type	identityType	String		M:Mandatory	Type of Consumer Identity transmitted or collected. Valid values: “EMAIL_ADDRESS” “MOBILE_PHONE_NUMBER”
Identity Value	identityValue	String	1-255	M:Mandatory	Consumer Identity value that corresponds to the Consumer Identity Type. Is used to locate information within the SRC Profile.

Card Product

Online Payment

Mobile QuickPass

QR Code

Cross-Border B2B Service

Token Program

SaaS Card Issuing Service Platform

Block Chain

Platforms

Global Service

Digital Solutions

Industry Solutions

Deferred Online ODA Mode

Real-Time Mode

Frictionless Parking

Transit QR Code Mode

Prompt

Kindly Reminder

Prompt