A record that includes all details of a transaction, including current status.

Returned directly or within a successful result object from the following requests:

Attributes
add_ons Array of AddOn objects

The collection of add-ons associated with a subscription.
additional_processor_response String

Optional additional processor response information, provided as further context for the primary processor response.
amount BigDecimal

The billing amount of the request.
android_pay_details

If payment_instrument_type is "android_pay_card", these are the details of the card used for the transaction.

note

Google Pay cards are represented as Android Pay cards in our API to prevent breaking changes.
bin String

The first 6 digits of the card number, also known as the Bank Identification Number (BIN). If this Google Pay card is network tokenized, its BIN may differ from the BIN of the underlying source card.
commercial enum

Whether the card type is a commercial card and is capable of processing Level 2 transactions. Possible values:

  • Braintree::CreditCard::Commercial::Yes
  • Braintree::CreditCard::Commercial::No
  • Braintree::CreditCard::Commercial::Unknown
country_of_issuance String

The country that issued the credit card. Possible country values follow ISO 3166-1.

The value Unknown will be returned if we cannot immediately determine the card's country of issuance from the bank identification number (BIN).
debit enum

Whether the card is a debit card. Possible values:

  • Braintree::CreditCard::Debit::Yes
  • Braintree::CreditCard::Debit::No
  • Braintree::CreditCard::Debit::Unknown
durbin_regulated enum

A value indicating whether the issuing bank's card range is regulated by the Durbin Amendment due to the bank's assets. Possible values:

  • Braintree::CreditCard::DurbinRegulated::Yes
  • Braintree::CreditCard::DurbinRegulated::No
  • Braintree::CreditCard::DurbinRegulated::Unknown
expiration_month String

The expiration month of the credit card, formatted MM.
expiration_year String

The 2- or 4-digit year associated with the credit card, formatted YY or YYYY.
google_transaction_id String

A unique identifier provided by Google to track the payment method's transactions.
healthcare enum

Whether the card is a healthcare card. Possible values:

  • Braintree::CreditCard::HealthCare::Yes
  • Braintree::CreditCard::HealthCare::No
  • Braintree::CreditCard::HealthCare::Unknown
image_url String

A URL that points to a payment method image resource (a PNG file) hosted by Braintree.
is_network_tokenized bool

Indicates whether this card has been network tokenized. A network tokenized card is a generated virtual card with a device-specific account number (DPAN) that is used in place of the underlying source card.
payroll enum

Whether the card is a payroll card. Possible values:

  • Braintree::CreditCard::Payroll::Yes
  • Braintree::CreditCard::Payroll::No
  • Braintree::CreditCard::Payroll::Unknown
prepaid enum

Whether the card is a prepaid card. Possible values:

  • Braintree::CreditCard::Prepaid::Yes
  • Braintree::CreditCard::Prepaid::No
  • Braintree::CreditCard::Prepaid::Unknown
product_id String

The code for the product type of the card (e.g. D (Visa Signature Preferred), G (Visa Business)). See Product ID codes below for possible values.
source_card_last_4 String

The last 4 digits of the card number. If this card is network tokenized, this is the last 4 digits of the customer's actual card.
source_card_type String

The card type. If this card is network tokenized, this is the card type of the customer's actual card.
source_description String

Indicates what type of payment method was tokenized by the network. Also includes an identifier for the account (e.g. last 4 digits if the payment method was a credit card).
token String

An alphanumeric value that references a specific payment method stored in your Vault. Value will be nil if the transaction was not created from a vaulted Android Pay card.
virtual_card_last_4 String

The last 4 digits of the card number. If this card is network tokenized, this is the last 4 digits of the device-specific account number (DPAN).
virtual_card_type String

The card type. If this card is network tokenized, this is the card type of the network tokenized card.
apple_pay_details

If payment_instrument_type is "apple_pay_card", these are the details of the credit card used for the transaction.
bin String

The first 6 digits of the device-specific account number (DPAN), known as the Bank Identification Number. This BIN may differ from the BIN of the underlying card.
card_type String

The type of the credit card. Possible values:

  • Apple Pay - Visa
  • Apple Pay - MasterCard
  • Apple Pay - American Express
  • Apple Pay - Discover
cardholder_name String

The cardholder name associated with the credit card.
commercial enum

Whether the card type is a commercial card and is capable of processing Level 2 transactions. Possible values:

  • Braintree::CreditCard::Commercial::Yes
  • Braintree::CreditCard::Commercial::No
  • Braintree::CreditCard::Commercial::Unknown
country_of_issuance String

The country that issued the credit card. Possible country values follow ISO 3166-1.

The value Unknown will be returned if we cannot immediately determine the card's country of issuance from the bank identification number (BIN).
debit enum

Whether the card is a debit card. Possible values:

  • Braintree::CreditCard::Debit::Yes
  • Braintree::CreditCard::Debit::No
  • Braintree::CreditCard::Debit::Unknown
durbin_regulated enum

A value indicating whether the issuing bank's card range is regulated by the Durbin Amendment due to the bank's assets. Possible values:

  • Braintree::CreditCard::DurbinRegulated::Yes
  • Braintree::CreditCard::DurbinRegulated::No
  • Braintree::CreditCard::DurbinRegulated::Unknown
expiration_month String

The expiration month of the credit card, formatted MM.
expiration_year String

The 4-digit expiration year of the credit card, formatted YYYY.
healthcare enum

Whether the card is a healthcare card. Possible values:

  • Braintree::CreditCard::HealthCare::Yes
  • Braintree::CreditCard::HealthCare::No
  • Braintree::CreditCard::HealthCare::Unknown
image_url String

A URL that points to a payment method image resource (a PNG file) hosted by Braintree.
issuing_bank String

The bank that issued the credit card.
last_4 String

The last 4 digits of the device-specific account number (DPAN).
payment_instrument_name String

A description of the payment method intended for display to the user, typically card type and last 4 digits of the physical card number stored by Wallet (formerly Passbook). We receive this description alongside the DPAN when processing an Apple Pay transaction.
payroll enum

Whether the card is a payroll card. Possible values:

  • Braintree::CreditCard::Payroll::Yes
  • Braintree::CreditCard::Payroll::No
  • Braintree::CreditCard::Payroll::Unknown
prepaid enum

Whether the card is a prepaid card. Possible values:

  • Braintree::CreditCard::Prepaid::Yes
  • Braintree::CreditCard::Prepaid::No
  • Braintree::CreditCard::Prepaid::Unknown
product_id String

The code for the product type of the card (e.g. D (Visa Signature Preferred), G (Visa Business)). See Product ID codes below for possible values.
source_description String

Indicates what type of payment method was tokenized by the network. Also includes an identifier for the account (e.g. last 4 digits if the payment method was a credit card).
token String

An alphanumeric value that references a specific payment method stored in your Vault. Value will be nil if the transaction was not created from a vaulted Apple Pay card.
authorization_adjustments

A collection of authorization adjustments associated with the transaction.
authorization_expires_at Time

The date/time the transaction will expire if it has the authorized status. For more details on authorization expiration timeframes, see the Statuses reference.
avs_error_response_code

This field is populated if there was an error when checking AVS or the processing bank does not support AVS. Possible values:

  • S = Issuing bank does not support AVS
  • E = AVS system error


If this value is nil, you will see responses in both avs_postal_code_response_code and avs_street_address_response_code.
avs_postal_code_response_code

This is populated if the processor supports the address verification system (AVS). Possible values:

  • M = Matches
  • N = Does not match
  • U = Not verified
  • I = Not provided
  • A = Not applicable
  • B = Bypass
avs_street_address_response_code

This is populated if the processor supports the address verification system (AVS). Possible values:

  • M = Matches
  • N = Does not match
  • U = Not verified
  • I = Not provided
  • A = Not applicable
  • B = Bypass
billing_details

The billing address details used to process this transaction. If billing address was stored in the Vault, then the billing_details is a snapshot of the address in the Vault at the time the transaction was created.

company String

The billing company name. See the transaction API requests section for details.
country_code_alpha2 String

