Comprehensive List of Variables

Payment Variables

https://secure.braintreepaymentgateway.com/api/transact.php

type “sale”, “void”, “refund”, “auth”, “capture”, “validate”, “credit”, or “update”

orderid

amount

Required for sale, auth, refund and credit transactions.

payment “creditcard” or “check”

Set Payment type to Electronic Check or Credit Card. Note: either check or credit card information can be passed to the Braintree Payment Gateway, but not together. Doing so will result in an error.

ccnumber

Valid credit card number. Pass if adding/running a credit card.

ccexp

Credit card expiration date if adding/running a credit card. ( Format: 1010 = October, 2010 )

checkname

The name on the customer’s bank account. Required for electronic check transactions. For Direct Post, make sure to encode any spaces or non-standard characters in the URL string. The only escaping necessary for Transparent Redirect is HTML escaping for any hidden form fields that could contain <, >, &, or “

checkaba

The customer’s bank account routing number. Pass if adding a checking account or running a transaction.

checkaccount

The customer’s bank account number. Pass if adding a checking account or running a transaction.

account_holder_type “business” or “personal”

The customer’s type of bank account. The value of this parameter is going to either be business or personal. Pass if adding a checking account or running a transaction.

account_type “checking” or “savings”

The customer’s bank account entity. The value of this parameter will be either checking or savings. Pass if adding a checking account or running a transaction.

sec_code “PPD”, “WEB”, “TEL”, or “CCD”

ACH Standard Entity Class codes. Required for all check transactions, PPD refers to prior written authorization from customer, WEB to electronic authorization, TEL to verbal authorization, and CCD should be used for all corporate checking accounts.

transactionid

Use to capture, void, refund, or update an existing transaction.

processor_id

Required if account has multiple processor ids. The processor_id variable allows merchants to seamlessly manage multiple merchant accounts, sales channels or company divisions. The processor ID is obtained under the Options => Load Balancing section in the Braintree Virtual Terminal Control Panel. If the processor id is not passed, it will default to the first one set up on your account.

cvv

Card security code. This value cannot be stored.

dup_seconds

Manually set duplicate transaction checking time.

currency

Defaults to USD. If your account is set up to accept multiple currencies, include this variable. Format currency=USD

ipaddress

IP address of the cardholder. Format: xxx.xxx.xxx.xxx

firstname

lastname

company

address1

address2

city

state

Card billing state. Format: NY (2 Character abbrev.)

zip

country

Card billing country. Format: CC (ISO-3166). Example country=US for the United States

phone

email

orderdescription

fax

product_sku_#* “nameofplan”

Required for recurring billing plans only. This value is the number of recurring billing plans to add the customer to. For example, to add a user to a single plan called “monthly”, you would pass “product_sku_1=monthly”.

tax

Required for Level 2 processing. Total tax amount. Format: x.xx

taxexempt

Required for Level 2 processing. Value should be either ‘T’ or ‘F’

ponumber

Required for Level 2 processing. Original Purchase Order/Customer Code number.

shipping

Required for Level 3 processing. Total shipping amount. Format: x.xx

website

merchant_receipt_email “email@merchant.com”

Allows the merchant to specify when to receive transaction receipts.

merchant_defined_field_#

For use with custom fields.

shipping_firstname

shipping_lastname

shipping_company

Company name where the product is being shipped

shipping_address1

Shipping address – line 1

shipping_address2

Shipping address – line 2

shipping_city

shipping_state

Shipping state, 2 character abbreviation.

shipping_zip

Shipping zip code

shipping_country

Shipping country. Format: CC (ISO-3166). Example country=US for the United States

tracking_number

Shipping Tracking number

shipping_carrier “ups”, “fedex”, “dhl”, or “usps”

Shipping carrier for order, value may only equal the ones listed here.

descriptor

Set payment descriptor (On supported processors)

descriptor_phone

Set payment descriptor phone (On supported processors)

Vault Variables

https://secure.braintreepaymentgateway.com/api/transact.php

type “sale”, “void”, “refund”, “auth”, “capture”, “credit”, or “update”

Required when issuing a transaction with a vault.

customer_vault “add_customer”, “update_customer”, or “delete_customer”

Should only be used when making additions or changes to a Vault record.

orderid

amount

For sale, auth, refund, and credit transactions.

payment “creditcard” or “check”

Set Payment type to Electronic Check or Credit Card. Note: either check or credit card information can be passed to the Braintree Payment Gateway, but not together. Doing so will result in an error.

ccnumber

Valid credit card number. Pass if adding/running a credit card.

ccexp

Credit card expiration date if adding/running a credit card. Format: 1010 = October, 2010

checkname

The name on the customer’s bank account. Required for check transactions. For Direct Post, make sure to encode any spaces or non-standard characters in the URL string. The only escaping necessary for Transparent Redirect is HTML escaping for any hidden form fields that could contain <, >, &, or “

checkaba

The customer’s bank account routing number. Pass if adding a checking account or running a transaction.

checkaccount

The customer’s bank account number. Pass if adding a checking account or running a transaction.

account_holder_type “business” or “personal”

The customer’s type of bank account. The value of this parameter is going to either be business or personal. Pass if adding a checking account or running a transaction.

account_type “checking” or “savings”

The customer’s bank account entity. The value of this parameter will be either checking or savings. Pass if adding a checking account or running a transaction.

customer_vault_id

Specifies the name of the vault ID. If you do not pass a customer_vault_id when adding a customer to the Vault, the Vault will randomly generate one and return it in the response.

transactionid

Use to capture, void, refund, or update an existing transaction.

currency

Defaults to USD. If your account is set up to accept multiple currencies, include this variable. Format currency=USD

dup_seconds

Manually set duplicate transaction checking time.

firstname

lastname

company

address1

address2

city

state

Card billing state Format: NY (2 Character abbrev.)

zip

country

Card billing country. Format: CC (ISO-3166). Example country=US for the United States

phone

email

orderdescription

fax

website

shipping_firstname

shipping_lastname

shipping_company

Company name where the product is being shipped

shipping_address1

Shipping address – line 1

shipping_address2

Shipping address – line 2

shipping_city

shipping_state

Shipping state, 2 character abbreviation.

shipping_zip

Shipping zip code

shipping_country

Shipping country. Format: CC (ISO-3166). Example country=US for the United States

tracking_number

Shipping Tracking number

shipping_carrier* ups, fedex, dhl, or usps—

Shipping carrier for order, value may be only the ones listed here.

Query Variables

https://secure.braintreepaymentgateway.com/api/query.php

transaction_id

customer_vault_id

order_id

orderid passed with transaction

last_name

email

cc_number

start_date

Only transactions that have been modified on or after this date will be retrieved. Note that any actions performed on a transaction (ie. a VOID) will cause the modified date to be updated.

end_date

Only transactions that have been modified on or before this date will be retrieved. Note that any actions performed on a transaction (ie. a VOID) will cause the modified date to be updated.

condition pending, pendingsettlement, failed, canceled, complete, or unknown

Retrieves only transactions with the specified transaction condition. A combination of the values above can be used, and should be separated by commas.

transaction_type “ck” or “cc”

action_type “sale”, “refund”, “credit”, “auth”, “capture”, or “void”

A combination of the values above can be used, and should be separated by commas. For example, to retrieve all transactions with credit or refund actions, use the following: refund,credit