dxp-ux

(0 reviews)

i1x-52k/GET - loyaltyAccount (TMF658

This operation retrieves a loyaltyAccount entity.

https://[localhost]:[port]/dxp-ux/v1/{businessId}/loyaltyAccount/{id}

name	type	description	required
businessId	string	2 letter ISO 3166 country code (TT, BB, JM, PA, PR etc.) identifying the business unit. Expected one for Peacock Mobile project is : "PR"-Puerto Rico	Y
id	string	Unique identifier like MSISDN OR Service Number	Y

name	type	description	required
client_id	string	The client_id identifying the channel.	Y
client_secret	string	Password associated with the client_id.	Y
X-Correlation-ID	string	Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction.	N

field name	type	description	required (mandatory-Y, optional-N, Not applicable- N/A)
id	string	Unique identifier for the loyalty program member.	N
name	string	The loyalty members name.	Y
accountBalance[]	array	Balances linked to the account	N
accountBalance[].balanceType	string	Type of the balance : deposit balance, disputed balance, loyalty balance, receivable balance...	Y
accountBalance[].amount{}	object	A base / value business entity used to represent money	Y
accountBalance[].amount.unit	string	Loyalty points	N
accountBalance[].amount.value	Number	A signed floating point number	N
accountBalance[].validFor{}	object	A period of time, either as a deadline	Y
accountBalance[].validFor.endDateTime	string	End of the time period	N
accountBalance[].validFor.startDateTime	string	Start of the time period	N