BaaS APIs Overview

Green Dot’s Banking-as-a-Service (BaaS) APIs enable partners to build, launch, and scale financial products using a secure, proven core banking platform. Our APIs are designed to support both business needs—such as reliability, scalability, and compliance—and developer needs, including clear documentation, consistent patterns, and predictable behavior.

Whether you’re launching a new financial product or extending an existing one, the BaaS APIs give you access to the core capabilities required to embed banking functionality directly into your applications.

What you can build with BaaS APIs

Using our BaaS APIs, partners can:

Integrate core banking capabilities into existing applications
Launch new financial products faster and more cost-effectively
Support growth into new customer segments or markets

Each partner integration is built around a secure, brand-specific model that includes the products, accounts, users, activities, and transactions needed to support your use case.

API design and standards

The BaaS APIs follow REST principles and operate over HTTPS. Standard HTTP methods are used to create, retrieve, and update resources, with predictable request and response patterns across endpoints.

Requests and responses use JSON
OAuth 2.0 is used for authentication and authorization

To support development and testing, partners receive access to a sandbox environment during onboarding.

📘
All BaaS APIs use UTC as the standard date and time format.

Core APIs

Green Dot’s BaaS platform is composed of a set of foundational APIs that nearly every partner integration relies on, along with add-on APIs that enable expanded functionality and differentiated user experiences. Your specific integration may use all or only a subset of these APIs, depending on your product model and program configuration.

Foundational APIs

These APIs form the backbone of most partner integrations. They support customer onboarding, account access, payments, money movement, and ongoing system synchronization.

Enrollments

The Enrollments API is typically the first API used in a partner integration. It establishes the initial banking relationship for a new user.

Partners use this API to:

Enroll new users into a Green Dot program
Create a user’s primary account
Issue an initial payment instrument (physical or virtual)

Users

The Users API manages customer profile information throughout the lifecycle of the relationship.

This API allows partners to:

Retrieve user profile details
Update user information as it changes over time

Accounts

The Accounts API provides access to essential account-level data and activity.

Common use cases include:

Retrieving account details and balances
Viewing transaction history
Accessing available account statements
Supporting identity verification and compliance workflows, including KYC-related checks

Payment Instruments

The Payment Instruments API manages cards and other payment instruments issued to users.

With this API, partners can:

Create physical and virtual payment instruments
Retrieve payment instrument details
Activate, replace, or reissue payment instruments
Set or reset ATM PINs
Request initial physical card fulfillment

Transfers

The Transfers API enables movement of funds between accounts.

Partners commonly use this API to support:

Transfers between internal accounts (purses)
Transfers to and from external accounts
Remote check deposits (MRDC)

Webhooks

The Webhooks API allows partners to receive real-time notifications about events occurring on user accounts, reducing the need for polling.

Webhook events include (but are not limited to):

Transactions and transfers
Account, user, and card updates
Statements and interest events
ACH, check, ATM, and P2P activity
Compliance, identity, and account status changes

Add-On API Examples

These APIs extend core banking functionality and are commonly used to enhance user experience, servicing, or cash access. Not all partner integrations require these APIs.

BillPay

The BillPay API enables bill payment functionality within partner applications.

Partners can use this API to:

Set up payees
Schedule one-time or recurring bill payments
View and manage bill payment activity

ATM Locator

The ATM Locator API helps users find nearby ATM locations.

Typical usage includes searching for in-network ATMs and displaying results within the partner application.

Retail Locator

The Retail Locator API allows users to locate participating retail locations that support cash reload services.

This API supports discovery of retailers offering:

SwipeReload
eCash cash loading

eCash

The eCash API enables barcode-based cash loading at participating retail locations.

With this API, partners can:

Generate barcodes for cash load transactions
Retrieve active barcodes associated with a user account
Retrieve details for a specific barcode
Access participating eCash partners for a given program

Customer Care

The Customer Care API supports customer servicing workflows where Green Dot provides customer support on behalf of partners.

Partners may use this API to:

Create and manage customer support cases
Allow users to submit cases for Green Dot review
Support regulated escalation and servicing scenarios

... and many more.

📘
The APIs listed on this page represent some of the most commonly used foundational and add-on APIs, but they are not exhaustive. Green Dot offers many additional optional APIs that support specialized features, advanced servicing, and unique product use cases.
To explore all available APIs, browse the developer portal or work directly with your Green Dot representative to identify the APIs that best align with your business model and integration needs.