• Developer Home /
• Direct Post /
• Transaction Variables

Transaction Variables
Direct Post API

Sale/Authorization/Credit/Validate

Variable Name	Description
type*	The type of transaction to be processed. Values: 'sale', 'auth', 'credit', or 'validate'
username*	Username assigned to merchant account.
password*	Password for the specified username.
ccnumber**	Credit card number.
ccexp**	Credit card expiration date. Format: MMYY
cvv	The card security code. While this is not required, it is strongly recommended.
checkname***	The name on the customer's ACH account.
checkaba***	The customer's bank routing number.
checkaccount***	The customer's bank account number.
account_holder_type***	The type of ACH account the customer has. Values: 'business' or 'personal'
account_type***	The ACH account entity of the customer. Values: 'checking' or 'savings'
sec_code***	The Standard Entry Class code of the ACH transaction. Values: 'PPD', 'WEB', 'TEL', or 'CCD'
amount	Total amount to be charged. For validate, the amount must be omitted or set to 0.00. Format: x.xx
currency	The transaction currency. Format: ISO 4217
payment***	The type of payment. Default: 'creditcard' Values: 'creditcard' or 'check'
processor_id	If using Multiple MIDs, route to this processor (processor_id is obtained under Settings->Load Balancing in the Control Panel).
dup_seconds	Sets the time in seconds for duplicate transaction checking on supported processors. Set to 0 to disable duplicate checking.
descriptor	Set payment descriptor on supported processors.
descriptor_phone	Set payment descriptor phone on supported processors.
descriptor_address	Set payment descriptor address on supported processors.
descriptor_city	Set payment descriptor city on supported processors.
descriptor_state	Set payment descriptor state on supported processors.
descriptor_postal	Set payment descriptor postal code on supported processors.
descriptor_country	Set payment descriptor country on supported processors.
descriptor_mcc	Set payment descriptor mcc on supported processors.
descriptor_merchant_id	Set payment descriptor merchant id on supported processors.
descriptor_url	Set payment descriptor url on supported processors.
billing_method	Should be set to 'recurring' to mark payment as a recurring transaction. Values: 'recurring'
orderdescription	Order description.
orderid	Order Id
ipaddress	IP address of cardholder, this field is recommended. Format: xxx.xxx.xxx.xxx
tax****	Total tax amount.
shipping****	Total shipping amount
ponumber****	Original purchase order
firstname	Cardholder's first name.
lastname	Cardholder's last name
company	Cardholder's company
address1	Card billing address
address2	Card billing address, line 2
city	Card billing city
state	Card billing state. Format: CC
zip	Card billing zip code
country	Card billing country. Country codes are as shown in ISO 3166. Format: CC
phone	Billing phone number
fax	Billing fax number
email	Billing email address
social_security_number	Customer's social security number, checked against bad check writers database if check verification is enabled.
drivers_license_number	Driver's license number.
drivers_license_dob	Driver's license date of birth.
drivers_license_state	The state that issued the customer's driver's license.
validation	Specify which Validation processors to use. If variable is passed blank, use none.
shipping_firstname	Shipping first name
shipping_lastname	Shipping last name
shipping_company	Shipping company
shipping_address1	Shipping address
shipping_address2	Shipping address, line 2
shipping_city	Shipping city
shipping_state	Shipping state Format: CC
shipping_zip	Shipping zip code
shipping_country	Shipping country Country codes are as shown in ISO 3166. Format: CC
shipping_email	Shipping email address
merchant_defined_field_#	You can pass custom information in up to 20 fields. Format: merchant_defined_field_1=Value
recurring	Recurring action to be processed. Values: add_subscription
plan_id	Create a subscription tied to a Plan ID if the sale/auth transaction is successful.
plan_payments	The number of payments before the recurring plan is complete. Note: Use '0' for 'until canceled'
plan_amount	The plan amount to be charged each billing cycle. Format: x.xx
day_frequency	How often, in days, to charge the customer. Cannot be set with 'month_frequency' or 'day_of_month'.
month_frequency	How often, in months, to charge the customer. Cannot be set with 'day_frequency'. Must be set with 'day_of_month'. Values: 1 through 24
day_of_month	The day that the customer will be charged. Cannot be set with 'day_frequency'. Must be set with 'month_frequency'. Values: 1 through 31 - for months without 29, 30, or 31 days, the charge will be on the last day
start_date	The first day that the customer will be charged. Format: YYYYMMDD
Level III specific order fields
shipping	Freight or shipping amount included in the transaction amount Default: '0.00' Format: x.xx
tax	The sales tax, included in the transaction amount, associated with the purchase. Setting tax equal to '-1' indicates an order that is exempt from sales tax. Default: '0.00' Format: x.xx
ponumber†	Purchase order number supplied by cardholder
orderid†	Identifier assigned by the merchant. This defaults to gateway transaction id.
shipping_country†	Shipping country (e.g. US) Format: CC
shipping_postal†	Postal/ZIP code of the address where purchased goods will be delivered. This field can be identical to the 'ship_from_postal' if the customer is present and takes immediate possession of the goods.
ship_from_postal†	Postal/ZIP code of the address from where purchased goods are being shipped, defaults to merchant profile postal code.
summary_commodity_code†	4 character international description code of the overall goods or services being supplied. The acquirer or processor will provide a list of current codes.
duty_amount	Amount included in the transaction amount associated with the import of purchased goods. Default: '0.00' Format: x.xx
discount_amount	Amount included in the transaction amount of any discount applied to complete order by the merchant. Default: '0.00' Format: x.xx
national_tax_amount	The national tax amount included in the transaction amount. Default: '0.00' Format: x.xx
alternate_tax_amount	Second tax amount included in the transaction amount in countries where more than one type of tax can be applied to the purchases. Default: '0.00' Format: x.xx
alternate_tax_id	Tax identification number of the merchant that reported the alternate tax amount.
vat_tax_amount	Contains the amount of any value added taxes which can be associated with the purchased item. Default: '0.00' Format: x.xx
vat_tax_rate	Contains the tax rate used to calculate the sales tax amount appearing. Can contain up to 2 decimal places, e.g. 1% = 1.00. Default: '0.00' Format: x.xx
vat_invoice_reference_number	Invoice number that is associated with the VAT invoice.
customer_vat_registration	Value added tax registration number supplied by the cardholder.
merchant_vat_registration	Government assigned tax identification number of the merchant for whom the goods or services were purchased from.
order_date	Purchase order date, defaults to the date of the transaction. Format: YYMMDD
Level III specific line item detail fields
item_product_code_#†	Merchant defined description code of the item being purchased.
item_description_#†	Description of the item(s) being supplied.
item_commodity_code_#†	International description code of the individual good or service being supplied. The acquirer or processor will provide a list of current codes.
item_unit_of_measure_#†	Code for units of measurement as used in international trade. Default: 'EACH'
item_unit_cost_#†	Unit cost of item purchased, may contain up to 4 decimal places.
item_quantity_#†	Quantity of the item(s) being purchased. Default: '1'
item_total_amount_#†	Purchase amount associated with the item. Defaults to: 'item_unit_cost_#' x 'item_quantity_#' rounded to the nearest penny.
item_tax_amount_#†	Amount of tax on specific item, amount should not be included in 'total_amount_#'. Default: '0.00'
item_tax_rate_#†	Percentage representing the value-added tax applied. Default: '0.00'
item_discount_amount_#	Discount amount which can have been applied by the merchant on the sale of the specific item. Amount should not be included in 'total_amount_#'.
item_discount_rate_#	Discount rate for the line item. 1% = 1.00. Default: '0.00'
item_tax_type_#	Type of value-added taxes that are being used.
item_alternate_tax_id_#	Tax identification number of the merchant that reported the alternate tax amount.

