See also the Braintree::Transaction response object.

To create a transaction, you must include an amount and either a payment_method_nonce, a payment_method_token, or a customer_id. Passing a customer_id is equivalent to passing the payment_method_token of the customer's default payment method.

The following example creates a transaction using a payment_method_nonce from a client and instructs that it should be submitted for settlement immediately using options.submit_for_settlement. You can see more examples, including using a vaulted payment method, below the parameter reference.

Ruby
Click to copy
Copied
result = Braintree::Transaction.sale(
  :amount => "10.00",
  :payment_method_nonce => nonce_from_the_client,
  :options => {
    :submit_for_settlement => true
  }
)
Parameters
:amount required, BigDecimal or String

The billing amount of the request. This value must be greater than 0, and must match the currency format of the merchant account. Cannot be greater than the maximum allowed by the processor. Contact our Support team for your specific limit.

:billing

Billing address information associated with a specific customer ID.

AVS rules are not applied when creating a transaction from a Vault record using a payment method token. We still submit the street address and postal code to the processor to run AVS checks. The transaction response includes processor AVS response codes.

:company String

Company name. 255 character maximum.

:country_code_alpha2 String

The ISO 3166-1 alpha-2 country code specified in an address. The gateway only accepts specific alpha-2 values.

PayPal transactions must use the alpha-2 format. See PayPal's country code documentation for details.

:country_code_alpha3 String

The ISO 3166-1 alpha-3 country code specified in an address. The gateway only accepts specific alpha-3 values.

:country_code_numeric String

The ISO 3166-1 numeric country code specified in an address. The gateway only accepts specific numeric values.

:country_name String

The country name specified in an address. We only accept specific country names.

:extended_address String

The extended address information—such as apartment or suite number. 255 character maximum.

:first_name String

The first name. The first name value must be less than or equal to 255 characters.

:last_name String

The last name. The last name value must be less than or equal to 255 characters.

:locality String

The locality/city. 255 character maximum.

:postal_code String

The postal code. Postal code must be a string of 4-9 alphanumeric characters, optionally separated by a dash or a space. Spaces, hyphens, and all other special characters are ignored.

:region String

The state or province. For PayPal addresses, the region must meet PayPal's state restrictions; for all other payment methods, it must be less than or equal to 255 characters.

:street_address String

The billing street address. 255 character maximum. Required when AVS rules are configured to require street address.

:billing_address_id String

The two-letter value for an address associated with a specific customer ID. The maximum number of addresses per customer is 50.

:channel String

For Partners and shopping carts only

If you are a shopping cart provider or other Braintree Partner, pass a string identifier for your service. For PayPal transactions, this maps to paypal.bn_code.

:credit_card

Typically requires PCI SAQ D compliance

We recommend using payment_method_nonce to avoid any PCI concerns with raw credit card data being present on your server.

A credit or debit payment method.

:cardholder_name String

The name associated with the credit card. Must be less than or equal to 175 characters.

:cvv String

A 3 or 4 digit card verification value assigned to credit cards.

To meet PCI guidelines, CVV will never be stored in the gateway. CVV is not required when creating a transaction from Vault tokens; CVV rules will be applied to transactions if and only if the CVV is supplied with the tokens.

CVV checking can also be done when you create or update the Vault record by using card verification.

:expiration_date String

The expiration date, formatted MM/YY or MM/YYYY. May be used instead of expiration_month and expiration_year.

:expiration_month Integer

The expiration month of a credit card, formatted MM. May be used with expiration_year, and instead of expiration_date.

:expiration_year Integer

The two or four digit year associated with a credit card, formatted YYYY or YY. May be used with expiration_month, and instead of expiration_date.

:number String

The 12-19 digit value consisting of a bank identification number (BIN) and primary account number (PAN).

:token String

An alphanumeric value that references a specific payment method stored in your Vault. Must be less than or equal to 36 characters. If using a custom integration, you can specify what you want the token to be. If not specified, the gateway will generate one that can be accessed on the result. If using our Drop-in UI, you cannot specify your own token. Length and format of gateway-generated tokens and IDs may change at any time.

:custom_fields

A collection of custom field/value pairs. Fields and values must be less than 255 characters. You must set up each custom field in the Control Panel prior to passing it with a request. Querying this value returns a collection of custom field values stored on the transaction object.

:customer

