Format

HTTPS POST using JSON data format.

IMPORTANT NOTE: merchants need to allow for additional fields to be added at the end of the Transaction Notification in future enhancements.

FIELD NAME	TYPE	SIZE (MAX)	DESCRIPTION
RequestType Required	RequestType		The request type for the transaction
MerchantID Required	string	50	A unique identifier to identify the merchant.
CardAcceptorID Required	string	50	A unique identifier used by the bank to identify the merchant
TransactionID Required	string	50	A unique identifier to identify the transaction.
TransactionDateTime	datetime		The transaction timestamp
ReconID	string	50	A unique identifier for reconciliation purposes
Amount Required	long		The authorization amount in the lowest monetary unit (cents for SA)
CurrencyCode	string	3	The currency code according to the ISO 4217 standard
OrderNumber	string	50	The transaction order or reference number. Note: Only Alphanumeric characters i.e. [a..z], [A..Z], [0..9] are allowed. NO spaces or special characters are allowed. The first 12 characters of this field will be sent to the acquirer/bank as the Retrieval Reference Number (RRN). Therefore the first 12 characters must be unique. Duplicate RRN’s may cause transaction failures.
PaymentService Required	PaymentServiceType		The target payment service
AuthCode	string	6	The authcode as returned by the acquirer
TransactionStatus Required	TransactionStatusType		The transaction status (Success, Failure and Other)
ResponseSource Required	string	50	The response code indicating the source of the response
ResponseCode Required	string	3	The response code indicating the transaction status
MaskedCardNumber	string	19	The original masked card PAN
ExpiryMonth	string	2	The expiry month of the card
ExpiryYear	string	4	The expiry year of the card
SystemsTraceAuditNumber Required	string	6	A unique identifier for reconciliation purposes
SaleReconID	string	100	A unique sale identifier for reconciliation purposes
RetrievalReferenceNumber Required	string	12	A unique identifier for reconciliation purposes
CommProtocol Required	string	4	Represents the communication protocol used (REST for notifications)
InitialAuthRef	string	50	The initial authorize reference is the value returned by the bank on the initial authorization. Merchants are required to send this for subsequent incremental authorizations or partial voids.
ResponseDescription	string	50	Describes the transaction result
NetworkToken	string	19	The masked token provided by the Card Schemes that is used in place of the card number

Authorize Example - Card

{
    "RequestType": "Authorize",
    "MerchantID": "8B67BF88-BB8D-4EB5-ADFC-0F5C97C7ED67",
    "CardAcceptorID": "1738194",
    "TransactionID": "2e0e1b85-bf91-45a9-b038-282e00036919",
    "TransactionDateTime": "2024-11-07T13:56:36.533",
    "ReconID": "MR747891457",
    "Amount": 50,
    "CurrencyCode": "ZAR",
    "OrderNumber": "MR43851259",
    "PaymentService": "CardNotPresent",
    "AuthCode": "238699",
    "TransactionStatus": "Success",
    "ResponseSource": "Acquirer",
    "ResponseCode": "00",
    "MaskedCardNumber": "541333******1429",
    "ExpiryMonth": "12",
    "ExpiryYear": "20",
    "SystemsTraceAuditNumber": "7543",
    "SaleReconID": "MR43851259",
    "RetrievalReferenceNumber": "00MR43851259",
    "InitialAuthRef": "",
    "CommProtocol": "REST"
}

Capture Example - Card

{
    "RequestType": "Capture",
    "MerchantID": "8B67BF88-BB8D-4EB5-ADFC-0F5C97C7ED67",
    "CardAcceptorID": "1738194",
    "TransactionID": "c96bafea-4303-4a1b-a1ad-62d66620741a",
    "TransactionDateTime": "2024-11-07T14:02:48.787",
    "ReconID": "MR747891457",
    "Amount": 50,
    "CurrencyCode": "ZAR",
    "OrderNumber": "MR22165670",
    "PaymentService": "CardNotPresent",
    "AuthCode": "850473",
    "TransactionStatus": "Success",
    "ResponseSource": "Acquirer",
    "ResponseCode": "00",
    "MaskedCardNumber": "541333******1429",
    "ExpiryMonth": "12",
    "ExpiryYear": "20",
    "SystemsTraceAuditNumber": "7553",
    "SaleReconID": "MR43851259",
    "RetrievalReferenceNumber": "00MR22165670",
    "InitialAuthRef": "",
    "CommProtocol": "REST"
}

Payment Example - EFT

 {
    "RequestType": "Payment",
    "MerchantID": "8B67BF88-BB8D-4EB5-ADFC-0F5C97C7ED67",
    "CardAcceptorID": "1738194",
    "TransactionID": "fea58214-e479-41c0-9373-a769f6a56306",
    "TransactionDateTime": "2024-11-07T14:06:36.313",
    "ReconID": "MR747891457",
    "Amount": 50,
    "CurrencyCode": "ZAR",
    "OrderNumber": "MR28988139",
    "PaymentService": "CardNotPresent",
    "AuthCode": "466930",
    "TransactionStatus": "Success",
    "ResponseSource": "Acquirer",
    "ResponseCode": "00",
    "MaskedCardNumber": "541333******1429",
    "ExpiryMonth":"12",
    "ExpiryYear": "20",
    "SystemsTraceAuditNumber": "7563",
    "SaleReconID": "MR43851259",
    "RetrievalReferenceNumber": "00MR28988139",
    "InitialAuthRef": "",
    "CommProtocol": "REST"
}