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": "PreAuthorizedPayment", ... } or with number: { "PaymentMethod": 5, ... }
For PreAuthorizedPayment, field "PaymentMethod" must be specified as "PreAuthorizedPayment", or 5.

PaymentMethodType

None.

AccountNumber

Token

string

None.

ExpirationDate

The expiration date for the credit card. Required.

string

Required

ZipCode

The billing zip code for the credit card.

string

None.

PaymentMethodType

What kind of card is passed in. Required.

CustomerPaymentMethodType

Required

CardNumberMasked

If the payment has a ProcessingType of Token then this value must be the format preserving masked PAN (e.g. 123456XXXXXX1234).

string

Max length: 200

PreAuthSessionId

The Transaction Reference ID returned from a Connected Payments Start PreAuth Session call. Required.

string

Required

PreAuthAuthorizationCode

The Transaction Authorization Code returned from a Connected Payments Start PreAuth Session call. Required.

string

Required

PreAuthAuditId

The Transaction Audit ID returned from a Connected Payments Start PreAuth Session call. Required.

integer

Required

SaveToken

Indicates if the customer wants to save this token.

boolean

None.

P2PECombo

Indicates which P2PE provider is used to apply payments when using tokens.

P2PEComboType

None.

Amount

How much is to be paid with this payment. This should match the amount pre-authorized amount during the CP iFrame session. Do NOT include TipAmount in Amount. For example if the order total is $12.00:

  • PreAuth Session = $15.00, then you must set Amount = $12.00 and TipAmount = $3.00
  • PreAuth Session = $12.00, then you must set Amount = $12.00 and either do not set TipAmount or set it to TipAmount = $0.00
  • Amount can't exceed order total.

decimal number

Required

TipAmount

Additional amount for the Tip.
This MUST match any tip added to the payment during the CP iFrame session. If you do not wish to pay extra tip, set TipAmount to 0, or do not provide TipAmount field at all. For payments with specified Amount, split charged amount between Amount and TipAmount, if you wish to 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.