Set Up Transaction Delivery

To set up Transaction Delivery to Amazon SQS, you must have access to the Nayax Core with the appropriate user permissions. Specifically, the following roles are required:

  • Transaction Dispatcher
  • Transactions Report Subscriber

Additionally, ensure you have the Amazon SQS Queue URL, Access Key, and Secret Key obtained during the queue setup process.

Operator Level Setup

Follow these steps to configure transaction delivery at the operator level in the Nayax Core:

  1. Log in to the Nayax Core.

  2. Go to Administration > Operator.

  3. Find the Operator you wish to set up.

  4. Click the Search button.

  5. Select the operator to display all tabs and details.

  6. Go to the Transactions Report tab.

  7. Set up Transaction Dispatching by completing the following steps:
    a. Select the checkbox next to Amazon SQS to enable this option.
    b. Enter the SQS credentials (Access Key, Secret Key and Queue URL).
    c. Click the Validate button to ensure the Queue credentials are correct.
    d. Enable Encryption (Optional). See the Set Up Encryption section for details.
    e. Choose payment methods to send. Only the selected payment methods will be dispatched to the Queue.
    You can also select the transaction type:

    • Free Transactions
    • Cancelled Transactions
    • Refund Transactions
    • Declined Transactions

    f. Select the Columns of information to include. See the table below for a description of available fields.

  8. Click the Save Information button to apply the changes.

By completing these steps, your transaction data will be securely delivered to Amazon SQS based on the configuration you’ve set up.

Example Transaction JSON Message

Below is an example of the transaction JSON message that will be sent to Amazon SQS once the setup is complete:

{
  "TransactionId": 3804536984,
  "RemoteStartTransactionId": null,
  "PaymentMethodId": 2,
  "SiteId": 6,
  "MachineTime": "2020-04-20T10:34:05.063",
  "Void": false,
  "MachineId": 54265,
  "Data": {
    "Card String": "0077020491",
    "Settlement Time (Date only)": "2020-04-20",
    "Settlement Time (Time only)": "07:34:15",
    "SeValue": 1.0000,
    "Operator Identifier": "500905",
    "Machine Group": "Snack's",
    "Raw ENI Loyalty Num": null,
    "Machine Name": "Oleg's Simulator 1",
    "Machine AuTime": "2020-04-20T10:34:05.063",
    "Machine SeTime": "2020-04-20T10:34:15.433",
    "Currency": "EUR",
    "Brand": null,
    "CLI": null,
    "Extra Charge": 0.0000,
    "Payment Service (Mobile using Credit Card)": "Prepaid Credit using Prepaid Credit",
    "Payment Method ID (1)": 2,
    "Recognition Method ID (3)": 3,
    "Catalog Number": "",
    "Device Number": "0000000000500902",
    "Actor Hierarchy": "Dually / Nayax Test Bunny / Connect 2020 Rocks /",
    "Payment Method Description": "Prepaid Credit",
    "Recognition Description": "Prepaid Credit",
    "Card First 4 Digits": "0077",
    "Card Last 4 Digits": null,
    "Card Type": "MIFARE received as Hexadecimal",
    "Transaction ID": 3804536984,
    "Site ID": 6,
    "Authorization Time": "2020-04-20T07:34:05.063",
    "Authorization Value": 6.0000,
    "PayServTransid": "200420073405",
    "sePayServTransId": null,
    "Settlement Time": "2020-04-20T07:34:15.433",
    "Cancel Type": null,
    "Is Revalue Transaction": false,
    "Preselection Status": 0,
    "Is Phone Registration": false,
    "Is Multivend": false,
    "Settlment Failed": null,
    "Sale ID": -1,
    "Sale Value": 0.0000,
    "Updated DT": "2020-04-20T07:34:15.433",
    "Constant Preauthorization Value": null,
    "Is Partial Confirmation": null,
    "Authorization Code": null,
    "Authorization Date and Time": null,
    "Authorization RRN": "200420073405",
    "Event Code": null,
    "Guest Name": null,
    "Token": null,
    "Zip Code": null,
    "Billing Provider ID": null,
    "AVS Only": null,
    "BOD Transaction Key": null,
    "Disable Debit Cards": null,
    "Force Transactions Terminal": null,
    "Use Phone Transaction": null,
    "License ID": null,
    "Merchant ID": null,
    "Billing Site ID": null,
    "Terminal ID": null,
    "User Password": null,
    "With ZIP": null,
    "Use Phone Contactless": false,
    "Use Phone Contact": false,
    "Debit Card Prefix": null,
    "Actor Description": "Connect 2020 Rocks",
    "Institute Description": "NAYAX US",
    "Location Code": 234234,
    "Location Description": "Booth 134",
    "Operator Institute Code": 4,
    "Area Description": "Connect 2020 Rocks",
    "OP Button Code": "Z1",
    "Barcode": null,
    "Cost Price": null,
    "Card Price": null,
    "Prepaid Price": null,
    "Machine Price": 4.0000,
    "Cash Price": null,
    "Default Price": null,
    "Actor Code": 12,
    "Display Card Number": "0077020491",
    "Card Holder Name": "Automatically Created",
    "User Identity": "1",
    "Billing Provider Name": null,
    "Is Offline Transaction": null,
    "Is EMV Transaction": null,
    "Machine AuTime (Date only)": "2020-04-20",
    "Machine AuTime (Time only)": "10:34:05",
    "Machine SeTime (Date only)": "2020-04-20",
    "Machine SeTime (Time only)": "10:34:15",
    "Updated DT (Date only)": "2020-04-20",
    "Updated DT (Time only)": "07:34:15",
    "Customer Type": 1,
    "Actor ID": 32622,
    "Client Id": "",
    "Contract Name": null,
    "Payout Day": null,
    "Contract Id": null,
    "Airport Id": null,
    "Is Refund Card": false,
    "Contract Number": null,
    "Airport Code": null,
    "Payed Value": 1.0000,
    "Consumer ID": 1906814004668638903,
    "Discount Card ID": 340897206534728,
    "Discount Card Number": "1424243531",
    "Discount Card User Identity": "",
    "Discount Card Physical Type ID": 30000531,
    "Discount Card Activation Date": null,
    "Discount Card Expiration Date": null,
    "Products": [
      {
        "Product(Product Name(MDB Code,PA Code))": "Bounty(0,A1)",
        "Product Group": "Snacks",
        "Product Code in Map": 0,
        "Product PA Code": "A1",
        "Product Volume Type": "600 ml",
        "Product Name": "Bounty",
        "Product VAT Id": null,
        "Product Tax Value": null,
        "Product Tax Code": null,
        "Product Vat Amount": null,
        "Product Net Price": null,
        "Product External Prepaid Price": null,
        "Product Group Code": null,
        "Product Group Sub Code": null,
        "Product Retail Price": null,
        "Product Discount Percentage": 0.00,
        "Product Discount Amount": 0.0000,
        "Product Bruto": 1.0000,
        "Product Catalog Number": ""
      }
    ]
  }
}

