Overview

The eCash API enables customers to create and use barcodes to add cash to their accounts at participating eCash locations.

How it Works

• The user generates a barcode using the mobile app or Green Dot's website.
• The user shows the barcode to the eCash Partner (retailer).
• The eCash Partner scans the barcode and allows the user to add funds to an account using cash.

Note: For eCash transactions that credit or debit an account, the transactionType is eCash.

eCash API Endpoints

Lists participating eCash partners associated with a program.

This endpoint is used to retrieve a list of eCash partners (retailers) for a specific programCode.

API Call Structure

GET /programs/{programCode}/accounts/{accountIdentifier}/ecashpartners

Gets the active barcodes associated with account identifier

This endpoint retrieves a list of active barcodes associated with a user’s account based on the account identifier.

API Call Structure

GET /programs/{programCode}/accounts/{accountIdentifier}/barcodes/list

Retrieves details of a specific barcode associated with a user’s account.

This endpoint retrieves the details about a specific barcode associated with a user’s account based on the accountIdentifier.

API Call Structure

GET /programs/{programCode}/accounts/{accountIdentifier}/barcodes/{barcodeHumanReadable}

Generates a new barcode for a given eCash partner (retailer).

This endpoint generates a new barcode for an eCash Partner (retailer).

API Call Structure

POST /programs/{programCode}/accounts/{accountIdentifier}/barcodes

Things to Remember

• Barcodes are retailer-specific due to the barcode format accepted by the retailer. Although some retailers have the same barcode format and a barcode can technically be used at retailers that share the same format, Green Dot recommends that barcodes be marketed as retailer specific. This prevents a customer from going to a retailer that may not accept the barcode format generated.
• Barcodes can only be used once.
• Funds are not available immediately. Most retailers have a 10-15 minute funding delay in place.
• If a new barcode is generated and it is not used, it will become expired.
  NOTE: The expiration date and time is returned in the response when the new barcode is generated.

Retrieves eCash partners by geographic location for a specific account.

Returns a list of participating eCash partners (retailers) near a specified location for the given account. You can search by latitude, longitude, ZIP code, city, state, and radius.

This endpoint is useful for finding nearby eCash partners where users can perform cash transactions. All location parameters are optional, but at least one should be provided to filter results. The response includes partner details that match the specified criteria.