The 2-letter billing country code. See the transaction API requests section for details.
country_code_alpha3 String

The 3-letter billing country code. See the transaction API requests section for details.
country_code_numeric String

The numeric billing country code. See the transaction API requests section for details.
country_name String

The billing country name. See the transaction API requests section for details.
extended_address String

The extended billing address. See the transaction API requests section for details.
first_name String

The first name. See the transaction API requests section for details.
id String

The billing details ID. A customer Vault record can contain up to 50 shipping and billing addresses, each with a unique ID. See the transaction API requests section for details.
last_name String

The last name. See the transaction API requests section for details.
locality String

The locality/city. See the transaction API requests section for details.
postal_code String

The postal code. See the transaction API requests section for details.
region String

The state or province. See the transaction API requests section for details.
street_address String

The street address. See the transaction API requests section for details.
channel String

If the transaction request was performed through a shopping cart provider or Braintree partner, this field will have a string identifier for that shopping cart provider or partner. For PayPal transactions, this maps to the PayPal account's bn_code.
created_at Time

The date/time the object was created.
credit_card_details

If payment_instrument_type is "credit_card", these are the details of the card used for the transaction. If the transaction was created using Vault tokens, then this attribute is a snapshot of the credit card in the Vault at the time the transaction was created.
bin

The first 6 digits of the credit card, known as the bank identification number (BIN).
card_type

The type of the credit card. Possible values:

  • American Express
  • Carte Blanche
  • China UnionPay
  • Discover
  • Elo
  • JCB
  • Laser
  • Maestro
  • MasterCard
  • Solo
  • Switch
  • Visa
  • Unknown
cardholder_name String

The cardholder name associated with the credit card.
commercial enum

Whether the card type is a commercial card and is capable of processing Level 2 transactions. Possible values:

  • Braintree::CreditCard::Commercial::Yes
  • Braintree::CreditCard::Commercial::No
  • Braintree::CreditCard::Commercial::Unknown
country_of_issuance String

The country that issued the credit card. Possible country values follow ISO 3166-1.

The value Unknown will be returned if we cannot immediately determine the card's country of issuance from the bank identification number (BIN).
customer_location enum

This is "US" if the billing address is in the US or if a country is not specified. The location is "International" if the billing country passed is not the US. Possible values:

  • Braintree::CreditCard::CustomerLocation::International
  • Braintree::CreditCard::CustomerLocation::US
debit enum

Whether the card is a debit card. Possible values:

  • Braintree::CreditCard::Debit::Yes
  • Braintree::CreditCard::Debit::No
  • Braintree::CreditCard::Debit::Unknown
durbin_regulated enum

A value indicating whether the issuing bank's card range is regulated by the Durbin Amendment due to the bank's assets. Possible values:

  • Braintree::CreditCard::DurbinRegulated::Yes
  • Braintree::CreditCard::DurbinRegulated::No
  • Braintree::CreditCard::DurbinRegulated::Unknown
expiration_date String

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

The expiration month of the credit card used, formatted MM.
expiration_year String

The expiration year of the credit card used, formatted YYYY.
healthcare enum

Whether the card is a healthcare card. Possible values:

  • Braintree::CreditCard::HealthCare::Yes
  • Braintree::CreditCard::HealthCare::No
  • Braintree::CreditCard::HealthCare::Unknown
image_url

A URL that points to an image resource (a PNG file) hosted by Braintree, which represents the issuing card network (Visa, Mastercard, American Express, Discover, JCB).
issuing_bank String

The bank that issued the credit card.
last_4

The last 4 digits of the credit card number.
masked_number

A value comprising the bank identification number (BIN), 6 asterisks blocking out the middle numbers (regardless of the number of digits present), and the last 4 digits of the card number. This complies with PCI security standards.
payroll enum

Whether the card is a payroll card. Possible values:

  • Braintree::CreditCard::Payroll::Yes
  • Braintree::CreditCard::Payroll::No
  • Braintree::CreditCard::Payroll::Unknown
prepaid enum

Whether the card is a prepaid card. Possible values:

  • Braintree::CreditCard::Prepaid::Yes
  • Braintree::CreditCard::Prepaid::No
  • Braintree::CreditCard::Prepaid::Unknown
product_id String

The code for the product type of the card (e.g. D (Visa Signature Preferred), G (Visa Business)). See Product ID codes below for possible values.
token String

The Vault token for the credit card. Unlike other attributes in this details map, this attribute is not a snapshot – if you update the payment method token after creating a transaction, the credit_card_details.token attribute will return the new value rather than the value associated with the transaction at the time it was created. See the transaction API requests section for additional details.
unique_number_identifier

A randomly-generated string that uniquely identifies a credit card number in the Vault. If the same credit card is added to a merchant's Vault multiple times, each Vault entry will have the same unique identifier. This value is randomly generated by merchant gateway account, so it will be different for each merchant's Vault.
currency_iso_code

The currency for the transaction (e.g. "USD" for US dollars). See the ISO 4217 codes.
custom_fields

A collection of custom field/value pairs.
customer_details

The customer details used to process this transaction. If the transaction was created using Vault tokens, then the customer_details is a snapshot of the customer in the Vault at the time the transaction was created.
company String

The customer company name. See the transaction API requests section for details.
email String

The email address. See the transaction API requests section for details.
fax String

The customer fax number. See the transaction API requests section for details.
first_name String

The first name. See the transaction API requests section for details.
id String

Reference value that is associated with the customer's id at the time of the transaction.
last_name String

The last name. See the transaction API requests section for details.
phone String

The customer phone number. See the transaction API requests section for details.
website String

The customer website address. See the transaction API requests section for details.
cvv_response_code

The processing bank's response to the card verification value (CVV) provided by the customer. Possible values:

  • M = Matches
  • N = Does not match
  • U = Not verified
  • I = Not provided
  • S = Issuer does not participate
  • A = Not applicable
  • B = Bypass
descriptor
name String

The value in the business name field of a customer's statement.
phone String

The value in the phone number field of a customer's statement.
url String

The value in the URL/web address field of a customer's statement.
disbursement_details

Disbursement details contain information about how and when the transaction was disbursed, including timing and currency information. This detail is only available if you have an eligible merchant account.
disbursement_date

The date that the funds associated with this transaction were disbursed. This attribute is only available if you have an eligible merchant account.
funds_held? bool

A value indicating whether funds have been withheld from a disbursement to the merchant's bank account.
settlement_amount BigDecimal

The amount of the transaction in the settlement currency. This attribute is only available if you have an eligible merchant account.
settlement_currency_exchange_rate

The exchange rate from the presentment currency to the settlement currency. This attribute is only available if you have an eligible merchant account.
settlement_currency_iso_code

The settlement currency. See the ISO 4217 codes. This attribute is only available if you have an eligible merchant account.
success?

A value indicating whether the funds were disbursed successfully. This value can change over time if we receive an exception and then retry the disbursement. This attribute is only available on eligible merchant accounts.

Some of the most common reasons that funds are held from disbursement are risk reviews of the merchant's recent processing or as a result of ACH returns or rejects. If funds are held (for any reason) you will be notified with the proper steps to take.
discount_amount BigDecimal

The data field that specifies the discount amount that was included in the total transaction amount. It can't be negative, and it does not add to the total transaction amount. If Braintree has approved your merchant account for Level 3 processing, we will pass this field to the processor on your behalf.
discounts Array of Discount objects

A collection of discounts associated with this subscription.
disputes Array of Dispute objects

A collection of disputes associated with the transaction.
escrow_status

This attribute is only available to Braintree Marketplace merchants. See Holding funds in escrow to learn more. Possible values:

  • "hold_pending"
  • "held"
  • "release_pending"
  • "released"
  • "refunded"
facilitated_details

If the transaction request was performed using payment information from a third party via the Grant API or Shared Vault, these fields will capture information about the merchant of record. These fields are primarily useful for the third party.
merchant_id String

The merchant ID of the merchant of record.
merchant_name String

The name of the business associated with the merchant of record.
payment_method_nonce String