When storing a new customer in the Vault, you can use this object to specify the customer's details. Only use this parameter when creating a new customer with a new payment method. See the customer object for further detail.

:company String

Company name. 255 character maximum.

:email String

Email address composed of ASCII characters. 255 character maximum.

:fax String

Fax number. 255 character maximum.

:first_name String

The first name. The first name value must be less than or equal to 255 characters.

:id String

A string value that will represent this specific customer in your Vault. 36 character maximum; must be unique within your Vault; valid characters are letters, numbers, -, and _; the words "all" and "new" currently cannot be used. If not specified on creation, the gateway will generate an alphanumeric ID that can be accessed on the result. The generated IDs will never start with a leading 0 and are case insensitive.

:last_name String

The last name. The last name value must be less than or equal to 255 characters.

:phone String

Phone number. Phone must be 10-14 characters and can only contain numbers, dashes, parentheses and periods.

:website String

Website URL. Must be less than or equal to 255 characters. Website must be well-formed. The URL scheme is optional.

:customer_id String

A string value representing an existing customer in your Vault that you want to charge.

:descriptor

Dynamic descriptors are not enabled on all accounts by default. If you receive a validation error of 92203 or if your dynamic descriptors are not displaying as expected, please contact our Support team.

Dynamic descriptors are sent on a per-transaction basis and define what will appear on your customers' credit card statements for a specific purchase. The clearer the description of your product, the less likely customers will issue chargebacks due to confusion or non-recognition.

See the dynamic descriptor example for additional information.

:name String

The value in the business name field of a customer's statement. The specific length/character requirements for this value depend on your processor. Contact our Support team for assistance.

:phone String

The value in the phone number field of a customer's statement. Phone must be 10-14 characters and can only contain numbers, dashes, parentheses and periods.

:url String

The value in the URL/web address field of a customer's statement. The URL must be 13 characters or shorter.

:device_data String

Customer device information. Required when creating transactions on the following payment method types:

This value will contain a Fraud Merchant ID as the unique, numeric identifier for a Kount account and a Device Session ID as the unique identifier for a customer device. For PayPal and Venmo transactions, this value will also include a PayPal Correlation ID.

:device_session_id String

A unique alphanumeric identifier used by our Advanced Fraud Tools to link a device to transactions.

:merchant_account_id String

The merchant account ID used to create a transaction. Currency is also determined by merchant account ID. If no merchant account ID is specified, we will use your default merchant account.

:options

Optional values that can be passed with a request.

:add_billing_address_to_payment_method bool

The option that determines whether the billing address information provided in the request should be added to the payment method specified. This option works only for new payment methods.

:hold_in_escrow bool

For Braintree Marketplace merchants only. This value specifies whether a transaction is held in escrow. See Escrow for more detail.

:paypal

PayPal-specific options.

:custom_field String

Variable passed directly to PayPal via the API for your own tracking purposes. Customers do not see this value, but you can see it in reports from your PayPal console. Unlike Braintree custom fields, this field does not need to be configured in the Braintree Control Panel, nor is the value stored in Braintree.

:description String

Description of the transaction that is displayed to customers in PayPal email receipts. Max 127 characters.

:skip_advanced_fraud_checking boolean

Prevents the transaction from being sent to Kount for evaluation as part of Advanced Fraud Tools checks. Use with caution – once you've skipped checks for a transaction, it is not possible to run them retroactively.

:skip_avs boolean

Skip AVS checks for the transaction. Will result in a processor response code of B for avs_postal_code_response_code and avs_street_address_response_code, and nil for avs_error_response_code. Use with caution – once you've skipped checks for a transaction, it is not possible to run them retroactively.

:skip_cvv boolean

Skip CVV checks for the transaction. Will result in a processor response code of B for cvv_response_code. Use with caution – once you've skipped checks for a transaction, it is not possible to run them retroactively.

:store_in_vault bool

The option that determines whether the payment method should be stored in the Vault, regardless of the transaction's success.

:store_in_vault_on_success bool

The option that determines whether the payment method associated with the successful transaction should be stored in the Vault.

:store_shipping_address_in_vault bool

The option that determines whether the shipping address information provided with the transaction should be associated with the customer ID specified. When passed, the payment method will always be stored in the Vault.

:submit_for_settlement bool

The option that determines whether an authorized transaction is submitted for settlement.

:three_d_secure

Options for 3D Secure verification. Can only be used when the payment method nonce parameter is present.

:required bool

