NewYour coding agent can read the release notes before it upgrades.Set up the MCP server →
PyPI · #2984 most downloaded on PyPI
Braintree Python Library
Last release 18 days ago
16 Sep 2026
Ships fairly regularly
a new release about every 6 weeks
Nearly every release is documented
notes for 32 of 33 stable releases
133 versions withdrawn
withdrawn after publishing
17 years old
166 releases · first in 2010
Fix path traversal vulnerability in CreditCard, CreditCardVerification, Customer, MerchantAccount, PayPalAccount, PaymentMethod, PaymentMethodNonce, P…
CreditCard, CreditCardVerification, Customer, MerchantAccount, PayPalAccount, PaymentMethod, PaymentMethodNonce, Plan, SepaDirectDebitAccount, Subscription, Testing, Transaction, TransactionLineItem, UsBankAccount, and UsBankAccountVerification gateways by validating that IDs used in request paths do not contain path separators or relative-path segmentsach_type to transaction searchsurcharge_amount to Transaction.refund()Fix path traversal vulnerability in Dispute and Address gateways by validating that IDs used in request paths do not contain path separators or relati…
shipping_address_id to Transaction.submit_for_settlement()phone_number, international_phone to shipping for Transaction.submit_for_settlement()Dispute and Address gateways by validating that IDs used in request paths do not contain path separators or relative-path segmentsEmailFormatIsInvalid (92963) and EmailIsTooLong (92964) validation error codes to PayPalAccountOAuthCredentials from exposing access_token and refresh_token in repr() output (e.g. logs and error trackers)preferred_payment_method_token parameter to ClientToken.generateOne column per quarter.
Deprecate debug_id on PayPalAccount, LocalPayment, and SepaDirectDebitAccount transaction detail objects
debug_id on PayPalAccount, LocalPayment, and SepaDirectDebitAccount transaction detail objectsaccount_reference_number_type to sender and receiver in transfer on TransactionCannotCloneThirdPartyCofNetworkTokenTransaction (915274) transaction validation error codeAdd mastercard_transaction_link_id to Transaction and CreditCardVerification
mastercard_transaction_link_id to Transaction and CreditCardVerificationDeprecate merchant create functionality
LocalPaymentContextGateway.create and LocalPaymentContextGateway.find methodsacquirerReferenceNumber to transaction search objectinternational_phone to Customer in Transactionaccount_funding_transaction from the Transaction requestapi_request_key (idempotency) support for Transaction.sale(), Transaction.credit(), Transaction.submit_for_settlement(), Transaction.submit_for_partial_settlement(), Transaction.void(), and Transaction.refund()surchargeAmount to transaction objectmax_connection_idle_seconds for request configurationDeprecate transactions for visa_checkout_card and maintain search functionality
accept_partial_authorization to Transaction Gateway and partially_authorized to Transactionvisa_checkout_card and maintain search functionalityach_type to options -> us_bank_account in Transaction.createach_type and requested_ach_type response fields to TransactionAdd extra fields in sender and receiver details in transfer to Transaction
sender and receiver details in transfer to TransactionAdjustmentAmountMustBeGreaterThanZerovenmo_merchant_data from TransactionAdd payment_account_reference to Transaction::ApplePayCard, Transaction::AndroidPayCard, Transaction::CreditCard, and CreditCardVerification
payment_account_reference to Transaction::ApplePayCard, Transaction::AndroidPayCard, Transaction::CreditCard, and CreditCardVerificationprocessing_merchant_category_code field in Transactiontransfer validation error codes in TransactionAdd Bank Account Instant Verification functionality
BankAccountInstantVerificationGateway for creating JWTsBankAccountInstantVerificationJwt response objectBankAccountInstantVerificationJwtRequest for JWT creationach_mandate_text and ach_mandate_accepted_at fields to TransactionUsBankAccountRequestINSTANT_VERIFICATION_ACCOUNT_VALIDATION method to UsBankAccountVerification.VerificationMethodach_reject_reason field to Transactionsender and receiver to transfer in Transactionis_device_token to ApplePayCard and ApplePayDetailsAdd upcoming_retry_date field to Transaction
upcoming_retry_date field to Transactionremaining_file_evidence_storage to Disputetransaction_retried webhooktransfer_type to TransactionAdd Session Id to Customer Recommendations Payload
Add account_information_inquiry to:
account_information_inquiry to:
CreditCardVerification.createPaymentMethod.create and PaymentMethod.updateCreditCard.create and CreditCard.updateAdd support for capturing payment facilitator and sub-merchant details with transactions
Add prepaid_reloadable from bin data in credit card responses
PayPalPaymentResource requestsFixes issue related to missing folders in package paths
Add support for creating and updating PayPal customer session
Add recipient/contact info: recipient_emailand recipient_phone to Transaction
recipient_emailand recipient_phone to TransactionAdd fail_on_duplicate_payment_method_for_customer option to
fail_on_duplicate_payment_method_for_customer option to
ClientTokenPaymentMethodCreditCardblik_aliases to LocalPaymentCompleted webhook and LocalPaymentDetailsamsung_pay_cardAdd payer_name, bic and iban_last_chars to LocalPaymentCompleted webhook
payer_name, bic and iban_last_chars to LocalPaymentCompleted webhookedit_paypal_vault_id to PayPalAccountani_first_name_response_code and ani_last_name_response_code to CreditCardVerificationshippingTaxAmount to Transactionnetwork_tokenization_attributes parameter to Transaction.saleNetworkTokenizationAttributeCryptogramIsRequired to CreditCardDeprecate paypal_tracking_id in favor of paypal_tracker_id in package_details
foreign_retailer to Transactioninternational_phone to Address and Customerfunding_source_description to PayPalAccountAndroidPayCard error codeREFUND_FAILED to WebhookNotification.Kindfinal_capture to Transaction submit_for_partial_settlement_signaturepaypal_tracking_id in favor of paypal_tracker_id in package_detailsAdd domains parameter support to ClientToken.generate
domains parameter support to ClientToken.generateAdd UnderReview status to Dispute
UnderReview status to DisputeDisputeUnderReview to WebhookNotification.Kind_Note: this will break integrations on versions of Python below 3.2. However, this is NOT a breaking change to this library, due to our current suppor…
cgi module. Note: this will break integrations on versions of Python below 3.2. However, this is NOT a breaking change to this library, due to our current support of Python 3.5+.PackageDetails class.packages to Transaction attributes.package_tracking method to TransactionGateway to make request to add tracking information to transactions.process_debit_as_credit to credit_card field in options field during Transaction create.three_d_secure_token in favor of three_d_secure_authentication_idupc_code, upc_type, and image_url to line_items in transactionvenmo_sdk_session and venmo_sdk_payment_method_codeAdd PickupInStore to ShippingMethod enum
PickupInStore to ShippingMethod enumexternal_vault and risk_data to CreditCardVerification.create requestphone_number in CreditCarddebit_network to Transaction fielddebit_network to TransactionSearch RequestDebitNetwork enum to CreditCardAdd SubscriptionBillingSkipped to WebhookNotification.Kind
SubscriptionBillingSkipped to WebhookNotification.KindarrivalDate and ticketIssuerAddress to Transaction.sale request and industry data support for Transaction.submitForSettlementdate_of_birth and country_code to IndustryData paramsMetaCheckoutCard, MetaCheckoutToken payment methodsMetaCheckoutCardDetails, MetaCheckoutTokenDetails to Transactionverification_add_ons to PaymentMethod create options for ACH NetworkCheckDeprecate evidenceSubmittable in Dispute
evidenceSubmittable in Disputeescape calls in generator for:
Add processing_overrides to Transaction.sale options
processing_overrides to Transaction.sale optionsAdd evidence_submittable to Dispute
evidence_submittable to Disputemerchant_token_identifier and source_card_last4 to ApplePayCardexpiration_date in:
CrediCardAndroidPayCardApplePayCardSamsungPayCardVisaCheckoutCardretry_ids and retried_transaction_id to Transaction objectAdd merchant_advice_code and merchant_advice_code_text to Transaction object
merchant_advice_code and merchant_advice_code_text to Transaction objectAdd intended_transaction_source to CreditCardVerification
intended_transaction_source to CreditCardVerificationthree_d_secure_pass_thru to CreditCardVerificationpayment_method_nonce to CreditCardVerificationthree_d_secure_authentication_id to CreditCardVerificationFixup issue where request sessions weren't including proxy settings (see #5677 for details).
Deprecate chargeback_protection_level and add protection_level to Dispute and DisputeSearch
ExcessiveRetry to GatewayRejectionReasonpre_dispute_program to Dispute and DisputeSearchAutoAccepted status to DisputeDisputeAutoAccepted to WebhookNotification.Kindchargeback_protection_level and add protection_level to Dispute and DisputeSearchshipping object to submit_for_settlement_signatureSEPADirectDebitAccount payment methodSEPADirectDebitAccount to transaction objectSEPA_DIRECT_DEBIT_ACCOUNT to PaymentInstrumentTypesepa_debit_paypal_v2_order_id to TransactionSearchsepa_direct_debit_accounts to CustomerPrepare http request before setting url to resolve issue where dot segments get normalized
Fix DeprecationWarning on invalid escape sequences (thanks @DavidCain)
DeprecationWarning on invalid escape sequences (thanks @DavidCain)Add LiabilityShift class and liability_shift to RiskData
LiabilityShift class and liability_shift to RiskDataach_return_responses_created_at and reason_code fields in TransactionSearch* Add retried to Transaction
retried to TransactionAdd PaymentMethodCustomerDataUpdated webhook
PaymentMethodCustomerDataUpdated webhookNothing published for this version
Add plan create/update/find API endpoint
TransactionReview webhook notificationAdd localPaymentFunded and localPaymentExpired webhooks
localPaymentFunded and localPaymentExpired webhooksAdd exchange_rate_quote_id to Transaction.sale
exchange_rate_quote_id to Transaction.saleExchangeRateQuoteIdIsTooLong to TransactionApplePayCard and AndroidPayCard:
commercialdebitdurbin_regulatedhealthcarepayrollprepaidproduct_idcountry_of_issuanceissuing_bankTransaction.TaxAmountIsRequiredForAibSwedish for attribute tax_amount to handle validation for AIB:Domestic Transactions in SwedenAdd payment_reader_card_details parameter to Transaction.sale
payment_reader_card_details parameter to Transaction.saleGrantedPaymentMethodRevokedchargeback_protection_level to DisputeSearchskip_advanced_fraud_checking to:
PaymentMethod.create and PaymentMethod.updateCreditCard.create and CreditCard.updateAdd tax_identifiers parameter to Customer.create and Customer.update
paypal_messages to Disputetax_identifiers parameter to Customer.create and Customer.updateAdd LocalPaymentReversed webhook
LocalPaymentReversed webhookstore_id and store_ids to Transaction.searchAdd merchant_account_id to Transaction.refund
merchant_account_id to Transaction.refundTransaction.adjust_authorization method to support for multiple authorizations for a single transactionDeprecate device_session_id and fraud_merchant_id in CreditCardGateway, CustomerGateway, PaymentMethodGateway, and TransactionGateway classes
installments to Transaction requestscount to installmentsdevice_session_id and fraud_merchant_id in CreditCardGateway, CustomerGateway, PaymentMethodGateway, and TransactionGateway classessca_exemption to Transaction.sale requestDeprecate recurring in Transaction sale requests
acquirer_reference_number to Transactionrecurring in Transaction sale requestsDeprecate masterpass_card and amex_checkout_card payment methods
masterpass_card and amex_checkout_card payment methodstransaction.credit could not be called using a gateway objectAdd validation error code Transaction.ProductSkuIsInvalid
Transaction.ProductSkuIsInvalidprocessed_with_network_token to Transactionis_network_tokenized to CreditCardAdd retrieval_reference_number to Transaction
retrieval_reference_number to Transactionnetwork_transaction_id to CreditCardVerificationproduct_sku to Transactioncustomer_device_id, customer_location_zip, and customer_tenure to RiskDataphone_number and shipping_method to AddressTransaction.ShippingMethodIsInvalidTransaction.ShippingPhoneNumberIsInvalidTransaction.BillingPhoneNumberIsInvalidRiskData.CustomerBrowserIsTooLongRiskData.CustomerDeviceIdIsTooLongRiskData.CustomerLocationZipInvalidCharactersRiskData.CustomerLocationZipIsInvalidRiskData.CustomerLocationZipIsTooLongRiskData.CustomerTenureIsTooLongAdd DisputeAccepted, DisputeDisputed, and DisputeExpired webhook constants
DisputeAccepted, DisputeDisputed, and DisputeExpired webhook constantsthree_d_secure_pass_thru to CreditCard.create, CreditCard.update, PaymentMethod.create, PaymentMethod.update, Customer.create, and Customer.update.Verification validation errors for 3D Securepayment_method_token to CreditCardVerificationSearchrecurring_customer_consent and recurring_max_amount to authentication_insight_options for PaymentMethodNonce.createFileIsEmpty error codeRemove deprecated Transparent Redirect
Authentication Insight to payment method nonce createAuthenticationIdsthree_d_secure_authentication_id to three_d_secure_infothree_d_secure_authentication_id support for transaction saleunrecognized status from Transaction, Subscription, and CreditCardVerificationGrantedPaymentInstrumentUpdate kind from Webhookline_items only returns the line items for a transaction response object. Use TransactionLineItem find_all to search all line items on a transaction, given a transaction_idNothing published for this version
Add RefundAuthHardDeclined and RefundAuthSoftDeclined to validation errors
RefundAuthHardDeclined and RefundAuthSoftDeclined to validation errorspurchase_order_number, tax_amount, and tax_exempt to Transaction.submit_for_settlementdiscount_amount, shipping_amount, ships_from_postal_code, line_items to Transaction.submit_for_settlementAdd support for managing Apple Pay domains (thanks @ethier #117)
ProcessorDoesNotSupportMotoForCardType to validation errorsCreditCardVerification, Customer, Dispute, and Transaction* Set correct version for PyPi
Add networkResponseCode and networkResponseText to transactions and verifications
networkResponseCode and networkResponseText to transactions and verificationscavv, xid, ds_transaction_id, eci_flag, and three_d_secure_version, to three_d_secure_infothree_d_secure_info to credit_card_verificationGraphQLClient to BraintreeGateway classAdd captureId field to local_payment_details
captureId field to local_payment_detailsrefundId field to local_payment_detailsdebugId field to local_payment_detailstransactionFeeAmount field to local_payment_detailstransactionFeeCurrencyIsoCode field to local_payment_detailsrefundFromTransactionFeeAmount field to local_payment_detailsrefundFromTransactionFeeCurrencyIsoCode field to local_payment_detailsds_transaction_id and three_d_secure_version to 3DS pass thru fieldspayer_info field to payment_method_nonce detailsbraintree.exceptions.http.timeout_error.ConnectTimeoutError (child class of TimeoutError)braintree.exceptions.http.timeout_error.ReadTimeoutError (child class of TimeoutError)room_tax support for transaction saleno_show support for transaction saleadvanced_deposit support for transaction salefire_safe support for transaction saleproperty_phone support for transaction saleadditional_charges support for transaction salePostalCodeIsRequiredForCardBrandAndProcessor to validation errorsNone values (#109)Add payment_method_nonce field to LocalPaymentCompleted webhook
payment_method_nonce field to LocalPaymentCompleted webhooktransaction field to LocalPaymentCompleted webhookLocalPaymentDetails to transactionsAdd refund_from_transaction_fee_amount field to paypal_details
refund_from_transaction_fee_amount field to paypal_detailsrefund_from_transaction_fee_currency_iso_code field to paypal_detailsrevoked_at field to paypal_accountPaymentMethodRevokedByCustomer webhookYour coding agent can read these notes before it upgrades. Set up the MCP server →