External Accounts API Endpoints

Create a new customer profile in the Green Dot system.

POST /programs/{programCode}/externalAccounts/customers

This API creates a customer profile. Afterwards, the customer must go through Green Dot's verification process before initiating any further API calls.

Update an existing customer profile.

PUT /programs/{programCode}/externalAccounts/customers/{customerToken}

Update an existing customer profile with encrypted data. The customer profile must exist and the request must be authorized.

Retrieve a customer profile.

GET /{programCode}/externalAccounts/customers/{customerToken}

Retrieve the details of a customer profile by customer token. Returns encrypted customer profile data.

Get transfer limits and fee rates for a program.

GET /programs/{programCode}/externalAccounts/transferLimitsAndFeeRates

Retrieve the transfer limits and fee rates for a specific program and transfer type.

Link a bank account to a customer profile.

POST /programs/{programCode}/externalAccounts/customers/{customerToken}/banks

Link a bank account to a customer profile using encrypted data. The bank account will be associated with the customer for future transfers.

Retrieve links for a customer profile by token and link type.

GET /programs/{programCode}/externalAccounts/customers/{customerToken}/links

Retrieve all links (cards or banks) for a customer profile, optionally filtered by link type.

Link a card to a customer profile.

POST /programs/{programCode}/externalAccounts/customers/{customerToken}/cards

Links a card to a customer profile using encrypted data. The card will be associated with the customer for future transfers.

Retrieve a transfer by customer token and transfer ID.

GET /{programCode}/externalAccounts/customers/{customerToken}/transfers/{transferId}

Retrieve the details of a specific transfer for a customer profile using the transfer ID.

Delete a bank link from a customer profile.

DELETE /programs/{programCode}/externalAccounts/customers/{customerToken}/banks/{linkId}

Delete a linked bank account from a customer profile. The bank link will be removed and cannot be used for future transfers.

Update a bank link for a customer profile.

PUT /programs/{programCode}/externalAccounts/customers/{customerToken}/banks/{linkId}

Update the details of a linked bank account for a customer profile.

Link a card to a source customer profile by GFT.

POST /programs/{programCode}/externalAccounts/sourceCustomers/{customerToken}/links

Link a card to a source customer profile for global fund transfer operations.

Delete a card link from a customer profile.

DELETE /programs/{programCode}/externalAccounts/customers/{customerToken}/cards/{linkId}

Delete a linked card from a customer profile. The card link will be removed and cannot be used for future transfers.

Retrieve card links for a source customer profile.

GET /programs/{programCode}/externalAccounts/sourceCustomers/{customerToken}/links

Retrieve all card links associated with a source customer profile.

Update a card link for a customer profile.

PUT /programs/{programCode}/externalAccounts/customers/{customerToken}/cards/{linkId}

Update the details of a linked card for a customer profile.

Search transfers by date range for a customer profile.

GET /programs/{programCode}/externalAccounts/customers/{customerToken}/transfers

Search for transfers associated with a customer profile within a specified date range and pagination.