Specify whether to require 3D Secure verification to succeed before creating a transaction. Defaults to true unless you explicitly pass false. For more information, see the 3D Secure server-side implementation guide.

:order_id String

Use this field to pass additional information about the transaction. On PayPal transactions, this field maps to the PayPal invoice number. PayPal invoice numbers must be unique in your PayPal business account.

:payment_method_nonce String

One-time-use reference to payment information provided by your customer, such as a credit card or PayPal account. Can be passed instead of a payment_method_token parameter.

:payment_method_token String

An alphanumeric value that references a specific payment method stored in your Vault. Must be less than or equal to 36 characters. If using a custom integration, you can specify what you want the token to be. If not specified, the gateway will generate one that can be accessed on the result. If using our Drop-in UI, you cannot specify your own token. Length and format of gateway-generated tokens and IDs may change at any time.

:purchase_order_number String

A Level II data field that can be used to pass a purchase order identification value of up to 12 ASCII characters for AIB and 17 ASCII characters for all other processors.

:recurring bool

A value indicating whether the transaction is being passed with a recurring ecommerce indicator (ECI) flag. If passed, the amount submitted for settlement must exactly match the authorized amount.

:risk_data

Customer device information, which is sent directly to supported processors for fraud analysis. These fields are automatically populated if using Advanced Fraud Tools. Currently only available when processing American Express via Amex Direct. Contact our Support team with any questions.

:customer_browser String

The User-Agent header provided by the customer's browser, which gives information about the browser. Maximum 255 characters.

:customer_ip String

The customer's IP address.

:service_fee_amount BigDecimal or String

The portion of a sub-merchant's transaction revenue that is routed to the master merchant account. If set, this value must be greater than or equal to 0, must match the appropriate currency format, and cannot exceed the transaction amount.

Available to Braintree Marketplace merchants and Partners. See charging a service fee and holding funds in escrow on Braintree Marketplace transactions.

:shared_billing_address_id String

For Shared Vault only

The ID of an address belonging to the OAuth application owner. If used in conjunction with a shared_customer_id, must belong to the specified customer.

:shared_customer_id String

For Shared Vault only

The ID of a customer belonging to the OAuth application owner. If no shared_payment_method_token is specified, the customer's default payment method will be used.

:shared_payment_method_token String

For Shared Vault only

The token of a payment method belonging to the OAuth application owner. If no shared_customer_id is explicitly specified, the customer that owns the payment method is implicitly specified. If used in conjunction with a shared_customer_id, must belong to the specified customer.

:shared_shipping_address_id String

For Shared Vault only

The ID of an address belonging to the OAuth application owner. If used in conjunction with a shared_customer_id, must belong to the specified customer.

:shipping

Shipping address information associated with a specific customer ID.

:company String

Company name. 255 character maximum.

:country_code_alpha2 String

The ISO 3166-1 alpha-2 country code specified in an address. The gateway only accepts specific alpha-2 values.

:country_code_alpha3 String

The ISO 3166-1 alpha-3 country code specified in an address. The gateway only accepts specific alpha-3 values.

:country_code_numeric String

The ISO 3166-1 numeric country code specified in an address. The gateway only accepts specific numeric values.

:country_name String

The country name specified in an address. We only accept specific country names.

:extended_address String

The extended address information—such as apartment or suite number. 255 character maximum.

:first_name String

The first name. The first name value must be less than or equal to 255 characters. Required if passing a PayPal shipping address.

:last_name String

The last name. The last name value must be less than or equal to 255 characters. Required if passing a PayPal shipping address.

:locality String

The locality/city. 255 character maximum. Required if passing a PayPal shipping address.

:postal_code String

The postal code. Postal code must be a string of 4-9 alphanumeric characters, optionally separated by a dash or a space. Spaces, hyphens, and all other special characters are ignored. Required if passing a PayPal shipping address.

:region String

The state or province. For PayPal addresses, the region must meet PayPal's state restrictions; for all other payment methods, it must be less than or equal to 255 characters. Required if passing a PayPal shipping address.

:street_address String

The street address. 255 character maximum. Only required for verification when AVS rules are configured to require street address. Required if passing a PayPal shipping address.

:shipping_address_id String

A shipping address associated with a specific customer ID. The maximum number of addresses per customer is 50.

:tax_amount BigDecimal or String

A Level II data field that specifies the amount of tax that was included in the total transaction amount. It cannot be negative, and it does not add to the total transaction amount.

