Sample Transactions

• POST transactions (POST to /terminals/[terminal_id]/transaction)
  • Sales
  • Refund
  • Void

Sales Sample

Sale

{
"transaction": {
	"transactionType": "SALE",
	"id": "12345",
	"orderId": "abc123",
	"subtotal": "10.00",
	"totalAmount": "10.00",
	"currency": "USD",
	"your_field_goes_here": "your value goes here",
	"you_can_add_more_fields": {
		"they_can_even_be_complex_objects" : ["it", "is", "fine"]
	}
}

Refund Samples

You issue a referenced refund by sending a "refTransactionId". This value should come from the ExternalID in the AnyPay response from the original SALE transaction.

Referenced Refund

{
    "transactionType": "REFUND",
    "totalAmount": 10.04,
    "refTransactionId": "9128",
    "currency": "USD"
}

Unreferenced Refund with Card Data

{
  "transactionType": "REFUND",
  "totalAmount" : "0.45",
  "id": "zscddassdas67asg4346",
  "currency": "USD",
   "cardNumber" : "4111111111111111",
  "cardExpiryMonth" : "12",
  "cardExpiryYear" : "19",
  "cardholderName" : "Jona Ave",
  "postalCode" : "54321",
  "address" : "Cardholder Address"
}

JSON

{
  "transactionType": "REFUND",
  "totalAmount" : "0.45",
  "id": "zscddassdas67asg4346",
  "currency": "USD"
}

Void Sample

Void

{
  "transactionType": "VOID",
  "terminalID": "term1",
  "UUID":"ac002e34-4795-4ae0-bcef-b878d63fe064",
  "id": "zscddassdas67asg4346"
}