Definitions

ActivationConfirmation

Information about a gift card activation to be confirmed.

Name	Type	Required	Restrictions	Description
id	string	required		The randomly generated UUID identifying this advice, as defined for a variant 4 UUID in RFC 4122
requestId	string	required		The UUID identifying the request that this advice relates to
time	string	required	format:date-time	The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision
thirdPartyIdentifiers	array[ThirdPartyIdentifier]	required		The unaltered thirdPartyIdentifiers array as supplied in the related BasicResponse message. Required if thirdPartyIdentifiers field was present in the BasicResponse. If no thirdPartyIdentifiers was received in the BasicResponse or no BasicResponse was received then this should be set to the thirdPartyIdentifiers sent in the original request.
stan	string	optional		The System Trace Audit Number can be used to locate transactions across different systems.
rrn	string	optional		This is a reference set by the original source of the transaction.
tenders	array[Tender]	required		An array of tenders used to pay for the transaction

ActivationRequest

Information about the gift card activation.

Name	Type	Required	Restrictions	Description
id	string	required		The randomly generated UUID identifying this transaction, as defined for a variant 4 UUID in RFC 4122
time	string	required	format:date-time	The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision
originator	Originator	required		Data relating to the originator of the transaction.
client	Institution	required		Data relating to the sender of Transaction.
settlementEntity	Institution	optional		Data relating to the entity with whom the Merchant will settle the transaction.
receiver	Institution	optional		Data relating to the entity which ultimately processes the request.
thirdPartyIdentifiers	array[ThirdPartyIdentifier]	required		An array of identifiers which each identify the transaction within each entity’s system.
slipData	SlipData	optional		Text to be printed on the customer receipt.
basketRef	string	optional		Used to group multiple transactions which would otherwise be considered independent.
tranType	string	optional	[GOODS_AND_SERVICES, CASH_WITHDRAWAL, DEBIT_ADJUSTMENT, GOODS_AND_SERVICES_WITH_CASH_BACK, NON_CASH, RETURNS, DEPOSIT, CREDIT_ADJUSTMENT, GENERAL_CREDIT, AVAILABLE_FUNDS_INQUIRY, BALANCE_INQUIRY, GENERAL_INQUIRY, CARD_VERIFICATION_INQUIRY, CARDHOLDER_ACCOUNTS_TRANSFER, GENERAL_TRANSFER, PAYMENT_FROM_ACCOUNT, GENERAL_PAYMENT, PAYMENT_TO_ACCOUNT, PAYMENT_FROM_ACCOUNT_TO_ACCOUNT, PLACE_HOLD_ON_CARD, GENERAL_ADMIN, CHANGE_PIN, CARD_HOLDER_INQUIRY, POINTS_INQUIRY]	Data relating to the type of transaction taking place (i.e. cash withdrawal, goods and services etc.).
srcAccType	string	optional	[DEFAULT, SAVINGS, CHEQUE, CREDIT, UNIVERSAL, ELECTRONIC_PURSE, GIFT_CARD, STORED_VALUE]	This specifies the type of source account being used in the transaction (i.e. cheque, savings).
destAccType	string	optional	[DEFAULT, SAVINGS, CHEQUE, CREDIT, UNIVERSAL, ELECTRONIC_PURSE, GIFT_CARD, STORED_VALUE]	This specifies the type of destination account being used in the transaction (i.e. cheque, savings).
stan	string	optional		The System Trace Audit Number can be used to locate transactions across different systems.
rrn	string	optional		This is a reference set by the original source of the transaction.
amounts	GiftcardAmounts	optional		Specifies an amount which should be loaded onto the card as part of the activation.
card	Card	required		Information about the gift card being activated.
posInfo	PosInfo	optional		Information about the POS.
product	Product	required		Information about the gift card product being activated.
cardHolder	Customer	optional		Information about the card holder of the gift card.

ActivationResponse

Information about the result of processing the card activation.

Name	Type	Required	Restrictions	Description
id	string	required		The randomly generated UUID identifying this transaction, as defined for a variant 4 UUID in RFC 4122
time	string	required	format:date-time	The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision
originator	Originator	required		Data relating to the originator of the transaction.
client	Institution	required		Data relating to the sender of Transaction.
settlementEntity	Institution	optional		Data relating to the entity with whom the Merchant will settle the transaction.
receiver	Institution	optional		Data relating to the entity which ultimately processes the request.
thirdPartyIdentifiers	array[ThirdPartyIdentifier]	required		An array of identifiers which each identify the transaction within each entity’s system.
slipData	SlipData	optional		Text to be printed on the customer receipt.
basketRef	string	optional		Used to group multiple transactions which would otherwise be considered independent.
tranType	string	optional	[GOODS_AND_SERVICES, CASH_WITHDRAWAL, DEBIT_ADJUSTMENT, GOODS_AND_SERVICES_WITH_CASH_BACK, NON_CASH, RETURNS, DEPOSIT, CREDIT_ADJUSTMENT, GENERAL_CREDIT, AVAILABLE_FUNDS_INQUIRY, BALANCE_INQUIRY, GENERAL_INQUIRY, CARD_VERIFICATION_INQUIRY, CARDHOLDER_ACCOUNTS_TRANSFER, GENERAL_TRANSFER, PAYMENT_FROM_ACCOUNT, GENERAL_PAYMENT, PAYMENT_TO_ACCOUNT, PAYMENT_FROM_ACCOUNT_TO_ACCOUNT, PLACE_HOLD_ON_CARD, GENERAL_ADMIN, CHANGE_PIN, CARD_HOLDER_INQUIRY, POINTS_INQUIRY]	Data relating to the type of transaction taking place (i.e. cash withdrawal, goods and services etc.).
srcAccType	string	optional	[DEFAULT, SAVINGS, CHEQUE, CREDIT, UNIVERSAL, ELECTRONIC_PURSE, GIFT_CARD, STORED_VALUE]	This specifies the type of source account being used in the transaction (i.e. cheque, savings).
destAccType	string	optional	[DEFAULT, SAVINGS, CHEQUE, CREDIT, UNIVERSAL, ELECTRONIC_PURSE, GIFT_CARD, STORED_VALUE]	This specifies the type of destination account being used in the transaction (i.e. cheque, savings).
stan	string	optional		The System Trace Audit Number can be used to locate transactions across different systems.
rrn	string	optional		This is a reference set by the original source of the transaction.
amounts	GiftcardAmounts	optional		Indicates the amount which was requested to be loaded onto the card during activation, the amount which was loaded and the balance of the gift card after activation.
card	Card	required		Information about the gift card being activated.
posInfo	PosInfo	optional		Information about the POS.
product	Product	required		Information about the gift card product being activated.
cardHolder	Customer	optional		Information about the card holder of the gift card.

ActivationReversal

Information about a gift card activation to be reversed.

Name	Type	Required	Restrictions	Description
id	string	required		The randomly generated UUID identifying this advice, as defined for a variant 4 UUID in RFC 4122
requestId	string	required		The UUID identifying the request that this advice relates to
time	string	required	format:date-time	The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision
thirdPartyIdentifiers	array[ThirdPartyIdentifier]	required		The unaltered thirdPartyIdentifiers array as supplied in the related BasicResponse message. Required if thirdPartyIdentifiers field was present in the BasicResponse. If no thirdPartyIdentifiers was received in the BasicResponse or no BasicResponse was received then this should be set to the thirdPartyIdentifiers sent in the original request.
stan	string	optional		The System Trace Audit Number can be used to locate transactions across different systems.
rrn	string	optional		This is a reference set by the original source of the transaction.
reversalReason	string	required	[TIMEOUT, CANCELLED, RESPONSE_NOT_FINAL]	The reason for the reversal

Barcode

Used to indicate barcode information for a slip line.

Name	Type	Required	Default	Restrictions	Description
data	string	required			Data to be encoded in the barcode
encoding	string	required			Specifies the encoding used in the barcode

BasicAdvice

The data required in all advice messages

Name	Type	Required	Restrictions	Description
id	string	required		The randomly generated UUID identifying this advice, as defined for a variant 4 UUID in RFC 4122
requestId	string	required		The UUID identifying the request that this advice relates to
time	string	required	format:date-time	The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision
thirdPartyIdentifiers	array[ThirdPartyIdentifier]	required		The unaltered thirdPartyIdentifiers array as supplied in the related BasicResponse message. Required if thirdPartyIdentifiers field was present in the BasicResponse. If no thirdPartyIdentifiers was received in the BasicResponse or no BasicResponse was received then this should be set to the thirdPartyIdentifiers sent in the original request.
stan	string	optional		The System Trace Audit Number can be used to locate transactions across different systems.
rrn	string	optional		This is a reference set by the original source of the transaction.

