Definitions

Account

Represents the status of a customer account

Name	Type	Required	Default	Restrictions	Description
accountRef	string	required		maxLength:40 minLength:6	A reference number identifying the bill payments processor, bill issuer, and customer
dueDate	string	optional		format:date	The effective date of the current billing period in the format yyyy-MM-dd

AccountLookupRequest

The data required to request account info

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.
accountRef	string	required	maxLength:40 minLength:6	A reference number identifying the bill payments processor, bill issuer, and customer

AccountLookupResponse

The data resulting from an account 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	BillSlipData	required		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.
customer	Customer	optional		Customer detail
amounts	BillpayAmounts	required		The message amount details such as account balance.
partPaymentAllowed	boolean	optional		Indicates whether a payment amount may be less than the amount due. Defaults to true.
overPaymentAllowed	boolean	optional		Indicates whether a payment amount may be more than the amount due. Defaults to true.
account	Account	required		The customer account detail

An32TokenPayment

Name	Type	Required	Default	Restrictions	Description

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.

BasicAdviceResponse

Basic advice response information.

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.

BasicReversal

An advice that notifies of the negative completion of a transaction. This can be either due to customer cancellation, or as a result of receiving a non-final response (or no response) to a request

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

BillSlipData

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.
phoneNumber	string	optional		The call centre phone number

BillpayAmounts

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.
maxPayableAmount	LedgerAmount	optional	The maximum amount a customer is allowed to pay towards an account, policy or some other payment.
minPayableAmount	LedgerAmount	optional	The minimum amount a customer is allowed to pay towards an account, policy or some other payment.

CardPayment

Name	Type	Required	Default	Restrictions	Description

Customer

A bill payment customer

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
idNumber	string	optional	maxLength:13	The customer’s ID Number
contactNumber	string	optional	maxLength:40	The customer’s contact number

EncryptedPin

A PIN required to authorise a transaction. EncryptionParameters should be provided where the service will be performing operations on the encrypted PIN, such as PIN translation. Only the PIN block need be provided where the service is expected to forward it to a third party, where the calling client and said third party have agreed upon encryption parameters beforehand.

Name	Type	Required	Default	Restrictions	Description
pinBlock	string	required		pattern:[a-fA-F0-9]{16}	Hexadecimal string representing the encrypted PIN to be used.
encryptionParameters	EncryptionParameters	optional			Parameters pertaining to the generation of the pinBlock. Required if the service is to perform any operations on the encrypted PIN, such as PIN translation.

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, UNKNOWN_CUSTOMER_ACCOUNT, UPSTREAM_UNAVAILABLE, ACCOUNT_ALREADY_SETTLED, INVALID_PRODUCT, INVALID_MERCHANT, RECEIVER_BLACKLISTED, LUHN_CHECK_FAILED, BLOCKED_USING_SETTLEMENT_ENTITY, BELOW_MINIMUM_ALLOWED_AMOUNT, ABOVE_MAXIMUM_ALLOWED_AMOUNT]	The type of error that occurred
errorMessage	string	required	maxLength:20	A short description of the error
requestType	string	required	[ACCOUNT_LOOKUP_REQUEST, TRAFFIC_FINE_LOOKUP_REQUEST, POLICY_LOOKUP_REQUEST, PAYMENT_REQUEST, TRAFFIC_FINE_PAYMENT_REQUEST, POLICY_PAYMENT_REQUEST, PAYMENT_REVERSAL, TRAFFIC_FINE_PAYMENT_REVERSAL, PAYMENT_CONFIRMATION, TRAFFIC_FINE_PAYMENT_CONFIRMATION, REFUND_REQUEST, REFUND_REVERSAL, REFUND_CONFIRMATION]	The type of request being processed when the error occurred. Refer to Release Notes for deprecated values.
id	string	required		The UUID of the message for which error occurred.
originalId	string	optional		The UUID of the original request message in the case of an error occurring for an advice message.
detailMessage	object	optional		A free form detailed description of a particular failure condition may optionally be supplied

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

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

LoyaltyCardPayment

Name	Type	Required	Default	Restrictions	Description

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

PaymentMethod

Base model for all payment types

Name	Type	Required	Restrictions	Description
type	string	required	[AN_32_TOKEN, LOYALTY_CARD, CARD]	The general method of payment used
name	string	optional		The specific method of payment used
amount	LedgerAmount	required		Ledger amount of the payment

PaymentRequest

Represents a request to perform a payment

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.
accountRef	string	required	maxLength:40 minLength:6	A reference number identifying the bill payments processor, bill issuer, and customer
amounts	BillpayAmounts	required		Contains the payment amount.
tenders	array[Tender]	optional		Contains the tenders for the payment request if available
paymentMethods	array[PaymentMethod]	optional		Contains the payment method for the payment request if available
customer	Customer	optional		Customer detail

PaymentResponse

