Skip to main content

Notifications Service

Introduction#

The Latitude notifications service is complementing service to allow Merchant partners to confirm responses from Latitude. Merchants may choose to act upon notifications, or simply use notifications for informational purposes (eg. additional logging/debugging).


Setup Pre-requisite Requirements#

Notification endpointsThe Merchant's endpoint where notifications should be posted. There is no limit to notification endpoints.
Please provide this information to your Latitude Financial Services representative

Default settings for Notifications#

SettingDescription
maxAttemptThe maximum number of reattempts should an error occur in posting to the defined notification endpoint.
The default is 1
conditionConditions are rules for which notifications should be triggered. By default, all transaction types that are processed via the iFrame and API services will generate notification messages
The following are the common list of transaction types. Each Merchant's integration is custom and not all transaction types will apply to every Merchant:
- card number authorisations (txnType=8 or 18)
- SMS attempts and corresponding account number authorisations (txnType=17)
- voids (txnType=30)
- refunds (txnType=20)
- captures (txnType=19)
> Note: all SMS attempts relating to an account number authorisations will be sent to the notification endpoint. If the Customer attempted the SMS generation 4 times, then the Merchant will receive all 4 SMS notifications.
Some Merchants may opt to only receive the final account number authorisation outcome, and not prior SMS attempts. Please provide this information to your Latitude Financial Services representative

Returned payment fields#

The default fields to be returned in the notification, if the field exists and is applicable to that form of payment method (i.e card number shopping, account number shopping or drivers license shopping).

"payment": {
"fields": [
"additionalData",
"lfsData",
"amount",
"cardCategory",
"cardExpiryDate",
"cardHolderName",
"cardSchema",
"cardSubCategory",
"cardToken",
"cardType",
"cardIssuer",
"cardIssuerCountry",
"cardYear",
"channel",
"configId",
"currency",
"customerId",
"device",
"ecm",
"email",
"finalAmount",
"localPaymentDate",
"localPaymentTime",
"maskedPAN",
"merchReference",
"metadata",
"metadata.LFSData",
"requestorIp",
"responseCode",
"settlementDate",
"surcharge",
"surchargeAmount",
"transactionDate",
"txnReference",
"txnType"]
}

Notifications Format and Examples#

The Latitude Payment Gateway will use the HTTPS POST method to send all notification payloads.

The message format will follow a standard JSON structure as used for API responses.

Example of Successful Purchase for Credit Card

{
"cardSchema": "MASTERCARD",
"metadata": {},
"channel": "api",
"cardCategory": "CREDIT",
"txnType": 19,
"cardExpiryDate": "08/22",
"ecm": "31",
"responseCode": "00",
"txnReference": "111111111111111",
"customerId": "Latitude",
"currency": "AUD",
"notificationId": "11111111-1111-1111-1111-111111111111",
"additionalData": {
"f41": "00000001",
"tii": "0 ",
"f11": 58028.0,
"f37": "111111111111",
"f48": "AT/CPC/2024IC/02LD/11350000549001180000002790",
"ecm": "31"
},
"merchReference": "111111111111",
"requestorIp": "127.0.0.1",
"amount": 57690,
"maskedPAN": "521894XXXXXX1111",
"cardHolderName": "Test User ",
"lfsData": {
"decision": "Accept",
"requestF48": "AT/CPC/2024IC/02LD/11350000549001180000002790",
"promoCode": "2024",
"promoDescription": "24 Months Interest Free",
"terminalId": "00000001",
"items": [
{
"productCode": "1135",
"total": 54900,
"quantity": 1,
"description": "Floor Cleaner"
},
{
"productCode": "1180",
"total": 2790,
"quantity": 1,
"description": "Delivery Cost"
}
]
},
"hierarchy": "Latitude|LatitudeTestAUOne|OnlineHostedAU",
"settlementDate": "2021-01-25T00:00:00Z",
"transactionDate": "2021-01-24T23:34:25Z",
"userName": "Latitude.LatitudeTestAUOne.OnlineHostedAU.demo",
}

Example of Declined Purchase for Credit Card

{
"cardSchema": "MASTERCARD",
"metadata": {
"amount": "1599.20",
"browser": "chrome",
"browser_version": "87.0",
"configId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"country": "GB",
"currency": "AUD",
"device_type": "computer",
"engine": "webkit",
"engine_version": "537.36",
"language": "en",
"os": "windows",
"timezone": "Australia/Sydney",
"channel": "iframe"
},
"channel": "iframe",
"cardCategory": "CREDIT",
"txnType": 18,
"cardExpiryDate": "01/23",
"ecm": "31",
"cardIssuer": "LATITUDE FINANCE AUSTRALIA",
"responseCode": "05",
"txnReference": "111111111111112",
"customerId": "Latitude",
"currency": "AUD",
"notificationId": "11111111-1111-1111-1111-111111111111",
"additionalData": {
"f41": "00000001",
"transactionMethod": "",
"tii": "0 ",
"responseF48": "RC/109",
"f11": 69702.0,
"f47": "CCVP\\",
"f38": "000000",
"f37": "111111111112",
"reasonCode": "109",
"f48": "AT/CPC/2012IC/01LD/1300000159920",
"ecm": "31"
},
"merchReference": "111111111112",
"requestorIp": "127.0.0.1",
"amount": 159920,
"maskedPAN": "521893XXXXXX1111",
"lfsData": {
"authCode": "000000",
"decision": "Reject",
"requestF48": "AT/CPC/2012IC/01LD/1300000159920",
"responseF48": "RC/109",
"reasonCode": "109",
"promoCode": "2012",
"promoDescription": "12 Months Interest Free",
"terminalId": "00000001",
"items": [
{
"productCode": "1300",
"total": 159920,
"quantity": 1,
"description": "Laptop"
}
]
},
"hierarchy": "Latitude|LatitudeTestAUOne|OnlineHostedAU",
"settlementDate": "2020-01-01T00:00:00Z",
"transactionDate": "2020-01-01T03:58:32Z",
"userName": "Latitude.LatitudeTestAUOne.OnlineHostedAU.demo",
"cardIssuerCountry": "AUSTRALIA"
}

