API Reference

Data Collection

With clean, itemised receipt data, you can boost your operational and marketing efficiency.

This is an example receipt data event webhook payload.

{

"outlet_id" : "003" ,

"pos_id" : "00312" ,

"dReceipt_id" : "55878743" ,

"pReceipt_id" : "A10000000" ,

"transaction_time" : "1546798060" ,

"payment_method" : "Cash" ,

"amount" : "2900.00" ,

"items" : [

{

"sku" : "15-inch laptop" ,

"qty" : "2" ,

"up" : "1200.00"

},

{

"sku" : "Internal SSD" ,

"qty" : "1" ,

"up" : "500.00"

}

],

"server_timestamp" : "1546798063",

"device_timestamp" : "1546798063"

}

Remote Printing

This is the API reference to print out any message you want from the receipt printer. Use this function to print out payment confirmation receipts and more. 

{

"header" : "Congratulations!" ,
"body" : "Your payment was successful!" ,
"footer" : "We look forward to seeing you again." 

}

Error Codes

Aimazing uses conventional HTTP response codes to indicate the success or failure of an API request. In general:

  • Codes in the 2xx range indicate success.

  • Codes in the 4xx range indicate an error that failed given the information provided.

Status code summary as below:

AImazing logo.png
  • Grey Facebook Icon
  • Grey LinkedIn Icon

© 2019 AImazing Pte Ltd.  All Rights Reserved.