Processors That Require Additional Transaction Parameters
Additional parameters are those required by individual processors beyond the core parameters. Parameters are organized alphabetically by processor.
- American Express Additional Credit Card Parameters
- Merchant e-Solutions (Cielo Payments) - Additional Credit Card Parameters
- Elavon Additional Credit Card Parameters
- FISERV Nashville - Additional Credit Card Parameters
- FISERV North - Additional Credit Card Parameters
- Heartland - Additional Credit Card Parameters
- Litle Additional Credit Card Parameters
- Paymentech Salem New Hampshire Additional Credit Card Parameters for American Express
- PayPal Credit Card Transaction Request Parameters
- TSYS Additional Credit Card Parameters
- Vantiv Additional Credit Card Parameters
- WorldPay Additional Credit Card Parameters
American Express Additional Credit Card Parameters
In addition to the core credit card parameters, American Express accepts the parameters described below to meet AMEX reporting and statement requirements.
PayPal recommends that you include these parameters if you would like to impact what appears on AMEX statements and reports.
Note: The PayPal processor does not support
SWIPE(card-present) transactions.
Retail Transaction Advice Addendum for SWIPE Transactions
| Field | Description |
|---|---|
L_DESCn | (Optional) Description of this line-item (n is a line item number from 1 to 6). Character length and limitations: 19 alphanumeric characters |
L_AMTn | (Optional) Amount of this line-item (n is a line item number from 1 to 6). Character length and limitations: Must include a decimal and be exact to the cent ( 42.00, not 42) and exclude comma separators (1234.56 not 1,234.56). 12 numeric characters |
L_QTYn | (Optional) Quantity of this line-item (n is a line item number from 1 to 6). Character length and limitations: 3 numeric characters |
Internet Transaction Data
| Field | Description |
|---|---|
BILLTOEMAIL | (Optional) Account holder's email address. Character length and limitations: 60 alphanumeric characters |
BILLTOPHONENUM | (Optional) Account holder's telephone number. Character length and limitations: 10 characters |
PHONETYPE | (Optional) Telephone company provided ANI information identifier digits indicating the telephone call type. Examples: cellular (61-63), pay phone (27) Character length and limitations: 2 characters |
CUSTHOSTNAME | (Optional) Name of the server that the account holder is connected to. Example: PHX.QW.AOL.COM.Character length and limitations: 60 alphanumeric and special characters |
CUSTBROWSER | (Optional) Name of the server that the account holder is connected to. Example: MOZILLA/4.0~(COMPATIBLE;~MSIE~5.0;~WINDOWS~95) Character length and limitations: 60 alphanumeric and special characters |
CUSTIP | (Optional) Account holder's IP address. Character length and limitations: 15 alphanumeric and special characters |
SHIPTOCOUNTRY | (Optional) Numeric country code of ship-to country. Example: USA would be 840. The Payflow API accepts 3-digit numeric country codes. Refer to ISO 3166-1 numeric. Character length and limitations: 3 characters |
SHIPMETHOD | (Optional) Shipping method code. The values are: - 01 = Same day- 02 = Overnight/next day- 03 = Priority, 2 - 3 days- 04 = Ground, 4 or more days- 05 = Electronic delivery- 06 - ZZ = Reserved for future use |
SKU | (Optional) Merchant product SKU. Character length and limitations: 15 alphanumeric characters |
Address Verification Service Parameters
| Field | Description |
|---|---|
BILLTOSTREET | (Optional) Account holder's street address (number and street name). Character length and limitations: 30 characters |
BILLTOZIP | (Optional) Account holder's 5- to 9-digit ZIP (postal) code excluding spaces, dashes, and non-numeric characters. Example: 951121737Character length and limitations: 9 characters |
BILLTOPHONENUM | (Optional) Account holder's telephone number. The formats are: - xxx-xxx-xxxx (US numbers) - +xxxxxxxxxxx (international numbers) Character length and limitations: 10 characters |
SHIPTOFIRSTNAME | (Optional) First name in the shipping address. Character length and limitations: 30 characters |
SHIPTOLASTNAME | (Optional) Last name in the shipping address. Character length and limitations: 30 characters |
SHIPTOSTREET | (Optional) Shipping street address. Character length and limitations: 30 characters |
SHIPTOCOUNTRY | (Optional) Numeric country code of ship-to country. Example: USA would be 840. The Payflow API accepts 3-digit numeric country codes. Refer to ISO 3166-1 numeric.Character length and limitations: 3 alphanumeric characters |
SHIPTOZIP | (Optional) Shipping 5- to 9-digit zip (postal) code excluding spaces, dashes, and non-numeric characters. Example: 951121737Character length and limitations: 9 alphanumeric characters |
SHIPTOPHONENUM | (Optional) Shipping telephone number. Character length and limitations: 10 alphanumeric characters |
Location Transaction Advice Addendum Parameters
| Field | Description |
|---|---|
MERCHANTNAME | (Optional) Name of merchant. Character length and limitations: 38 alphanumeric characters |
MERCHANTSTREET | (Optional) Merchant's street address (number and street name). Character length and limitations: 38 alphanumeric characters. If more than 38 characters, use proper and meaningful abbreviation. Do not truncate. |
MERCHANTCITY | (Optional) The name of the city were the transaction took place. - If you are a third-party biller (bill for services or goods rendered by another entity), you must enter the name of the city in which the seller is located. - If you are a mail order, phone order, or internet industry, you may substitute the name of the city in which the merchant's order processing facility is located. Character length and limitations: 21 alphanumeric characters. If more than 21 characters, use proper and meaningful abbreviation. Do not truncate. |
MERCHANTSTATE | (Optional) The region code that corresponds to the state, province, or country subdivision of the merchant location where the transaction took place. Region code examples: - CA = California, USA- NS = Nova Scotia, Canada- COS = Colima MexicoIf you are a third-party biller (bill for services or goods rendered by another entity), you must enter the region code that corresponds to the state, province, or country subdivision in which the seller is located. Character length and limitations: 3 alphanumeric characters |
MERCHANTZIP | (Optional) The 5- to 9-digit zip (postal) code excluding spaces, dashes, and non-numeric characters where the transaction took place. If you are a third-party biller (bill for services or goods rendered by another entity), you must enter the postal code that corresponds to the seller's location. Character length and limitations: 15 alphanumeric characters |
MERCHANTCOUNTRYCODE | (Optional) Country code of the location where the transaction took place. The Payflow API accepts 3-digit numeric country codes. Refer to ISO 3166-1 numeric. Character length and limitations: 3-character country code. |
MERCHANTLOCATIONID | (Optional) Merchant-assigned store or location number (or name) that uniquely identifies where the transaction took place. Character length and limitations: 15 alphanumeric characters |
MERCHANTID | (Required) American Express-assigned service establishment number used to identify and facilitate payments to merchants. Character length and limitations: 15 alphanumeric characters. |
MERCHANTCONTACTINFO | (Optional) Merchant's telephone number or web address. (URLs and e-mail addresses may be lowercase, as appropriate.) This entry may appear on the descriptive bill on the card-member's statement, or may be used to resolve billing inquiries and disputes. Note: American Express strongly recommends that aggregators (third-parties who bill for goods or services rendered by another entity) always fill in this field with the URL, e-mail address, or telephone number of the contact responsible for resolving disputes or inquiries.Character length and limitations: 40 alphanumeric characters |
Transaction Advice Detail Parameters
| Field | Description |
|---|---|
ADDLAMTn | (Optional) Detail of a charge where n is a value from 1 - 5. Use for additional breakdown of the amount. Character length and limitations: Must include a decimal and be exact to the cent ( 42.00, not 42) and exclude comma separators (1234.56 not 1,234.56). Examples are a tip (ADDLAMT1=3.00) and a convenience charge (ADDLAMT2=2.00). 12 numeric characters. The amount passed must not contain more than two decimal places. |
ADDLAMTTYPEn | (Optional) A 3-digit code indicating the type of the corresponding charge detail, where n is a value from 1 - 5. Character length and limitations: 3 numeric characters |
Airline Passenger Data Parameters
| Field | Description |
|---|---|
AIR-DEPARTUREDATE | (Optional) Departure date in the format YYYYMMDD.Character length and limitations: 8 alphanumeric characters |
AIR-PASSENGERNAME | (Optional) Name of the passenger in the following format with fields separated by a space: surname first name middle initial title Character length and limitations: 60 alphanumeric characters |
AIR-ORIGIN | (Optional) Airport code of the originating airport. For a list of airport codes, see https://www.world-airport-codes.com/alphabetical/airport-code/a.html.Note: Present day airport codes are three characters in length. The five character length is designed to allow for future expansionCharacter length and limitations: 5 alphanumeric characters |
AIR-DESTINATION | (Optional) Destination airport code for the first segment of the trip; this is not necessarily the final destination. For example, if a passenger flies from STL to MIA with a layover at JFK, the destination airport is JFK For a list of airport codes, see https://www.world-airport-codes.com/alphabetical/airport-code/a.html.Note: Present day airport codes are three characters in length. The five character length is designed to allow for future expansionCharacter length and limitations: 5 alphanumeric characters |
AIR-NUMBEROFCITIES | (Optional) Number of unique cities in this trip including the cities of origin and destination, where a maximum value of 10 is allowed. For example, AIR-NUMBEROFCITIES is 3 for the following trip: - DEN to LAX - LAX to SFO - SFO to DEN If not provided, this value is equal to the number of AIR-ROUTINGCITYn parameters. |
AIR-ROUTINGCITYn | (Optional) Airport codes of each city in this flight including cities of origin and destination, where n is a value from 1 to 10. Character length and limitations: 5 alphanumeric characters |
AIR-CARRIERn | (Optional) Two character airline code for each unique airline in this flight, where n is a value from 1 to 10. If the same carrier is used for multiple segments of the trip, it is passed only once. For example, the two AIR-CARRIERn values for the following trip are UA and AA:- UA flight from IAD to DEN - UA flight from DEN to LAX - UA flight from LAX to SFO - AA flight from SFO to DFW Character length and limitations: 24 alphanumeric characters |
AIR-FAREBASIS | (Optional) List discounts associated with the travel. Character length and limitations: 24 alphanumeric characters |
AIR-NUMBEROFPASSENGERS | (Optional) Number of passengers on this trip. Character length and limitations: numeric |
AIR-ISETICKET | (Optional) If this is an electronic ticket. The values are: - Y = yes- N = noCharacter length and limitations: 1 alphanumeric character |
AIR-RESERVATIONCODE | (Optional) Code assigned to the travel reservation before the ticket was purchased. Character length and limitations: 15 alphanumeric characters |
Payment Account Reference
| Field | Description |
|---|---|
PAR | (Optional - Request) Value YThe Payment Account Reference (PAR) is a non-financial reference number assigned to each unique Primary Account Number (PAN) and mapped to all its affiliated Payment Tokens. For Merchants that encounter both PAN and Token transactions, PAR provides the ability to link both types of Transactions and activities for a card account. Note: If a Merchant requests to receive the PAR and none is available, the Authorization Response message will not contain any response.Character length and limitations: 1 alpha characters |
PARID | (Optional - Response) A unique identifier returned when PAR=Y is sent in the authorization request. This identification number is associated with a specific cardholder PAN and can be used in place of sensitive consumer identification fields.Character length and limitations: 35 alphanumeric characters |
Note: This information is not used by Payflow and is only provided in the original response. See Payment Account Reference (PAR) for more information on how you can use this data outside of Payflow.
Simple Example:
Request: TRXTYPE=S&TENDER=C&ACCT=378282246310005&AMT=10.00&EXPDATE=1222TCARDONFILE=CITI&SCAEXEMPTION=SCP&PAR=Y&VERBOSITY=HIGH Response: RESULT=0&PNREF=A93J0E9031E0&RESPMSG=Approved&AUTHCODE=010101&TXID=051854388718753&PARID=00311941003556616430678538799514282&AMEXID=051854388718753&AMEXPOSDATA=1609S0100130American Express Other Parameters
| Field | Description |
|---|---|
BILLTOFIRSTNAME | (Optional) Account holder's first and last name. Note: Even though the parameter name indicates only the first name, this single parameter holds all of the person's name information (both first and last name, at a minimum).Character length and limitations: 13 alphanumeric characters |
BILLTOLASTNAME | (Optional) Account holder's last name. Character length and limitations: 13 alphanumeric characters |
INVNUM | (Optional) Merchant invoice number. The merchant invoice number is used for authorizations and settlements and, depending on your merchant bank, will appear on your customer's credit card statement and your bank reconciliation report. If you do not provide an invoice number, the transaction ID ( PNREF ) will be submitted. Character length and limitations: 9 alphanumeric characters |
ORDERDATE | (Optional) Specifies an order date. Character length and limitations: 6 numeric characters Format: mmddyy (with no slashes or dashes). For example, July 28, 2003 is 072803. |
ORDERDATETIME | (Optional) Specifies an order time and date. Character length and limitations: 19 alphanumeric characters Format is either YYYY-MM-DD or YYYY-MM-DD HH:MI:SS (where HH is in 24-hour time). If the value does not conform to one of the formats or if the date is not valid (for example, 2004-17-35), then the transaction is rejected with: RESULT=7(SIG_FIELD_ERR) RESPMSG=Invalid ORDERTIME. A truncated version of the ORDERTIME value (up to 7 characters) overwrites any value provided by ORDERDATE. If no value is provided, a NULL value is stored. |
Merchant e-Solutions (Cielo Payments) - Additional Credit Card Parameters
In addition to the core credit card parameters, Merchant e-Solutions accepts the parameters described below.
| Field | Description |
|---|---|
INVNUM | (Optional) Merchant invoice number. The merchant invoice number is used for authorizations and settlements and, depending on your merchant bank, will appear on your customer's credit card statement and your bank reconciliation report. If you do not provide an invoice number, the transaction ID ( PNREF ) will be submitted.Note: Not supported by Payflow Link.Character length and limitations: 17 alphanumeric characters |
MERCHDESCR | (Optional) Use this parameter to pass in your DBA name and other data describing the transaction (default: merchant name). This information is usually displayed in the account holder's statement. Character length and limitations: 25 alphanumeric characters |
MERCHSVC | (Optional) Defaults to the city where the merchant outlet is located for retail and to the merchant's phone number for non-retail. For example, 800 111-1111. This information is usually displayed in the account holder's statement. Character length and limitations: 13 alphanumeric characters |
Elavon Additional Credit Card Parameters
In addition to the core credit card parameters, Elavon accepts the parameter described below.
| Field | Description |
|---|---|
RECURRING | (Optional) Identifies the transaction as recurring. This value does not activate the Payflow Recurring Billing Service API. If the RECURRING parameter was set to Y for the original transaction, then the setting is ignored when forming credit, void, and force transactions. If you subscribe to Payflow Fraud Protection Services:- To avoid charging you to filter recurring transactions that you know are reliable, the fraud filters do not screen recurring transactions. - To screen a prospective recurring customer, submit the transaction data using PayPal Manager's Manual Transactions page. The filters screen the transaction in the normal manner. If the transaction triggers a filter, then you can follow the normal process to review the filter results. Character length and limitations: 1 alphanumeric character ( Y or N) |
Elavon Travel Parameters
Elavon also accepts the travel parameters described below.
| Field | Description |
|---|---|
DEPARTUREDATE | (Required) |
COMPLETIONDATE | (Required) |
MERCHANTREFCODE | (Required) |
TAXAMT | (Required) |
PONUM | (Optional) |
FISERV Nashville - Additional Credit Card Parameters
In addition to the core credit card parameters, FISERV Nashville accepts the parameters described below.
| Field | Description |
|---|---|
INVNUM | (Optional) Merchant invoice number. The merchant invoice number is used for authorizations and settlements and, depending on your merchant bank, will appear on your customer's credit card statement and your bank reconciliation report. If you do not provide an invoice number, the transaction ID ( PNREF ) will be submitted. Character length and limitations: 9 alphanumeric characters |
FISERV North - Additional Credit Card Parameters
In addition to the core credit card parameters, FISERV North accepts the parameters described
| Field | Description |
|---|---|
DESC | (Optional) Use the DESC parameters to pass in your DBA name and other data describing the transaction. This information will be displayed in the account holder's statement.Note: FISERV North passes the descriptive data to the card associations with the following character lengths:Visa: 25 Mastercard: 22 AMEX: 20 DISC: 22 Some card associations truncate the value to 19 characters. If you have questions, consult the card association. Character length and limitations: 25 alphanumeric characters |
MERCHDESCR | (Optional) Use this parameter to pass in your DBA name and other data describing the transaction. This information is usually displayed in the account holder's statement. Character length and limitations: 25 alphanumeric characters |
MERCHSVC | (Optional) Defaults to the city where the merchant outlet is located for retail and to the merchant's phone number for non-retail. For example, 800 111-1111. This information is usually displayed in the account holder's statement. Character length and limitations: 13 alphanumeric characters |
Heartland - Additional Credit Card Parameters
In addition to the core credit card parameters, Heartland accepts the parameters described below.
| Field | Description |
|---|---|
INVNUM | (Optional) Merchant invoice number. The merchant invoice number is used for authorizations and settlements and, depending on your merchant bank, will appear on your customer's credit card statement and your bank reconciliation report. If you do not provide an invoice number, the transaction ID ( PNREF ) will be submitted.Note: Not supported by Payflow Link.Character length and limitations: 17 alphanumeric characters |
MERCHDESCR | (Optional) Use this parameter to pass in your DBA name and other data describing the transaction (default: merchant name). This information is usually displayed in the account holder's statement. Character length and limitations: 25 alphanumeric characters |
MERCHSVC | (Optional) Defaults to the city where the merchant outlet is located for retail and to the merchant's phone number for non-retail. For example, 800 111-1111. This information is usually displayed in the account holder's statement. Character length and limitations: 13 alphanumeric characters |
Litle Additional Credit Card Parameters
| Field | Description |
|---|---|
AUTHDATE | Required for Force transactions. Authorization date. Character length and limitations: 11 alphanumeric characters |
CUSTOMERID | (Optional) Customer identification. Character length and limitations: 18 alphanumeric characters |
INVNUM | (Optional) Merchant invoice number. The merchant invoice number is used for authorizations. If you do not provide an invoice number, the transaction ID ( PNREF ) will be submitted. Character length and limitations: 20 alphanumeric characters |
MERCHANTCITY | (Optional) The name of the city were the transaction took place. - If you are a third-party biller (bill for services or goods rendered by another entity), you must enter the name of the city in which the seller is located. - If you are a mail order, phone order, or internet industry, you may substitute the name of the city in which the merchant's order processing facility is located. Character length and limitations: 21 alphanumeric characters |
MERCHANTURL | (Optional) Merchant's website. This information is usually displayed in the account holder's statement. Character length and limitations: 40 alphanumeric characters |
MERCHDESCR | (Optional) Use this parameter to pass in your DBA name and other data describing the transaction (default: merchant name). This information is usually displayed in the account holder's statement. Character length and limitations: 25 alphanumeric characters |
MERCHSVC | (Optional) Defaults to the city where the merchant outlet is located for retail and to the merchant's phone number for non-retail. For example, 800 111-1111. This information is usually displayed in the account holder's statement. Character length and limitations: 13 alphanumeric characters |
PONUM | (Optional) Purchase order number. Character length and limitations: 25 alphanumeric characters |
REPORTGROUP | (Optional) Category that the transaction is in, for example, coffee mugs. This field is for your own use. Character length and limitations: 25 alphanumeric characters |
BILLTOSTREET2 | (Optional) Second street address. Character length and limitations: 35 alphanumeric characters |
BILLTOSTREET3 | (Optional) Third street address. Character length and limitations: 35 alphanumeric characters |
TAXAMT | (Optional) Total tax amount. Character length and limitations: Must include a decimal and be exact to the cent ( 42.00, not 42) and exclude comma separators (1234.56 not 1,234.56). 12 numeric characters |
TAXEXEMPT | (Optional) Indicates whether the customer is tax exempt. Value is: - Y - The customer is tax exempt. - N - The customer is not tax exempt (default).Character length and limitations: 1 alpha character |
Paymentech Salem - New Hampshire - Additional Credit Card Parameters for American Express
In addition to the core credit card parameters, Paymentech Salem accepts the parameters to meet American Express statement and reporting requirements described below.
Paymentech Salem - Internet Transaction Data Parameters
| Field | Description |
|---|---|
BILLTOEMAIL | (Optional) Account holder's email address. Character length and limitations: 60 alphanumeric characters |
BILLTOPHONENUM | (Optional) Account holder's telephone number. Character length and limitations: 20 characters |
PHONETYPE | (Optional) Telephone company provided ANI information identifier digits indicating the telephone call type. Examples: cellular (61-63), pay phone (27) Character length and limitations: 2 characters |
CUSTHOSTNAME | (Optional) Name of the server that the account holder is connected to. Example: PHX.QW.AOL.COM.Character length and limitations: 60 alphanumeric and special characters |
CUSTBROWSER | (Optional) Name of the server that the account holder is connected to. Example: MOZILLA/4.0 (COMPATIBLE MSIE 5.0; WINDOWS 95)Character length and limitations: 60 alphanumeric and special characters |
CUSTIP | (Optional) Account holder's IP address. Character length and limitations: 15 alphanumeric and special characters |
SHIPTOCOUNTRY | (Optional) Numeric country code of ship-to country. Example: USA would be 840. The Payflow API accepts 3-digit numeric country codes. Refer to ISO 3166-1 numeric.Character length and limitations: 3 alphanumeric characters |
SHIPMETHOD | (Optional) Shipping method code. The values are: - 01 = Same day- 02 = Overnight/next day- 03 = Priority, 2 - 3 days- 04 = Ground, 4 or more days- 05 = Electronic delivery- 06 - ZZ = Reserved for future use |
SKU | (Optional) Merchant product SKU. Character length and limitations: 15 alphanumeric and special characters |
Paymentech Salem - AVS Parameters
| Field | Description |
|---|---|
BILLTOSTREET | (Optional) Account holder's street address (number and street name). Character length and limitations: 30 characters |
BILLTOZIP | (Optional) Account holder's 5- to 9-digit ZIP (postal) code excluding spaces, dashes, and non-numeric characters. Example: 951121737Character length and limitations: 9 characters |
BILLTOPHONENUM | (Optional) Account holder's telephone number. The formats are: - xxx-xxx-xxxx (US numbers) - +xxxxxxxxxxx (international numbers) Character length and limitations: 10 characters |
SHIPTOFIRSTNAME | (Optional) First name in the shipping address. Character length and limitations: 30 characters |
SHIPTOLASTNAME | (Optional) Last name in the shipping address. Character length and limitations: 30 characters |
SHIPTOSTREET | (Optional) Shipping street address. Character length and limitations: 30 characters |
SHIPTOCOUNTRY | (Optional) Numeric country code of ship-to country. Example: USA would be 840. The Payflow API accepts 3-digit numeric country codes. Refer to ISO 3166-1 numeric.Character length and limitations: 3 alphanumeric characters |
SHIPTOZIP | (Optional) Shipping 5- to 9-digit zip (postal) code excluding spaces, dashes, and non-numeric characters. Example: 951121737Character length and limitations: 9 alphanumeric characters |
SHIPTOPHONENUM | (Optional) Shipping telephone number. Character length and limitations: 10 alphanumeric characters |
Paymentech Salem - Additional Credit Card Parameters for M Record
| Field | Description |
|---|---|
MERCHDESCR | (Optional) Use this parameter to pass in your DBA name and other data describing the transaction. This information is usually displayed in the account holder's statement. Character length and limitations: 25 alphanumeric characters |
MERCHSVC | (Optional) Defaults to the city where the merchant outlet is located for retail and to the merchant's phone number for non-retail. For example, 800 111-1111. This information is usually displayed in the account holder's statement. Character length and limitations: 13 alphanumeric characters |
PayPal Credit Card Transaction Request Parameters
In addition to the core credit card parameters, PayPal accepts the parameters described below.
| Parameter | Description |
|---|---|
AMT | (Required) Amount (US Dollars) U.S. based currency. AMT=ITEMAMT + TAXAMT + FREIGHTAMT + HANDLINGAMT + INSURANCEAMT - DISCOUNTNote: You must setLimitations: Must not exceed 10,000.00 USD in any currency. Nine numeric characters plus decimal (.) character. No currency symbol. Specify the exact amount to the cent using a decimal point; use 34.00, not 34. Do not include comma separators; use 1199.95 not 1,199.95. Nine numeric characters plus decimal. |
CURRENCY | (Required) The currency code. Note: AUD - Australian dollar CAD - Canadian dollar EUR - Euro GBP - British pound JPY - Japanese Yen USD - US dollar Limitations: Three characters. |
BUTTONSOURCE | (Optional) Identification code for use by third-party applications to identify transactions. Limitations: 32 alphanumeric characters. |
CUSTIP | (Optional) IP address of payer's browser as recorded in its HTTP request to your website. This value is optional but recommended.Note: PayPal records this IP address as a means to detect possible fraud.Limitations: 15-character string in dotted quad format: xxx.xxx.xxx.xxx |
CAPTURECOMPLETE | (Optional) Indicates if this Delayed Capture transaction is the last capture you intend to make. The values are: - Y (default)- N Note: IfLimitations: 12-character alphanumeric string. |
CUSTOM | (Optional) A free-form field for your own use. Limitations: 256-character alphanumeric string. |
EMAIL | (Optional) Email address of payer. Limitations: 127 alphanumeric characters. |
INVNUM | (Optional) Your own unique invoice or tracking number. Limitations: 127 alphanumeric characters. |
ITEMAMT | (Required if L_COSTn is specified). Sum of cost of all items in this order. ITEMAMT = L_QTY0 LCOST0 + L_QTY1 LCOST1 + L_QTYn * L_COSTn Limitations: Nine numeric characters plus decimal (.) character. No currency symbol. Specify the exact amount to the cent using a decimal point; use 34.00, not 34. Do not include comma separators; use 1199.95 not 1,199.95. Limitations: Nine numeric characters plus decimal. |
TAXAMT | (Required if L_TAXAMTn is specified) Sum of tax for all items in this order.TAXAMT = L_QTY0 L_TAXAMT0 + L_QTY1 L_TAXAMT1 + L_QTYn * L_TAXAMTn Note: You must setLimitations: Nine numeric characters plus decimal (.) character. No currency symbol. Specify the exact amount to the cent using a decimal point; use 34.00, not 34. Do not include comma separators; use 1199.95 not 1,199.95. Nine numeric characters plus decimal. |
FREIGHTAMT | (Optional) Total shipping costs for this order. Note: You must setLimitations: Nine numeric characters plus decimal (.) character. No currency symbol. Specify the exact amount to the cent using a decimal point; use 34.00, not 34. Do not include comma separators; use 1199.95 not 1,199.95. Nine numeric characters plus decimal. |
HANDLINGAMT | (Optional) Total handling costs for this order. Note: You must setLimitations: Nine numeric characters plus decimal (.) character. No currency symbol. Specify the exact amount to the cent using a decimal point; use 34.00, not 34. Do not include comma separators; use 1199.95 not 1,199.95. Nine numeric characters plus decimal. |
DISCOUNT | (Optional) Shipping discount for this order. Specify the discount as a positive amount. Limitations: Nine numeric characters plus decimal (.) character. No currency symbol. Specify the exact amount to the cent using a decimal point; use 34.00, not 34. Do not include comma separators; use 1199.95 not 1,199.95. |
INSURANCEAMT | (Optional) Total shipping insurance cost for this order. Limitations: Nine numeric characters plus decimal (.) character. No currency symbol. Specify the exact amount to the cent using a decimal point; use 34.00, not 34. Do not include comma separators; use 1199.95 not 1,199.95. |
L_NAMEn | (Optional) Line-item name. Character length and limitations: 36 alphanumeric characters. |
L_DESCn | (Optional) Line-item description of the item purchased such as hiking boots or cooking utensils. |
L_COSTn | (Required if L_QTYn is supplied) Cost of the line item. The line-item unit price must be a positive number and be greater than zero.Note: You must setLimitations: Nine numeric characters plus decimal (.) character. No currency symbol. Specify the exact amount to the cent using a decimal point; use 34.00, not 34. Do not include comma separators; use 1199.95 not 1,199.95. Nine numeric characters plus decimal. |
L_QTYn | (Required if L_COSTn is supplied) Line-item quantity. Limitations: 10-character integer. |
L_SKUn | (Optional) Product number. Limitations: 18-characters. |
L_TAXAMTn | (Optional) Line-item tax amount. Limitations: Nine numeric characters plus decimal (.) character. No currency symbol. Specify the exact amount to the cent using a decimal point; use 34.00, not 34. Do not include comma separators; use 1199.95 not 1,199.95. |
MERCHANTSESSIONID | (Optional) Your customer Direct Payment session identification token. PayPal records this session token as an additional means to detect possible fraud. Limitations: 64 characters. |
MERCHDESCR | (Optional) Information that is usually displayed in the account holder's statement, for example, <Your-Not-For-Profit> <State>, <Your-Not-For-Profit> <Branch-Name>, <Your-Website> dues or <Your-Website> list fee. |
Character length and limitations: 23 alphanumeric characters, can include the special characters dash (
-) and dot (.) only. Asterisks (*) are NOT permitted. If it includes a space character ( ), enclose the "<Soft-Descriptor>" value in double quotes.Note:| |`MERCHANTCITY`|(Optional) A unique phone number, email address or URL, which is displayed on the account holder's statement. PayPal recommends passing a toll-free phone number because, typically, this is the easiest way for a buyer to contact the seller in the case of an inquiry.For US Website Payments Pro AMEX cards only and only for merchants passing dynamic soft descriptors, the dynamic soft descriptors for AMEX cards are only guaranteed once the transaction settles. This means that during the authorization time the card issuing bank might show their customer the registered business or legal name for the merchant versus the dynamic soft descriptor passed on a per API transaction.
Character length and limitations: 13 characters including special characters, such as, space,
!, ", #, $, %, &, ', (\`, \`), +, -,*, /, :, ;, <\`, \`=\`, \`>, ?, @, comma and period.If it includes the space character (
), enclose the "<Soft-Descriptor-City>" value in double quotes.Note:| |`NOTIFYURL`|*(Optional)* Your URL for receiving Instant Payment Notification (IPN) about this transaction. If you do not specify `NOTIFYURL` in the request, the notification URL from your Merchant Profile is used, if one exists.Underscore (
_) is an illegal character for this field. If it is passed, then it will be removed leaving the remaining characters in the same order. For example,New_Yorkchanges toNewYork.
Limitations: 2048 alphanumeric characters.| |`ORDERDESC`|*(Optional)* Description of items the customer is purchasing.
Limitations: 127 alphanumeric characters.| |`RECURRINGTYPE`|*(Optional)* Type of transaction occurrence. The values are:
- `F` = First occurrence
- `S` = Subsequent occurrence (default)
Limitations: One alpha character.| |`BILLTOSTREET`|*(Conditional)* Bill-to street address.
**Note:** Some merchants maybe required to pass this billing information. Please test your integration first to determine if the billing information fields are required.Limitations: 100-character string.| |`BILLTOCITY`|*(Conditional)* Bill-to city address.
**Note:** Some merchants maybe required to pass this billing information. Please test your integration first to determine if the billing information fields are required.Limitations: 40 alphanumeric characters.| |`BILLTOSTATE`|*(Conditional)* Bill-to state or province address.
**Note:** Some merchants maybe required to pass this billing information. Please test your integration first to determine if the billing information fields are required.Limitations: 40 alphanumeric characters.| |`BILLTOCOUNTRY`|*(Conditional)* Bill-to country address. For the PayPal acquirer, see the [PayPal country codes](/api/nvp-soap/country-codes/).
**Note:** Some merchants maybe required to pass this billing information. Please test your integration first to determine if the billing information fields are required.Limitations: 2 alphanumeric characters.| |`SHIPTOSTREET`|*(Optional)* Ship-to street address.
**Note:** If you pass in any of the ship-to address parameters such as `SHIPTOCITY` or `SHIPTOSTATE`, you must pass in the complete set (that is, `SHIPTOSTREET`, `SHIPTOCITY`, `SHIPTOSTATE`, `SHIPTOCOUNTRY`, and `SHIPTOZIP`).Limitations: 100-character string.| |`SHIPTOCITY`|*(Optional)* Ship-to city address.
**Note:** If you pass in any of the ship-to address parameters such as `SHIPTOCITY` or `SHIPTOSTATE`, you must pass in the complete set (that is, `SHIPTOSTREET`, `SHIPTOCITY`, `SHIPTOSTATE`, `SHIPTOCOUNTRY`, and `SHIPTOZIP`).Limitations: 40-character string.| |`SHIPTOSTATE`|*(Optional)* Ship-to state or province address.
**Note:** If you pass in any of the ship-to address parameters such as `SHIPTOCITY` or `SHIPTOSTATE`, you must pass in the complete set (that is, `SHIPTOSTREET`, `SHIPTOCITY`, `SHIPTOSTATE`, `SHIPTOCOUNTRY`, and `SHIPTOZIP`).Limitations: 40-character string.| |`SHIPTOCOUNTRY`|*(Optional)* Ship-to country code. For the PayPal acquirer, see the [PayPal country codes](/api/nvp-soap/country-codes/).
**Note:** If you pass in any of the ship-to address parameters such as `SHIPTOCITY` or `SHIPTOSTATE`, you must pass in the complete set (that is, `SHIPTOSTREET`, `SHIPTOCITY`, `SHIPTOSTATE`, `SHIPTOCOUNTRY`, and `SHIPTOZIP`).Limitations: Two alpha characters.| |`SHIPTOZIP`|*(Optional)* U.S. ship-to zip code or other country-specific postal code.
**Note:** If you pass in any of the ship-to address parameters such as `SHIPTOCITY` or `SHIPTOSTATE`, you must pass in the complete set (that is, `SHIPTOSTREET`, `SHIPTOCITY`, `SHIPTOSTATE`, `SHIPTOCOUNTRY`, and `SHIPTOZIP`).Limitations: 20-character string.|
TSYS Additional Credit Card Parameters
| Field | Description |
|---|---|
MERCHANTNAME | *(Optional) Name of merchant. The name provided must correspond to the name printed on the customer receipt. Character length and limitations: 25 alphanumeric characters |
MERCHANTCITY | (Optional) Used for in-person Retail transactions The name of the city were the transaction took place. The name provided must correspond to the location/city name printed on the customer receipt. Character length and limitations: 13 alphanumeric characters |
MERCHANTCONTACTINFO | (Optional) Used for Mail-Order and e-Commerce transactions Merchant's telephone number or web address. (URLs and e-mail addresses may be lowercase, as appropriate.) This entry may appear on the descriptive bill on the card-member's statement, or may be used to resolve billing inquiries and disputes. Character length and limitations: 13 alphanumeric characters |
Vantiv Additional Credit Card Parameters
| Field | Description |
|---|---|
MERCHDESCR | (Optional) Use this parameter to pass in your DBA name and other data describing the transaction. This information will be displayed in the account holder's statement. Character length and limitations: 25 alphanumeric characters |
Vantiv Soft Merchant Descriptor Parameters
| Field | Description |
|---|---|
MERCHANTNAME | (Optional) Name of merchant. Character length and limitations: 38 alphanumeric characters |
MERCHANTSTREET | (Optional) Merchant's street address (number and street name). Character length and limitations: 38 alphanumeric characters. If more than 38 characters, use proper and meaningful abbreviation. Do not truncate. |
MERCHANTCITY | (Optional) The name of the city were the transaction took place. - If you are a third-party biller (bill for services or goods rendered by another entity), you must enter the name of the city in which the seller is located. - If you are a mail order, phone order, or internet industry, you may substitute the name of the city in which the merchant's order processing facility is located. Character length and limitations: 21 alphanumeric characters. If more than 21 characters, use proper and meaningful abbreviation. Do not truncate. |
MERCHANTSTATE | (Optional) The region code that corresponds to the state, province, or country subdivision of the merchant location where the transaction took place. Region code examples: - CA = California, USA- NS = Nova Scotia, Canada- COS = Colima MexicoIf you are a third-party biller (bill for services or goods rendered by another entity), you must enter the region code that corresponds to the state, province, or country subdivision in which the seller is located. Character length and limitations: 3 alphanumeric characters |
MERCHANTZIP | (Optional) The 5 to 9-digit zip (postal) code excluding spaces, dashes, and non-numeric characters where the transaction took place. If you are a third-party biller (bill for services or goods rendered by another entity), you must enter the postal code that corresponds to the seller's location. Character length and limitations: 15 alphanumeric characters |
MERCHANTCOUNTRYCODE | (Optional) Country code of the location where the transaction took place. The Payflow API accepts 3-digit numeric country codes. Refer to ISO 3166-1 numeric. Character length and limitations: 3-character country code. |
MERCHANTLOCATIONID | (Optional) Merchant-assigned store or location number (or name) that uniquely identifies where the transaction took place. Character length and limitations: 15 alphanumeric characters |
MERCHANTID | (Required) American Express-assigned service establishment number used to identify and facilitate payments to merchants. Character length and limitations: 15 alphanumeric characters. |
MERCHANTCONTACTINFO | (Optional) Merchant's telephone number or web address. (URLs and e-mail addresses may be lowercase, as appropriate.) This entry may appear on the descriptive bill on the card-member's statement, or may be used to resolve billing inquiries and disputes. Note: American Express strongly recommends that aggregators (third-parties who bill for goods or services rendered by another entity) always fill in this field with the URL, e-mail address, or telephone number of the contact responsible for resolving disputes or inquiries.Character length and limitations: 40 alphanumeric characters |
WorldPay Additional Credit Card Parameters
| Field | Description |
|---|---|
ADDLAMTn | (Optional) Detail of a charge, where n is a value from 1 - 5. Use for additional breakdown of the amount. Character length and limitations: Must include a decimal and be exact to the cent ( 42.00, not 42) and exclude comma separators (1234.56 not 1,234.56). Examples are a tip (ADDLAMT1=3.00) and a convenience charge (ADDLAMT2=2.00). 11 alphanumeric characters. The amount passed must not contain more than two decimal places. |
ADDLAMTTYPEn | (Optional) A 3-digit code indicating the type of the corresponding charge detail, where n is a value from 1 - 5.Character length and limitations: 18 alphanumeric characters |
CATTYPE | (Optional) Type of terminal. Character length and limitations: numeric characters |
CONTACTLESS | (Optional) Describes the card input capability. It is the value RFD, which means the card contains a radio frequency identification (RFID) chip for communicating with a point-of-sale device with an RFID receiver.Character length and limitations: alpha characters |