Name | Description | Type | Additional information |
---|---|---|---|
PaymentMethod |
Required to tell the system how the user is going to pay for the order.
{
"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:
|
decimal number |
Required |
TipAmount |
Additional amount for the 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.
|
integer |
None. |