In addition to the payment methods enumerated above, 2Checkout also supports 1-click purchase flows in which you use valid previous order references belonging to returning customers to pay for new orders with their previously used cards and PayPal accounts.
| Parameter | Type / Description |
|---|---|
Vendor3DSReturnURL | Required (string) URL address to which customers are redirected after the 3DS details get validated by the bank and the order is successfully authorized. |
Vendor3DSCancelURL | Required (string) URL address to which customers are redirected if the 3DS details were not validated or the order could not be authorized. |
WSOrder | Optional (String) The WSOrder parameter is used to control the website URL displayed in the email messages shoppers receive after they place an order. By default, 2Checkout reports the URL set as Homepage in the Account information area. Adding WSOrder to the buy-links for your products will cause the optional website address set by using the parameter to override and replace the Homepage URL in the email notifications sent to customers. The behavior is similar to the WS_ORDER parameter supported on checkout/cart pages and described here. |
Optional (string)
The currency ISO code for the payment - ISO 4217. Example: “usd.”
Optional (string)
Shopper country. ISO 3166 two-letter code. Example: “us.”
Optional (string)
ISO 639-1 two-letter code. The language used for the purchase process. Example: “en.”
Optional (string)
Set external reference identifiers for orders. Enables you to replicate the functionality of the REF parameter included into Buy Links. Maximum 100 characters. If there is a need for longer references, you can apply an md5 hash for any string value, resulting in a 32 characters string. You can verify the hash after the order notification, on the client side.
Optional (string)
The link source for the sales. Enables you to replicate the functionality of the SRC (separate link identifier) parameter when included into Buy Links. Use the SRC parameter to track sale sources.
Maximum length 255 characters.
| | `CustomerReference` |Optional (integer)
Set an external customer ID, attached to the customer.
Required (string)
The affiliate unique code (as returned by the affiliates API methods).
Optional (string)
The affiliate source.
Required (array of objects)
Details below.
Object
Details below.
Mandatory (string)
Unique product identifier your control. Max length 256 characters. Only for catalog products.
Optional (integer)
Number of units
Optional (array of strings)
Array of price option codes.
Optional (string)
SKU identifier.
Object - Can be NULL
If Price Type is set to 'CUSTOM', dynamic pricing can be added to the order via the Amount parameter.
| | `Items.OrderItem.CrossSell` |Object – Can be NULL
Details below.
String
The product code of the master product you set to trigger the campaign.
String
Unique, system-generated identifier for cross-sell campaigns.
Object – Can be NULL
Details below.
Integer
The length of the trial subscription lifetime in days.
Double / Optional
Total trial price in the payment currency before 2Checkout deducts any taxes, discounts, etc.
String
The alpha-numeric characters, underscores and dashes that are set as the field identifier.
String
Selected field value.
String
Specify the date time stamp when the subscription becomes active. Format 2016-07-02 22:22:22 (YYYY-MM-DD HH:mm:ss). Available for JSON-RPC and REST.
Send empty or NULL to activate subscriptions on the same date when customers purchase them.
You can exclude HH:mm:ss when sending the date and include only YYYY-MM-DD. In this case, 2Checkout uses 00:00:01. Default time zone GMT+02:00.
| | `Items.OrderItem.SubscriptionCustomSettings` |Optional (object)
To use this, the ExtraInformation object with AssistedSale property set to "true" is required.
Required (string)
Billing cycle unit NET/GROSS.
Required (string)
DAY/MONTH. Can be NULL.
Required (float)
Billing cycle (renewal) price.
Required (integer)
Billing cycle length. Can be NULL.
Optional (integer)
Contract period length (expressed in the specified CycleUnit; must be multiple of CycleLength). Can be NULL.
Optional (boolean)
Merchant deal auto-renewal flag.
Optional (boolean)
Client deal auto-renewal flag.
Required (object)
Details below.
Required (string)
Shopper name.
Required (string)
Shopper surname.
Required (string)
Shopper country. ISO 3166 two-letter code.
Optional (string)
Required for US, Canada, Brazil, Turkey, India and Romania
The state in the shopper's country. Mandatory when you set the Billing Country to US, Canada, Brazil, Turkey, India and Romania. Use case insensitive utf8 strings for the full name, or just the two letter code.
Required (string)
Shopper city.
Required (string)
Shopper address.
Optional (string)
Shopper address.
Required (string)
ZIP/ Postal code.
Required (string)
Shopper email address.
Optional (string)
Shopper phone number. Mandatory when you set Brazil as the Billing Country. Can be NULL.
Optional (string)
Company name. Can be null for end users. When present, you also need to provide the FiscalCode.
Optional (string) – Required for Brazil
Optional (string)
Tax Exempt Certification id used to deduct taxes for US orders
Example: 1b80eecc349v
Required (object)
Details below.
Required (string)
Shopper name from the delivery details.
Required (string)
Shopper surname from the delivery details.
Required (string)
Shopper country. ISO 3166 two-letter code from the delivery details.
Optional (string) – Required for the US, Canada, Brazil, Turkey, India, and Romania
The state in the shopper's country. Mandatory when you set the Billing Country to US, Canada, Brazil, Turkey, India, and Romania. Use case insensitive utf8 strings for the full name, or just the two-letter code.
Optional (string)
Shopper city from the delivery details.
Optional (string)
Shopper address from the delivery details.
Optional (string)
Shopper address from the delivery details.
Optional (string)
ZIP/ Postal code from the delivery details.
Optional (string)
Shopper email address from the delivery details.
Optional (string)
Shopper phone number from the delivery details. Mandatory when you set Brazil as the Billing Country. Can be NULL.
Optional (string)
Company name from the delivery details. Can be null for end users. When present, you also need to provide the FiscalCode.
Optional (object)
For products that require physical delivery, use this object to send the shipping method.
| | `DeliveryInformation.ShippingMethod` |Object
Details below
| | `DeliveryInformation.ShippingMethod.Code` |String
System-generated identified for your shipping method configuration
Required (object)
Adapt this object to the desired payment method.
Required (string)
The payment method:
Required (string)
The currency ISO code for the payment - ISO 4217. Example: “usd.”
Optional (object)
Object structure and parameters differ according to payment method selected and API method (placing orders (POST) vs. retrieving order data (GET)).
NULL for 0 value orders for which you’re not requiring customers to enter payment details.
| | `PaymentDetails.PaymentMethod.RecurringEnabled` |Optional (boolean)
true – shopper checks the auto-renewal checkbox and 2Checkout charges subscription renewals using a recurring billing process.
false – shopper doesn’t check the auto-renewal checkbox.
| | `PaymentDetails.PaymentMethod.CardPayment` |Optional (object)
Details below.
Required (string)
The credit/debit card number.
Required (string)
visa, visaelectron, mastercard, maestro, amex, discover, dankort, cartebleue, jcb, hipercard, elo
Required (string)
The year in which the card expires.
Required (string)
The month in which the card expires.
Required (string)
Cardholder name.
Required (string)
Credit Card Identification - an extra ID printed on the card, usually a 3-4 digit number, the CVC2/CVV2.
Required (string)
URL address to which customers are redirected after the 3DS details get validated by the bank and the order is successfully authorized.
Required (string)
URL address to which customers are redirected if the 3DS details were not validated or the order could not be authorized.
Optional (float)
The interval of time in seconds in which shoppers enter their name in the HolderName field. An abnormally short interval is usually a red flag for fraud attempts.
Can be NULL, but not a negative number.
| | `PaymentDetails.PaymentMethod.CardPayment.CardNumberTime` |Optional (float)
The interval of time in seconds in which shopper enters their card number in the CardNumber field. An abnormally short interval is usually a red flag for fraud attempts.
Can be NULL, but not a negative number.
| | `PaymentDetails.PaymentMethod.CardPayment.InstallmentsNumber` |Optional (Int)
Number of installments. Available only when customers un Brazil pay with Visa or MasterCard using Brazilian Real as the order currency. Use 1 or exclude the parameter for full payments.
Optional (object)
Details below.
Optional (string)
Email address customers use for their PayPal account.
Optional (string)
The PayPal Express Checkout redirect URL returned by calling the getPayPalExpressCheckoutRedirectURL method. The return URL is the page on your website to which PayPal redirects yourbuyer's browser after the buyer logs into PayPal and approves the payment. Typically, this is a secure page (https\://...) on your site.
Optional (string)
The cancel URL is the page on your website to which PayPal redirects your buyer's browser if the buyer does not approve the payment. Typically, this is the secure page (https\://...) on your site from which you redirected the buyer to PayPal.
Optional (string) |
|
The funding source is the buyer's source for the payment. Values can be "Standard", where the buyer's funding source is the regular one in their PayPal account, or "Credit", where the buyer's funding source is a credit line in their PayPal account.
Optional (Object)
Details below.
Optional (string)
Order reference a previous purchase that reached the Approved/Complete status. You can use orders for which customers paid with credit/debit cards or with PayPal. The status of orders should be AUTHRECEIVED or COMPLETE.
Check the validity of references with the isValidOrderReference method.
The 2Checkout system blocks you from using references for fraudulent or potentially fraudulent orders.
| | `PaymentDetails.PaymentMethod.PurchaseOrderPaymentDetails` |Optional (Object)
Details below.
Optional (string)
Identifier that business customers use internally in their organization to track and manage Purchase Orders (PO). Can be NULL.
Optional (boolean)
Can be NULL.
| | `PaymentDetails.PaymentMethod.WE_CHAT_PAY` |Optional (string)
Details below
Optional (string)
The return URL is the page to which your customers are redirected after their successful payment.
Optional (string)
The cancel URL is the page to which your customers are redirected after their failed payment attempt.
Optional (string)
Details below
Optional (string)
The return URL is the page to which your customers are redirected after their successful payment.
Optional (string)
The cancel URL is the page to which your customers are redirected after their failed payment attempt.
Required (string)
String contains the SWIFT code of the bank, the plus sign "+", and the first 3 characters from the bank name. E.q.: in the case of Rabobank, code parameter is "RABONL2U+RAB".
Optional (Object)
By using EXISTING\_PAYMENT\_DAT you no longer require shoppers to enter any payment details.
Optional (string)
Returned as a part of the process of retrieving customer information by SSOToken.
Optional (string)
Details below.
Optional (string)
The return URL is the page to which your customers are redirected after their successful payment. The return URL is the page to which your customers are redirected after their successful payment.
Optional (object)
Details below.
Optional (string)
Full name of the account holder.
Optional (string)
Bank Routing number consisting of up to 17 digits.
Optional (string)
Account number with fixed 9 digit length.
Optional (string)
Possible values are "S" for SAVINGS accounts or "C" for CHECKING accounts.
Optional (string)
Shopper IP.
Optional (Array of strings)
Array of promotion codes.
Optional (object)
Details below.
Optional (string)
The alpha-numeric characters, underscores, and dashes that are set as the field identifier.
Optional (string)
Field text visible to shoppers in the cart.
Optional (string)
Selected field value.
Optional (string)
Local shopper time in the following format: Y-m-d H:i:s.
This parameter can impact the fraud score of an order when it's missing, NULL or incorrectly formatted.
| | `GiftDetails` |Optional (object)
Contains contact details for the recipient of a gift purchase.
Optional (string)
First name of gift recipient.
Optional (string)
Last name of gift recipient.
Optional (string)
Email of gift recipient. 2Checkout uses this email for the delivery/fulfillment process.
Optional (string)
Custom text shoppers provide as a message to the gift recipient.
| Parameter | Type / Description |
|---|---|
Order information | Object Object containing order information. |