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
addOns Array of AddOn objects

The collection of add-ons associated with a subscription.
additionalProcessorResponse string

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

The billing amount of the request.
androidPayCardDetails

If paymentInstrumentType is "android_pay_card", these are the details of the credit 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 device-specific account number (DPAN), known as the Bank Identification Number. This BIN may differ from the BIN of the underlying card.
expirationMonth string

The expiration month of the credit card, formatted MM.
expirationYear string

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

A unique identifier provided by Google to track the payment method's transactions.
imageUrl string

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

The last 4 digits of the payment method tokenized by the network.
sourceCardType string

The type of the card tokenized by the network.
sourceDescription 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.
virtualCardLast4 string

The last 4 digits of the device-specific account number (DPAN).
virtualCardType string

The card type of the device-specific account number (DPAN).
applePayCardDetails

If paymentInstrumentType is "apple_pay_card", these are the details of the credit card used for the transaction.
cardType string

The type of the credit card. Possible values:

  • Apple Pay - Visa
  • Apple Pay - MasterCard
  • Apple Pay - American Express
  • Apple Pay - Discover
cardholderName string

The cardholder name associated with the credit card.
expirationMonth string

The expiration month of the credit card, formatted MM.
expirationYear string

The 4-digit expiration year of the credit card, formatted YYYY.
imageUrl string

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

The last 4 digits of the device-specific account number (DPAN).
paymentInstrumentName 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.
sourceDescription 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.
authorizationAdjustments

A collection of authorization adjustments associated with the transaction.
authorizationExpiresAt DateTime

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

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 null, you will see responses in both avsPostalCodeResponseCode and avsStreetAddressResponseCode.
avsPostalCodeResponseCode

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
avsStreetAddressResponseCode

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
billingDetails

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.
countryCodeAlpha2 string

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

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

The numeric billing country code. See the transaction API requests section for details.
countryName string

The billing country name. See the transaction API requests section for details.
extendedAddress string

The extended billing address. See the transaction API requests section for details.
firstName 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.
lastName 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.
postalCode 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.
streetAddress 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.
createdAt DateTime

The date/time the object was created.
creditCardDetails

If paymentInstrumentType 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).
cardType

The type of the credit card. Possible values:

  • American Express
  • Carte Blanche
  • China UnionPay
  • Discover
  • Elo
  • JCB
  • Laser
  • Maestro
  • MasterCard
  • Solo
  • Switch
  • Visa
  • Unknown
cardholderName 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
countryOfIssuance 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).
customerLocation 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::INTERNATIONAL
  • Braintree_CreditCard::US
debit enum

Whether the card is a debit card. Possible values:

  • Braintree_CreditCard::DEBIT_YES
  • Braintree_CreditCard::DEBIT_NO
  • Braintree_CreditCard::DEBIT_UNKNOWN
durbinRegulated 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::DURBIN_REGULATED_YES
  • Braintree_CreditCard::DURBIN_REGULATED_NO
  • Braintree_CreditCard::DURBIN_REGULATED_UNKNOWN
expirationDate string

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

The expiration month of the credit card used, formatted MM.
expirationYear 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
imageUrl

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).
issuingBank string

The bank that issued the credit card.
last4

The last 4 digits of the credit card number.
maskedNumber

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
productId 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 creditCardDetails.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.
uniqueNumberIdentifier

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.
currencyIsoCode

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

A collection of custom field/value pairs.
customerDetails

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.
firstName 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.
lastName 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.
cvvResponseCode

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.
disbursementDetails

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.
disbursementDate

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

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

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

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

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.
discountAmount String

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.
escrowStatus

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"
facilitatedDetails

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.
merchantId string

The merchant ID of the merchant of record.
merchantName string

The name of the business associated with the merchant of record.
paymentMethodNonce string

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

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 third party. These fields are primarily useful for the merchant of record.
oauthApplicationClientId string

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

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

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

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

  • "application_incomplete"
  • "avs"
  • "avs_and_cvv"
  • "cvv"
  • "duplicate"
  • "fraud"
  • "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.
lineItems

A collection of line items associated with the transaction.
masterpassCardDetails

If paymentInstrumentType 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).
cardType

The type of the credit card. Possible values:

  • American Express
  • Discover
  • JCB
  • Maestro
  • MasterCard
  • Visa
cardholderName 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
countryOfIssuance 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).
customerLocation 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::INTERNATIONAL
  • Braintree_CreditCard::US
debit enum

Whether the card is a debit card. Possible values:

  • Braintree_CreditCard::DEBIT_YES
  • Braintree_CreditCard::DEBIT_NO
  • Braintree_CreditCard::DEBIT_UNKNOWN
durbinRegulated 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::DURBIN_REGULATED_YES
  • Braintree_CreditCard::DURBIN_REGULATED_NO
  • Braintree_CreditCard::DURBIN_REGULATED_UNKNOWN
expirationDate string

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

The expiration month of the credit card used, formatted MM.
expirationYear 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
imageUrl

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).
issuingBank string

The bank that issued the credit card.
last4