:tax_exempt bool

A Level II data field that indicates whether or not the transaction should be considered eligible for tax exemption. This does not affect the total transaction amount.

:three_d_secure_pass_thru

Results of a merchant-performed 3D Secure authentication. You will only need to use these fields if you've performed your own integration with a 3D Secure MPI provider (e.g. Cardinal Centinel). Otherwise, Braintree's SDKs handle this for you in our standard 3D Secure integration.

:cavv String

Cardholder authentication verification value.

:eci_flag required, String

Electronic commerce indicator.

:xid String

Transaction identifier resulting from 3D Secure authentication.

:transaction_source String

Specifies the type of ecommerce indicator (ECI) flag to pass with the transaction. Accepted values:

  • recurring = Transactions for recurring payments or subscriptions.
  • moto = Transactions for mail or telephone orders.

Overrides the separate recurring param if both are present. If neither param is present, the default ecom ECI flag will be passed.

Examples

Full example

Here is an example of passing in everything a typical merchant might use.

Some parameters are mutually exclusive, so we'll show those in separate examples. If there is anything you want to store with the transaction details that we don't have a field for, you can always use custom fields.

Ruby
Click to copy
Copied
result = Braintree::Transaction.sale(
  :amount => "100.00",
  :order_id => "order id",
  :merchant_account_id => "a_merchant_account_id",
  :payment_method_nonce => nonce_from_the_client,
  :customer => {
    :first_name => "Drew",
    :last_name => "Smith",
    :company => "Braintree",
    :phone => "312-555-1234",
    :fax => "312-555-1235",
    :website => "http://www.example.com",
    :email => "drew@example.com"
  },
  :billing => {
    :first_name => "Paul",
    :last_name => "Smith",
    :company => "Braintree",
    :street_address => "1 E Main St",
    :extended_address => "Suite 403",
    :locality => "Chicago",
    :region => "IL",
    :postal_code => "60622",
    :country_code_alpha2 => "US"
  },
  :shipping => {
    :first_name => "Jen",
    :last_name => "Smith",
    :company => "Braintree",
    :street_address => "1 E 1st St",
    :extended_address => "Suite 403",
    :locality => "Bartlett",
    :region => "IL",
    :postal_code => "60103",
    :country_code_alpha2 => "US"
  },
  :options => {
    :submit_for_settlement => true
  },
)

If all the parameters are valid, a transaction will be created with a status of submitted_for_settlement and success? will return true.

Ruby
Click to copy
Copied
result.success?
#=> true
result.transaction.type
#=> "credit"
result.transaction.status
#=> "submitted_for_settlement"

Storing in Vault

When creating a transaction, you can also store the payment method in your Vault.

Existing customer with new payment method

To associate this transaction's payment method with an existing customer, pass a customer_id along with options.store_in_vault or options.store_in_vault_on_success as true.

Ruby
Click to copy
Copied
result = Braintree::Transaction.sale(
  :amount => "10.00",
  :payment_method_nonce => nonce_from_the_client,
  :customer_id => "the_customer_id",
  :options => {
    :store_in_vault_on_success => true
  }
)

New customer with new payment method

To store a payment method for a new customer, set options.store_in_vault or options.store_in_vault_on_success to true on your transaction. You can optionally specify customer parameters for your new customer, as well:

Ruby
Click to copy
Copied
result = Braintree::Transaction.sale(
  :amount => "10.00",
  :payment_method_nonce => nonce_from_the_client,
  :customer => {
    :id => "a_customer_id"
  },
  :options => {
    :store_in_vault_on_success => true
  }
)
note

store_in_vault_on_success vaults the payment method only if the transaction is successful.

Using a vaulted payment method

You can create a transaction using a payment method stored in the Vault by passing a payment_method_token:

Ruby
Click to copy
Copied
result = Braintree::Transaction.sale(
  :payment_method_token => "the_token",
  :amount => "10.00"
)

Or use customer_id, which will use the customer's default payment method:

Ruby
Click to copy
Copied
result = Braintree::Transaction.sale(
  :customer_id => "the_customer_id",
  :amount => "10.00"
)

Specify merchant account

To specify which merchant account to use, pass the merchant_account_id when creating the transaction.

Ruby
Click to copy
Copied
result = Braintree::Transaction.sale(
  :amount => "10.00",
  :merchant_account_id => "your_merchant_account",
  :payment_method_nonce => nonce_from_the_client
)