The granted payment_method_nonce used to create the transaction. Only populated if the transaction was created with a nonce granted via the Grant API.
facilitator_details

If the transaction request was performed using payment information from a third party via the Grant API, Shared Vault or Google Pay, these fields will capture information about the third party. These fields are primarily useful for the merchant of record.
oauth_application_client_id String

The unique identifier for the OAuth application that owns the payment information used to create the transaction.
oauth_application_name String

The display name of the OAuth application that owns the payment information used to create the transaction.
source_payment_method_token String

The alphanumeric value that references a specific payment method stored in the facilitator's Vault.
gateway_rejection_reason

This value will only be set if the transaction status is gateway_rejected. Possible values:

  • "application_incomplete"
  • "avs"
  • "avs_and_cvv"
  • "cvv"
  • "duplicate"
  • "fraud"
  • "risk_threshold"
  • "three_d_secure"
  • "token_issuance"
id String

The unique transaction identifier. Length and format of gateway-generated tokens and IDs may change at any time.
line_items

A collection of line items associated with the transaction.
masterpass_card_details

If payment_instrument_type is "masterpass_card", these are the details of the card used for the transaction. If the transaction was created using Vault tokens, then this attribute is a snapshot of the Masterpass card in the Vault at the time the transaction was created.
bin

The first 6 digits of the credit card, known as the bank identification number (BIN).
card_type

The type of the credit card. Possible values:

  • American Express
  • Discover
  • JCB
  • Maestro
  • MasterCard
  • Visa
cardholder_name String

The cardholder name associated with the credit card.
commercial enum

Whether the card type is a commercial card and is capable of processing Level 2 transactions. Possible values:

  • Braintree::CreditCard::Commercial::Yes
  • Braintree::CreditCard::Commercial::No
  • Braintree::CreditCard::Commercial::Unknown
country_of_issuance String

The country that issued the credit card. Possible country values follow ISO 3166-1.

The value Unknown will be returned if we cannot immediately determine the card's country of issuance from the bank identification number (BIN).
customer_location enum

This is "US" if the billing address is in the US or if a country is not specified. The location is "International" if the billing country passed is not the US. Possible values:

  • Braintree::CreditCard::CustomerLocation::International
  • Braintree::CreditCard::CustomerLocation::US
debit enum

Whether the card is a debit card. Possible values:

  • Braintree::CreditCard::Debit::Yes
  • Braintree::CreditCard::Debit::No
  • Braintree::CreditCard::Debit::Unknown
durbin_regulated enum

A value indicating whether the issuing bank's card range is regulated by the Durbin Amendment due to the bank's assets. Possible values:

  • Braintree::CreditCard::DurbinRegulated::Yes
  • Braintree::CreditCard::DurbinRegulated::No
  • Braintree::CreditCard::DurbinRegulated::Unknown
expiration_date String

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

The expiration month of the credit card used, formatted MM.
expiration_year String

The expiration year of the credit card used, formatted YYYY.
healthcare enum

Whether the card is a healthcare card. Possible values:

  • Braintree::CreditCard::HealthCare::Yes
  • Braintree::CreditCard::HealthCare::No
  • Braintree::CreditCard::HealthCare::Unknown
image_url

A URL that points to an image resource (a PNG file) hosted by Braintree, which represents the issuing card network (Visa, Mastercard, American Express, Discover).
issuing_bank String

The bank that issued the credit card.
last_4

The last 4 digits of the credit card number.
masked_number

A value comprising the bank identification number (BIN), 6 asterisks blocking out the middle numbers (regardless of the number of digits present), and the last 4 digits of the card number. This complies with PCI security standards.
payroll enum

Whether the card is a payroll card. Possible values:

  • Braintree::CreditCard::Payroll::Yes
  • Braintree::CreditCard::Payroll::No
  • Braintree::CreditCard::Payroll::Unknown
prepaid enum

Whether the card is a prepaid card. Possible values:

  • Braintree::CreditCard::Prepaid::Yes
  • Braintree::CreditCard::Prepaid::No
  • Braintree::CreditCard::Prepaid::Unknown
product_id String

The code for the product type of the card (e.g. D (Visa Signature Preferred), G (Visa Business)). See Product ID codes below for possible values.
token String

The Vault token for the Masterpass card. Unlike other attributes in this details map, this attribute is not a snapshot – if you update the payment method token after creating a transaction, the masterpass_card_details.token attribute will return the new value rather than the value associated with the transaction at the time it was created. See the transaction API requests section for additional details.
merchant_account_id String

The merchant account ID used to create a transaction. Currency is also determined by merchant account ID.
network_response_code String

The network response code. When present, this field can provide additional detail about why a transaction was declined, but the processor_response_code should be considered the source of truth. See the list of possible network responses.
network_response_text String

The network response text for the network_response_code.
network_transaction_id String

The network transaction identifier provided by the payment network. This should be provided in requests to create subsequent transactions if the card used in this transaction is being stored in an external vault. This identifier can be passed in the external_vault.previous_network_transaction_id field of subsequent transactions.
order_id String

The order ID of the transaction. On PayPal transactions, this field maps to the PayPal invoice number. PayPal invoice numbers are unique in your PayPal business account.
payment_instrument_type

The method of payment used to process the transaction. Possible values:

  • "android_pay_card"
  • "apple_pay_card"
  • "credit_card"
  • "masterpass_card"
  • "paypal_account"
  • "paypal_here"
  • "samsung_pay_card"
  • "us_bank_account"
  • "venmo_account"
  • "visa_checkout_card"
paypal_details

If payment_instrument_type is "paypal_account", these are the details of the PayPal account used for the transaction.
authorization_id String

The identification value of the authorization within PayPal's API.
capture_id String

PayPal id for a transaction.
custom_field String

Custom field/value pairs.
image_url String

A URL that points to a PayPal image resource (a PNG file) hosted by Braintree.
payer_email String

The email address associated with the PayPal account that was used to create the request. This field will not be populated if the PayPal transaction declines and the payment method was not previously stored in the Vault.
payer_first_name String

The first name associated with the PayPal account used to create the request.
payer_id String

The identifier for the PayPal account used in the request.
payer_last_name String

The last name associated with the PayPal account used to create the request.
payer_status String

The status of the PayPal account used to create the request.
payment_id String

The identification value of the payment within PayPal's API.
refund_from_transaction_fee_amount String

The refund from the transaction fee amount of the PayPal transaction.

A refund from transaction fee of 1 will always be returned for sandbox integrations.
refund_from_transaction_fee_currency_iso_code String

The currency of the associated refund from the transaction fee.
refund_id String

PayPal id for a refund.
seller_protection_status String

Indicates whether a transaction qualifies for PayPal Seller Protection.
shipping_option_id String

The identification value of the shipping option selected during PayPal Checkout.
tax_id String

Payer's tax id. Only returned for payments from Brazilian accounts.
tax_id_type String

Payer's tax id type. Only returned for payments from Brazilian accounts. Allowed values BR_CPF or BR_CNPJ.
token String

An alphanumeric value that references a specific payment method stored in your Vault. Length and format of gateway-generated tokens and IDs may change at any time.
transaction_fee_amount String

The transaction fee amount of the PayPal transaction.

A transaction fee of 1 will always be returned for sandbox integrations.
transaction_fee_currency_iso_code String

The currency of the associated transaction fee.
paypal_here_details

If payment_instrument_type is "paypal_here", these are the details of the PayPal Here payment method used for the transaction. See the PayPal Here guide for details.
authorization_id String

The identification value of the authorization within PayPal's API.
capture_id String

PayPal ID for a transaction.
invoice_id String

PayPal ID for the invoice for the transaction.
last_4 String

The last 4 digits of the credit card number.
payment_id String

The identification value of the payment within PayPal's API.
payment_type String

The type of the credit card. Possible values:

  • A - American Express
  • D - Discover
  • J - JCB
  • T - Maestro
  • M - MasterCard
  • V - Visa
refund_id String

PayPal ID for a refund.
transaction_fee_amount