JSON Message Fields Description

The following table describes the fields included in the transaction JSON message:

Field NameTypeDescription
Machine NamestringMachine / POS Name as defined under Operations > Machines > Machine Name
Machine ModelstringModel of the machine used.
Operator IdentifierstringUnique identifier for the machine operator.
Machine AuTimeDate TimeAuthorization time of the machine.
Machine SeTimeDate TimeSettlement time of the machine.
CurrencystringCurrency used in the transaction.
Card StringstringEncrypted or masked card data.
BrandstringBrand associated with the transaction or card.
CLIstringCaller Line Identification for tracking.
SeValueDecimalSettled value of the transaction.
Extra ChargeDecimalAny additional charges applied.
Payment ServicestringPayment service used, e.g., mobile payment via credit card.
Payment Method ID (1)IntegerIdentifier for the primary payment method.
Recognition Method ID (3)IntegerIdentifier for recognition method used.
Catalog NumberstringProduct catalog number.
ProductstringProduct name, including MDB Code or PA Code if applicable.
Device NumberstringUnique identifier of the device used for the transaction.
Actor HierarchystringHierarchy of the actor involved in the transaction.
Payment Method DescriptionstringDescription of the payment method used.
Recognition DescriptionstringDescription of the recognition method applied.
Card First 4 DigitsstringFirst four digits of the card number.
Card Last 4 DigitsstringLast four digits of the card number.
Card TypestringType of card used, e.g., debit or credit.
Machine GroupstringGroup or category the machine belongs to.
Product GroupstringGroup or category the product belongs to.
Transaction IDIntegerUnique identifier for the transaction.
Site IDIntegerIdentifier for the site where the transaction occurred.
Authorization TimeDate TimeTime when the transaction was authorized.
Authorization ValueDecimalAuthorized value of the transaction.
PayServTransidIntegerPayment service transaction ID.
sePayServTransIdstringSettlement payment service transaction ID.
Settlement TimeDate TimeTime when the transaction was settled.
Product Code in MapIntegerMapped product code identifier.
Cancel TypeIntegerType of cancellation, if applicable.
Is Revalue TransactionBooleanIndicates if this is a revalue transaction.
Preselection StatusIntegerStatus of the preselection process.
Is Phone RegistrationBooleanIndicates if the phone is registered.
Is MultivendBooleanIndicates if the transaction involves multiple vending actions.
Settlement FailedIndicates if the settlement process failed.
Sale IDIntegerUnique identifier for the sale.
Sale ValueDecimalValue of the sale transaction.
Updated DTDate TimeDate and time of the last update.
Constant Preauthorization ValuePreauthorized constant value, if applicable.
Is Partial ConfirmationIndicates if the confirmation was partial.
Authorization CodestringCode for authorization.
Authorization Date and TimeDate and time of the authorization.
Authorization RRNstringRetrieval reference number for the authorization.
Event CodeCode associated with the event.
Guest NamestringName of the guest, if applicable.
TokenToken associated with the transaction.
Zip CodeZIP code of the location, if applicable.
Billing Provider IDIdentifier for the billing provider.
AVS OnlyIndicates if the transaction was AVS-only.
BOS Transaction KeyKey for the BOS transaction.
Disable Debit CardsIndicates if debit cards are disabled.
Force Transactions TerminalIndicates if transactions are forced on the terminal.
Use Phone TransactionIndicates if phone-based transactions are used.
License IDIdentifier for the license.
Merchant IDIdentifier for the merchant.
Billing Site IDIdentifier for the billing site.
Terminal IDUnique identifier for the terminal.
User NameUser name associated with the transaction.
User PasswordPassword of the user.
With ZIPIndicates if ZIP verification was performed.
Use Phone ContactlessIndicates if contactless phone transactions are used.
Use Phone ContactIndicates if phone contact transactions are used.
Debit Card PrefixPrefix for debit cards.
Actor DescriptionDescription of the actor involved in the transaction.
Institute DescriptionstringDescription of the associated institute.
Location CodeIntegerCode for the location of the transaction.
Location DescriptionstringDescription of the transaction location.
Operator Institute CodeIntegerCode of the operator’s institute.
Area DescriptionDescription of the area where the transaction occurred.
Product PA CodePA code of the product.
OP Button CodestringCode for the operator button pressed.
Product Volume TypeType of volume measurement for the product.
BarcodestringBarcode of the product.
Cost PriceDecimalCost price of the product.
Card PriceDecimalPrice when paid with a card.
Prepaid PriceDecimalPrepaid price of the product.
Machine PriceDecimalPrice charged by the machine.
Cash PriceDecimalPrice when paid in cash.
Default PriceDecimalDefault price of the product.
Product NameName of the product.
Actor CodeIntegerCode of the actor involved.
Actor IDIntegerUnique ID for the actor.
Display Card NumberstringMasked display of the card number.
Card Holder NamestringName of the cardholder.
User IdentitystringIdentity of the user associated with the transaction.
Billing Provider NameName of the billing provider.
Is Offline TransactionIndicates if the transaction was offline.
Is EMV TransactionIndicates if the transaction used EMV technology.
Machine AuTime (Date only)stringAuthorization date of the machine in a date-only format.
Machine AuTime (Time only)stringAuthorization time of the machine in a time-only format.
Machine SeTime (Date only)stringSettlement date of the machine in a date-only format.
Machine SeTime (Time only)stringSettlement time of the machine in a time-only format.
Settlement Time (Date only)stringSettlement date in a date-only format.
Settlement Time (Time only)stringSettlement time in a time-only format.
Updated DT (Date only)stringLast updated date in a date-only format.
Updated DT (Time only)stringLast updated time in a time-only format.
Raw ENI Loyalty NumRaw ENI loyalty number.
Parsed ENI Loyalty NumParsed ENI loyalty number.
ProductsObjectList of products involved in the transaction.
Product VAT IdVAT identifier for the product.
Product Tax ValueTax value applied to the product.
Product Tax CodeTax code associated with the product.
Product Vat AmountAmount of VAT applied to the product.
Product Net PriceNet price of the product before taxes.
Product External Prepaid PriceExternal prepaid price of the product.
Customer TypeType of customer involved in the transaction.
Product Group CodeCode of the product group.
Product Group Sub CodeSub-code of the product group.
Product Retail PriceRetail price of the product.
Product Discount PercentagePercentage of discount applied to the product.
Product Discount AmountDiscount amount applied to the product.
Product BrutoGross value of the product.
Product Catalog NumberCatalog number of the product.
Client IdUnique ID for the client.
Contract NameName of the contract associated with the transaction.
Payout DayDay when the payout is scheduled.
Contract IdID of the contract associated with the transaction.
Airport IdIntegerUnique ID of the airport, if applicable.
Member TypeType of membership associated with the transaction.
Is Refund CardBooleanIndicates if the card used is a refund card.
Contract NumberNumber of the contract associated with the transaction.
Airport CodestringCode of the airport, if applicable.
Payed ValueDecimalValue paid in the transaction.
Consumer IDIntegerUnique ID for the consumer.
Discount Card IDIntegerUnique ID for the discount card used.
Discount Card NumberstringNumber of the discount card used.
Discount Card User IdentitystringIdentity of the discount card user.
Discount Card Physical Type IDstringPhysical type ID of the discount card.
Discount Card Activation DatestringActivation date of the discount card.
Discount Card Expiration DatestringExpiration date of the discount card.