Overview

Funds movement is one of the core capabilities offered by Green Dot to its partners. Green Dot exposes cash pickup barcode generation capability through a set of RESTFul Transfer API endpoints. The Transfer API can be used to generate barcodes that customers can use to pickup cash at any participating retailer. The cash pickup funding destination is represented in the API as links. Methods are provided to add and verify new links and to initiate cash pickuptransfers for specific 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 may be facilitating transactions on behalf of many customers. In the 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.

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.

Making a Transfer

A simple workflow for generating a claim code for cash pickup looks like below:

1. Make a POST /customers/{customerid} request as documented at POST /customers to create a new customer.
2. Make a POST/customers/{customerid}/links/type/cash request using CustomerID from the previous response to create a cash pickup link.
3. Make a POST/transfers/{transferid} request using CustomerID and cash pickup link from the previous response to create a cash pickup claim code.
4. Make a POST/transfers/confirm/{transferId} request using TransferId from the previous response to cancel the cash pickup claim code.