PrePaidPayment
Provided PaymentMethod must be PrePaid (3).
Payment was already made, information will be just passed down along the Order
during submission. If something goes wrong and order was not sucessfuly submitted,
for example capacity was exceeded, payment cancellation must be handled properly.
NOTE:
As it is, order submission may time out :(. I hope this would be very rare case,
but order may have been submitted sucessfuly,
or it may have failed,
or it may still be processing on the server.
Better check the order status later, whether you need to cancel your payment.
| Name | Description | Type | Additional 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": "PrePaid",
...
} or with number:
{
"PaymentMethod": 3,
...
}
For PayAtSitePayment, field "PaymentMethod" must be
specified as "PrePaid", or 3.
|
PaymentMethodType
|
None.
|
| PaymentMethodType |
What kind of card is passed in.
|
CustomerPaymentMethodType
|
Required
|
| 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 means remaining balance was paid by this payment.
So Amount >= 0, or not provided at all.
|
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.
For example order total is $12.00:
- Amount = $0.00, TipAmount = $2.00, was charged $14.00 for this payment, if there wasn't another payment.
- Amount = $0.00, TipAmount = $2.00, was charged $10.00 for this payment, if there were previous payments in total amount of $4.00, regardless of their TipAmount.
-
Amount = $3.00, TipAmount = $2.00, will charge $5.00 for this payment, regardless
of previous payments, make sure all your payments do not exceed order total.
For payments with specified Amount, split charged amount between Amount and TipAmount,
if extra tip was paid.
For payments without specified Amount (or Amount set to 0), provide only extra TipAmount,
if extra tip was paid.
|
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.
|