The amount of the transaction fee assessed for the PayPal Here transaction.
transaction_fee_currency_iso_code String

The currency of the associated transaction fee.
transaction_initiation_date Time

The date/time the transaction was initiated in PayPal systems.
transaction_updated_date Time

The date/time the transaction was last updated in PayPal systems.
plan_id String

The plan identifier.
processor_authorization_code

The authorization code returned by the processor.
processor_response_code String

The processor response code. See the list of possible processor authorization responses.
processor_response_text String

The processor response text. See the list of possible processor authorization responses.
processor_response_type String

The processor response type. Possible values:

  • "approved"
  • "soft_declined"
  • "hard_declined"

See the list of possible processor authorization responses, and definitions of soft and hard declines.
processor_settlement_response_code String

The status of the request to capture the funds. See the list of possible processor settlement responses.
processor_settlement_response_text String

The text explanation of the above processor settlement response code.
purchase_order_number String

A Level 2 data field that can be used to store a purchase order identification value.
recurring

A value indicating whether the transaction was passed with a recurring ecommerce indicator (ECI) flag.
refund_ids

The transaction refund ID(s) associated with a sale transaction. See the transaction API requests section for details.
refunded_transaction_id String

The sale transaction ID associated with a refund transaction. See the transaction API requests section for details.
risk_data

Any applicable risk data associated with the transaction. The data includes the risk identifier, the device data captured flag, and the risk decision, which can provide further context on how a transaction was scored by Braintree.
decision String

The risk decision. Possible values:

  • Not Evaluated
  • Approve
  • Review
  • Decline
device_data_captured bool

Flag indicating whether device session data was successfully captured and processed by the fraud service. Currently available in the .NET, Node, and PHP client libraries.
fraud_service_provider String

The fraud service used to determine if a transaction is likely to be fraudulent.
id String

The risk data identifier.
samsung_pay_card_details

If payment_instrument_type is "samsung_pay_card", these are the details of the card used for the transaction. If the transaction was created using Vault tokens, then this attribute is a snapshot of the Samsung Pay card in the Vault at the time the transaction was created.
bin

The first 6 digits of the credit card, known as the bank identification number (BIN).
card_type

The type of the credit card. Possible values:

  • American Express
  • MasterCard
  • Visa
cardholder_name String

The cardholder name associated with the credit card.
commercial enum

Whether the card type is a commercial card and is capable of processing Level 2 transactions. Possible values:

  • Braintree::CreditCard::Commercial::Yes
  • Braintree::CreditCard::Commercial::No
  • Braintree::CreditCard::Commercial::Unknown
country_of_issuance String

The country that issued the credit card. Possible country values follow ISO 3166-1.

The value Unknown will be returned if we cannot immediately determine the card's country of issuance from the bank identification number (BIN).
customer_location enum

This is "US" if the billing address is in the US or if a country is not specified. The location is "International" if the billing country passed is not the US. Possible values:

  • Braintree::CreditCard::CustomerLocation::International
  • Braintree::CreditCard::CustomerLocation::US
debit enum

Whether the card is a debit card. Possible values:

  • Braintree::CreditCard::Debit::Yes
  • Braintree::CreditCard::Debit::No
  • Braintree::CreditCard::Debit::Unknown
durbin_regulated enum

A value indicating whether the issuing bank's card range is regulated by the Durbin Amendment due to the bank's assets. Possible values:

  • Braintree::CreditCard::DurbinRegulated::Yes
  • Braintree::CreditCard::DurbinRegulated::No
  • Braintree::CreditCard::DurbinRegulated::Unknown
expiration_date String

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

The expiration month of the credit card used, formatted MM.
expiration_year String

The expiration year of the credit card used, formatted YYYY.
healthcare enum

Whether the card is a healthcare card. Possible values:

  • Braintree::CreditCard::HealthCare::Yes
  • Braintree::CreditCard::HealthCare::No
  • Braintree::CreditCard::HealthCare::Unknown
image_url

A URL that points to an image resource (a PNG file) hosted by Braintree, which represents the issuing card network (Visa, Mastercard, American Express, Discover).
issuing_bank String

The bank that issued the credit card.
last_4

The last 4 digits of the credit card number.
masked_number

A value comprising the bank identification number (BIN), 6 asterisks blocking out the middle numbers (regardless of the number of digits present), and the last 4 digits of the card number. This complies with PCI security standards.
payroll enum

Whether the card is a payroll card. Possible values:

  • Braintree::CreditCard::Payroll::Yes
  • Braintree::CreditCard::Payroll::No
  • Braintree::CreditCard::Payroll::Unknown
prepaid enum

Whether the card is a prepaid card. Possible values:

  • Braintree::CreditCard::Prepaid::Yes
  • Braintree::CreditCard::Prepaid::No
  • Braintree::CreditCard::Prepaid::Unknown
product_id String

The code for the product type of the card (e.g. D (Visa Signature Preferred), G (Visa Business)). See Product ID codes below for possible values.
source_card_last_4 String

The last 4 digits of the payment method tokenized by the network.
token String

The Vault token for the Samsung Pay card. Unlike other attributes in this details map, this attribute is not a snapshot – if you update the payment method token after creating a transaction, the samsung_pay_card_details.token attribute will return the new value rather than the value associated with the transaction at the time it was created. See the transaction API requests section for additional details.
service_fee_amount BigDecimal

The portion of a sub-merchant's transaction revenue that was routed to the master merchant account.

Available to Braintree Marketplace merchants. See Creating Transactions with Service Fees for more details.
settlement_batch_id String

The identification value of the settlement batch in which the transaction was processed. The format may change at any time but is currently YYYY-MM-DD_m_d where m is the merchant account token without special characters and d is an alphanumeric string to guarantee uniqueness.
shipping_amount BigDecimal

The data field that specifies the shipping cost on the entire transaction. It can't be negative, and it does not add to the total transaction amount. If Braintree has approved your merchant account for Level 3 processing, we will pass this field to the processor on your behalf.
shipping_details

The shipping address details used to process this transaction. If shipping address was stored in the Vault, then the shipping_details is a snapshot of the address in the Vault at the time the transaction was created.
company String

The shipping company name. See the transaction API requests section for details.
country_code_alpha2 String

The 2-letter shipping country code. See the transaction API requests section for details.
country_code_alpha3 String

The 3-letter shipping country code. See the transaction API requests section for details.
country_code_numeric String

The numeric shipping country code. See the transaction API requests section for details.
country_name String

The shipping country name. See the transaction API requests section for details.
extended_address String

The extended shipping address. See the transaction API requests section for details.
first_name String

The first name. See the transaction API requests section for details.
id String

The shipping details ID. A customer Vault record can contain up to 50 shipping and billing addresses, each with a unique ID. See the transaction API requests section for details.
last_name String

The last name. See the transaction API requests section for details.
locality String

The locality/city. See the transaction API requests section for details.
postal_code String

The postal code. See the transaction API requests section for details.
region String

The state or province. See the transaction API requests section for details.
street_address String

The street address. See the transaction API requests section for details.
ships_from_postal_code String

The data field that specifies the postal code of the shipping location. If Braintree has approved your merchant account for Level 3 processing, we will pass this field to the processor on your behalf.
status String

Possible values:

  • AuthorizationExpired
  • Authorized
  • Authorizing
  • SettlementPending
  • SettlementDeclined
  • Failed
  • GatewayRejected
  • ProcessorDeclined
  • Settled
  • Settling
  • SubmittedForSettlement
  • Voided

See the transaction status explanations for details.
status_history

A collection of status history details showing the transaction's status changes over time.
subscription_details
billing_period_end_date

The end date for the current billing period, regardless of subscription status. Automatic retries on past due subscriptions do not change the start and end dates of the current billing period.
billing_period_start_date

The start date for the current billing period, regardless of subscription status. Automatic retries on past due subscriptions do not change the start and end dates of the current billing period.
subscription_id String

The value used to identify a specific subscription.
tax_amount BigDecimal

A Level 2 data field that specifies the amount of tax that was included in the total transaction amount. It is never negative, and it does not add to the total transaction amount.
tax_exempt bool

