API Reference

Generate External Account Link Token

post
https://example.com/programs//account//token/create

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.

Path Params
string
required

The program code for the partner implementation.

string
required

The unique identifier for the account to link.

Body Params

The Gd.Bos.DataTransfer.Request.ExternalAccountLinkTokenRequest containing provider information for token creation.

string | null

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.

string
enum

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

Allowed:
options
object | null

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

string
enum

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

Allowed:
string | null

The unique identifier of the customer requesting the link token.

Headers
string
required

A unique identifier (GUID) for tracking the request.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized

Updated 2 months ago

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json
text/json

Updated 2 months ago