API Reference

Included in payloads

{
    // total amount (= subtotal - discount + tax + tips + svc)
    "amount": 5.00,
    
    // same as "amount" (may be removed in the future)
    "amountAuthorized": 0,
    
    "cardHolder": "",
    "cardSystem": -1,
    "cashbackAmount": 0,
    "customerId": "",
    "discountAmount": 0,
    "extInvoiceNumber": "",
    "orderId": "",
    
    // related Auth transaction (for tip adjustment and capture)
    "originalTx": <Transaction>,
    
    "pan": "",
    "platform": 0,
    "platformAuthCode": "",
    "platformBatchNumber": "",
    "platformReferenceNumber": "",
    "platformTxId": "",
    "platformTxType": "",
    "refundedAmount": 0,
    
    // main amount (without any extras)
    "subtotal": 5.00,
    
    // service charge (includes taxSvc and tipsSvc)
    "svcAmount": 0.00,
    
    // service charge percentage (e.g. 3.99 means 3.99%)
    "svcPercent": 0.00,
    
    "tax": 0.00,
    
    // service charge portion related to the tax
    "taxSvc": 0,
    
    "tenderType": 0,
    "tips": 0.00,
    
    // service charge portion related to tips
    "tipsSvc": 0,
    
    "type": 0,
    "voided": false
  }

Constants

// tenderType
TENDER_CREDIT = 0
TENDER_DEBIT = 1
TENDER_EBT = 2
TENDER_CASH = 3
TENDER_INVOICE = 4
TENDER_GIFT = 5

// type
TYPE_SALE = 0
TYPE_REFUND = 1
TYPE_VOID = 2
TYPE_REFUND_QUICK = 3
TYPE_AUTH = 4
TYPE_CAPTURE = 5
TYPE_ADJUST = 6   // tip adjustment

// cardSystem
CARD_SYSTEM_UNKNOWN = -1
CARD_SYSTEM_VISA = 0
CARD_SYSTEM_MC = 1
CARD_SYSTEM_DISCOVER = 2
CARD_SYSTEM_AMEX = 3
CARD_SYSTEM_DINERS = 4
CARD_SYSTEM_JCB = 5
CARD_SYSTEM_MAESTRO = 6

// platform
PLATFORM_QUICKSALE = 0