Skip to main content

GraphQL API

We've adopted GraphQL for Braintree's next-generation API. We're offering the option to use this new API directly without a library.

graphql logo

Why GraphQL

We're using GraphQL because it's great for developers, partners, and merchants. GraphQL brings:

  • A richly expressive open-source specification, maintained by a dedicated foundation.
  • Schemas and types that strictly define valid requests and responses.
  • Introspection, meaning you can ask any GraphQL API what it can do.
  • Developer tools to ease learning and integration.
  • The flexibility to specify exactly what data you care about, and retrieve only as much or as little data as needed.
  • The efficiency of combining multiple traditional REST endpoints into one request.
  • The freedom to use any programming language you want — and no more SDKs to manage and update on your server.

With GraphQL, we are enabling faster, safer, and more extensible integration of commerce capabilities into your product.

Status of the API

Our GraphQL API currently supports basic server-side transaction processing. While it does not yet offer the full feature set that our server-side SDKs have, you can use it to:

  • Charge payment methods
  • Authorize payment methods
  • Vault payment methods
  • Capture transactions
  • Reverse and refund transactions
  • Look up transactions and payment methods by ID

Combine this with our JavaScript, iOS, or Android SDKs to securely collect raw payment data from the client, and you have everything you need for core transaction processing server-side.


We're hard at work adding more functionality. Keep an eye out for more features coming soon. If you'd like to request a feature, feel free to open an issue.


As this product is under development, the content on this site will change over time. However, we do not anticipate making any backwards-incompatible or breaking changes to the API as currently published.

Graphiql explorer

Exploring the API

We've integrated the GraphiQL project into our new documentation to allow you to explore and test the API straight from your browser. You can try out the API Explorer right now.


For a no-frills static reference with changelog, see our Schema Repository.


Or, check out our Guides for in-depth, topic-by-topic documentation.

icon

Cookies help customize Braintree for you, and some are necessary to make our site work. By using Braintree, you accept our use of cookies. Learn more about the cookies we use and how you can manage them.