v1

latestOpenAPI 3.0.12026-07-243407211.3 MB

Transfers

Generate External Account Link Token

Generates a secure link token for connecting an external bank account using a third-party provider. Returns the generated link token for use in account linking flows.

post/programs/{programCode}/account/{accountIdentifier}/token/create

Path parameters

programCodestring required

The program code for the partner implementation.

accountIdentifierstring required

The unique identifier for the account to link.

Headers

X-GD-RequestIdstring required

A unique identifier (GUID) for tracking the request.

Request body

AccountReferenceIdstring nullable

The internal reference ID for the Green Dot account to which the external account will be linked. This property is not serialized in the request payload.

deviceType'Unknown' | 'Web' | 'IOS' | 'Android'

The type of device initiating the link token request (e.g., Web, IOS, Android).

optionsobject nullable

Optional. A dictionary of additional options or parameters to customize the link token request.

externalaccountprovider'None' | 'Plaid' | 'PlaidLinkToken' | 'Finicity'

The external account provider type (e.g., Plaid, Finicity) used to generate the link token.

customerIdstring nullable

The unique identifier of the customer requesting the link token.

Response

responseCodestring nullable

The response code indicating the result of the link token request (e.g., "200" for success).

linkTokenstring nullable

The link token generated by the external account provider, used to initiate the account linking process.

errorCodestring nullable

The error code returned if the link token request failed.

errorMessagestring nullable

The error message describing the reason for failure, if applicable.

errorTypestring nullable

The type or category of error, if the request was not successful.