Payment receipt email variables
Last updated: 15-Oct-2024
Rate this article:
Overview
Payment receipt shopper emails can be customized according to your own business needs. You can do so by using the variables in the list below. Check the 'Mandatory' column to see the variables that are required in your customized version of the e-mail.
| Variable name | Description | Test value | Mandatory |
|---|---|---|---|
| ADDRESS1 | The first section of the delivery address | 123, Main Street | No |
| ADDRESS1_D | The first section of the delivery address | 123, Main Street | No |
| ADDRESS2 | The second section of the delivery address | 0 | No |
| ADDRESS2_D | The second section of the delivery address | 0 | No |
| ALLOW_MYACCOUNT_PROMO | Include or exclude myAccount information in the email body | 1 | No |
| APPROVAL | Issuer (bank) payment identifier. | AU1234 | No |
| AUTO_RENEWAL | Indicates whether or not the shopper has enabled automatic renewal on the subscription | 1 | No |
| 2CHECKOUT_COMPANY_NAME | 2Checkout company name | 2Checkout | No |
| AVS_MATCH | Gateway AVS | Z | No |
| 2CHECKOUT_LOGO | 2Checkout logo URL | https://secure.2checkout.com/images/e...endor_logo.png | Yes |
| 2CHECKOUT_ON_BANK_STATEMENT_SPECIFIC | This is mandatory content you need to keep in your emails, given 2Checkout acts as Reseller / Merchant of Record for online purchases on your website. | The charge on your bank statement will appear as 2Checkout. | Yes |
| BANK_STATEMENT | Account statement descriptor | 2checkout*Software Inc | No |
| BANK_STATEMENT_DESCRIPTOR | Account statement descriptor | 2checkout*Software Inc | No |
| BASE_URL | Merchant's full host | https://secure.2checkout.com | No |
| BUSINESS_COMPANY | 2Checkout company name | 2Checkout | No |
| BUSINESS_HOTLINE | 2Checkout support phone | 0 | No |
| BUSINESS_HOTLINEUS | 2Checkout US hotline number | 0 | No |
| BUSINESS_SUPEMAIL | 2Checkout support email address | support@2checkout.com | No |
| BUSINESS_WEBSITE | 2Checkout website | http://www.2Checkout.com | No |
| CARD_LAST_DIGITS | Last 4 digits of the card used to perform the payment | 1111 | No |
| CBANKACCOUNT | Shopper's bank account used on the billing information | 0 | No |
| CBANKNAME | Shopper's bank name used on the billing information | 0 | No |
| CITY | Shopper's city used on the billing information | Anytown | No |
| CITY_D | Shopper's city used on the delivery information | Anytown | |
| COMMERCIALNAME | Merchant's commercial name | Software Company Name | No |
| COMPANY | Shopper company name used on the delivery information. If no delivery information is available, no company name is displayed. | Customer company | No |
| COMPANY_D | Shopper company name used on the delivery information. If no delivery information is available, no company name is displayed. | Customer company | No |
| COUNTRY | Shopper's country used on the billing information | France | No |
| COUNTRY_D | Shopper's country used on the delivery information | U.S.A | No |
| CURRENCY | Order billing currency | USD | Yes |
| CURRENCY_ORIGINAL | Original order currency (applicable to refunds) | 0 | No |
| CUSTOMEREMAIL | Shopper's email address used on the billing information | example@customer-email.com | No |
| CVV2_MATCH | Gateway CVV2 check response | M | No |
| DELIVERABILITY | Order delivery status | 0 | No |
| DELIVRABILITY | The delivery status of the loaded order | 0 | No |
| DISPLAY_MY_ACCOUNT_INFO | Include or exclude myAccount information in the email body | 1 | No |
| ENCRYPTED_MERCHANT_CODE | Encrypted merchant code | 0 | No |
| FIRSTNAME | Shopper's first name used on the delivery information | John | No |
| FIRSTNAME_D | Shopper's first name used on the delivery information | John | No |
| FIRST_NAME_BILLING | Shopper's first name used on the billing information | John | Yes |
| FIRST_NAME_DELIVERY | Shopper's first name used on the delivery information | John | No |
| FISCALCODE | Shopper's fiscal code used on the billing information | 0 | No |
| FISCAL_CODE | Shopper's fiscal code used on the billing information | 0 | No |
| GATEWAY_ERROR_CODE | Gateway error code | GW_PROCESSING_ERROR See the full list of Possible Values |
No |
| GATEWAY_ERROR_MESSAGE | Reason why the transaction failed. (e.g. Invalid card, insufficient funds) | Error processing the card transaction. The card account has not been debited. Card data is invalid or incomplete. | No |
| GENERALTOTAL | Total order price | 79 | No |
| GLOBALDISCOUNT | Order total discount | 3 | No |
| HAS_RENEWAL_PRODUCTS | Flag that indicates whether at least one product has renewal settings | 0 | No |
| HOTLINE_NUMBERS | Array of attributes for 2Checkout hotline numbers | 0 | No |
| HOTLINE_NUMBERS.NG_PHONE[index1].HotlineName | Countries where 2Checkout support information is available | USA/Canada | No |
| HOTLINE_NUMBERS.NG_PHONE[index1].HotlineValue | 2Checkout phone number(s) for shopper support | +1 (650) 963-5701 | No |
| INT_REF | Global Collect internal reference | 123456789 | No |
| IS_RENEWAL | Flag that indicates whether at least one product has renewal settings | 0 | No |
| LANGUAGE | Order language (abbreviated) selected by shopper | 0 | No |
| LASTNAME | Shopper's last name used on the delivery information | Doe | No |
| LASTNAME_D | Shopper's last name used on the delivery information | Doe | No |
| LAST_NAME_BILLING | Shopper's last name used on the billing information | Doe | Yes |
| LAST_NAME_DELIVERY | Shopper's last name used on the delivery information | Doe | No |
| MERCHANT_COMMERCIAL_NAME | Merchant's commercial name | Software Company Name | No |
| MERCHANT_COMPANY | Merchant's company name | 0 | No |
| MERCHANT_ID | Seller ID | 0 | No |
| MERCHANT_SUPPORT_EMAIL | Merchant support email address | merchant@email.com | No |
| MERCHANT_SUPPORT_PHONE | Merchant support phone number | 123 456 789 0 | No |
| MY_ACCOUNT_LOGIN_EMAIL | Email address used by shopper to login/signup to myAccount | customer@email.com | No |
| MY_ACCOUNT_LOGIN_TOKEN | Token assigned to the shopper in order to access myAccount | 0 | No |
| MY_ACCOUNT_LOGIN_URL | 2Checkout myAccount login/sign-up URL | Signup / Login | Yes |
| MY_ACCOUNT_URL | URL for myAccount. To the BASE_URL we add /myaccount/ | 0 | No |
| NAMES_OF_PRODUCTS | Names of all products in the order, comma separated | 0 | No |
| ORDERDATE | Order placement date | 41970.18889 | No |
| ORDER_AMOUNT | Total order price | 79 | Yes |
| ORDER_AMOUNT_ORIGINAL | Original order value (applicable to refunds) | 0 | No |
| ORDER_DATE | Order placement date | 42563 | Yes |
| ORDER_DATE_STANDARD_FORMAT | Standard format used for the order placement date | 0 | No |
| ORDER_FLOW | Purchase flow used to place the order | 0 | No |
| ORDER_REFERENCE_NUMBER | Order reference number | 9xxxxxx | Yes |
| ORDER_STATUS | Order status | 0 | No |
| ORDER_WEBSITE | Website where the shopper placed the order | http://www.software-company-website.com | Yes |
| PAYMENT_METHOD | English name for the payment method used | Visa/MasterCard/Eurocard | Yes |
| PAYMENT_TYPE_INFO | English payment method name. Includes last four card digits (if applicable). | 0 | No |
| PAYTYPE | Identification number for the payment method selected during ordering process | 1 | No |
| PAYTYPESTR | English name for the payment method used | Visa/MasterCard/Eurocard | No |
| PAY_TYPE | Identification number for the payment method selected during ordering process | 1 | No |
| PHONE | Shopper's phone number used on the billing information | 0 | No |
| PHONE_D | Shopper's phone number used on the delivery information | 555-555-555 | No |
| PRODUCT_ADDITIONAL_FIELDS_TEXT | Additional field text set at product level. | Additional text set on the product. | No |
| PRODUCT_ADDITIONAL_FIELDS_VALUE | Additional field value set at product level. | Sample value | No |
| PRODUCTS | Products data. | 0 | No |
| PRODUCTS[index1].CODE | Product code. | P_CODE | No |
| PRODUCTS[index1].DISCOUNT | Product discount value per product line | 2 | No |
| PRODUCTS[index1].ID | Product ID number | 4572518 | No |
| PRODUCTS[index1].INFO | Additional product information defined by merchant when generating buy links | Product info 1 | No |
| PRODUCTS[index1].IS_TRIAL | Indicates whether this is a trial product | 1 | No |
| PRODUCTS[index1].LICENSE_TYPE | Type of purchased subscription | RENEWAL | No |
| PRODUCTS[index1].NAME | Product name | Installation Service | No |
| PRODUCTS[index1].PCODE | Product code. | P_CODE_1 | No |
| PRODUCTS[index1].PID | Product ID number | 4572518 | No |
| PRODUCTS[index1].PNAME | Product name | Installation Service | No |
| PRODUCTS[index1].PRICE | Product unit price | 20 | No |
| PRODUCTS[index1].PRODUCT_OPTIONS | Product pricing options configured in the 2Checkout Merchant Control Panel | 0 | No |
| PRODUCTS[index1].PRODUCT_OPTIONS[index2].OptionText | Ignore internal var. | 0 | No |
| PRODUCTS[index1].PROMONAME | Name of the promotion applied to the product | Some promotion | No |
| PRODUCTS[index1].QUANTITY | Purchased product quantity | 2 | No |
| PRODUCTS[index1].SKU | Product SKU | SKU1234 | No |
| PRODUCTS[index1].SHORT_DESCRIPTION | Short product description | 0 | No |
| PRODUCTS[index1].TOTAL | Total gross price per product line (before applying discounts) | 40 | No |
| PRODUCTS[index1].TOTAL_PRICE | Total net price per product line (before applying discounts) | 40 | No |
| PRODUCTS[index1].TRIAL_PERIOD | Product trial period. | 7 | No |
| PRODUCTS[index1].UNIT_PRICE | Product unit price | 20 | No |
| PRODUCTS[index1].VAT | VAT/Sales tax value per product line | 3.8 | No |
| PRODUCTS_DATA[index1].IdProduct | Product ID number | 0 | No |
| PRODUCTS_DATA[index1].PRODUCT_SHORT_DESCRIPTION | Short product description | 0 | No |
| PRODUCTS_NO | Number of products in cart | 0 | No |
| REFERENCE_NUMBER_EXTERNAL | External order reference (can be added by the merchant as buy link parameter) | 0 | No |
| REFNO | Order reference number | 9xxxxxx | No |
| REFNOEXT | External order reference (can be added by the merchant as buy link parameter) | 0 | No |
| REGISTRATIONNUMBER | Shopper's registration number used on the billing information | 0 | No |
| REGISTRATION_NUMBER | Shopper's registration number used on the billing information | 0 | No |
| RETRYLINK | Payment retry link | 0 | No |
| RETRY_LINK | Payment retry link | 0 | No |
| SELLERCOMPANY | Merchant's company name | 0 | No |
| SELLERID | Seller ID | 0 | No |
| SHIPPING | Shipping fee amount | 2 | No |
| SHIPPING_FEE | Shipping fee amount | 2 | No |
| SHOPPER_ADDRESS_1_BILLING | First section of the billing address | 123, Main Street | No |
| SHOPPER_ADDRESS_1_DELIVERY | First section of the delivery address | 123, Main Street | No |
| SHOPPER_ADDRESS_2_BILLING | Second section of the billing address | 0 | No |
| SHOPPER_ADDRESS_2_DELIVERY | Second section of the delivery address | 0 | No |
| SHOPPER_BANK_ACCOUNT | Shopper's bank account used on the billing information | 0 | No |
| SHOPPER_BANK_NAME | Shopper's bank name used on the billing information | 0 | No |
| SHOPPER_CITY_BILLING | Shopper's city used on the billing information | Anytown | No |
| SHOPPER_CITY_DELIVERY | Shopper's city used on the delivery information | Anytown | No |
| SHOPPER_COMPANY_BILLING | Shopper's company name used on the billing information | Customer company | No |
| SHOPPER_COMPANY_DELIVERY | Shopper company name used on the delivery information. If no delivery information is available. no company name is displayed. | Customer company | No |
| SHOPPER_COUNTRY_BILLING | Shopper's country used on the billing information | U.S.A | No |
| SHOPPER_COUNTRY_DELIVERY | Shopper's country used on the delivery information | U.S.A | No |
| SHOPPER_EMAIL_ADDRESS_BILLING | Shopper's email address used on the billing information | example@customer-email.com | No |
| SHOPPER_PHONE_BILLING | Shopper's phone number used on the billing information | 0 | No |
| SHOPPER_PHONE_DELIVERY | Shopper's phone number used on the delivery information | 555-555-555 | No |
| SHOPPER_STATE_BILLING | Shopper's state used on the billing information | Anystate | No |
| SHOPPER_STATE_DELIVERY | Shopper's state used on the delivery information | Anystate | No |
| SHOPPER_ZIP_CODE_BILLING | Shopper's ZIP code used on the billing information | 12345 | No |
| SHOPPER_ZIP_CODE_DELIVERY | Shopper's ZIP code used on the delivery information | 12345 | No |
| STATE | Shopper's state used on the billing information | Anystate | No |
| STATE_D | Shopper's state used on the delivery information | Anystate | No |
| SUBTOTAL | The order amount without vat and shipping | 79 | No |
| SUPPORTEMAIL | Merchant support email address | 0 | No |
| SUPPORTPHONE | Merchant support phone number | 0 | No |
| TECHEMAIL | Merchant support email address | 0 | No |
| TECHPHONE | Merchant support phone number | 0 | No |
| TOTALEQUIV | Order amount converted in all vendor currencies | 0 | No |
| TOTAL_DISCOUNT | Total order discount | 3 | No |
| TOTAL_VAT | Total order VAT | 0 | No |
| UPLOADLINK | File upload link | 0 | No |
| UPLOAD_LINK | File upload link | 0 | No |
| USER_EMAIL | Email address used by shopper to login/signup to myAccount | example@customer-email.com | No |
| USER_TOKEN | Shopper token for 2Checkout myAccount access | 0 | No |
| VALIDATION_CODE | Global Collect validation code | VA0122 | No |
| WEBSITE | Website where the shopper placed the order | http://www.software-company-website.com | No |
| ZIPCODE | Shopper's ZIP code used on the billing information | 12345 | No |
| ZIPCODE_D | Shopper's ZIP code used on the delivery information | 12345 | No |
Related articles
Rate this article:
