NameDescriptionTypeAdditional information
PaymentMethod

Required to tell the system how the user is going to pay for the order.

There are other payment types. It may be specified by type name, or by its corresponing index number.

  • SecureCreditCardPayment = 0
  • ClearCreditCardPayment = 1
  • PayAtSitePayment = 2
  • PrePaid = 3
  • StoredValueCard = 4
  • PreAuthorizedPayment = 5
JSON example:
{ "PaymentMethod": "StoredValueCard", ... } or with number: { "PaymentMethod": 4, ... }
For PayAtSitePayment, field "PaymentMethod" must be specified as "StoredValueCard", or 4.

PaymentMethodType

None.

CardNumber

Plain text card number for the payment - intended to be used with StoredValueCard enum

string

None.

Pin

Pin for Stored Value Card payment. Required if attempting to apply stored value and if company setting "Aloha Enterprise ePin Validation Required" is set to true.

string

None.

Amount

How much is to be paid with this payment.

  • Amount can't exceed order total.
  • If value is not provided, default value 0 will be used.
  • If value is 0, it doesn't mean to pay remaining balance as in other payment types. In this case, for this payment type, TipAmount must be provided, if Amount 0.

Allowed is:
  • Amount > 0 and TipAmount >= 0
  • Amount = 0 and TipAmount > 0

decimal number

None.

TipAmount

Additional amount for the Tip.
Do NOT include TipAmount in Amount. If you do not wish to pay extra tip, set TipAmount to 0, or do not provide TipAmount field at all. Amount = $3.00 and TipAmount = $2.00 will charge (Amount + TipAmount) $5.00 for this payment.
Split charged amount between Amount and TipAmount, if you wish pay extra tip.

decimal number

None.

OrderOfProcess

Order in which to proccess this payment. If specified value is zero or negative, it is the same as if it was not specified. Order of processing starts at 1.

Value may not be provided in two cases:

  • If this is the only payment.
  • If there are two payments. Other payment must be StoredValueCardPayment also without OrderOfProcess specified
  • Otherwise value must be unique among other payments. StoredValueCardPayment payments must have OrderOfProcess before other payments. StoredValueCardPayment payments must be processed first, if used.

integer

None.