Represents a response to a payment 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	BillSlipData	required		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.
customer	Customer	optional		Customer detail
amounts	BillpayAmounts	required		The message amount details such as account balance.
partPaymentAllowed	boolean	optional		Indicates whether a payment amount may be less than the amount due. Defaults to true.
overPaymentAllowed	boolean	optional		Indicates whether a payment amount may be more than the amount due. Defaults to true.
account	Account	required		The customer account detail
tenders	array[Tender]	optional		Contains the tenders for the payment response if available
paymentMethods	array[PaymentMethod]	optional		Contains the payment method for the payment response 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

Policy

Represents the status of a customer policy

Name	Type	Required	Default	Restrictions	Description
policyNumber	string	required		maxLength:40 minLength:6	A reference number identifying the policy to the processor.
dueDate	string	optional		format:date	The date by which the next policy payment must be made in the format yyyy-MM-dd.

PolicyLookupRequest

The data required to request policy info

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.
policyNumber	string	required	maxLength:40 minLength:6	A reference number identifying the policy to the service provider.

PolicyLookupResponse

The data resulting from a policy 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	BillSlipData	required		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.
customer	Customer	optional		Customer detail
amounts	BillpayAmounts	required		The message amount details such as account balance.
partPaymentAllowed	boolean	optional		Indicates whether a payment amount may be less than the amount due. Defaults to true.
overPaymentAllowed	boolean	optional		Indicates whether a payment amount may be more than the amount due. Defaults to true.
policy	Policy	required		The customer policy detail

PolicyPaymentRequest

Represents a request to perform a payment of a traffic fine.

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.
policyNumber	string	required	maxLength:40 minLength:6	A reference number identifying the policy to the service provider.
amounts	BillpayAmounts	required		Contains the payment amount.
tenders	array[Tender]	optional		Contains the tenders for the payment request if available
paymentMethods	array[PaymentMethod]	optional		Contains the payment method for the payment request if available
customer	Customer	optional		Customer detail

PolicyPaymentResponse

Represents a response to a policy payment 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	BillSlipData	required		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.
customer	Customer	optional		Customer detail
amounts	BillpayAmounts	required		The message amount details such as account balance.
partPaymentAllowed	boolean	optional		Indicates whether a payment amount may be less than the amount due. Defaults to true.
overPaymentAllowed	boolean	optional		Indicates whether a payment amount may be more than the amount due. Defaults to true.
policy	Policy	required		The customer policy detail

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.

RefundRequest

Represents a request to refund a payment

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.
issuerReference	string	required	pattern:[A-Z0-9]{1,20}	An identifier that is printed on the customer slip and uniquely identifies the payment on the bill issuer’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
refundReason	string	required	maxLength:20	The reason for the refund as given by the customer

RefundResponse

Represents a response to a refund 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	BillSlipData	required		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.
customer	Customer	optional		Customer detail
amounts	BillpayAmounts	required		The message amount details such as account balance.
partPaymentAllowed	boolean	optional		Indicates whether a payment amount may be less than the amount due. Defaults to true.
overPaymentAllowed	boolean	optional		Indicates whether a payment amount may be more than the amount due. Defaults to true.
account	Account	optional		The customer account detail
trafficFine	TrafficFine	optional		The customer trafficFine detail
policy	Policy	optional		The customer policy detail

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

TenderAdvice

An advice that notifies of the successful completion of a transaction.

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

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.

TrafficFine

Represents the status of a traffic fine

Name	Type	Required	Default	Restrictions	Description
noticeNumber	string	required		maxLength:40 minLength:6	A reference number identifying the traffic fine to the processor’s system.
dueDate	string	optional		format:date	The date by which the traffic fine should be paid in the format yyyy-MM-dd.

TrafficFineLookupRequest

The data required to request traffic fine info

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.
noticeNumber	string	required	maxLength:40 minLength:6	A reference number identifying the traffic fine to the service provider.

TrafficFineLookupResponse

The data resulting from a traffic fine 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	BillSlipData	required		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.
customer	Customer	optional		Customer detail
amounts	BillpayAmounts	required		The message amount details such as account balance.
partPaymentAllowed	boolean	optional		Indicates whether a payment amount may be less than the amount due. Defaults to true.
overPaymentAllowed	boolean	optional		Indicates whether a payment amount may be more than the amount due. Defaults to true.
trafficFine	TrafficFine	required		The traffic fine detail

TrafficFinePaymentRequest

Represents a request to perform a payment of a traffic fine.

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.
noticeNumber	string	required	maxLength:40 minLength:6	A reference number identifying the traffic fine to the service provider.
amounts	BillpayAmounts	required		Contains the payment amount.
tenders	array[Tender]	optional		Contains the tenders for the payment request if available
paymentMethods	array[PaymentMethod]	optional		Contains the payment method for the payment request if available
customer	Customer	optional		Customer detail

TrafficFinePaymentResponse

Represents a response to a payment 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	BillSlipData	required		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.
customer	Customer	optional		Customer detail
amounts	BillpayAmounts	required		The message amount details such as account balance.
partPaymentAllowed	boolean	optional		Indicates whether a payment amount may be less than the amount due. Defaults to true.
overPaymentAllowed	boolean	optional		Indicates whether a payment amount may be more than the amount due. Defaults to true.
trafficFine	TrafficFine	required		The customer account detail