A Level 2 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_info

The 3D Secure information for this transaction.
cavv String

Cardholder Authentication Verification Value or "CAVV". The main encrypted message issuers and card networks use to verify authentication has occured. Mastercard refers to this field as AAV, while American Express refers to this field as AEVV.
ds_transaction_id String

Transaction identifier resulting from 3D Secure 2 authentication.
eci_flag String

The value of the electronic commerce indicator (ECI) flag, which indicates the outcome of the 3DS authentication.

Possible values for Mastercard:

  • 00 = Failed or not attempted
  • 01 = Attempted
  • 02 = Success

Possible values for all other card brands:

  • 07 = Failed or not attempted
  • 06 = Attempted
  • 05 = Success
enrolled String

Indicates whether a card is enrolled in a 3D Secure program or not. Possible values:

  • Y = Yes
  • N = No
  • U = Unavailable
  • B = Bypass
  • E = RequestFailure
liability_shift_possible? bool

Indicates whether a liability shift is possible.
liability_shifted? bool

Indicates whether the liability shifted or not.
status String

The 3D Secure status value. For a list of all possible statuses and their liability shifts, see the 3D Secure guide.
three_d_secure_version String

The version of 3D Secure authentication used for the transaction. Composed of digits separated by periods (e.g. 1.0.2, 2.1.0).
xid String

Transaction identifier resulting from 3D Secure authentication. This field will no longer be used in 3D Secure 2 authentications.
type String

The value that defines whether a transaction is a sale or credit.
updated_at Time

The date/time the object was last updated.
venmo_account

If payment_instrument_type is "venmo_account", these are the details of the Venmo account used for the transaction.

Venmo payments are currently in a limited release and are only available to select merchants. See the Venmo guide for details.
image_url String

A URL that points to a payment method image resource (a PNG file) hosted by Braintree.
source_description String

A short description of the payment method, including the Venmo username.
token String

An alphanumeric value that references a specific payment method stored in your Vault. Value will be nil if the transaction was not created from a vaulted Venmo account.
username String

The Venmo username of the Venmo account.
venmo_user_id String

The Venmo user ID of the Venmo account.
visa_checkout_card_details

If payment_instrument_type is "visa_checkout_card", these are the details of the card used for the transaction. If the transaction was created using Vault tokens, then this attribute is a snapshot of the Visa Checkout card in the Vault at the time the transaction was created.
bin

The first 6 digits of the credit card, known as the bank identification number (BIN).
call_id String

The Visa assigned identifier of the transaction.
card_type

The type of the credit card. Possible values:

  • American Express
  • Discover
  • MasterCard
  • Visa
cardholder_name String

The cardholder name associated with the credit card.
commercial enum

Whether the card type is a commercial card and is capable of processing Level 2 transactions. Possible values:

  • Braintree::CreditCard::Commercial::Yes
  • Braintree::CreditCard::Commercial::No
  • Braintree::CreditCard::Commercial::Unknown
country_of_issuance String

The country that issued the credit card. Possible country values follow ISO 3166-1.

The value Unknown will be returned if we cannot immediately determine the card's country of issuance from the bank identification number (BIN).
customer_location enum

This is "US" if the billing address is in the US or if a country is not specified. The location is "International" if the billing country passed is not the US. Possible values:

  • Braintree::CreditCard::CustomerLocation::International
  • Braintree::CreditCard::CustomerLocation::US
debit enum

Whether the card is a debit card. Possible values:

  • Braintree::CreditCard::Debit::Yes
  • Braintree::CreditCard::Debit::No
  • Braintree::CreditCard::Debit::Unknown
durbin_regulated enum

A value indicating whether the issuing bank's card range is regulated by the Durbin Amendment due to the bank's assets. Possible values:

  • Braintree::CreditCard::DurbinRegulated::Yes
  • Braintree::CreditCard::DurbinRegulated::No
  • Braintree::CreditCard::DurbinRegulated::Unknown
expiration_date String

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

The expiration month of the credit card used, formatted MM.
expiration_year String

The expiration year of the credit card used, formatted YYYY.
healthcare enum

Whether the card is a healthcare card. Possible values:

  • Braintree::CreditCard::HealthCare::Yes
  • Braintree::CreditCard::HealthCare::No
  • Braintree::CreditCard::HealthCare::Unknown
image_url

A URL that points to an image resource (a PNG file) hosted by Braintree, which represents the issuing card network (Visa, Mastercard, American Express, Discover).
issuing_bank String

The bank that issued the credit card.
last_4

The last 4 digits of the credit card number.
masked_number

A value comprising the bank identification number (BIN), 6 asterisks blocking out the middle numbers (regardless of the number of digits present), and the last 4 digits of the card number. This complies with PCI security standards.
payroll enum

Whether the card is a payroll card. Possible values:

  • Braintree::CreditCard::Payroll::Yes
  • Braintree::CreditCard::Payroll::No
  • Braintree::CreditCard::Payroll::Unknown
prepaid enum

Whether the card is a prepaid card. Possible values:

  • Braintree::CreditCard::Prepaid::Yes
  • Braintree::CreditCard::Prepaid::No
  • Braintree::CreditCard::Prepaid::Unknown
product_id String

The code for the product type of the card (e.g. D (Visa Signature Preferred), G (Visa Business)). See Product ID codes below for possible values.
token String

The Vault token for the Visa Checkout card. Unlike other attributes in this details map, this attribute is not a snapshot – if you update the payment method token after creating a transaction, the visa_checkout_card_details.token attribute will return the new value rather than the value associated with the transaction at the time it was created. See the transaction API requests section for additional details.
voice_referral_number

The value passed by the merchant with a voice-authorized transaction.

Result object

Read more about result objects.

Successful result

If the result is successful, the transaction will have either an authorized status, or (if the options.submit_for_settlement option was used) a submitted for settlement status.

Ruby 
result.success?
#=> true

transaction = result.transaction
transaction.status
#=> "authorized"

Additionally, you may inspect the result to determine if the transaction was created using a specific payment method type (e.g. PayPal account or a credit card), using the provided format.

Ruby 
transaction = result.transaction
transaction.payment_instrument_type == PaymentInstrumentType::PayPalAccount
#=> false
transaction.payment_instrument_type == PaymentInstrumentType::CreditCard
#=> true

Unsuccessful result

Success will return false if:

Ruby 
result.success?
#=> false

result.errors

Validation errors

If any parameters are invalid, then the success call will return false and the result object will contain one or more validation errors indicating which parameters were invalid.

When receiving a validation error, a Transaction object will not be present on the result object.

Processor declined

If the processor declines the transaction during the authorization, the processor response will be available on the transaction object.

Ruby 
result.success?
#=> false
result.transaction.status
#=> "processor_declined"

result.transaction.processor_response_type
#=> "soft_declined"
result.transaction.processor_response_code
#=> "2001"
result.transaction.processor_response_text
#=> "Insufficient Funds"

As a supplement to the standardized processor response codes, we will return bank-specific Additional Processor Responses on the transaction object. The standardized code is what you should use when handling the result object, but the Additional Processor Response might provide further context.

Ruby 
result.transaction.additional_processor_response
# e.g. "05 : NOT AUTHORISED"

Processor settlement declined

If the processor declines the transaction at the settlement stage, the processor response will be available on the transaction object.

Ruby 
result.success?
#=> false
result.transaction.status
#=> "settlement_declined"
result.transaction.processor_settlement_response_code
#=> "4001"
result.transaction.processor_settlement_response_text
#=> "Settlement Declined"

Gateway rejection

If the transaction is rejected by the gateway based on your account settings, you can check for the transaction status and gateway rejection reason.

Ruby 
result.success?
#=> false
result.transaction.status
#=> "gateway_rejected"
result.transaction.gateway_rejection_reason
#=> e.g. "cvv"

Risk data

We will also return any applicable risk data on transactions. The data includes the risk identifier, the device data captured flag, and the risk decision, which can provide further context on how a transaction was scored by Braintree.

