Customizing MerchantΒΆ

While we make all attempts to cover most of the functionality of the payment processors but may fall short sometimes. There is absolutely no need to worry as the gateway and integration objects are extensible.

Merchant looks for gateways and integration objects under every INSTALLED_APPS in So it is possible for you to write your custom or modified objects within your app without having to patch the merchant code.


Most of what is written below will also be applicable for gateways and you will have to replace instances of integration with gateway.

Suppose you want to extend the Braintree Payments Integration, to render a different template on success instead of the default billing/braintree_success.html.

Here is the process:

  • In any of the settings.INSTALLED_APPS, create an integrations module (in layman’s term an integrations directory with an file under that directory).

  • Create a file in that integrations directory that follows the convention below:


    Let us name the modified integration as modified_bp, then the filename would be:

    and the Integration class name in that file as ModifiedBpIntegration.


    The naming of the file and class follows a simple rule. The filename is split on underscores and each element of the split sequence is capitalized to obtain the class name.

    So in our example, in the

    class ModifiedBpIntegration(BraintreePaymentsIntegration):
        def braintree_success_handler(self, request, response):
           return render_to_response("my_new_success.html",
                                     {"resp": response},
  • Then use the new integration in your code just as you would for a built-in integration:

    >>> bp_obj = get_integration("modified_bp")