Complex Types

The complex types are used to define reusable objects in the service contract.

AccountDetail

A bank account definition.

Contains elements as defined in the following table.

An address defintion.

Contains elements as defined in the following table.

ELEMENT	TYPE	SIZE(MAX)	DESCRIPTION
AddressLine1	string	50	The first address line. Typically a business or apartment complex name. For aggregators this will contain the address of the sub merchant.
AddressLine2	string	50	The second address line. Typically a street name and number.
City	string	50	The city name.
Neighbourhood	string	50	The address neighbourhood.
PostCode	string	10	The post or zip code. For aggregators this will contain the postal code of the sub merchant.
Region	string	50	The province or state.
CountryCode	string	3	The country numeric code according to the ISO 3166-1 standard. The default value for South Africa is 710

A bank card definition.

Contains elements as defined in the following table.

ELEMENT	TYPE	SIZE(MAX)	DESCRIPTION
Token	string	50	A token that can be used to identify the captured card in subsequent transactions.
CardAssociation	string	50	The card association.
CardType	BankCardType		The type of bank card (debit or credit).
CardholderName	string	50	The cardholder name printed on the card.
CardNumber	string	19	The bank card number.
ExpiryMonth	int	2	The card expiry month. For RCS Cards ExpiryMonth is not required
ExpiryYear	int	2	The card expiry year. For RCS Cards ExpiryYear is not required
SecurityCode	string	4	The card security code (CSC / CVV / CVD). It is highly recommended that the CVV be provided for all initial transactions in order to fully authenticate the customer.
TokenCryptogram	string	32	Only to be populated when external scheme token is being used. Field can contain either MasterCard or Visa cryptogram data

Card definition returned by ListMerchantCards.

Contains elements as defined in the following table.

ELEMENT	TYPE	SIZE(MAX)	DESCRIPTION
MerchantUserID Required	string	50	The merchant’s identifier for the user
CardholderName Required	string	50	The cardholder name printed on the card.
MaskedCardNumber Required	string	19	The masked bank card number.
ExpiryMonth Required	int	2	The card expiry month.
ExpiryYear Required	int	2	The card expiry year.

A collection of additional information regarding the method response.

Contains elements as defined in the following table.

ELEMENT	TYPE	SIZE(MAX)	DESCRIPTION
Source Required	string	50	The service that generated the transact result code. Please see here for Service details
Code Required	string	100	The transaction result code. Please note, the result code is Service dependent
Description Required	string	500	The transaction result description.
ClientMessage Required	String	200	A user-friendly message that can be relayed to the end-user.

Card definition returned by ListUserCards.

Contains elements as defined in the following table.

ELEMENT	TYPE	SIZE(MAX)	DESCRIPTION
Token Required	string	50	A token to identify the stored card details.
CardholderName Required	string	50	The cardholder name printed on the card.
MaskedCardNumber Required	string	19	The masked bank card number.
ExpiryMonth Required	int	2	The card expiry month.
ExpiryYear Required	int	2	The card expiry year.
CardVerification Required	string	40	Provides additional verification information
NetworkTokenStatus	string	40	Provides the token status

This allows for externally obtained authentication data to be provided by the merchant or aggregator.

Contains elements as defined in the following table.

ELEMENT	TYPE	SIZE(MAX)	DESCRIPTION
Cavv Required	string	50	This is the cavv data obtained from the authentication process.
Eci Required	string	50	This is the ECI value obtained from the authentication process (eg: "02", "05", "06", "07")
Enrolled Required	string	1	This is the enrollment status of the card obtained from the authentication process (eg: "y", "n")
ParesStatus Required	string	1	This is the Pares status obtained from the authentication process (eg "y", "n")
Xid Required	string	50	This is the unique xid obtained from the authentication process
Secure3DVersion Required	string	9	This is the version of Secure3D being used. (eg: "2.2.0")
Secure3DDirectoryServerTransId Required	string	50	This is the unique Directory Server Transaction ID obtained from the authentication process
Secure3DAuthenticationType Required	string	2	This is the authentication type used (eg: "01", "02", "03")