Ruby 
result.transaction.risk_data.id
#=> "1SG23YHM4BT5"
result.transaction.risk_data.decision
#=> "Decline"
result.transaction.risk_data.device_data_captured
#=> true

The possible values of the risk decision are:

  • "Not Evaluated"
  • "Approve"
  • "Review"
  • "Decline"

Params retrieval

See our documentation on result objects.

Examples

Currencies

Each merchant account can only process transactions for a single currency. Setting which merchant account to use will also determine which currency the transaction is processed with.

Ruby 
result.transaction.currency_iso_code
#=> "USD"

Settlement status

Check the result for success, and if it has failed, then first check for validation errors. If there are no validation errors, inspect the processor_settlement_response_code on the transaction, which will indicate if the processor declined the request.

Ruby 
if result.success?
  # transaction successfully submitted for settlement
elsif result.errors.any?
  puts result.errors.inspect
else
  puts result.transaction.processor_settlement_response_code
  puts result.transaction.processor_settlement_response_text
end

Processor settlement declined

If the settlement request is declined by the processor, the processor response will be available on the transaction object.

Ruby 
result.success?
#=> false
result.transaction.status
#=> "settlement_declined"
result.transaction.processor_settlement_response_code
#=> "4001"
result.transaction.processor_settlement_response_text
#=> "Settlement Declined"

Voiding settlement

If you submit a transaction for settlement and then decide you actually don't want to settle it, you can void it before it's settled. After it's settled, you'll need to refund it instead.

To check if the transaction has been settled, find the transaction and check the status.

Ruby 
transaction = gateway.transaction.find("the_transaction_id")
    if transaction.status == "submitted_for_settlement"
      # can void
    elsif transaction.status == "settled"
      # will have to refund it
    else
      # this example only expected one of the two above statuses
    end
This code snippet now uses gateway instance methods instead of class-level methods. Learn more.

Authorization adjustments

When submitting a transaction for settlement, if you specify a settlement amount that is different than the authorized amount, an authorization adjustment may be performed automatically.

For each adjustment performed, an authorization adjustment object will be associated with the original transaction. These adjustment objects will include the following details:

Adjustment Detail Description
amount The difference between the authorized amount and the amount submitted for settlement. Negative values indicate the authorized amount was adjusted down.
success A boolean value indicating if the adjustment was successful.
timestamp The date/time when the adjustment was performed.
proccessor_response_type The processor response type. Possible values: "approved", "soft_declined", "hard_declined". See the list of possible processor authorization responses.
proccessor_response_code The processor response code. See the list of possible processor authorization responses.
proccessor_response_text The processor response text. See the list of possible processor authorization responses.

Status history details

Each status detail object contains the following attributes:

Status Detail Description
amount The amount of the request.
status A record of the statuses that a transaction has progressed through. Possible values:
  • AuthorizationExpired
  • Authorized
  • Authorizing
  • SettlementPending
  • SettlementConfirmed
  • SettlementDeclined
  • Failed
  • GatewayRejected
  • ProcessorDeclined
  • Settled
  • Settling
  • SubmittedForSettlement
  • Voided
timestamp The date/time the status change was performed. Results are returned in UTC.
transaction_source How a transaction was created. Possible values:
  • Api
  • ControlPanel
  • Recurring
user The Braintree Control Panel username of the person who performed an action that triggered the status change of the transaction.

You can use these status events to retrieve information around transaction status changes.

Ruby 
transaction = gateway.transaction.find("the_transaction_id")
transaction.status_history.each do |event|
    puts event.amount
    puts event.status
    puts event.timestamp
    puts event.transaction_source
    puts event.user

end
This code snippet now uses gateway instance methods instead of class-level methods. Learn more.

Product ID codes

The Braintree gateway returns the following product IDs for credit and debit card payment methods. The product ID is generally 1-3 characters and indicates the specific credit product that was issued to the customer.

