Getting Started with Brails API Reference

Welcome to the Brails API Reference! Here, you will find the complete list of available methods to manage virtual cards, process payments, retrieve transactions, and integrate other features into your applications.

About the API

The Brails API is a RESTful API that lets you interact with the Brails platform You can use the Brails API to:

Create and manage virtual cards
Make payments
View transactions
Manage your Brails account

Base URL and Sandbox Environment

The sandbox environment is for testing. You can build and test your API integration here without using real money or affecting real data.

Sandbox Base URL:

Use this for testing: https://sandboxapi.onbrails.com/api/v1/

Example: To get customer data, use: https://sandboxapi.onbrails.com/api/v1/customers

Production Base URL:

When you're ready to go live with real money, just change the base URL to the production URL.

Note: Always test in the sandbox first. Switch to the production URL only when everything is working perfectly.

What You Will Need

To use the Brails API, you will need:

A Sandbox Account Sign up for a Sandbox Account (opens in a new tab)to test your API integration safely.
An API Key The Brails API uses an API key for authentication. You can generate an API key from your Sandbox dashboard:

Go to Developers on the side menu.
Click Generate a new key to create your API key.

How to Use Your API Key

For every API request, include your API key in the Authorization header like this:

📘

Authorization: Bearer BRAILS-API-KEY

Important: Keep your API key secret. Never share it or expose it publicly.

Developer Documentation

For detailed information, visit the Brails Developer Documentation (opens in a new tab).