The last 4 digits of the credit card number.
maskedNumber

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
productId 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 masterpassCardDetails.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.
merchantAccountId string

The merchant account ID used to create a transaction. Currency is also determined by merchant account ID.
networkTransactionId 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 externalVault.previousNetworkTransactionId field of subsequent transactions.
orderId 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.
paymentInstrumentType

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

  • "android_pay_card"
  • "apple_pay_card"
  • "credit_card"
  • "masterpass_card"
  • "paypal_account"
  • "samsung_pay_card"
  • "venmo_account"
  • "visa_checkout_card"
paypalDetails

If paymentInstrumentType is "paypal_account", these are the details of the PayPal account used for the transaction.
authorizationId string

The identification value of the authorization within PayPal's API.
captureId string

PayPal id for a transaction.
customField string

Custom field/value pairs.
imageUrl string

A URL that points to a PayPal image resource (a PNG file) hosted by Braintree.
payerEmail 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.
payerFirstName string

The first name associated with the PayPal account used to create the request.
payerId string

The identifier for the PayPal account used in the request.
payerLastName string

The last name associated with the PayPal account used to create the request.
payerStatus string

The status of the PayPal account used to create the request.
paymentId string

The identification value of the payment within PayPal's API.
refundId string

PayPal id for a refund.
sellerProtectionStatus string

Indicates whether a transaction qualifies for PayPal Seller Protection.
taxId string

Payer's tax id. Only returned for payments from Brazilian accounts.
taxIdType 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.
transactionFeeAmount string

The transaction fee amount of the PayPal transaction.

A transaction fee of 1 will always be returned in sandbox integrations.
transactionFeeCurrencyIsoCode string

The currency of the associated transaction fee.
planId string

The plan identifier.
processorAuthorizationCode

The authorization code returned by the processor.
processorResponseCode string

The processor response code. See the list of possible processor authorization responses.
processorResponseText string

The processor response text. See the list of possible processor authorization responses.
processorResponseType 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.
processorSettlementResponseCode string

The status of the request to capture the funds. See the list of possible processor settlement responses.
processorSettlementResponseText string

The text explanation of the above processor settlement response code.
purchaseOrderNumber 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.
refundIds

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

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

Risk data on credit card 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.
decision string

The risk decision. Possible values:

  • Not Evaluated
  • Approve
  • Review
  • Decline
deviceDataCaptured bool

Flag indicating whether device session data was successfully captured and processed by Kount. Currently available in the Python, .NET, Node and PHP client libraries.
id string

The risk data identifier.
samsungPayCardDetails

If paymentInstrumentType 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).
cardType

The type of the credit card. Possible values:

  • American Express
  • MasterCard
  • Visa
cardholderName 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
countryOfIssuance 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).
customerLocation 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::INTERNATIONAL
  • Braintree_CreditCard::US
debit enum

Whether the card is a debit card. Possible values:

  • Braintree_CreditCard::DEBIT_YES
  • Braintree_CreditCard::DEBIT_NO
  • Braintree_CreditCard::DEBIT_UNKNOWN
durbinRegulated 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::DURBIN_REGULATED_YES
  • Braintree_CreditCard::DURBIN_REGULATED_NO
  • Braintree_CreditCard::DURBIN_REGULATED_UNKNOWN
expirationDate string

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

The expiration month of the credit card used, formatted MM.
expirationYear 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
imageUrl

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).
issuingBank string

The bank that issued the credit card.
last4

The last 4 digits of the credit card number.
maskedNumber

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
productId 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.
sourceCardLast4 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 samsungPayCardDetails.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.
serviceFeeAmount String

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.
settlementBatchId 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.
shippingAmount String

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.
shippingDetails

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.
countryCodeAlpha2 string

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

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

The numeric shipping country code. See the transaction API requests section for details.
countryName string

The shipping country name. See the transaction API requests section for details.
extendedAddress string

The extended shipping address. See the transaction API requests section for details.
firstName 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.
lastName 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.
postalCode 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.
streetAddress string

The street address. See the transaction API requests section for details.
shipsFromPostalCode 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:

  • AUTHORIZATION_EXPIRED
  • AUTHORIZED
  • AUTHORIZING
  • SETTLEMENT_PENDING
  • SETTLEMENT_DECLINED
  • FAILED
  • GATEWAY_REJECTED
  • PROCESSOR_DECLINED
  • SETTLED
  • SETTLING
  • SUBMITTED_FOR_SETTLEMENT
  • VOIDED

See the transaction status explanations for details.
statusHistory

This value is a record of the statuses that a transaction has progressed through. Possible values:

  • AUTHORIZATION_EXPIRED
  • AUTHORIZED
  • AUTHORIZING
  • SETTLEMENT_PENDING
  • SETTLEMENT_CONFIRMED
  • SETTLEMENT_DECLINED
  • FAILED
  • GATEWAY_REJECTED
  • PROCESSOR_DECLINED
  • SETTLED
  • SETTLING
  • SUBMITTED_FOR_SETTLEMENT
  • VOIDED