Basket

Information about the items paid for using the gift card.

Name	Type	Required	Default	Restrictions	Description
basketId	string	required		pattern:[0-9A-Za-z]{1,20}	An identifier for the collection of items being paid for.
items	array[Item]	required			The items being purchased.

Card

Information about a gift card; its number, rank, expiry date and optionally the PIN either unencrypted or encrypted.

Name	Type	Required	Restrictions	Description
pan	string	required	pattern:[0-9]{1,19}	Primary account number that uniquely identifies this card.
expiryDate	string	required	pattern:[0-9]{4}	The card expiry date, in YYMM format.
clearPin	string	optional		The pin number associated with the card unencrypted.
encryptedPin	string	optional	pattern:[0-9ABCDEF]+	The encrypted pin number associated with the card in HEX format.
rank	string	optional		The rank of the card on the Giftcard system. For example: primary, secondary, collector.
pin	Pin	optional		Pin that can either be of type clear PIN or encryted PIN. This value takes precendence overencryptedPin and clearPin fields.

Club

Information about a club; its name, description, customer membership and products.

Name	Type	Required	Description
name	string	required	The name of this marketing attribute.
description	string	optional	The description of this marketing attribute.
member	boolean	required	If the customer associated with this card is a member of this marketing attribute.
marketToCustomer	boolean	required	Should the customer associated with card be subjected to marketing for this specific marketing attribute.
products	array[Product]	optional	The products for which this club is associated with.

Customer

A customer who ultimately requests a transaction be performed.