Product ID code Product name
001 Discover Consumer Credit – Rewards
002 Discover Commercial Credit
003 Discover Consumer Debit
004 Discover Commercial Debit
005 Discover Prepaid Gift
006 Discover Prepaid ID known
007 Discover Consumer Credit – Premium
008 Discover Consumer Credit - Core
009 Discover Private Label Credit
010 Discover Commercial Credit – Executive Business
011 Discover Consumer Credit – Premium Plus
012 Discover Commercial Prepaid – Non-Reloadable
013 Discover PayPal
014 Discover PayPal Mobile
A Visa Traditional
B Visa Traditional Rewards
BPD MasterCard Business Premium Debit
C Visa Signature
CIR MasterCard Cirrus
D Visa Signature Preferred
DAG Global Debit MasterCard Salary
DAP Platinum Debit MasterCard Salary
DAS Standard Debit MasterCard Salary
DLG Debit MasterCard Gold Delayed Debit
DLH Debit MasterCard World Embossed Delayed Debit
DLP Debit MasterCard Platinum Delayed Debit
DLS Debit MasterCard Card Delayed Debit
DOS Standard Debit MasterCard Social
DWF Debit MasterCard Humanitarian Prepaid
E Visa Proprietary ATM
F Visa Classic
G Visa Business
G1 Visa Signature Business
G3 Visa Business Enhanced (US only)
G4 Visa Infinite Business
G5 Visa Business Rewards
I Visa Infinite
I Visa Infinite Privilege
I2 Visa UHNW
IB American Express Non-US
IR American Express Non-US Reloadable
IS American Express Non-US Stored Value
J3 Visa Healthcare
K Visa Corporate T&E
K1 Visa GSA Corporate T&E
L Visa Electron
MAB World Elite MasterCard for Business Card
MAC MasterCard World Elite Corporate Card
MAP MasterCard Commercial Payments Account
MAQ MasterCard Prepaid Commercial Payments Account
MBB MasterCard Prepaid Consumer
MBC MasterCard Prepaid Voucher
MBD MasterCard Professional Debit BusinessCard Card
MBE MasterCard Electronic Business Card
MBF Prepaid MC Food
MBK MasterCard Black Card
MBM Prepaid MC Meal
MBP MasterCard Corporate Prepaid
MBS MasterCard B2B Product
MBT MasterCard Corporate Prepaid Travel
MBW World MasterCard Black Edition Debit
MCB MasterCard BusinessCard Card
MCC MasterCard Credit Card (mixed BIN)
MCD Debit MasterCard Card
MCE MasterCard Electronic Card
MCF MasterCard Fleet Card
MCG Gold MasterCard Card
MCH MasterCard Premium Charge
MCO MasterCard Corporate (Meeting) Card
MCP MasterCard Purchasing Card
MCS (Unembossed) Standard MasterCard Card
MCT Titanium MasterCard Card
MCV Merchant-Branded Program
MCW World MasterCard Card
MDB Debit MasterCard BusinessCard Card
MDG Gold Debit MasterCard Card
MDH World Debit Embossed MasterCard Card
MDJ Debit MasterCard (Enhanced)
MDL MasterCard Business Debit Other Embossed
MDO MasterCard Debit Other
MDP Premium Debit MasterCard Card
MDR MasterCard Debit Brokerage
MDS Debit MasterCard Card
MDT Commercial Debit MasterCard Card
MDW World Elite Debit MasterCard
MEB MasterCard Executive BusinessCard Card
MEC MasterCard Electronic Commercial
MEF MasterCard Electronic Payment Account
MEO MasterCard Corporate Executive Card
MET Titanium Debit MasterCard Card
MFB MasterCard Flex World Elite
MFD MasterCard Flex Platinum
MFE MasterCard Flex Charge World Elite
MFH MasterCard Flex World
MFL MasterCard Flex Charge Platinum
MFW MasterCard Flex World Charge
MGF MasterCard Government Commercial Card
MHA MasterCard Healthcare Prepaid Non-Tax
MHB MasterCard HSA Substantiated (Debit MasterCard)
MHD MasterCard HELOC Debit Standard
MHH MasterCard HSA Non-Substantiated (Debit MasterCard)
MHK MasterCard Magna Health Access Card
MHD MasterCard HELOC Debit Gold
MHD MasterCard HELOC Debit Platninum
MHD MasterCard HELOC Debit Premium
MIA Prepaid MasterCard Unembossed Student Card
MIK Prepaid MasterCard Electronic Student (Non-US) Card
MIL Unembossed MasterCard Student Card (Non-US)
MIP Prepaid Debit MasterCard Student Card
MIU Debit MasterCard Unembossed (Non-US)
MLA MasterCard Central Travel Solutions Air Card
MLB MasterCard Brazil Benefit for Home Improvement
MLD MasterCard Distribution Card
MLE MasterCard Brazil General Benefits
MLF MasterCard Agro Card
MLL MasterCard Central Travel Solutions Land Card
MNF MasterCard Public Sector Commercial Card
MNW MasterCard World Card
MOC Standard Maestro Social
MOG Maestro Gold Card
MOP Maestro Platinum
MOW World Maestro
MPA MasterCard Prepaid Debit Standard Payroll
MPB MasterCard Preferred Business Card
MPD MasterCard Flex Prepaid
MPF MasterCard Prepaid Debit Standard Gift
MPG Debit MasterCard Standard Prepaid General Spend
MPH MasterCard Cash
MPJ Prepaid Debit MasterCard Card Gold
MPK MasterCard Prepaid Government Commercial Card
MPL Platinum MasterCard Card
MPM MasterCard Prepaid Debit Standard Consumer Incentive
MPN MasterCard Prepaid Debit Standard Insurance
MPO MasterCard Prepaid Debit Standard Offer
MPP MasterCard Prepaid Card – Commercial Reward Funding
MPQ MasterCard Prepaid Debit Standard Government Disaster
MPR MasterCard Prepaid Debit Standard Travel
MPT MasterCard Prepaid Debit Standard Teen
MPV MasterCard Prepaid Debit Standard Government
MPW Debit MasterCard Business Card Prepaid Workplace Business
MPX MasterCard Prepaid Debit Standard Flex Benefit
MPY MasterCard Prepaid Debit Standard Employee Incentive
MPZ MasterCard Prepaid Debit Standard Government Consumer
MRB MasterCard Prepaid Electronic Business Card (Non-US)
MRC Prepaid MasterCard Electronic Card (Non-US)
MRF MasterCard European Regulated Individual Pay
MRG MasterCard Prepaid Card (Non-US)
MRH MasterCard Platinum Prepaid Travel (US)
MRJ Prepaid MasterCard Gold Card
MRK Prepaid MasterCard Public Sector Commercial Card
MRL Prepaid MasterCard Electronic Commercial Card (Non-US)
MRO MasterCard Rewards Only
MRP Standard Retailer Centric Payments
MRS Prepaid MasterCard ISIC Student Card
MRW Prepaid MasterCard Business Card (Non-US)
MSA Prepaid Maestro Payroll Card
MSB Maestro Small Business Card
MSF Prepaid Maestro Gift Card
MSG Prepaid Maestro Consumer Reloadable Card
MSI Maestro Student Card
MSJ Prepaid Maestro Gold
MSM Prepaid Maestro Consumer Promotion Card
MSN Prepaid Maestro Insurance Card
MSO Prepaid Maestro Other Card
MSQ Unknown MasterCard
MSR Prepaid Maestro Travel Card
MST Prepaid Maestro Teen Card
MSV Prepaid Maestro Government Benefit Card
MSW Prepaid Maestro Corporate (Reloadable) Card
MSX Prepaid Maestro Flex Benefit Card
MSY Prepaid Maestro Employee Incentive Card
MSZ Prepaid Maestro Emergency Assistance Card
MTP MasterCard Platinum Prepaid Travel (UK and Brazil)
MUS Prepaid Unembossed MasterCard Card
MUW MasterCard World Domestic Affluent
MWB World Elite MasterCard Business Card
MWD World Deferred MasterCard
MWE World Elite MasterCard Card
MWF MasterCard Humanitarian Prepaid
MWO World Elite MasterCard Corporate Card
MWR MasterCard World Retailer Centric Payments
N Visa Platform
N1 Visa Rewards
N2 Visa Select
OLB Maestro Small Business Delayed Debit
OLG Maestro Gold Delayed Debit
OLP Maestro Platinum Delayed Debit
OLS Maestro (Student Card) Delayed Debit
OLW World Maestro Delayed Debit
P Visa Gold
PMC MasterCard Proprietary Credit Card (Swedish domestic)
PMD MasterCard Proprietary Debit Card (Swedish domestic)
PSC MasterCard Common Proprietary Swedish Credit Card
PSD MasterCard Common Proprietary Swedish Debit Card
PVA MasterCard Private Label A
PVB MasterCard Private Label B
PVC MasterCard Private Label C
PVD MasterCard Private Label D
PVE MasterCard Private Label E
PVF MasterCard Private Label F
PVG MasterCard Private Label G
PVH MasterCard Private Label H
PVI MasterCard Private Label I
PVJ MasterCard Private Label J
PVL MasterCard Private Label L
Q Visa Private Label
Q2 Visa Private Label Basic
Q3 Visa Private Label Standard
Q4 Visa Private Label Enhanced
Q5 Visa Private Label Specialized
Q6 Visa Private Label Premium
R Visa Proprietary
RP American Express US Reloadable
S Visa Purchasing
S1 Visa Purchasing with Fleet
S2 Visa GSA Purchasing
S3 Visa GSA Purchasing with Fleet
S4 Visa Government Services Loan
S5 Visa Commercial Transport (EBT)
S6 Visa Business Loan
S7 Visa Distribution
SAG Gold MasterCard Salary Immediate Debit
SAL Standard Maestro Salary
SAP Platinum MasterCard Salary Immediate Debit
SAS Standard MasterCard Salary Immediate Debit
SOS Standard MasterCard Social Immediate Debit
SUR Prepaid Unembossed MasterCard Card (Non-US)
SV American Express US Stored Value
TBE MasterCard Electronic Business Immediate Debit
TCB MasterCard Corporate Immediate Debit
TCC MasterCard (mixed BIN) Immediate Debit
TCE MasterCard (Electronic) Student Card Immediate Debit
TCF MasterCard Fleet Card Immediate Debit
TCG Gold MasterCard Card Immediate Debit
TCO MasterCard (Corporate) Immediate Debit
TCP MasterCard Purchasing Card Immediate Debit
TCS MasterCard Standard (Unembossed) Card Immediate Debit
TCW MasterCard World Signia Immediate Debit
TEB MasterCard Executive BusinessCard Card Immediate Debit
TEC MasterCard Electronic Commercial Immediate Debit
TEO MasterCard Corporate Executive Card Immediate Debit
TNF MasterCard Public Sector Commercial Card Immediate Debit
TNW MasterCard New World Immediate Debit
TPB MasterCard Preferred Business Card Immediate Debit
TPL Platinum MasterCard Immediate Debit
TWB World MasterCard Black Edition Immediate Debit
U Visa Travel Money
V Visa V Pay
WBE World MasterCard Black Edition
X Visa B2B Virtual Payments

Network response codes

In addition to the processor response code and text, some transaction and verification objects also include a network response code and text.

These network response values are the raw responses that may be returned by the card network, and when present they can provide additional detail about why a request was approved or declined. However, this information is supplemental to the processor response code; you should consider the processor response code to be the source of truth.

Each card network has distinct response codes:

