String
2Checkout generates unique reference numbers for all orders (purchases). You can use this parameter to retry authorizations for orders with failed transactions by changing the payment method.
NULL when you place new orders.
| | `ChargebackResolution` |String
Chargeback status information. Possible values:
To manage chargeback notifications navigate to Control Panel Dashboard →Integrations → Webhooks and API, and click on the IPN settings tab.
In the General IPN Settings section, under Triggers, make sure to check the boxes next to the following options:
Also, check the checkbox next to the CHARGEBACK\_RESOLUTION parameter featured in the Response tags area.
| | `ChargebackReasonCode` |String
Identifier for the chargeback dispute reason from the 2Checkout system. Empty for orders with no chargeback dispute initiated.
Possible values:
String
The consecutive order number 2Checkout associates with orders and displays in the Order search area of your account.
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.
String
The status of the order:
String
The status of the order resulted from the evaluation by the 2Checkout anti-fraud system or by a member of the anti-fraud department. This status varies for new purchases and for orders requiring customers to make manual payments.
Possible values:
String
Shows if you approved or not a partner order. Possible values:
String
ISO 639-1 two-letter code. Language used for the purchase process. Example: “en.”
String
Y-m-d H:i:s (2014-05-22 00:12:12) The datetime stamp (in the API time zone defined in cPanel) when customers place their orders.
String
Y-m-d H:i:s (2014-05-22 00:12:12) The datetime stamp (in the API time zone defined in cPanel) when the order reach the Complete status.
NULL for order that did not reach the Complete/Finished stage.
| | `Source` |String
The link source for the sale. 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. Cannot be null.
| | `Affiliate` |Object
Details below.
String
The unique code of the affiliate who refer orders.
String
The link source for affiliate referred sales. Similar to the functionality of the SRC (separate link identifier) parameter included into Buy Links, but controlled by the AFFSRC parameter. Affiliates use the AFFSRC parameter to track sale sources for their referrals. Maximum length 255 characters.
String
Affiliate name.
String
Affiliate website URL from the Affiliate Details.
Boolean
true or false, depending on whether the order requires shipping.
Boolean
true or false, depending on whether product delivery has been completed.
Object
Details below.
String
Shopper name.
String
Shopper surname.
String
Shopper country. ISO 3166 two-letter code.
String
The state in the shopper's country. Mandatory when you set the Billing Country to US, Turkey, India and Romania. Use case insensitive utf8 strings for the full name, or just the two letter code.
String
Shopper city.
String
Shopper address.
String
Shopper address.
String
ZIP/ Postal code.
String
Shopper email address.
String
Shopper phone number. Mandatory when you set Brazil as the Billing Country. Can be NULL.
String
Company name. Can be null for end users. When present, you also need to provide the FiscalCode.
String
setPaymentDetails. When present, you also need to provide the Company name.Can be null for end users.
| | `DeliveryDetails` |Object
Optional. When missing, 2Checkout uses the same details as for the BillingDetails object.
Details below.
String
Shopper name from the delivery details.
String
Shopper surname from the delivery details.
String
Shopper country. ISO 3166 two-letter code from the delivery details.
String
The state in the shopper's country from the delivery details. Mandatory when you set the Billing Country to US, Turkey and Romania. Use case insensitive utf8 strings for the full name, or just the two letter code.
String
Shopper city from the delivery details.
String
Shopper address from the delivery details.
String
Shopper address from the delivery details.
String
ZIP/ Postal code from the delivery details.
String
Shopper email address from the delivery details.
String
Shopper phone number from the delivery details. Mandatory when you set Brazil as the Billing Country. Can be NULL.
String
Company name from the delivery details. Can be null for end users. When present, you also need to provide the FiscalCode.
Optional (object)
Adapt this object to the desired payment method.
String
The payment method:
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)). For payments with credit cards, PalPay Express, previous order reference and purchase order use the objects below.
For payments with check and wire, send only the ‘CHECH’ and ‘WIRE’ strings.
null for 0 value orders for which you’re not requiring customers to enter payment details.
| | `PaymentDetails.PaymentMethod.RecurringEnabled` |Boolean
true or false, depending on whether the shoppers checked the subscription auto-renewal checkbox or not, during the purchase process.
Optional (object)
Details below.
String
visa, visaelectron, mastercard, maestro, amex, discover, dankort, cartebleue, jcb, hipercard, elo
String
First four digits of the credit card.
String
Last four digits of the credit card.
Boolean
true or false, depending whether the order has active recurring options
String
URL to which customers are redirected after a successful 3DS process.
String
URL to which customers are redirected after a failed 3DS process.
Integer
Number of installments used for paying the order.
Optional (object)
Details below.
String
The beneficiary of the payment.
Can be NULL.
| | `PaymentDetails.PaymentMethod.CheckPaymentDetails.CheckPostalAddress` |String
The address of the beneficiary.
Can be NULL.
| | `PaymentDetails.PaymentMethod.CheckPaymentDetails.Amount` |Float
The total costs incurred by the customer for an order.
Can be NULL.
| | `PaymentDetails.PaymentMethod.CheckPaymentDetails.Currency` |String
The currency ISO code of the order/payment - ISO 4217.
Can be NULL.
| | `PaymentDetails.PaymentMethod.PayPalExpress` |Object
Details below.
String
Email address customers use for their PayPal account.
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 your buyer's browser after the buyer logs into PayPal and approves the payment. Typically, this is a secure page (https\://...) on your site.
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.
Object
Details below.
Float
The total costs customers incur.
Can be NULL.
| | `PaymentDetails.PaymentMethod.WirePaymentDetails.Currency` |String
The currency ISO code of the order - ISO 4217.
Can be NULL.
| | `PaymentDetails.PaymentMethod.WirePaymentDetails.PaymentReference` |String
Transaction identifier.
Can be NULL.
| | `PaymentDetails.PaymentMethod.WirePaymentDetails.RoutingNumber` |String
Identification number assigned to financial institutions.
Can be NULL.
| | `PaymentDetails.PaymentMethod.WirePaymentDetails.BankAccounts` |Optional (array of objects)
Details below.
String
The beneficiary of the payment.
Can be NULL.
| | `PaymentDetails.PaymentMethod.WirePaymentDetails.BankAccounts.BankName` |String
The name of the beneficiary's bank.
Can be NULL.
| | `PaymentDetails.PaymentMethod.WirePaymentDetails.BankAccounts.BankCountry` |String
The country of the beneficiary's bank.
Can be NULL.
| | `PaymentDetails.PaymentMethod.WirePaymentDetails.BankAccounts.BankCity` |String
The city of the beneficiary's bank.
Can be NULL.
| | `PaymentDetails.PaymentMethod.WirePaymentDetails.BankAccounts.BankAddress` |String
The address of the beneficiary's bank.
Can be NULL.
| | `PaymentDetails.PaymentMethod.WirePaymentDetails.BankAccounts.BankAccount` |String
The number for the account in which customers transfer the funds.
Can be NULL.
| | `PaymentDetails.PaymentMethod.WirePaymentDetails.BankAccounts.BankAccountIban` |String
The IBAN of the beneficiary's bank.
Can be NULL.
| | `PaymentDetails.PaymentMethod.WirePaymentDetails.BankAccounts.BankAccountSwiftCode` |String
The Swift Code of the beneficiary's bank.
Can be NULL.
| | `PaymentDetails.PaymentMethod.WirePaymentDetails.BankAccounts.Currency` |String
The currency ISO code for the bank account - ISO 4217.
Can be NULL.
| | `PaymentDetails.PaymentMethod.DIRECT_DEBIT_ACH` |Object
Details below.
String
Full name of the account holder.
String
Bank Routing number with fixed 9 digit length.
String
Account number consisting of up to 17 digits.
String
Possible values are "S" for SAVINGS accounts or "C" for CHECKING accounts.
String
Shopper IP.
Object
2Checkout populates the parameters of the customer entity with information from the customer whose AvangateCustomerReference or ExternalCustomerReference you send during the purchase.
Details Below.
Integer
System-generated 2Checkout customer reference. Aggregate subscriptions under the same Customer account if the products they're associated to are purchased by the same shopper by adding the AV\_CUSTOMERID (case sensitive) parameter to buy links. The 2Checkout system generates default customer numerical (integer) IDs (AV\_CUSTOMERID) automatically for all orders containing products that feature subscriptions.
String
The external customer reference you control. Aggregate subscriptions under the same Customer account if the products they're associated to are purchased by the same shopper by adding the CUSTOMERID (case sensitive) parameter to buy links.
String
Customer's first name.
String
Customer's last name.
String
Customer's country code (ISO 3166 two-letter code).
String
Customer's state. For example, "Alabama","Alaska","Arizona".
String
Customer's city.
String
Customer's address.
String
Customer's address.
String
Zip code.
String
Customer's email.
String
Customer's phone number.
String
Company name.
String
For companies, it needs to be the VAT ID. 2Checkout validates this values and throws an error if the VAT ID is invalid/incorrect. When present, you need to also provide Company name.
Can be null for end users.
| | `CustomerDetails.Fax` |String
Customer's fax number.
Boolean
true or false, depending on whether the customer account is active or inactive. An active customer account features at least one Active or Past due subscription.
Boolean
true or false, depending on whether the customer account features only trials or also paid subscriptions.
String
ISO 639-1 two-letter code. Example: “en.”
Array of objects
Details below.
Object
Populated only when you retrieve customer information by SSOToken.
String
Token for the EXISTING\_PAYMENT\_DATA flow. Use it to charge customers using cards they used in the past for purchases from your 2Checkout account.
String
visa, visaelectron, mastercard, maestro, amex, discover, dankort, cartebleue, jcb, hipercard, elo
String
Last four digits of the credit card.
String
Card expiration month.
String
Card expiration year.
String
Card holder name.
String
2Checkout automatically tracks the source of purchases:
Optional (Int)
2Checkout's commission for the order.
String
PURCHASE\_ORDER - Sent only when shoppers used Purchase Orders.
REGULAR - Sent in all other cases.
| | `GiftDetails` |Optional (object)
Contains contact details for the recipient of a gift purchase.
String
First name of gift recipient.
String
Last name of gift recipient.
String
Email of gift recipient. 2Checkout uses this email for the delivery/fulfillment process.
String
Custom text shoppers provide as a message to the gift recipient.
Object (optional)
Details below.
String
PO status. Possible values:
Boolean
TRUE or FALSE, depending on whether you set POs to auto-approve or not.
Boolean
TRUE or FALSE, depending on whether require document upload or not.
Integer
The term of net payment in days.
Boolean
TRUE or FALSE, depending on whether copy documents from previous order or not.
String
URL of Purchase Order form which needs to be printed, signed and uploaded.
String
Identifier that business customers use internally in their organization to track and manage Purchase Orders (PO). Can be NULL.
Optional (object)
Details below.
String
Can be:
1. The PO doc upload link - If you set AutoApprove as FALSE on the original order and before shoppers upload the PO.
2. Payment link for orders with POs. Business customers can use the PaymentLink to finalize payment for orders with POs. If you set AutoApprove as TRUE on the original order and if 2Checkout and you approve the PO.
| | `PaymentLink` |String
In scenarios in which an issue blocks the transaction from finalizing, 2Checkout provides a retry link where shopper can complete their purchase by providing new payment details.
String
Partner code you configured for your partner. NULL for eStore orders.
Float
Partner margin you set for the order. NULL for eStore orders.
Float
The percentage of the partner margin from the net value of the products ordered, minus the value of any discounts. NULL for eStore orders.
Float
Extra margin you offer by editing partner orders. NULL for eStore orders.
Float
The percentage of the extra partner margin from the net value of the products ordered, minus the partner margin and the value of any discounts. NULL for eStore orders.
Float
Extra discount you offer by editing partner orders. NULL for eStore orders.
Float
The percentage of the partner margin from the net value of the products ordered, minus the value of any coupon discounts. NULL for eStore orders.
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.
| | `TestOrder` |Boolean
True for test orders. False of regular orders.
Array of strings
Payment gateway processing errors.
Array of objects
Details below.
String
Product name.
String
Product short description.
Boolean
true or false, depending on product delivery type.
Boolean
Possible values:
String
The text entered in the Additional information field when generating Buy links, or via the INFO\[PRODUCT\_ID] parameter used in Buy links.
Boolean
Object
Details below
String
Possible values:
Object
Information related to the download file.
String
Delivery description.
String
Description of codes delivered.
Array of strings
Array with the codes delivered
String
Unique, system-generated subscription identifier.
String
The date time stamp when shoppers acquired their subscriptions corresponding to the moment when the 2Checkout system marks the purchase as finished. Format (YYYY-MM-DD HH:mm:ss). Default GMT+02:00.
e.g. 2015-08-11 15:18:52
| | `Items.ProductDetails.Subscriptions.SubscriptionStartDate` |String
Example: 2015-09-29 17:57:59
String
The date time stamp of upcoming renewal/expiration for subscriptions not taking into account grace period settings.
Format (YYYY-MM-DD HH:mm:ss). Default GMT+02:00.
e.g. 2015-09-11 15:18:52
| | `Items.ProductDetails.Subscriptions.Lifetime` |Boolean
Boolean
Boolean
Boolean
String
Unique, system-generated subscription identifier.
Array of strings
Array of price option codes.
String
Unique code that the 2Checkout system generates or that you set for each pricing options group.
Boolean
Array of strings
The code you set or that the 2Checkout system generates for each price option child inside a pricing options group parent.
Object
This object returns the price per unit at order line level.
In the case of trials, the object returns the costs for the trial to full subscription conversion.
| | `Items.Price.UnitNetPrice` |Float
The value per product unit, excluding sales tax/VAT expressed in the payment currency.
Float
Total value per product unit, including sales tax/VAT expressed in the payment currency. UnitGrossPrice does not reflect any discounts.
Float
Sales tax/VAT per product unit expressed in the payment currency.
Float
Value of the discount per product unit expressed in the payment currency.
Float
The value per product unit, expressed in the payment currency, excluding sales tax/VAT, from which 2Checkout deducts the unit discount.
Float
Total costs shoppers incur per product unit, expressed in the payment currency. This value includes sales tax/VAT, 2Checkout and affiliate commissions, but 2Checkout deducts the value of any discounts.
Float
Value of the affiliate commission per product unit calculated expressed in the payment currency.
2Checkout deducts discounts from the costs incurred by shoppers before calculating affiliate commissions.
2Checkout does not take into account shipping costs when calculating affiliate commissions.
NULL when 2Checkout does not apply an affiliate commission.
| | `Items.Price.Currency` |String
The currency ISO code for the payment - ISO 4217. Example: usd.
| | `Items.Price.NetPrice` |Float
The value per order line, excluding sales tax/VAT expressed in the payment currency.
Float
Total value per order line, including sales tax/VAT expressed in the payment currency. UnitGrossPrice does not reflect any discounts.
Float
The NetPrice value per order line (in the payment currency), excluding sales tax/VAT, from which 2Checkout deducts discounts.
Float
Total costs shoppers incur per order line, expressed in the payment currency. This value includes sales tax/VAT, 2Checkout and affiliate commissions, but 2Checkout deducts the value of any discounts.
Example:
Float
Value of the discounts per order line expressed in the payment currency.
Float
Value of sales tax/VAT per order line expressed in the payment currency.
Float
Value of the affiliate commission per order line, calculated from the NetDiscountedPrice expressed in the payment currency. Or NULL. 2Checkout does not take into account shipping costs when calculating affiliate commissions.
Integer
Percentage of the VAT/tax applied to the order.
Integer
Handling fee applied to the NET price configuration.
Integer
Handling fee applied to the GROSS price configuration.
String
System-generated reference for the product item.
String
Possible values:
String
Unique product identifier your control. Max length 256 characters.
Integer
Number of units
String
SKU identifier.
Object
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
Details below.
Integer
The length of the trial subscription lifetime in days.
Float
Total trial price in the payment currency before 2Checkout deducts any taxes, discounts, etc.
Float
The total value of taxes for the trial in the payment currency, before 2Checkout deducts any discounts.
Float
Total trial price in the payment currency, not including taxes, before 2Checkout deducts any discounts.
Array of objects
Details below.
String
The alpha-numeric characters, underscores and dashes that are set as the field identifier.
String
Field text visible to shoppers in the cart.
String
Selected field value.
Object
Details below.
String
Promotion name.
String
Promotion description.
String
The date when you set the promotion to start. NULL for promotions that start immediately after you create them.
String
The date when you set the promotion to end. NULL for promotions you want active indefinitely.
Integer
2Checkout only applies the promotion to a maximum number of orders you define.
Can be NULL if you want the promotion to apply to an unlimited number of orders.
| | `Items.Promotion.MaximumQuantity` |Integer
Discount only applies to a maximum number of units purchased through a single order, smaller than the quantity you defined. Shoppers purchase any extra units at full price. Can be NULL if you want the promotion to apply to an unlimited number units.
Boolean
The instant discount option auto-applies the discount for ALL selected products, without the need for shoppers to enter a discount coupon.
String
Promotion coupon/voucher.
String
Discounts can be set as a percentage from the product price or as a fixed amount in the chosen currency.
String
true or false, depending on whether a promotion is active or disabled.
String
Array of objects
Details below.
String
Promotion name.
String
Promotion description.
String
The date when you set the promotion to start. NULL for promotions that start immediately after you create them.
String
The date when you set the promotion to end. NULL for promotions you want active indefinitely.
Integer
2Checkout only applies the promotion to a maximum number of orders you define.
Can be NULL if you want the promotion to apply to an unlimited number of orders.
| | `Promotions.MaximumQuantity` |Integer
Discount only applies to a specific number of units purchased at once, smaller than the maximum quantity you defined. Shoppers purchase any extra units at full price. Can be NULL if you want the promotion to apply to an unlimited number units.
Boolean
The instant discount option auto-applies the discount for ALL selected products, without the need for shoppers to enter a discount coupon.
String
Promotion coupon/voucher.
String
Discounts can be set as a percentage from the product price or as a fixed amount in the payment currency.
String
true or false, depending on whether a promotion is active or disabled.
String
Array of objects
Details below.
String
The alpha-numeric characters, underscores and dashes that are set as the field identifier.
String
Field text visible to shoppers in the cart.
String
Selected field value.
String
The currency ISO code for the payment - ISO 4217. Example: usd.
Float
Order value excluding sales tax/VAT expressed in the payment currency.
Float
Total order value, including sales tax/VAT expressed in the payment currency. GrossPrice does not reflect any discounts.
Float
The NetPrice order value excluding sales tax/VAT, from which 2Checkout deducts discounts. NetDiscountedPrice is expressed in the payment currency.
Float
Total costs shoppers incur, expressed in the payment currency. This value includes sales tax/VAT, 2Checkout and affiliate commissions, but 2Checkout deducts the value of any discounts.
For example:
Float
Value of the discounts for an order expressed in the payment currency.
Float
Value of sales tax/VAT expressed in the payment currency.
Float
Value of the affiliate commission for the order calculated from the NetDiscountedPrice expressed in the payment currency. Or NULL. 2Checkout does not take into account shipping costs when calculating affiliate commissions.
Integer
Exchange rate used by 2Checkout for converting the order to your payout currency.
Integer
Exchange rate markup for the order.
String
The ISO code of your account's payout currency - ISO 4217.