Name	Type	Required	Restrictions	Description
firstName	string	optional	maxLength:40	The customer’s first name(s)
lastName	string	optional	maxLength:40	The customer’s last name
address	string	optional	maxLength:80	The customer’s address
dateOfBirth	string	optional	format:date-time	The customer’s date of birth
status	string	optional		The status of this customer on the Giftcard system. For example: active, inactive
msisdn	string	optional	pattern:^+?[1-9]\d{0,14}	This must conform to the ITU E.164 numbering plan (https://www.itu.int/rec/T-REC-E.164/en) e.g. 27821234567 for a South African number.
emailAddress	string	optional	format:email	The customer’s email address. This address must conform to RFC 5322 3.4.1 addr-spec (https://tools.ietf.org/html/rfc5322#section-3.4.1).

EncryptionParameters

Parameters pertaining to the generation of the PIN block. Required if the service is to perform any operations on the encrypted PIN, such as translation.

Name	Type	Required	Restrictions	Description
pinBlockFormat	string	optional	[ISO_9564_FORMAT_0, ISO_9564_FORMAT_1, ISO_9564_FORMAT_3]	PIN block format that was used when encrypting the PIN. Defaults to ISO_9564_FORMAT_0.
accountNumber	string	required	pattern:[0-9]{12}	12 digit account number used when encrypting the PIN. When account number is a card number (PAN), this is the rightmost 12 digits excluding the check digit.
keyIndex	integer	optional	format:int32	Index of the key under which the PIN block is encrypted. Where keys are exchanged in TR-31 KeyBlock format, this should be set to the key version number field of the key used for encryption. If this field is not populated, the most recently exchanged key will be used. Note that omitting this field may require a higher level of synchronization during automated key exchange in some environments.

ErrorDetail

Represents the outcome of a completed transaction

Name	Type	Required	Restrictions	Description
errorType	string	required	[DUPLICATE_RECORD, FORMAT_ERROR, FUNCTION_NOT_SUPPORTED, GENERAL_ERROR, INVALID_AMOUNT, ROUTING_ERROR, TRANSACTION_NOT_SUPPORTED, UNABLE_TO_LOCATE_RECORD, UPSTREAM_UNAVAILABLE, INVALID_PRODUCT, CARD_NOT_ACTIVATED, CARD_ACTIVATED, CARD_VOIDED, CARD_BLOCKED, CARD_DELETED, FUNCTION_BLOCKED_FOR_CARD_RANK, INSUFFICIENT_FUNDS, INVALID_CARD_NUMBER, CARD_EXPIRED, INCORRECT_PIN, TEMPORARY_FAILURE, DO_NOT_HONOUR, PIN_ATTEMPTS_EXCEEDED]	The type of error that occurred
errorMessage	string	required	maxLength:20	A short description of the error
detailMessage	object	optional		A free form detailed description of a particular failure condition may optionally be supplied
requestType	string	required	[ACTIVATION_CONFIRMATION, ACTIVATION_REQUEST, ACTIVATION_REVERSAL, LOAD_CONFIRMATION, LOAD_REQUEST, LOAD_REVERSAL, LOOKUP_REQUEST, REDEMPTION_CONFIRMATION, REDEMPTION_REQUEST, REDEMPTION_REVERSAL, REPLACE_CONFIRMATION, REPLACE_REQUEST, REPLACE_REVERSAL, TRANSFER_CONFIRMATION, TRANSFER_REQUEST, TRANSFER_REVERSAL, VOID_CONFIRMATION, VOID_REQUEST, VOID_REVERSAL]	The type of request being processed when the error occurred.
id	string	required		The UUID of the message for which the error occurred.
originalId	string	optional		The UUID of the original request message int he case of an error occurring for an advice message.

GiftcardAmounts

Amounts which make up the transaction. Absent amounts have zero value.

Name	Type	Required	Description
requestAmount	LedgerAmount	optional	The transaction amount requested by the customer to be authorised or approved. This is the total amount the customer wishes to pay for a service or virtual product.
approvedAmount	LedgerAmount	optional	The transaction amount which was approved by the upstream entity.
feeAmount	LedgerAmount	optional	Fees charged by the upstream entity for processing the transaction.
balanceAmount	LedgerAmount	optional	The remaining balance on the customer’s account.
additionalAmounts	object	optional	Any additional amounts that are involved in a transaction which don’t appropriately fit into the other amount fields.
availableBalance	LedgerAmount	optional	The funds currently available on the card which may be redeemed. This field should not include loads which must still be finalised.

Institution

Originating, acquiring, processing, or receiving institution details

Name	Type	Required	Default	Restrictions	Description
id	string	required			The institution’s ID. API implementations should take care to set this field as appropriate for the implementation.
name	string	required		maxLength:40	The institutions’s name

Item

A unique product and quantity thereof which is part of a customer's basket. This should not be confused with the Product model which describes a gift card product sold by retailers.

Name	Type	Required	Restrictions	Description
productId	string	optional	pattern:[0-9A-Za-z]{1,20}	An identifier for the product such as a barcode.
productName	string	optional	pattern:[0-9A-Za-z]{1,50}	The name of the product.
productType	string	optional	pattern:[0-9A-Za-z]{1,30}	The type of the product e.g. food, clothing etc.
quantity	number	optional	format:float	The number of units of product bought. This could be whole units if suitable for the product (e.g. tins of beans) or a fractional value in the case of a volume or mass value.
unit	string	optional	[UNIT, LITRE, KILOGRAM]	The unit the quantity is measured in.

LedgerAmount

An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT

Name	Type	Required	Restrictions	Description
amount	integer	required	format:int64	Amount in minor denomination, e.g. R799.95 is encoded as 79995
currency	string	required	pattern:[0-9]{3}	Three digit currency number from ISO 4217, e.g. South African Rand is encoded as 710
ledgerIndicator	string	optional	[DEBIT, CREDIT]	Indicates whether this amount is a debit or a credit. Only required when the amount can be either a debit or a credit

LoadConfirmation

Information about a gift card load to be confirmed.

Name	Type	Required	Restrictions	Description
id	string	required		The randomly generated UUID identifying this advice, as defined for a variant 4 UUID in RFC 4122
requestId	string	required		The UUID identifying the request that this advice relates to
time	string	required	format:date-time	The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision
thirdPartyIdentifiers	array[ThirdPartyIdentifier]	required		The unaltered thirdPartyIdentifiers array as supplied in the related BasicResponse message. Required if thirdPartyIdentifiers field was present in the BasicResponse. If no thirdPartyIdentifiers was received in the BasicResponse or no BasicResponse was received then this should be set to the thirdPartyIdentifiers sent in the original request.
stan	string	optional		The System Trace Audit Number can be used to locate transactions across different systems.
rrn	string	optional		This is a reference set by the original source of the transaction.
tenders	array[Tender]	required		An array of tenders used to pay for the transaction

LoadRequest

Information about the load being made on the gift card.

Name	Type	Required	Restrictions	Description
id	string	required		The randomly generated UUID identifying this transaction, as defined for a variant 4 UUID in RFC 4122
time	string	required	format:date-time	The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision
originator	Originator	required		Data relating to the originator of the transaction.
client	Institution	required		Data relating to the sender of Transaction.
settlementEntity	Institution	optional		Data relating to the entity with whom the Merchant will settle the transaction.
receiver	Institution	optional		Data relating to the entity which ultimately processes the request.
thirdPartyIdentifiers	array[ThirdPartyIdentifier]	required		An array of identifiers which each identify the transaction within each entity’s system.
slipData	SlipData	optional		Text to be printed on the customer receipt.
basketRef	string	optional		Used to group multiple transactions which would otherwise be considered independent.
tranType	string	optional	[GOODS_AND_SERVICES, CASH_WITHDRAWAL, DEBIT_ADJUSTMENT, GOODS_AND_SERVICES_WITH_CASH_BACK, NON_CASH, RETURNS, DEPOSIT, CREDIT_ADJUSTMENT, GENERAL_CREDIT, AVAILABLE_FUNDS_INQUIRY, BALANCE_INQUIRY, GENERAL_INQUIRY, CARD_VERIFICATION_INQUIRY, CARDHOLDER_ACCOUNTS_TRANSFER, GENERAL_TRANSFER, PAYMENT_FROM_ACCOUNT, GENERAL_PAYMENT, PAYMENT_TO_ACCOUNT, PAYMENT_FROM_ACCOUNT_TO_ACCOUNT, PLACE_HOLD_ON_CARD, GENERAL_ADMIN, CHANGE_PIN, CARD_HOLDER_INQUIRY, POINTS_INQUIRY]	Data relating to the type of transaction taking place (i.e. cash withdrawal, goods and services etc.).
srcAccType	string	optional	[DEFAULT, SAVINGS, CHEQUE, CREDIT, UNIVERSAL, ELECTRONIC_PURSE, GIFT_CARD, STORED_VALUE]	This specifies the type of source account being used in the transaction (i.e. cheque, savings).
destAccType	string	optional	[DEFAULT, SAVINGS, CHEQUE, CREDIT, UNIVERSAL, ELECTRONIC_PURSE, GIFT_CARD, STORED_VALUE]	This specifies the type of destination account being used in the transaction (i.e. cheque, savings).
stan	string	optional		The System Trace Audit Number can be used to locate transactions across different systems.
rrn	string	optional		This is a reference set by the original source of the transaction.
amounts	GiftcardAmounts	required		Specifies an amount which should be loaded onto the card.
card	Card	required		Information about the gift card being loaded.
posInfo	PosInfo	optional		Information about the POS.
product	Product	optional		Information about the gift card product being loaded.
cardHolder	Customer	optional		Information about the card holder.

LoadResponse

Information about the load made on the gift card.

Name	Type	Required	Restrictions	Description
id	string	required		The randomly generated UUID identifying this transaction, as defined for a variant 4 UUID in RFC 4122
time	string	required	format:date-time	The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision
originator	Originator	required		Data relating to the originator of the transaction.
client	Institution	required		Data relating to the sender of Transaction.
settlementEntity	Institution	optional		Data relating to the entity with whom the Merchant will settle the transaction.
receiver	Institution	optional		Data relating to the entity which ultimately processes the request.
thirdPartyIdentifiers	array[ThirdPartyIdentifier]	required		An array of identifiers which each identify the transaction within each entity’s system.
slipData	SlipData	optional		Text to be printed on the customer receipt.
basketRef	string	optional		Used to group multiple transactions which would otherwise be considered independent.
tranType	string	optional	[GOODS_AND_SERVICES, CASH_WITHDRAWAL, DEBIT_ADJUSTMENT, GOODS_AND_SERVICES_WITH_CASH_BACK, NON_CASH, RETURNS, DEPOSIT, CREDIT_ADJUSTMENT, GENERAL_CREDIT, AVAILABLE_FUNDS_INQUIRY, BALANCE_INQUIRY, GENERAL_INQUIRY, CARD_VERIFICATION_INQUIRY, CARDHOLDER_ACCOUNTS_TRANSFER, GENERAL_TRANSFER, PAYMENT_FROM_ACCOUNT, GENERAL_PAYMENT, PAYMENT_TO_ACCOUNT, PAYMENT_FROM_ACCOUNT_TO_ACCOUNT, PLACE_HOLD_ON_CARD, GENERAL_ADMIN, CHANGE_PIN, CARD_HOLDER_INQUIRY, POINTS_INQUIRY]	Data relating to the type of transaction taking place (i.e. cash withdrawal, goods and services etc.).
srcAccType	string	optional	[DEFAULT, SAVINGS, CHEQUE, CREDIT, UNIVERSAL, ELECTRONIC_PURSE, GIFT_CARD, STORED_VALUE]	This specifies the type of source account being used in the transaction (i.e. cheque, savings).
destAccType	string	optional	[DEFAULT, SAVINGS, CHEQUE, CREDIT, UNIVERSAL, ELECTRONIC_PURSE, GIFT_CARD, STORED_VALUE]	This specifies the type of destination account being used in the transaction (i.e. cheque, savings).
stan	string	optional		The System Trace Audit Number can be used to locate transactions across different systems.
rrn	string	optional		This is a reference set by the original source of the transaction.
amounts	GiftcardAmounts	required		Indicates the amount which was requested to be loaded onto the card, the amount which was loaded and the balance of the gift card after the load.
card	Card	required		Information about the gift card being loaded.
posInfo	PosInfo	optional		Information about the POS.
product	Product	optional		Information about the gift card product being loaded.
cardHolder	Customer	optional		Information about the card holder.

LoadReversal

Information about the gift card load being reversed.

Name	Type	Required	Restrictions	Description
id	string	required		The randomly generated UUID identifying this advice, as defined for a variant 4 UUID in RFC 4122
requestId	string	required		The UUID identifying the request that this advice relates to
time	string	required	format:date-time	The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision
thirdPartyIdentifiers	array[ThirdPartyIdentifier]	required		The unaltered thirdPartyIdentifiers array as supplied in the related BasicResponse message. Required if thirdPartyIdentifiers field was present in the BasicResponse. If no thirdPartyIdentifiers was received in the BasicResponse or no BasicResponse was received then this should be set to the thirdPartyIdentifiers sent in the original request.
stan	string	optional		The System Trace Audit Number can be used to locate transactions across different systems.
rrn	string	optional		This is a reference set by the original source of the transaction.
reversalReason	string	required	[TIMEOUT, CANCELLED, RESPONSE_NOT_FINAL]	The reason for the reversal

LookupRequest

Information about a gift card to be retrieved.

Name	Type	Required	Restrictions	Description
id	string	required		The randomly generated UUID identifying this transaction, as defined for a variant 4 UUID in RFC 4122
time	string	required	format:date-time	The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision
originator	Originator	required		Data relating to the originator of the transaction.
client	Institution	required		Data relating to the sender of Transaction.
settlementEntity	Institution	optional		Data relating to the entity with whom the Merchant will settle the transaction.
receiver	Institution	optional		Data relating to the entity which ultimately processes the request.
thirdPartyIdentifiers	array[ThirdPartyIdentifier]	required		An array of identifiers which each identify the transaction within each entity’s system.
slipData	SlipData	optional		Text to be printed on the customer receipt.
basketRef	string	optional		Used to group multiple transactions which would otherwise be considered independent.
tranType	string	optional	[GOODS_AND_SERVICES, CASH_WITHDRAWAL, DEBIT_ADJUSTMENT, GOODS_AND_SERVICES_WITH_CASH_BACK, NON_CASH, RETURNS, DEPOSIT, CREDIT_ADJUSTMENT, GENERAL_CREDIT, AVAILABLE_FUNDS_INQUIRY, BALANCE_INQUIRY, GENERAL_INQUIRY, CARD_VERIFICATION_INQUIRY, CARDHOLDER_ACCOUNTS_TRANSFER, GENERAL_TRANSFER, PAYMENT_FROM_ACCOUNT, GENERAL_PAYMENT, PAYMENT_TO_ACCOUNT, PAYMENT_FROM_ACCOUNT_TO_ACCOUNT, PLACE_HOLD_ON_CARD, GENERAL_ADMIN, CHANGE_PIN, CARD_HOLDER_INQUIRY, POINTS_INQUIRY]	Data relating to the type of transaction taking place (i.e. cash withdrawal, goods and services etc.).
srcAccType	string	optional	[DEFAULT, SAVINGS, CHEQUE, CREDIT, UNIVERSAL, ELECTRONIC_PURSE, GIFT_CARD, STORED_VALUE]	This specifies the type of source account being used in the transaction (i.e. cheque, savings).
destAccType	string	optional	[DEFAULT, SAVINGS, CHEQUE, CREDIT, UNIVERSAL, ELECTRONIC_PURSE, GIFT_CARD, STORED_VALUE]	This specifies the type of destination account being used in the transaction (i.e. cheque, savings).
stan	string	optional		The System Trace Audit Number can be used to locate transactions across different systems.
rrn	string	optional		This is a reference set by the original source of the transaction.
card	Card	optional		Information about the gift card being retrieved. Either this field or the cardHolder field should be set.
posInfo	PosInfo	optional		Information about the POS which captured the card details.
cardHolder	Customer	optional		Information about the card holder. Either this field or the card field should be set.

LookupResponse

Information about the result of processing the gift card lookup request.

Name	Type	Required	Restrictions	Description
id	string	required		The randomly generated UUID identifying this transaction, as defined for a variant 4 UUID in RFC 4122
time	string	required	format:date-time	The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision
originator	Originator	required		Data relating to the originator of the transaction.
client	Institution	required		Data relating to the sender of Transaction.
settlementEntity	Institution	optional		Data relating to the entity with whom the Merchant will settle the transaction.
receiver	Institution	optional		Data relating to the entity which ultimately processes the request.
thirdPartyIdentifiers	array[ThirdPartyIdentifier]	required		An array of identifiers which each identify the transaction within each entity’s system.
slipData	SlipData	optional		Text to be printed on the customer receipt.
basketRef	string	optional		Used to group multiple transactions which would otherwise be considered independent.
tranType	string	optional	[GOODS_AND_SERVICES, CASH_WITHDRAWAL, DEBIT_ADJUSTMENT, GOODS_AND_SERVICES_WITH_CASH_BACK, NON_CASH, RETURNS, DEPOSIT, CREDIT_ADJUSTMENT, GENERAL_CREDIT, AVAILABLE_FUNDS_INQUIRY, BALANCE_INQUIRY, GENERAL_INQUIRY, CARD_VERIFICATION_INQUIRY, CARDHOLDER_ACCOUNTS_TRANSFER, GENERAL_TRANSFER, PAYMENT_FROM_ACCOUNT, GENERAL_PAYMENT, PAYMENT_TO_ACCOUNT, PAYMENT_FROM_ACCOUNT_TO_ACCOUNT, PLACE_HOLD_ON_CARD, GENERAL_ADMIN, CHANGE_PIN, CARD_HOLDER_INQUIRY, POINTS_INQUIRY]	Data relating to the type of transaction taking place (i.e. cash withdrawal, goods and services etc.).
srcAccType	string	optional	[DEFAULT, SAVINGS, CHEQUE, CREDIT, UNIVERSAL, ELECTRONIC_PURSE, GIFT_CARD, STORED_VALUE]	This specifies the type of source account being used in the transaction (i.e. cheque, savings).
destAccType	string	optional	[DEFAULT, SAVINGS, CHEQUE, CREDIT, UNIVERSAL, ELECTRONIC_PURSE, GIFT_CARD, STORED_VALUE]	This specifies the type of destination account being used in the transaction (i.e. cheque, savings).
stan	string	optional		The System Trace Audit Number can be used to locate transactions across different systems.
rrn	string	optional		This is a reference set by the original source of the transaction.
amounts	GiftcardAmounts	required		Indicates the balance of the gift card at the time of the request.
card	Card	required		Information about the gift card for which information is being requested.
posInfo	PosInfo	required		Information about how card details were captured at the POS.
product	Product	optional		Information about the product associated with the gift card if the gift card has been activated.
cardHolder	Customer	optional		Information about the card holder of the gift card.
points	PointAmounts	optional		Information on points associated with this card. For example: balance, currency value.
clubs	array[Club]	optional		The clubs associated with this card.
marketingAttributes	array[MarketingAttribute]	optional		The marketing attributes associated with this card.

MarketingAttribute

Relevant marketing information related to the consumer.

Name	Type	Required	Description
name	string	required	The name of this marketing attribute.
description	string	optional	The description of this marketing attribute.
member	boolean	required	If the customer associated with this card is a member of this marketing attribute.
marketToCustomer	boolean	required	Should the customer associated with card be subjected to marketing for this specific marketing attribute.

Merchant

Merchant related data. Must be included if available

Name	Type	Required	Restrictions	Description
merchantType	string	required	pattern:[0-9]{4}	The assigned four digit merchant category code
merchantId	string	required	maxLength:15 minLength:15	The assigned merchant identifier. Also known as card acceptor id
merchantName	MerchantName	required		The name of a merchant

MerchantName

A container object representing the Merchant Name and Location

Name	Type	Required	Restrictions	Description
name	string	required	maxLength:23	The merchant or trading as name associated with the merchant
city	string	required	maxLength:13	The city where the merchant is located
region	string	required	maxLength:2	The state or region where the merchant is located
country	string	required	maxLength:2	The country where the merchant is located

Originator

The Originator object encapsulates data relating to the originator of the transaction

Name	Type	Required	Restrictions	Description
institution	Institution	required		The institution originating the request, as issued by Electrum
terminalId	string	required	maxLength:8 minLength:8	The ID that uniquely identifies each device or system in an originator’s institution capable of sending requests. Required for transactions initiated from physical card entry or point-of-sale devices
merchant	Merchant	required		Merchant data. Required if available

Base model for capturing either a clear PIN or encrypted PIN

Name	Type	Required	Default	Restrictions	Description
type	string	required		[CLEAR_PIN, ENCRYPTED_PIN]	Whether the PIN is communicated in the clear or encrypted.

PinClear

Name	Type	Required	Default	Restrictions	Description

PinEncrypted

Name	Type	Required	Default	Restrictions	Description

PointAmounts

Point Amounts which make up the transaction. Absent amounts have zero value.

Name	Type	Required	Description
requestAmount	PointsAmount	optional	The points amount requested by the customer to be authorised or approved. This is the total amount the customer wishes to pay for a service or virtual product.
approvedAmount	PointsAmount	optional	The points amount which was approved by the upstream entity.
balanceAmount	PointsAmount	optional	The remaining points balance on the customer’s account.
availableAmount	PointsAmount	optional	The points currently available on the card which may be redeemed. This field should not include loads which must still be finalised.

PointsAmount

Points related information. This is the description of the points involved in a transaction.

Name	Type	Required	Restrictions	Description
amount	integer	required	format:int64	The number of points.
currencyEquivalent	LedgerAmount	optional		The value of the points amount in a given currency.
pointsDueToExpire	integer	optional	format:int64	Number of points due for expiry next.
expiryDate	string	optional	format:date-time	The date at which the next expiry of points will occur.

PosEntryMode

Describes how the PAN and PIN were captured by the POS.

Name	Type	Required	Default	Restrictions	Description
panEntryMode	string	required		[UNKNOWN, MANUAL, MAGSTRIPE_NO_CVV, BARCODE, OCR, ICC_CVV, CONTACTLESS_ICC, MAGSTRIPE_CVV, CONTACTLESS_MAGSTRIPE, ICC_NO_CVV, ORIG_MODE, FALLBACK]	Describes the method by which the PAN was captured.
pinEntryCapability	string	required		[UNKNOWN, CAN_ACCEPT, CANNOT_ACCEPT]	Describes whether the PIN can be entered.

PosInfo

POS related data.

Name	Type	Required	Default	Restrictions	Description
entryMode	PosEntryMode	optional			Describes the manner in which the POS captured card and PIN data.
posConditionCode	string	optional		[NORMAL_PRESENTMENT, CUSTOMER_NOT_PRESENT, CUSTOMER_PRESENT_AND_CARD_NOT_PRESENT, CUSTOMER_IDENTITY_VERIFIED, PUBLIC_UTILITY_TERMINAL, CUSTOMER_TERMINAL, MANUAL_REVERSAL, UNATTENDED_TERMINAL_AND_CARD_CAN_BE_RETAINED, UNATTENDED_TERMINAL_AND_CARD_CANNOT_BE_RETAINED]	Describes the circumstances of the transaciton at the POS.

Product

Product related data. This is the description of the gift card sold as a product at a retailer. This should not be confused with the products which form Items in a Basket.

Name	Type	Required	Restrictions	Description
id	string	required	pattern:[0-9A-Za-z]{1,100}	An identifier of the product which the gift card pertains to. This code is sent by the originator and allows the receiver to identify the gift card product
barcode	string	optional	pattern:[0-9A-Za-z]{1,13}	A barcode code identifying the product the gift card pertains to.
type	string	optional	pattern:.{1,50}	An indication of the type of product offered through the gift card.

RedemptionConfirmation

Information about a gift card redemption to be confirmed.

Name	Type	Required	Restrictions	Description
id	string	required		The randomly generated UUID identifying this advice, as defined for a variant 4 UUID in RFC 4122
requestId	string	required		The UUID identifying the request that this advice relates to
time	string	required	format:date-time	The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision
thirdPartyIdentifiers	array[ThirdPartyIdentifier]	required		The unaltered thirdPartyIdentifiers array as supplied in the related BasicResponse message. Required if thirdPartyIdentifiers field was present in the BasicResponse. If no thirdPartyIdentifiers was received in the BasicResponse or no BasicResponse was received then this should be set to the thirdPartyIdentifiers sent in the original request.
stan	string	optional		The System Trace Audit Number can be used to locate transactions across different systems.
rrn	string	optional		This is a reference set by the original source of the transaction.

RedemptionRequest

Information about the redemption being made on the gift card.

Name	Type	Required	Restrictions	Description
id	string	required		The randomly generated UUID identifying this transaction, as defined for a variant 4 UUID in RFC 4122
time	string	required	format:date-time	The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision
originator	Originator	required		Data relating to the originator of the transaction.
client	Institution	required		Data relating to the sender of Transaction.
settlementEntity	Institution	optional		Data relating to the entity with whom the Merchant will settle the transaction.
receiver	Institution	optional		Data relating to the entity which ultimately processes the request.
thirdPartyIdentifiers	array[ThirdPartyIdentifier]	required		An array of identifiers which each identify the transaction within each entity’s system.
slipData	SlipData	optional		Text to be printed on the customer receipt.
basketRef	string	optional		Used to group multiple transactions which would otherwise be considered independent.
tranType	string	optional	[GOODS_AND_SERVICES, CASH_WITHDRAWAL, DEBIT_ADJUSTMENT, GOODS_AND_SERVICES_WITH_CASH_BACK, NON_CASH, RETURNS, DEPOSIT, CREDIT_ADJUSTMENT, GENERAL_CREDIT, AVAILABLE_FUNDS_INQUIRY, BALANCE_INQUIRY, GENERAL_INQUIRY, CARD_VERIFICATION_INQUIRY, CARDHOLDER_ACCOUNTS_TRANSFER, GENERAL_TRANSFER, PAYMENT_FROM_ACCOUNT, GENERAL_PAYMENT, PAYMENT_TO_ACCOUNT, PAYMENT_FROM_ACCOUNT_TO_ACCOUNT, PLACE_HOLD_ON_CARD, GENERAL_ADMIN, CHANGE_PIN, CARD_HOLDER_INQUIRY, POINTS_INQUIRY]	Data relating to the type of transaction taking place (i.e. cash withdrawal, goods and services etc.).
srcAccType	string	optional	[DEFAULT, SAVINGS, CHEQUE, CREDIT, UNIVERSAL, ELECTRONIC_PURSE, GIFT_CARD, STORED_VALUE]	This specifies the type of source account being used in the transaction (i.e. cheque, savings).
destAccType	string	optional	[DEFAULT, SAVINGS, CHEQUE, CREDIT, UNIVERSAL, ELECTRONIC_PURSE, GIFT_CARD, STORED_VALUE]	This specifies the type of destination account being used in the transaction (i.e. cheque, savings).
stan	string	optional		The System Trace Audit Number can be used to locate transactions across different systems.
rrn	string	optional		This is a reference set by the original source of the transaction.
amounts	GiftcardAmounts	required		Specifies the amount which the gift card is being redeemed against.
card	Card	required		Information about the gift card being used for redemption.
posInfo	PosInfo	optional		Information about the POS.
product	Product	optional		Information about the gift card product being used for redemption.
basket	Basket	optional		The collection of products for which the gift card is being redeemed.
points	PointAmounts	optional		Specifies the points amount which the gift card is being redeemed against.
cardHolder	Customer	optional		Information about the card holder.

RedemptionResponse

Information about the redemption made on the gift card.

Name	Type	Required	Restrictions	Description
id	string	required		The randomly generated UUID identifying this transaction, as defined for a variant 4 UUID in RFC 4122
time	string	required	format:date-time	The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision
originator	Originator	required		Data relating to the originator of the transaction.
client	Institution	required		Data relating to the sender of Transaction.
settlementEntity	Institution	optional		Data relating to the entity with whom the Merchant will settle the transaction.
receiver	Institution	optional		Data relating to the entity which ultimately processes the request.
thirdPartyIdentifiers	array[ThirdPartyIdentifier]	required		An array of identifiers which each identify the transaction within each entity’s system.
slipData	SlipData	optional		Text to be printed on the customer receipt.
basketRef	string	optional		Used to group multiple transactions which would otherwise be considered independent.
tranType	string	optional	[GOODS_AND_SERVICES, CASH_WITHDRAWAL, DEBIT_ADJUSTMENT, GOODS_AND_SERVICES_WITH_CASH_BACK, NON_CASH, RETURNS, DEPOSIT, CREDIT_ADJUSTMENT, GENERAL_CREDIT, AVAILABLE_FUNDS_INQUIRY, BALANCE_INQUIRY, GENERAL_INQUIRY, CARD_VERIFICATION_INQUIRY, CARDHOLDER_ACCOUNTS_TRANSFER, GENERAL_TRANSFER, PAYMENT_FROM_ACCOUNT, GENERAL_PAYMENT, PAYMENT_TO_ACCOUNT, PAYMENT_FROM_ACCOUNT_TO_ACCOUNT, PLACE_HOLD_ON_CARD, GENERAL_ADMIN, CHANGE_PIN, CARD_HOLDER_INQUIRY, POINTS_INQUIRY]	Data relating to the type of transaction taking place (i.e. cash withdrawal, goods and services etc.).
srcAccType	string	optional	[DEFAULT, SAVINGS, CHEQUE, CREDIT, UNIVERSAL, ELECTRONIC_PURSE, GIFT_CARD, STORED_VALUE]	This specifies the type of source account being used in the transaction (i.e. cheque, savings).
destAccType	string	optional	[DEFAULT, SAVINGS, CHEQUE, CREDIT, UNIVERSAL, ELECTRONIC_PURSE, GIFT_CARD, STORED_VALUE]	This specifies the type of destination account being used in the transaction (i.e. cheque, savings).
stan	string	optional		The System Trace Audit Number can be used to locate transactions across different systems.
rrn	string	optional		This is a reference set by the original source of the transaction.
amounts	GiftcardAmounts	optional		Indicates the amount which the gift card was being redeemed for, the amount which was redeemed and the balance of the gift card after redemption.
card	Card	required		Information about the gift card being redeemed.
posInfo	PosInfo	optional		Information about the POS.
product	Product	optional		Information about the gift card product being redeemed.
basket	Basket	optional		The collection of products for which the gift card is being redeemed.
points	PointAmounts	optional		Specifies the points amount for the account the giftcard is associated with.
cardHolder	Customer	optional		Information about the card holder.

RedemptionReversal

Information about the gift card redemption being reversed.

Name	Type	Required	Restrictions	Description
id	string	required		The randomly generated UUID identifying this advice, as defined for a variant 4 UUID in RFC 4122
requestId	string	required		The UUID identifying the request that this advice relates to
time	string	required	format:date-time	The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision
thirdPartyIdentifiers	array[ThirdPartyIdentifier]	required		The unaltered thirdPartyIdentifiers array as supplied in the related BasicResponse message. Required if thirdPartyIdentifiers field was present in the BasicResponse. If no thirdPartyIdentifiers was received in the BasicResponse or no BasicResponse was received then this should be set to the thirdPartyIdentifiers sent in the original request.
stan	string	optional		The System Trace Audit Number can be used to locate transactions across different systems.
rrn	string	optional		This is a reference set by the original source of the transaction.
reversalReason	string	required	[TIMEOUT, CANCELLED, RESPONSE_NOT_FINAL]	The reason for the reversal

ReplaceConfirmation

Information about a gift card replace request to be confirmed.

Name	Type	Required	Restrictions	Description
id	string	required		The randomly generated UUID identifying this advice, as defined for a variant 4 UUID in RFC 4122
requestId	string	required		The UUID identifying the request that this advice relates to
time	string	required	format:date-time	The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision
thirdPartyIdentifiers	array[ThirdPartyIdentifier]	required		The unaltered thirdPartyIdentifiers array as supplied in the related BasicResponse message. Required if thirdPartyIdentifiers field was present in the BasicResponse. If no thirdPartyIdentifiers was received in the BasicResponse or no BasicResponse was received then this should be set to the thirdPartyIdentifiers sent in the original request.
stan	string	optional		The System Trace Audit Number can be used to locate transactions across different systems.
rrn	string	optional		This is a reference set by the original source of the transaction.

ReplaceRequest

Information about the replace request to switch an old card with a new card (Transfer funds out of and void old card).

Name	Type	Required	Restrictions	Description
card	Card	optional
targetCard	Card	optional
id	string	required		The randomly generated UUID identifying this transaction, as defined for a variant 4 UUID in RFC 4122
time	string	required	format:date-time	The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision
originator	Originator	required		Data relating to the originator of the transaction.
client	Institution	required		Data relating to the sender of Transaction.
settlementEntity	Institution	optional		Data relating to the entity with whom the Merchant will settle the transaction.
receiver	Institution	optional		Data relating to the entity which ultimately processes the request.
thirdPartyIdentifiers	array[ThirdPartyIdentifier]	required		An array of identifiers which each identify the transaction within each entity’s system.
slipData	SlipData	optional		Text to be printed on the customer receipt.
basketRef	string	optional		Used to group multiple transactions which would otherwise be considered independent.
tranType	string	optional	[GOODS_AND_SERVICES, CASH_WITHDRAWAL, DEBIT_ADJUSTMENT, GOODS_AND_SERVICES_WITH_CASH_BACK, NON_CASH, RETURNS, DEPOSIT, CREDIT_ADJUSTMENT, GENERAL_CREDIT, AVAILABLE_FUNDS_INQUIRY, BALANCE_INQUIRY, GENERAL_INQUIRY, CARD_VERIFICATION_INQUIRY, CARDHOLDER_ACCOUNTS_TRANSFER, GENERAL_TRANSFER, PAYMENT_FROM_ACCOUNT, GENERAL_PAYMENT, PAYMENT_TO_ACCOUNT, PAYMENT_FROM_ACCOUNT_TO_ACCOUNT, PLACE_HOLD_ON_CARD, GENERAL_ADMIN, CHANGE_PIN, CARD_HOLDER_INQUIRY, POINTS_INQUIRY]	Data relating to the type of transaction taking place (i.e. cash withdrawal, goods and services etc.).
srcAccType	string	optional	[DEFAULT, SAVINGS, CHEQUE, CREDIT, UNIVERSAL, ELECTRONIC_PURSE, GIFT_CARD, STORED_VALUE]	This specifies the type of source account being used in the transaction (i.e. cheque, savings).
destAccType	string	optional	[DEFAULT, SAVINGS, CHEQUE, CREDIT, UNIVERSAL, ELECTRONIC_PURSE, GIFT_CARD, STORED_VALUE]	This specifies the type of destination account being used in the transaction (i.e. cheque, savings).
stan	string	optional		The System Trace Audit Number can be used to locate transactions across different systems.
rrn	string	optional		This is a reference set by the original source of the transaction.
oldCard	Card	required		Information about the gift card that is being replaced.
newCard	Card	required		Information about the new gift card that will replace the old card.
posInfo	PosInfo	optional		Information about the POS.
product	Product	optional		Information about the gift card product being used for the gift card replace.
cardHolder	Customer	optional		Information about the card holder.

ReplaceResponse

Information about the replace request made to switch an old card with a new card.

Name	Type	Required	Restrictions	Description
card	Card	optional
targetCard	Card	optional
id	string	required		The randomly generated UUID identifying this transaction, as defined for a variant 4 UUID in RFC 4122
time	string	required	format:date-time	The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision
originator	Originator	required		Data relating to the originator of the transaction.
client	Institution	required		Data relating to the sender of Transaction.
settlementEntity	Institution	optional		Data relating to the entity with whom the Merchant will settle the transaction.
receiver	Institution	optional		Data relating to the entity which ultimately processes the request.
thirdPartyIdentifiers	array[ThirdPartyIdentifier]	required		An array of identifiers which each identify the transaction within each entity’s system.
slipData	SlipData	optional		Text to be printed on the customer receipt.
basketRef	string	optional		Used to group multiple transactions which would otherwise be considered independent.
tranType	string	optional	[GOODS_AND_SERVICES, CASH_WITHDRAWAL, DEBIT_ADJUSTMENT, GOODS_AND_SERVICES_WITH_CASH_BACK, NON_CASH, RETURNS, DEPOSIT, CREDIT_ADJUSTMENT, GENERAL_CREDIT, AVAILABLE_FUNDS_INQUIRY, BALANCE_INQUIRY, GENERAL_INQUIRY, CARD_VERIFICATION_INQUIRY, CARDHOLDER_ACCOUNTS_TRANSFER, GENERAL_TRANSFER, PAYMENT_FROM_ACCOUNT, GENERAL_PAYMENT, PAYMENT_TO_ACCOUNT, PAYMENT_FROM_ACCOUNT_TO_ACCOUNT, PLACE_HOLD_ON_CARD, GENERAL_ADMIN, CHANGE_PIN, CARD_HOLDER_INQUIRY, POINTS_INQUIRY]	Data relating to the type of transaction taking place (i.e. cash withdrawal, goods and services etc.).
srcAccType	string	optional	[DEFAULT, SAVINGS, CHEQUE, CREDIT, UNIVERSAL, ELECTRONIC_PURSE, GIFT_CARD, STORED_VALUE]	This specifies the type of source account being used in the transaction (i.e. cheque, savings).
destAccType	string	optional	[DEFAULT, SAVINGS, CHEQUE, CREDIT, UNIVERSAL, ELECTRONIC_PURSE, GIFT_CARD, STORED_VALUE]	This specifies the type of destination account being used in the transaction (i.e. cheque, savings).
stan	string	optional		The System Trace Audit Number can be used to locate transactions across different systems.
rrn	string	optional		This is a reference set by the original source of the transaction.
amounts	GiftcardAmounts	required		Indicates the balance amount which now exists in the new card (balance from old card transferred to new card).
oldCard	Card	required		Information about the gift card being replaced.
newCard	Card	required		Information about the new gift card that will be used instead of the old replaced card.
posInfo	PosInfo	optional		Information about the POS.
product	Product	optional		Information about the gift card product being used for the giftcard replace operation.
cardHolder	Customer	optional		Information about the card holder.

ReplaceReversal

Information about the gift card replace operation being reversed.

Name	Type	Required	Restrictions	Description
id	string	required		The randomly generated UUID identifying this advice, as defined for a variant 4 UUID in RFC 4122
requestId	string	required		The UUID identifying the request that this advice relates to
time	string	required	format:date-time	The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision
thirdPartyIdentifiers	array[ThirdPartyIdentifier]	required		The unaltered thirdPartyIdentifiers array as supplied in the related BasicResponse message. Required if thirdPartyIdentifiers field was present in the BasicResponse. If no thirdPartyIdentifiers was received in the BasicResponse or no BasicResponse was received then this should be set to the thirdPartyIdentifiers sent in the original request.
stan	string	optional		The System Trace Audit Number can be used to locate transactions across different systems.
rrn	string	optional		This is a reference set by the original source of the transaction.
reversalReason	string	required	[TIMEOUT, CANCELLED, RESPONSE_NOT_FINAL]	The reason for the reversal

SlipData

Data that may be printed on the customer slip for information purposes

Name	Type	Required	Restrictions	Description
messageLines	array[SlipLine]	optional		An array of text lines and optional formatting to be printed on the customer slip.
slipWidth	integer	optional	format:int32	The width of the slip in normal (unformatted) characters.
issuerReference	string	optional	pattern:[A-Z0-9]{1,40}	An identifier that is printed on the customer slip and uniquely identifies the payment on the service provider’s system. This value is used by the customer to request a refund when the service supports this function, and it is thus important that this number is unique.

SlipLine

A line of text to be printed on the till slip

Name	Type	Required	Restrictions	Description
barcode	Barcode	optional		Barcode information for this line
text	string	required		Text contained on the line
fontWidthScaleFactor	number	optional	format:double	Scale factor for font width. Assume 1.0 (i.e. normal size) if not present.
fontHeightScaleFactor	number	optional	format:double	Scale factor for font height. Assume 1.0 (i.e. normal size) if not present.
line	boolean	optional		Denotes a solid line on the slip. Assume false if not present.
cut	boolean	optional		Indicates the slip should be cut at this line. Assume false if not present.

Tender

Details of the Tender used by a customer towards a payment

Name	Type	Required	Restrictions	Description
accountType	string	optional	[DEFAULT, SAVINGS, CHEQUE, CREDIT, UNIVERSAL, ELECTRONIC_PURSE, STORED_VALUE]	The type of account
amount	LedgerAmount	required		The tendered amount
cardNumber	string	optional	pattern:[0-9]{6}[0-9]{0,13}*	A PCI compliant masked card number, with at least the first 6 digits in the clear. Only applicable to card based transactions
reference	string	optional	maxLength:40	A free text reference
tenderType	string	required	[CASH, CHEQUE, CREDIT_CARD, DEBIT_CARD, WALLET, ROUNDING, GIFT_CARD, LOYALTY_CARD, OTHER]	The type of tender used

ThirdPartyIdentifier

An identifier assigned by an entity which process the message. Identifiers are keyed by institution ID thereby enabling any institution to recall a transaction within the entity's own system using the entity's own identifier. Entity's must not alter the identifier set by another entity. Once an identifier has been set by an entity, all other entity's must send that identifier in subsequent messages.

Name	Type	Required	Default	Restrictions	Description
institutionId	string	required			The entity’s institution ID.
transactionIdentifier	string	required			The identifier assigned to this transaction by the institution represented in institutionId. This value should be unique within the institution’s system.

TransferConfirmation

Information about a gift card transfer to be confirmed.

Name	Type	Required	Restrictions	Description
id	string	required		The randomly generated UUID identifying this advice, as defined for a variant 4 UUID in RFC 4122
requestId	string	required		The UUID identifying the request that this advice relates to
time	string	required	format:date-time	The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision
thirdPartyIdentifiers	array[ThirdPartyIdentifier]	required		The unaltered thirdPartyIdentifiers array as supplied in the related BasicResponse message. Required if thirdPartyIdentifiers field was present in the BasicResponse. If no thirdPartyIdentifiers was received in the BasicResponse or no BasicResponse was received then this should be set to the thirdPartyIdentifiers sent in the original request.
stan	string	optional		The System Trace Audit Number can be used to locate transactions across different systems.
rrn	string	optional		This is a reference set by the original source of the transaction.

TransferRequest

Information about the transfer being from a source gift card to a target gift card.

Name	Type	Required	Restrictions	Description
card	Card	optional
id	string	required		The randomly generated UUID identifying this transaction, as defined for a variant 4 UUID in RFC 4122
time	string	required	format:date-time	The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision
originator	Originator	required		Data relating to the originator of the transaction.
client	Institution	required		Data relating to the sender of Transaction.
settlementEntity	Institution	optional		Data relating to the entity with whom the Merchant will settle the transaction.
receiver	Institution	optional		Data relating to the entity which ultimately processes the request.
thirdPartyIdentifiers	array[ThirdPartyIdentifier]	required		An array of identifiers which each identify the transaction within each entity’s system.
slipData	SlipData	optional		Text to be printed on the customer receipt.
basketRef	string	optional		Used to group multiple transactions which would otherwise be considered independent.
tranType	string	optional	[GOODS_AND_SERVICES, CASH_WITHDRAWAL, DEBIT_ADJUSTMENT, GOODS_AND_SERVICES_WITH_CASH_BACK, NON_CASH, RETURNS, DEPOSIT, CREDIT_ADJUSTMENT, GENERAL_CREDIT, AVAILABLE_FUNDS_INQUIRY, BALANCE_INQUIRY, GENERAL_INQUIRY, CARD_VERIFICATION_INQUIRY, CARDHOLDER_ACCOUNTS_TRANSFER, GENERAL_TRANSFER, PAYMENT_FROM_ACCOUNT, GENERAL_PAYMENT, PAYMENT_TO_ACCOUNT, PAYMENT_FROM_ACCOUNT_TO_ACCOUNT, PLACE_HOLD_ON_CARD, GENERAL_ADMIN, CHANGE_PIN, CARD_HOLDER_INQUIRY, POINTS_INQUIRY]	Data relating to the type of transaction taking place (i.e. cash withdrawal, goods and services etc.).
srcAccType	string	optional	[DEFAULT, SAVINGS, CHEQUE, CREDIT, UNIVERSAL, ELECTRONIC_PURSE, GIFT_CARD, STORED_VALUE]	This specifies the type of source account being used in the transaction (i.e. cheque, savings).
destAccType	string	optional	[DEFAULT, SAVINGS, CHEQUE, CREDIT, UNIVERSAL, ELECTRONIC_PURSE, GIFT_CARD, STORED_VALUE]	This specifies the type of destination account being used in the transaction (i.e. cheque, savings).
stan	string	optional		The System Trace Audit Number can be used to locate transactions across different systems.
rrn	string	optional		This is a reference set by the original source of the transaction.
amounts	GiftcardAmounts	required		Specifies the amount which is being transferred from a source giftcard to a target giftcard.
sourceCard	Card	required		Information about the gift card that funds are being transferred from.
targetCard	Card	required		Information about the gift card that funds are being transferred to.
posInfo	PosInfo	optional		Information about the POS.
product	Product	optional		Information about the gift card product being used for the transfer.
cardHolder	Customer	optional		Information about the card holder.

TransferResponse

Information about the transfer made from a source gift card to a target gift card.

Name	Type	Required	Restrictions	Description
card	Card	optional
id	string	required		The randomly generated UUID identifying this transaction, as defined for a variant 4 UUID in RFC 4122
time	string	required	format:date-time	The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision
originator	Originator	required		Data relating to the originator of the transaction.
client	Institution	required		Data relating to the sender of Transaction.
settlementEntity	Institution	optional		Data relating to the entity with whom the Merchant will settle the transaction.
receiver	Institution	optional		Data relating to the entity which ultimately processes the request.
thirdPartyIdentifiers	array[ThirdPartyIdentifier]	required		An array of identifiers which each identify the transaction within each entity’s system.
slipData	SlipData	optional		Text to be printed on the customer receipt.
basketRef	string	optional		Used to group multiple transactions which would otherwise be considered independent.
tranType	string	optional	[GOODS_AND_SERVICES, CASH_WITHDRAWAL, DEBIT_ADJUSTMENT, GOODS_AND_SERVICES_WITH_CASH_BACK, NON_CASH, RETURNS, DEPOSIT, CREDIT_ADJUSTMENT, GENERAL_CREDIT, AVAILABLE_FUNDS_INQUIRY, BALANCE_INQUIRY, GENERAL_INQUIRY, CARD_VERIFICATION_INQUIRY, CARDHOLDER_ACCOUNTS_TRANSFER, GENERAL_TRANSFER, PAYMENT_FROM_ACCOUNT, GENERAL_PAYMENT, PAYMENT_TO_ACCOUNT, PAYMENT_FROM_ACCOUNT_TO_ACCOUNT, PLACE_HOLD_ON_CARD, GENERAL_ADMIN, CHANGE_PIN, CARD_HOLDER_INQUIRY, POINTS_INQUIRY]	Data relating to the type of transaction taking place (i.e. cash withdrawal, goods and services etc.).
srcAccType	string	optional	[DEFAULT, SAVINGS, CHEQUE, CREDIT, UNIVERSAL, ELECTRONIC_PURSE, GIFT_CARD, STORED_VALUE]	This specifies the type of source account being used in the transaction (i.e. cheque, savings).
destAccType	string	optional	[DEFAULT, SAVINGS, CHEQUE, CREDIT, UNIVERSAL, ELECTRONIC_PURSE, GIFT_CARD, STORED_VALUE]	This specifies the type of destination account being used in the transaction (i.e. cheque, savings).
stan	string	optional		The System Trace Audit Number can be used to locate transactions across different systems.
rrn	string	optional		This is a reference set by the original source of the transaction.
amounts	GiftcardAmounts	required		Indicates the amount which was being transferred from a source gift card to a target gift card, the amount which was transferred and the balance of the source gift card after the transfer
sourceCard	Card	required		Information about the gift card that funds are being transferred from.
targetCard	Card	required		Information about the gift card that funds are being transferred to.
posInfo	PosInfo	optional		Information about the POS.
product	Product	optional		Information about the gift card product being used for the transfer.
cardHolder	Customer	optional		Information about the card holder.

TransferReversal

Information about the gift card transfer being reversed.

Name	Type	Required	Restrictions	Description
id	string	required		The randomly generated UUID identifying this advice, as defined for a variant 4 UUID in RFC 4122
requestId	string	required		The UUID identifying the request that this advice relates to
time	string	required	format:date-time	The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision
thirdPartyIdentifiers	array[ThirdPartyIdentifier]	required		The unaltered thirdPartyIdentifiers array as supplied in the related BasicResponse message. Required if thirdPartyIdentifiers field was present in the BasicResponse. If no thirdPartyIdentifiers was received in the BasicResponse or no BasicResponse was received then this should be set to the thirdPartyIdentifiers sent in the original request.
stan	string	optional		The System Trace Audit Number can be used to locate transactions across different systems.
rrn	string	optional		This is a reference set by the original source of the transaction.
reversalReason	string	required	[TIMEOUT, CANCELLED, RESPONSE_NOT_FINAL]	The reason for the reversal

VoidConfirmation

Information about a gift card void to be confirmed.

Name	Type	Required	Restrictions	Description
id	string	required		The randomly generated UUID identifying this advice, as defined for a variant 4 UUID in RFC 4122
requestId	string	required		The UUID identifying the request that this advice relates to
time	string	required	format:date-time	The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision
thirdPartyIdentifiers	array[ThirdPartyIdentifier]	required		The unaltered thirdPartyIdentifiers array as supplied in the related BasicResponse message. Required if thirdPartyIdentifiers field was present in the BasicResponse. If no thirdPartyIdentifiers was received in the BasicResponse or no BasicResponse was received then this should be set to the thirdPartyIdentifiers sent in the original request.
stan	string	optional		The System Trace Audit Number can be used to locate transactions across different systems.
rrn	string	optional		This is a reference set by the original source of the transaction.

VoidRequest

Information about the void of the gift card.

Name	Type	Required	Restrictions	Description
id	string	required		The randomly generated UUID identifying this transaction, as defined for a variant 4 UUID in RFC 4122
time	string	required	format:date-time	The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision
originator	Originator	required		Data relating to the originator of the transaction.
client	Institution	required		Data relating to the sender of Transaction.
settlementEntity	Institution	optional		Data relating to the entity with whom the Merchant will settle the transaction.
receiver	Institution	optional		Data relating to the entity which ultimately processes the request.
thirdPartyIdentifiers	array[ThirdPartyIdentifier]	required		An array of identifiers which each identify the transaction within each entity’s system.
slipData	SlipData	optional		Text to be printed on the customer receipt.
basketRef	string	optional		Used to group multiple transactions which would otherwise be considered independent.
tranType	string	optional	[GOODS_AND_SERVICES, CASH_WITHDRAWAL, DEBIT_ADJUSTMENT, GOODS_AND_SERVICES_WITH_CASH_BACK, NON_CASH, RETURNS, DEPOSIT, CREDIT_ADJUSTMENT, GENERAL_CREDIT, AVAILABLE_FUNDS_INQUIRY, BALANCE_INQUIRY, GENERAL_INQUIRY, CARD_VERIFICATION_INQUIRY, CARDHOLDER_ACCOUNTS_TRANSFER, GENERAL_TRANSFER, PAYMENT_FROM_ACCOUNT, GENERAL_PAYMENT, PAYMENT_TO_ACCOUNT, PAYMENT_FROM_ACCOUNT_TO_ACCOUNT, PLACE_HOLD_ON_CARD, GENERAL_ADMIN, CHANGE_PIN, CARD_HOLDER_INQUIRY, POINTS_INQUIRY]	Data relating to the type of transaction taking place (i.e. cash withdrawal, goods and services etc.).
srcAccType	string	optional	[DEFAULT, SAVINGS, CHEQUE, CREDIT, UNIVERSAL, ELECTRONIC_PURSE, GIFT_CARD, STORED_VALUE]	This specifies the type of source account being used in the transaction (i.e. cheque, savings).
destAccType	string	optional	[DEFAULT, SAVINGS, CHEQUE, CREDIT, UNIVERSAL, ELECTRONIC_PURSE, GIFT_CARD, STORED_VALUE]	This specifies the type of destination account being used in the transaction (i.e. cheque, savings).
stan	string	optional		The System Trace Audit Number can be used to locate transactions across different systems.
rrn	string	optional		This is a reference set by the original source of the transaction.
card	Card	required		Information about the gift card being voided.
posInfo	PosInfo	optional		Information about the POS.
product	Product	optional		Information about the gift card product being voided.
cardHolder	Customer	optional		Information about the card holder.

VoidResponse

Information about the outcome of voiding process.

Name	Type	Required	Restrictions	Description
id	string	required		The randomly generated UUID identifying this transaction, as defined for a variant 4 UUID in RFC 4122
time	string	required	format:date-time	The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision
originator	Originator	required		Data relating to the originator of the transaction.
client	Institution	required		Data relating to the sender of Transaction.
settlementEntity	Institution	optional		Data relating to the entity with whom the Merchant will settle the transaction.
receiver	Institution	optional		Data relating to the entity which ultimately processes the request.
thirdPartyIdentifiers	array[ThirdPartyIdentifier]	required		An array of identifiers which each identify the transaction within each entity’s system.
slipData	SlipData	optional		Text to be printed on the customer receipt.
basketRef	string	optional		Used to group multiple transactions which would otherwise be considered independent.
tranType	string	optional	[GOODS_AND_SERVICES, CASH_WITHDRAWAL, DEBIT_ADJUSTMENT, GOODS_AND_SERVICES_WITH_CASH_BACK, NON_CASH, RETURNS, DEPOSIT, CREDIT_ADJUSTMENT, GENERAL_CREDIT, AVAILABLE_FUNDS_INQUIRY, BALANCE_INQUIRY, GENERAL_INQUIRY, CARD_VERIFICATION_INQUIRY, CARDHOLDER_ACCOUNTS_TRANSFER, GENERAL_TRANSFER, PAYMENT_FROM_ACCOUNT, GENERAL_PAYMENT, PAYMENT_TO_ACCOUNT, PAYMENT_FROM_ACCOUNT_TO_ACCOUNT, PLACE_HOLD_ON_CARD, GENERAL_ADMIN, CHANGE_PIN, CARD_HOLDER_INQUIRY, POINTS_INQUIRY]	Data relating to the type of transaction taking place (i.e. cash withdrawal, goods and services etc.).
srcAccType	string	optional	[DEFAULT, SAVINGS, CHEQUE, CREDIT, UNIVERSAL, ELECTRONIC_PURSE, GIFT_CARD, STORED_VALUE]	This specifies the type of source account being used in the transaction (i.e. cheque, savings).
destAccType	string	optional	[DEFAULT, SAVINGS, CHEQUE, CREDIT, UNIVERSAL, ELECTRONIC_PURSE, GIFT_CARD, STORED_VALUE]	This specifies the type of destination account being used in the transaction (i.e. cheque, savings).
stan	string	optional		The System Trace Audit Number can be used to locate transactions across different systems.
rrn	string	optional		This is a reference set by the original source of the transaction.
amounts	GiftcardAmounts	optional		Specifies the balance of the gift card when it was voided.
card	Card	required		Information about the gift card being voided.
posInfo	PosInfo	optional		Information about the POS.
product	Product	optional		Information about the gift card product being voided.
cardHolder	Customer	optional		Information about the card holder.

VoidReversal

Information about the gift card void being reversed.

Name	Type	Required	Restrictions	Description
id	string	required		The randomly generated UUID identifying this advice, as defined for a variant 4 UUID in RFC 4122
requestId	string	required		The UUID identifying the request that this advice relates to
time	string	required	format:date-time	The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision
thirdPartyIdentifiers	array[ThirdPartyIdentifier]	required		The unaltered thirdPartyIdentifiers array as supplied in the related BasicResponse message. Required if thirdPartyIdentifiers field was present in the BasicResponse. If no thirdPartyIdentifiers was received in the BasicResponse or no BasicResponse was received then this should be set to the thirdPartyIdentifiers sent in the original request.
stan	string	optional		The System Trace Audit Number can be used to locate transactions across different systems.
rrn	string	optional		This is a reference set by the original source of the transaction.
reversalReason	string	required	[TIMEOUT, CANCELLED, RESPONSE_NOT_FINAL]	The reason for the reversal