Green Dot Retail API - Overview

Introduction

The Green Dot Retail API enables authorized retail partners to offer cash-based financial services to customers at point-of-sale locations. It is an RPC-style JSON API that communicates over HTTPS with Green Dot Corporation's core processing platform, allowing partners to initiate and manage real-time cash movement transactions tied to prepaid cards, debit cards, MoneyPak products, and barcode-based payment accounts.

This API is designed for developers and technical teams building POS integrations at retail locations where customers can perform cash-in and cash-out transactions without visiting a bank branch.

What Can Partners Offer?

Green Dot's Retail API allows retail partners to bring a range of financial services to their customers at the register:

Purchase new card products — Customers can buy a Green Dot or partner-branded prepaid card directly at the register. Once purchased, the card can be activated and used immediately.

Purchase MoneyPak — Customers can buy a MoneyPak product using cash, which can then be used to send funds to friends or family members who have a compatible prepaid or bank account.

Cash deposits to prepaid and debit cards — Customers can deposit cash onto a Green Dot card, a partner-branded card, or a qualifying third-party debit, prepaid card, or digital wallet — all without a bank account required.

Cash deposits using a barcode — Customers with a Green Dot barcode (generated through a mobile app or partner system) can deposit cash directly at the register, or make cash payments toward eCommerce orders, utility bills, loans, rent, and other obligations.

Cash deposits to any US debit card (Point of Banking) — Partners enabled for Point of Banking can accept cash deposits to virtually any valid US debit card, expanding access to customers across card programs.

Void pending transactions — Transactions that are still within their funding delay window can be cancelled at the register, providing an immediate correction mechanism before funds settle.

Note: The specific services your integration supports depend on the agreement between your organization and Green Dot Corporation. Contact your Green Dot account manager for details on which transaction types are enabled for your program.

API Categories

Card Reload

Validates and processes cash deposits to prepaid and debit card accounts using the card's PAN (account number). Partners first call Get Card Details to confirm the card is eligible and retrieve fee and limit information, then call Reload to commit the transaction. Point of Banking Payment follows a similar flow with additional cardholder identity fields.

Endpoints: Get Card Details · Reload · Point of Banking Payment

Barcode / eCash

Accepts cash payments linked to a customer's barcode. The barcode is scanned at the register and validated before the transaction is committed. Supports both card account deposits and bill/payment applications.

Endpoints: Get Barcode Details · Barcode Payment

Package Sales

Sells new prepaid card packages and MoneyPak products. Partners validate the package barcode with Get Package Details before committing the sale with Package Sale.

Endpoints: Get Package Details · Package Sale

Transaction Voids

Cancels a Reload, Package Sale, or Barcode Payment that is still within its funding delay window. The void must be submitted before fundingDelaySeconds elapses.

Endpoint: Void

System

A lightweight connectivity check for integration health monitoring.

Endpoint: Ping

How It Works

API Design

Property	Value
Protocol	HTTPS only
Style	RPC over JSON
Authentication	OAuth 2.0 Client Credentials (Microsoft identity platform)
Content-Type	`application/json`
Base URL	`https://{env}-fscpartner-apim.go2bankonline.com/fscpartner/v1`
API Version	V1

Environments

Environment	`{env}`	Use
Production	`prod`	Live transactions
PIE (Partner Integration Environment)	`pie`	Integration development and testing

Validate-Then-Execute Pattern

Most transaction flows follow a two-step pattern:

Validate — Call the /details endpoint to confirm eligibility and retrieve fees and limits to display to the customer before they commit.
Execute — If the customer proceeds, call the transaction endpoint (/reload, /sale, /payment) to commit the transaction.

This pattern gives cashiers accurate fee and limit information at the point of interaction, reducing errors and failed transactions.

Standard Response Envelope

All API responses share a common set of base fields:

Field	Type	Description
`requestId`	String	Echo of the `X-GD-RequestId` from the request header
`responseId`	String	Unique response identifier generated by Green Dot
`responseDateTime`	DateTime	UTC timestamp of the response
`responseCode`	Numeric	Success or failure code (`0` = Success)
`responseDescription`	String	Human-readable description of the response code

For the complete list of response codes, see Response Codes.

Getting Started

To begin integration:

Work with your Green Dot account manager to obtain OAuth 2.0 credentials and have your server IPs allowlisted.
Review Getting Started for authentication setup and metadata requirements.
Use the PIE environment for all development and testing before going live.