sjparsons/custom-actions-docs

Custom Actions documentation

Custom Actions

^{Last edit: 04/19/2020}

Availability: We're building Custom Actions with the same proven expertise and rock-solid foundations you expect from Braintree.

Email custom-actions-requests@braintreepayments.com to learn more.

Custom Actions is a serverless platform that opens the Braintree ecosystem to you and your developers by providing the capability to extend our built-in offerings. With Custom Actions, you can add new payment methods we don't currently support, send transaction data to your accounting systems, run fraud tools from the vendor of your choice, or develop a custom workflow unique to your business.

Contents

• Custom Actions
  • What is it?
  • Benefits
    • Single integration
    • Unified reporting
  • Use cases
    • Payment methods
    • Fraud tools
    • Data import & export
  • Getting Started
    • Requirements
  • Guides

What is it?

We've defined triggers within Braintree that can execute code you've deployed into our platform. This code, called a Custom Action behaves as an Event Handler and is responsible for interacting with partners and vendors connected with your business. Often these handlers are simply mapping data from a third-party source to Braintree specific data.

Custom Actions focuses on developer experience as a first-class value. We provide tools to allow you to iterate quickly and deploy seamlessly. At its core, Custom Actions uses GraphQL and TypeScript to ensure type safety for your integration. These technologies also allow you to develop your integration locally within your own environment and leverage familiar tooling.

Benefits

Single integration

Payment methods run through Custom Actions are actionable within Braintree, just like any other. For example, you can initiate refunds or settle transactions the same as you would for a card payment.

Unified reporting

By consolidating all of your transaction data within Braintree, you can view all of your commerce data in one place. Globally available Custom Actions are deployed globally. This means you can tailor your commerce to specific regions and enhance the experience for your users by minimizing latency.

Use cases

Payment methods

With Custom Actions, you can accept a payment method Braintree doesn’t support or initiate complex workflows with third-parties such as Twilio to take payment information over the phone.

Fraud tools

You can use Custom Actions to run transactions through a fraud service.

Data import & export

Coming soon

Getting Started

Requirements

• A Braintree sandbox account – (signup here)
• Access to Custom Actions – (email custom-actions-requests@braintreepayments.com for access)
• Node.js v10.16 or later (download)
  • nvm is recommended to manage Node.js versions.
• Familiarity with git and command-line tools

Guides

• Accept a new payment method