Disbursements and Cash Pickup Overview

Funds movement is one of the core capabilities offered by Green Dot to its partners. Green Dot exposes this capability through a set of RESTFul Transfer API endpoints. This Transfer API can be used to move funds between Green Dot managed accounts, and to and from external accounts or services. These different funding sources and destinations are represented in the API as links. Methods are provided to add and verify new links and to create fund transfers between links.

The Transfer API also introduces the customer object, representing the party authorizing a transfer. In some applications, the partner and customer are synonymous while in other applications a partner maybe facilitating transactions on behalf of many customers. In this latter case, the customer object is a convenient container to track the funding links authorized for a specific customer and the transfers created on behalf of a specific customer.

When using the Transfer API in conjunction with the Registration and Account APIs it is helpful to note that a Green Dot Bank account holder does not need to create a customer object separate from their account. Instead, their AccountId can be used directly in the Transfer API or a proxy CustomerID can be retrieved from account details. See Making a Transfer for further details.

This documentation is intended for developers who are well-versed with REST. We use standard built-in HTTP features to allow partners, who are familiar with HTTP Authentication and HTTP verbs, to quickly become proficient at communicating with our Transfer API. This document contains use cases for handling different types of transfers. Each demonstrated use case contains a code sample section that highlights a calling of the API along with the required data elements for that transfer type.

Green Dot uses conventional HTTP response code to indicate success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the information provided and codes in the 5xx range indicate an error with Green Dot’s server.

This documentation can always be retrieved by going to [prefix]/docs.