subscriptionDetails
billingPeriodEndDate

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.
billingPeriodStartDate

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.
subscriptionId string

The value used to identify a specific subscription.
taxAmount String

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.
taxExempt 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.
threeDSecureInfo

The 3D Secure information for this transaction.
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
liabilityShiftPossible bool

Indicates whether a liability shift is possible.
liabilityShifted 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.
type string

The value that defines whether a transaction is a sale or credit.
updatedAt DateTime

The date/time the object was last updated.
venmoAccount

If paymentInstrumentType 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.
imageUrl string

A URL that points to a payment method image resource (a PNG file) hosted by Braintree.
sourceDescription 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.
venmoUserId string

The Venmo user ID of the Venmo account.
visaCheckoutCardDetails

If paymentInstrumentType 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).
callId string

The Visa assigned identifier of the transaction.
cardType

The type of the credit card. Possible values:

  • American Express
  • Discover
  • MasterCard
  • Visa
cardholderName 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
countryOfIssuance 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).
customerLocation 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::INTERNATIONAL
  • Braintree_CreditCard::US
debit enum

Whether the card is a debit card. Possible values:

  • Braintree_CreditCard::DEBIT_YES
  • Braintree_CreditCard::DEBIT_NO
  • Braintree_CreditCard::DEBIT_UNKNOWN
durbinRegulated 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::DURBIN_REGULATED_YES
  • Braintree_CreditCard::DURBIN_REGULATED_NO
  • Braintree_CreditCard::DURBIN_REGULATED_UNKNOWN
expirationDate string

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

The expiration month of the credit card used, formatted MM.
expirationYear 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
imageUrl

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).
issuingBank string

The bank that issued the credit card.
last4

The last 4 digits of the credit card number.
maskedNumber

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
productId 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 visaCheckoutCardDetails.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.
voiceReferralNumber

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.submitForSettlement option was used) a submitted for settlement status.

PHP
Copy
Copied
$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.

PHP
Copy
Copied
$transaction = $result->transaction;
$transaction->paymentInstrumentType == Braintree_PaymentInstrumentType::PAYPAL_ACCOUNT;
# false
$transaction->paymentInstrumentType == Braintree_PaymentInstrumentType::CREDIT_CARD;
# true

Unsuccessful result

Success will return false if:

PHP
Copy
Copied
$result->success
# false

$result->errors->deepAll()

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.

PHP
Copy
Copied
$result->success
# false

$result->transaction->status
# "processor_declined"

$result->transaction->processorResponseType
# "soft_declined"

$result->transaction->processorResponseCode
# e.g. 2000

$result->transaction->processorResponseText
# e.g. "Do Not Honor"

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.

PHP
Copy
Copied
$result->transaction->additionalProcessorResponse
# 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.

PHP
Copy
Copied
$result->success
# false

$result->transaction->status
# "settlement_declined"

$result->transaction->processorSettlementResponseCode
# e.g. 4001

$result->transaction->processorSettlementResponseText
# e.g. "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.

PHP
Copy
Copied
$result->success
# false

$result->transaction->status
# "gateway_rejected"

$result->transaction->gatewayRejectionReason
# e.g. "cvv"

Risk data

We will also return the risk data on all credit card 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.

PHP
Copy
Copied
$result->transaction->riskData->id
# "1SG23YHM4BT5"
$result->transaction->riskData->decision
# "Decline"
$result->transaction->riskData->deviceDataCaptured
# 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.

PHP
Copy
Copied
$transaction->currencyIsoCode
# e.g. '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 $processorSettlementResponseCode on the transaction, which will indicate if the processor declined the request.

PHP
Copy
Copied
$result = $gateway->transaction()->submitForSettlement('the_transaction_id', '35.00');
if ($result->success) {
    // success
} else if ($result->errors->deepSize() > 0) {
    print_r($result->errors);
} else {
    echo $result->transaction->processorSettlementResponseCode;
    echo $result->transaction->processorSettlementResponseText;
}
This code snippet now uses gateway instance methods instead of class-level methods. Learn more.

Processor settlement declined

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

PHP
Copy
Copied
$result->success
# false

$result->transaction->status
# "settlement_declined"

$result->transaction->processorSettlementResponseCode
# e.g. 4001

$result->transaction->processorSettlementResponseText
# e.g. "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.

PHP
Copy
Copied
$transaction = $gateway->transaction()->find('the_transaction_id');
if ($transaction->status == Braintree_Transaction::SUBMITTED_FOR_SETTLEMENT) {
  # can void
} else if ($transaction->status == Braintree_Transaction::SETTLED) {
  # will have to refund it
} else {
  # This example only expected one of the two above statuses
}
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.
proccessorResponseType The processor response type. Possible values: "approved", "soft_declined", "hard_declined". See the list of possible processor authorization responses.
proccessorResponseCode The processor response code. See the list of possible processor authorization responses.
proccessorResponseText The processor response text. See the list of possible processor authorization responses.

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 Infitinte 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

See also

Still have questions?

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