UnionPay International Developer

Open API >Offers & Benefits >Umall

Umall

Offers & Benefits Merchant

Interface between UMALL and merchant online mall

Sandbox Testing

API Introduction

Key Features

Centralized display: UMALL displays the popular products of many merchants.

Preferential and convenient: cardholders can enjoy preferential price direct access to the popular goods of merchants in H5 mall.

When to Use it?

Merchant access Uplan H5 Emall

Who Use it?

Merchant online mall developer

Where to Use it?

Global

Flow Chart

UMALL 流程图.png

API Reference

Get Merchant list
Get Popular Product list
Order Push

Interface description

This API is used to get merchant list data

Request Method

HTTP POST

Request Parameter

Field name	Identifier	Type	Request	Note
sign	sign	String	M:Mandatory	Signature
timestamp	timestamp	String	M:Mandatory	Timestamp. Format: yyyyMMddHHmms
serviceId	serviceId	String	M:Mandatory	Service Provider Id

Synchronous Response parameters

Filed name

Identifier

Type

Length

Request

Default value

Note

errno

String

M:Mandatory

Error code

errmsg

String

200

O:Optional

Error Message

sign

String

128

M:Mandatory

Signature

data

JSONArray

M:Mandatory

Merchant list

merchantId	String	1	50	M:Mandatory
merchantName	String	1	200	M:Mandatory
merchantUrl	String	1	255	M:Mandatory
uplanMerchantId	String	1	50	M:Mandatory	Merchant ID in Uplan system, which is necessary to transmit when exists
hasHotProduct	String	1	5	M:Mandatory	Whether is hot product
updateTime	String	1	14	M:Mandatory	yyyyMMddHHmmss

Interface description

This API is used to get popular product data

Request Method

HTTP POST

Request Parameter

Field name	Identifier	Type	Request	Note
sign	sign	String	M:Mandatory	Signature
merchantId	merchantId	String	M:Mandatory
timestamp	timestamp	String	M:Mandatory	Timestamp. Format: yyyyMMddHHmms
serviceId	serviceId	String	M:Mandatory	Service Provider Id

Synchronous Response parameters

Filed name

Identifier

Type

Length

Request

Default value

Note

errno

String

M:Mandatory

Error code

errmsg

String

200

O:Optional

Error Message

sign

String

128

M:Mandatory

Signature

data

JSONArray

M:Mandatory

Hot Product list

productId	productId	int	11	M:Mandatory
productName	productName	String	200	M:Mandatory
productImage	productImage	String	255	M:Mandatory
currencyCode	currencyCode	String	10	M:Mandatory
counterPrice	counterPrice	BigDecimal	18	O:Optional
costPrice	costPrice	BigDecimal	18	O:Optional
retailPrice	retailPrice	BigDecimal	18	M:Mandatory
retailPriceRmb	retailPriceRmb	BigDecimal	18	O:Optional
specSorting	specSorting	int	5	M:Mandatory
productUrl	productUrl	String	255	M:Mandatory
updateTime	updateTime	String	14	M:Mandatory	yyyyMMddHHmms

Interface description

This API is used by service provider to push order and status change info to UnionPay

Request Method

HTTP POST

Request Parameter

Field name

Identifier

Type

Length

Request

Default value

Note

serviceId

String

M:Mandatory

timestamp

String

M:Mandatory

userId

String

M:Mandatory

channelId

String

M:Mandatory

merchantId

String

M:Mandatory

merchantName

String

200

M:Mandatory

orderNo

String

M:Mandatory

status

String

M:Mandatory

createTime

String

M:Mandatory

yyyyMMddHHmmss

paymentTime

String

O:Optional

yyyyMMddHHmmss

updateTime

String

M:Mandatory

yyyyMMddHHmmss

orderUrl

String

255

M:Mandatory

totalNumber

int

M:Mandatory

orderCurrency

String

M:Mandatory

orderAmount

BigDecimal

M:Mandatory

couponId

String

O:Optional

couponName

String

255

O:Optional

couponAmount

BigDecimal

O:Optional

payAmount

BigDecimal

M:Mandatory

goodsData

JSONArray

M:Mandatory

productId	productId	int	11	M:Mandatory
productName	productName	String	200	M:Mandatory
retailPrice	retailPrice	BigDecimal	18	M:Mandatory
buyNumber	buyNumber	int	5	M:Mandatory
specNames	specNames	String	100	O:Optional
productImage	productImage	String	255	M:Mandatory

sign

String

M:Mandatory

Synchronous Response parameters

	Filed name	Identifier	Type	Length	Request	Default value	Note
	errno	errno	String		M:Mandatory
	errmsg	errmsg	String		None

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