Card Network Code Text
Visa 00 Successful approval/completion or V.I.P. PIN verification is successful
Visa 01 Refer to card issuer
Visa 02 Refer to card issuer, special condition
Visa 03 Invalid merchant or service provider
Visa 04 Pick up card
Visa 05 Do not Honor
Visa 06 Error
Visa 07 Pick up card, special condition (other than lost/stolen card)
Visa 10 Partial Approval
Visa 11 V.I.P. approval
Visa 12 Invalid transaction
Visa 13 Invalid amount (currency conversion field overflow); or amount exceeds maximum for card program
Visa 14 Invalid account number (no such number)
Visa 15 No such issuer
Visa 19 Re-enter transaction
Visa 21 No action taken (unable to back out prior transaction)
Visa 25 Unable to locate record in file, or account number is missing from the inquiry
Visa 28 File is temporarily unavailable
Visa 39 No credit account
Visa 41 Pick up card (lost card)
Visa 43 Pick up card (stolen card)
Visa 51 Insufficient funds
Visa 52 No checking account
Visa 53 No savings account
Visa 54 Expired card
Visa 55 Incorrect PIN
Visa 57 Transaction not permitted to cardholder
Visa 58 Transaction not allowed at terminal
Visa 59 Suspected fraud
Visa 61 Activity amount limit exceeded
Visa 62 Restricted card (for instance, in Country Exclusion table)
Visa 63 Security violation
Visa 64 Transaction does not fulfill AML requirement
Visa 65 Activity count limit exceeded
Visa 75 Allowable number of PIN-entry tries exceeded
Visa 76 Unable to locate previous message (no match on retrieval reference number)
Visa 77 Previous message located for a repeat or reversal, but repeat or reversal data inconsistent with original message
Visa 78 Blocked, first used — Transaction from new cardholder, and card not properly unblocked
Visa 79 Transaction reversed
Visa 80 Visa transactions: credit issuer unavailable. Private label: invalid date
Visa 81 PIN cryptographic error found (error found by VIC security module during PIN decryption)
Visa 82 Negative Online CAM, dCVV, iCVV, or CVV results Or Offline PIN authentication interrupted
Visa 85 No reason to decline request for account number verification, address verification, CVV2 verification, or credit voucher or merchandise return
Visa 86 Cannot verify PIN
Visa 91 Issuer unavailable or switch inoperative (STIP not applicable or available for this transaction) Issuers can respond with this code, which V.I.P. passes to the acquirer without invoking stand-in processing (STIP). Issuer processors use the code to indicate they cannot perform authorization on issuers’ behalf. Code causes decline at POS.
Visa 1A Additional customer authentication required
Visa B1 B116 Surcharge amount not permitted on Visa cards
Visa N0 Force STIP
Visa N3 Cash service not available
Visa N4 Cashback request exceeds issuer limit
Visa N7 Decline for CVV2 failure
Visa N8 Transaction amount exceeds pre-authorized approval amount
Visa P2 P2 Invalid biller information
Visa P5 PIN change/unblock request declined
Visa P6 Unsafe PIN
Visa R0 Stop payment order
Visa R1 Revocation of authorization order
Visa R3 Revocation of all authorizations order
Visa Z3 Unable to go online; declined
Visa XA Forward to issuer
Visa XD Forward to issuer
Visa Q1 Card authentication failed Or Offline PIN authentication interrupted
Mastercard 00 Approved or completed successfully
Mastercard 01 Refer to card issuer
Mastercard 03 Invalid merchant
Mastercard 04 Capture card Capture
Mastercard 05 Do not honor
Mastercard 08 Honor with ID
Mastercard 10 Partial Approval
Mastercard 12 Invalid transaction
Mastercard 13 Invalid amount
Mastercard 14 Invalid card number
Mastercard 15 Invalid issuer
Mastercard 30 Format error
Mastercard 41 Lost card
Mastercard 43 Stolen Card
Mastercard 51 Insufficient funds/over credit limit
Mastercard 54 Expired card
Mastercard 55 Invalid PIN
Mastercard 57 Transaction not permitted to issuer/cardholder
Mastercard 58 Transaction not permitted to acquirer/terminal
Mastercard 61 Exceeds withdrawal amount limit
Mastercard 62 Restricted card
Mastercard 63 Security violation
Mastercard 65 Exceeds withdrawal count limit
Mastercard 70 Contact Card Issuer
Mastercard 71 PIN Not Changed
Mastercard 75 Allowable number of PIN tries exceeded
Mastercard 76 Invalid/nonexistent To Account specified
Mastercard 77 Invalid/nonexistent From Account specified
Mastercard 78 Invalid/nonexistent account specified (general)
Mastercard 81 Domestic Debit Transaction Not Allowed (Regional use only)
Mastercard 84 Invalid Authorization Life Cycle
Mastercard 85 Not declined. Valid for all zero amount transactions.
Mastercard 86 PIN Validation not possible
Mastercard 87 Purchase Amount Only, No Cash Back Allowed
Mastercard 88 Cryptographic failure
Mastercard 89 Unacceptable PIN—Transaction Declined—Retry
Mastercard 91 Authorization System or issuer system inoperative
Mastercard 92 Unable to route transaction
Mastercard 94 Duplicate transmission detected
Mastercard 96 System error
Discover 00 Approved or completed successfully
Discover 01 Reserved for future use
Discover 02 Reserved for future use
Discover 03 Invalid Merchant
Discover 04 Capture Card
Discover 05 Do not honor
Discover 07 Pick-up Card, special condition
Discover 08 Reserved for future use
Discover 10 Approved for partial amount
Discover 11 Approved
Discover 12 Invalid transaction
Discover 13 Invalid amount
Discover 14 Invalid Card Number
Discover 15 Reserved for future use
Discover 19 Re-enter transaction
Discover 30 Format error
Discover 31 Bank not supported by switch
Discover 33 Reserved for future use
Discover 34 Reserved for future use
Discover 35 Reserved for future use
Discover 36 Reserved for future use
Discover 37 Reserved for future use
Discover 38 Allowable PIN tries exceeded
Discover 39 No credit Account
Discover 40 Requested function not supported
Discover 41 Lost Card
Discover 43 Stolen Card
Discover 51 Decline
Discover 53 No savings Account
Discover 54 Expired Card
Discover 55 Invalid PIN
Discover 56 No Card record
Discover 57 Transaction not permitted to Issuer/Cardholder
Discover 58 Transaction not permitted to Acquirer/terminal
Discover 59 Suspected fraud
Discover 60 Card acceptor contact Acquirer
Discover 61 Exceeds withdrawal amount limit
Discover 62 Restricted Card
Discover 63 Security violation
Discover 64 Original amount incorrect
Discover 65 Exceeds withdrawal count limit
Discover 66 Card Acceptor call Acquirer’s security dept
Discover 67 Hard capture (requires ATM pick-up)
Discover 68 Response received too late Decline
Discover 75 Allowable number of PIN tries exceeded
Discover 76 Invalid/nonexistent “to” Account specified
Discover 77 Invalid/nonexistent “from” Account specified
Discover 78 Invalid/nonexistent Account specified (general)
Discover 83 Domain Restriction Controls Failure
Discover 85 No reason to decline
Discover 87 Network unavailable
Discover 91 Authorization system or Issuer system inoperative
Discover 92 Unable to route transaction Decline
Discover 93 Transaction cannot be completed, violation of law
Discover 94 Duplicate transmission detected
Discover 96 System malfunction Decline
Discover N1 System up
Discover N2 Soft down
Discover N3 System down
Discover N7 Decline for AVS or CID mismatch
Discover P5 PIN Change/Unblock failed
Discover P6 New PIN not accepted
American Express 000 Approved
American Express 001 Approved with ID
American Express 002 Partial Approval (Prepaid Cards only)
American Express 100 Deny
American Express 101 Expired Card / Invalid Expiration Date
American Express 106 Exceeded PIN attempts
American Express 107 Please Call Issuer
American Express 109 Invalid merchant
American Express 110 Invalid amount
American Express 111 Invalid account / Invalid MICR (Travelers Cheque)
American Express 115 Requested function not supported
American Express 117 Invalid PIN
American Express 119 Cardmember not enrolled / not permitted
American Express 122 Invalid card security code (a.k.a., CID, 4DBC, 4CSC)
American Express 125 Invalid effective date
American Express 181 Format error
American Express 183 Invalid currency code
American Express 187 Deny - New card issued
American Express 189 Deny - Canceled or Closed Merchant/SE
American Express 200 Deny - Pick up card
American Express 900 Accepted - ATC Synchronization
American Express 909 System Malfunction (Cryptographic error)
American Express 912 Issuer not available

See also