Name | Description | Type | Additional information |
---|---|---|---|
PaymentMethod |
Required to tell the system how the user is going to pay for the order.
{
"PaymentMethod": "ClearCreditCardPayment",
...
} or with number:
{
"PaymentMethod": 1,
...
}
For ClearCreditCardPayment, field "PaymentMethod" must be
specified as "ClearCreditCardPayment", or 1.
|
PaymentMethodType |
None. |
AccountNumber |
Credit card number, token or braintree nonce. |
string |
None. |
ExpirationDate |
The expiration date for the credit card. Required. |
string |
Required |
SecurityCode |
The security code for the credit card. This field is required if company setting MobileCvvEnabled is set to true. |
string |
None. |
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 |
ProcessingType |
Indicates if the AccountNumber should be
processed as a credit card or tokenized payment.
|
ProcessingType |
None. |
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. |
DeviceData |
Device data, from which are transaction provided for preventing possible frauds. Used for Braintree provider. |
string |
None. |
Amount |
How much is to be paid with this payment.
|
decimal number |
None. |
TipAmount |
Additional amount for the Tip.
For payments without specified Amount (or Amount set to 0), provide only extra 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.
|
integer |
None. |
SessionKey |
If using FreedomPay, the session key for the transaction |
string |
None. |
PaymentKey |
If using FreedomPay, the payment key for the transaction |
string |
None. |
CreateToken |
set to True if you want to create a token during payment |
boolean |
None. |
CardHolderName |
The cardholder's name, needed for FreedomPay |
string |
None. |
BillingInfo |
Billing information, needed for FreedomPay 3DS |
BillingInfo |
None. |