If you don't specify the merchant account to use to process a transaction, Braintree will process it using your default merchant account.

If you would like to change which merchant account is default, contact our Support team.

Using stored addresses

You can use addresses stored on a customer by passing the address's ID. This works for both the shipping address and billing address.

Ruby
Click to copy
Copied
result = Braintree::Transaction.sale(
  :customer_id => "the_customer_id",
  :amount => "10.00",
  :billing_address_id => "AA",
  :shipping_address_id => "AB"
)

Custom fields

Whatever you configure as the API name for your custom fields will be used when setting them on the transaction. Here is an example of setting custom fields with API names of custom_field_one and custom_field_two.

Ruby
Click to copy
Copied
result = Braintree::Transaction.sale(
  :amount => "10.00",
  :payment_method_nonce => nonce_from_the_client,
  :custom_fields => {
    :custom_field_one => "value one",
    :custom_field_two => "value two"
  }
)

if result.success?
  result.transaction.custom_fields
  #=> {:custom_field_one => "value one", :custom_field_two => "value two"}
end

Dynamic descriptors

Dynamic descriptors are typically composed of a name and phone number or URL. The name generally includes both the business name and product name, separated by an asterisk (*). Depending on the type of transaction you're creating, the length/character limits may differ from those outlined above. For example, you can only specify up to 18 characters for dynamic descriptor names on Braintree Marketplace transactions. See below for details on PayPal and Braintree Marketplace dynamic descriptors.

Your processor may also restrict which descriptor values you can pass; certain processors allow you to pass URLs instead of phone numbers, while others accept only phone numbers or only names. If your processor supports URLs and you send both a phone number and URL, we will only pass the URL to the processor. Contact Support for more information on your processor's specific requirements.

Ruby
Click to copy
Copied
result = Braintree::Transaction.sale(
  :amount => "10.00",
  :payment_method_nonce => nonce_from_the_client,
  :descriptor => {
    :name => "company*my product",
    :phone => "3125551212",
    :url => "company.com"
  }
)

result.transaction.descriptor.name
#=> "company*my product"

result.transaction.descriptor.phone
#=> "3125551212"

PayPal

Only the name of the descriptor will be passed for PayPal transactions. The PayPal dynamic descriptor includes the prefix PAYPAL * by default and is truncated to a total of 22 characters to follow PayPal's descriptor character limit.

The payment information displayed to a customer in their PayPal account overview does not contain the dynamic descriptor. The information displayed there is data the merchant has configured with PayPal directly (e.g. business name, email address, business contact details).

Braintree Marketplace

The only dynamic descriptor value we will pass for Braintree Marketplace transactions is the name you specify. We will not send any dynamic phone or url values to the processor, but we will pass the phone from the hard descriptor on your master merchant account.

The dynamic descriptor name can only contain the ASCII characters a-z, A-Z, the numbers 0-9, and the characters .-+ and spaces (it cannot contain special characters like Ñ, ü, and é). The maximum length is 18 characters; we will truncate any longer strings. The descriptor we pass to the processor will start with "BT *", followed by the name you specify.

  • If the specified name is 12 characters or fewer, the descriptor we pass to the processor will end with a randomly generated 6-character string (e.g. 123abc) which identifies the sub-merchant:
    Click to copy
    Copied
    BT *MYDESCRIPTOR123abc
  • If the specified name is 13 characters or greater, the descriptor we pass to the processor will not end with a randomly generated 6-character string:
    Click to copy
    Copied
    BT *MYDESCRIPTORISLONG
note

The sub-merchant cannot access the 6-character string—we automatically append it to the descriptor name after you submit the transaction request. The string cannot be changed, as it is required in order to identify each transaction we process for the sub-merchant.

Hold a Braintree Marketplace transaction in escrow on creation

Upon creating a Braintree Marketplace transaction, you can specify that its funds should be held in escrow. These funds can then be released at your discretion. By default, funds are not held in escrow.

Ruby
Click to copy
Copied
result = Braintree::Transaction.sale(
  :amount => "100.00",
  :merchant_account_id => "blue_ladders_store",
  :payment_method_nonce => nonce_from_the_client,
  :options => {
    :submit_for_settlement => true,
    :hold_in_escrow => true
  },
  :service_fee_amount => "10.00"
)

Still have questions?

If you can’t find an answer, contact our Support team.