*	Always required
**	Required for credit card transactions
***	Required for ACH transactions
****	Required for Level 2 transactions
†	Required for Level 3 transactions

Notes:

• Level II fields are required for Level II processing.
• Level II and Level III fields are required for Level III processing.
• You can pass only credit card or e-check transaction variables in a request, not both in the same request.
• Certain banks may require some optional fields.

Capture

Variable Name	Description
type*	Type of transaction. Values: 'capture'
username*	Username assigned to merchant account.
password*	Password for the specified username.
transactionid*	Original payment gateway transaction id
amount*	Total amount to be settled. This amount must be equal to or less than the original authorized amount. Format: x.xx
tracking_number	Shipping tracking number
shipping_carrier	Shipping carrier. Values: 'ups', 'fedex', 'dhl', or 'usps'
orderid	Order id.

*	Always required

Void

Variable Name	Description
type*	Type of transaction. Values: 'void'
username*	Username assigned to merchant account.
password*	Password for the specified username.
transactionid*	Original payment gateway transaction id

*	Always required

Refund

Variable Name	Description
type*	Type of transaction. Values: 'refund'
username*	Username assigned to merchant account.
password*	Password for the specified username.
transactionid*	Original payment gateway transaction id
amount	Total amount to be refunded. This amount may be equal to or less than the settled amount. Format: x.xx

*	Always required

Update

Variable Name	Description
type*	Type of transactions. Values: 'update'
username*	Username assigned to merchant account.
password*	Password for the specified username.
transactionid*	Original payment gateway transaction id
tracking_number	Shipping tracking number
shipping_carrier	Shipping carrier. Values: 'ups', 'fedex', 'dhl', or 'usps'
shipping_date	Shipping date. Format: YYYYMMDD
merchant_defined_field_#	Merchant Defined Fields. Format: merchant_defined_field_1=Value

*	Always required