Exceptions
Handling exceptions
Handling exceptions is straightforward and follows common language conventions.
- Python
try:
customer = gateway.customer.find("an_unknown_customer_id")
except braintree.exceptions.not_found_error.NotFoundError as e:
print e
Our list of available exceptions is up-to-date with the latest versions of the server SDKs. Check our migration guide if you are integrating from an older version.
Authentication Error
braintree.exceptions.authentication_error.AuthenticationErrorRaised when your API keys are incorrect. If you're getting this exception when first integrating, double-check that you haven't accidentally tried to use your sandbox keys in production or vice-versa.
Authorization Error
braintree.exceptions.authorization_error.AuthorizationErrorRaised when the API key that you're using is not authorized to perform the attempted action according to the role assigned to the user who owns the API key.
This error can also occur if the data you submitted was malformed – either a parameter isn't in the allowed list, or it is at the wrong location in the nested parameters.
Configuration Error
braintree.exceptions.configuration_error.ConfigurationErrorRaised when the library isn't configured. Make sure you have environment, merchantId, publicKey, and privateKey.
- Python
gateway = braintree.BraintreeGateway(
braintree.Configuration(
braintree.Environment.Sandbox,
merchant_id="your_merchant_id",
public_key="your_public_key",
private_key="use_your_private_key"
)
)
Invalid Challenge
braintree.exceptions.invalid_challenge_error.InvalidChallengeErrorRaised when the webhook challenge you attempt to verify is in an invalid format.
Invalid Signature
braintree.exceptions.invalid_signature_error.InvalidSignatureErrorRaised when the webhook notification you attempt to parse has an invalid signature.
This could be caused by a payload being modified in transit or if you attempt to parse messages that did not originate from our servers.
Not Found Error
braintree.exceptions.not_found_error.NotFoundErrorRaised when the record that you're trying to operate on can't be found. For example, if you try to update a customer and the customer ID isn't valid. For references and associations, you'll receive a validation error if the reference is invalid. For example, when creating a credit card and specifying which customer ID it should be associated to, if the customer ID is invalid, it will be a validation error, not a not found exception.
Server Error
braintree.exceptions.server_error.ServerErrorRaised when something goes wrong on the Braintree server when trying to process your request.
Unexpected Error
braintree.exceptions.unexpected_error.UnexpectedErrorRaised when an error occurs that the client library is not built to handle. If this happens, there's probably a bug in the client library.
Too Many Requests Error
braintree.exceptions.too_many_requests_error.TooManyRequestsErrorRaised when requests associated with your account reach unsafe levels. We may limit API resources by merchant if activity risks negative impact to other merchants.
Upgrade Required Error
braintree.exceptions.upgrade_required_error.UpgradeRequiredErrorRaised when you're trying to use a version of the library that is no longer supported. Please see our Server SDK Deprecation Policy for more information.
Timeouts
Timeout Exception
braintree.exceptions.http.timeout_error.ReadTimeoutErrorRaised when a request times out because it takes longer than the custom timeout limit you set in the server SDKs. A request that returns this exception could still be successful if it processes within the Braintree gateway timeout limit of 60 seconds. Learn more about timeouts.
Gateway Timeout Error
braintree.exceptions.gateway_timeout_error.GatewayTimeoutErrorRaised when Braintree servers time out delivering a response. For search API calls, this usually indicates the amount of information you are requesting is greater than the amount of time Braintree servers have to retrieve it and send a response. Try breaking down your search calls into smaller batches.
Request Timeout Error
braintree.exceptions.request_timeout_error.RequestTimeoutErrorRaised when Braintree servers time out waiting for the entire request from your server. This usually indicates an issue upstream of Braintree.
Service Unavailable Error
braintree.exceptions.service_unavailable_error.ServiceUnavailableErrorRaised when Braintree or a downstream service is unavailable.