Example of a Successful SMS authorisation

{
"metadata": {
"amount": "116485",
"configId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"currency": "AUD",
"channel": "iframe"
},
"channel": "iframe",
"txnType": 17,
"ecm": "31",
"responseCode": "00",
"txnReference": "111111111111113",
"customerId": "Latitude",
"notificationId": "11111111-1111-1111-1111-111111111111",
"additionalData": {
"f41": "00000001",
"transactionMethod": "S",
"tii": "0 ",
"mobileNumber": "XX7XXX6666",
"responseF48": "MB/XX7XXX6666",
"f11": 36523.0,
"f38": "036523",
"f37": "111111111113",
"f48": "AT/SDB/12091999",
"ecm": "31"
},
"merchReference": "1-SMS-111111111113",
"requestorIp": "127.0.0.1",
"amount": 0,
"maskedPAN": "521893XXXXXX1111",
"lfsData": {
"dateOfBirth": "12091999",
"accountNumber": "521893XXXXXX1111",
"authCode": "036523",
"decision": "Accept",
"requestF48": "AT/SDB/12091999",
"responseF48": "MB/XX7XXX6666",
"transactionMethod": "S",
"mobileNumber": "XX7XXX6666",
"promoCode": "2006",
"promoDescription": "6 Months Interest Free",
"terminalId": "00000001",
"items": [
{
"productCode": "1380",
"total": 54400,
"quantity": 1,
"description": "Laptop"
},
{
"productCode": "1380",
"total": 28400,
"quantity": 1,
"description": "Laptop"
},
{
"productCode": "1380",
"total": 29700,
"quantity": 1,
"description": "Laptop"
},
{
"productCode": "1180",
"total": 3985,
"quantity": 1,
"description": "Delivery Cost"
}
]
},
"hierarchy": "Latitude|LatitudeTestAUOne|OnlineHostedAU",
"settlementDate": "2020-01-01T00:00:00Z",
"transactionDate": "2020-01-01T20:50:26Z",
"userName": "Latitude.LatitudeTestAUOne.OnlineHostedAU.demo",
}

Example of an Unsuccessful SMS authorisation

{
"requestorIp": "127.0.0.1",
"amount": 0,
"metadata": {
"amount": "299.85",
"configId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"currency": "NZD",
"channel": "iframe"
},
"maskedPAN": "601073XXXXXX1111",
"lfsData": {
"dateOfBirth": "05011999",
"accountNumber": "601073XXXXXX1111",
"authCode": "000000",
"decision": "Error",
"requestF48": "AT/SDB/05011999",
"transactionMethod": "S",
"promoCode": "2006",
"promoDescription": "6 Months Interest Free",
"terminalId": "00000001",
"items": [
{
"productCode": "1300",
"total": 29985,
"quantity": 3,
"description": "Online Purchase"
}
]
},
"hierarchy": "Latitude|LatitudeTestNZOne|OnlineHostedNZ",
"txnType": 17,
"settlementDate": "2020-01-01T00:00:00Z",
"transactionDate": "2020-01-01T07:02:09Z",
"userName": "Latitude.LatitudeTestNZOne.OnlineHostedNZ.demo",
"ecm": "31",
"responseCode": "92",
"txnReference": "111111111111114",
"customerId": "Latitude",
"notificationId": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
"additionalData": {
"f41": "00000001",
"transactionMethod": "S",
"tii": "0 ",
"f11": 161663.0,
"f38": "000000",
"f37": "880000067000",
"f48": "AT/SDB/05011999",
"ecm": "31"
},
"merchReference": "1-SMS-111111111111114"
}

Example of Successful Capture

{
"cardSchema": "MASTERCARD",
"metadata": {},
"channel": "api",
"cardCategory": "CREDITLINE",
"txnType": 19,
"cardExpiryDate": "01/22",
"ecm": "31",
"responseCode": "00",
"txnReference": "111111111111111",
"customerId": "Latitude",
"currency": "AUD",
"notificationId": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
"additionalData": {
"f41": "00000001",
"tii": "0 ",
"f11": 77777.0,
"f37": "1111111111 ",
"f48": "AT/CPC/2024IC/01LD/1300000027200",
"ecm": "31"
},
"merchReference": "1111111111",
"requestorIp": "false",
"amount": 27200,
"maskedPAN": "503946XXXXXX1111",
"lfsData": {
"decision": "Accept",
"requestF48": "AT/CPC/2024IC/01LD/1300000027200",
"promoCode": "2024",
"promoDescription": "24 Months Interest Free",
"terminalId": "00000001",
"items": [
{
"productCode": "1300",
"total": 27200,
"quantity": 1,
"description": "Desk"
}
]
},
"hierarchy": "Latitude|LatitudeTestAUOne|OnlineHostedAU",
"settlementDate": "2021-01-25T00:00:00Z",
"transactionDate": "2021-01-25T06:54:26Z",
"userName": "Latitude.LatitudeTestAUOne.OnlineHostedAU.demo",
}