Bank Connection

Details about a connection to a third party for this bank account.

JSON

{
  "id": "dc0dc633-1760-4d43-ba1d-da94ed701f06",
  "externalAccountID": "string",
  "connectionID": "string",
  "token": "string",
  "organizationID": "string",
  "externalOrganizationID": "string",
  "accountHolderName": "John Doe",
  "connectionStatus": "VERIFIED",
  "provider": "FLINKS",
  "createdAt": "2020-12-31T15:10:55Z",
  "updatedAt": "2020-12-31T15:10:55Z"
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	A unique bank connection identifier.
externalAccountID	string	false	none	This is the identification number for a payment method within a customer account provided by a third party authorization program.
connectionID	string	false	none	This is a one-time identification number provided to lookup a newly created customer account in a third party authorization program.
token	string	false	none	This is a token that is used to connect to a third party authorization program.
organizationID	string	false	none	This is the organization number the account is assigned to by a third party authorization program.
externalOrganizationID	string	false	none	This is the organization number the account is assigned to by a third party authorization program.
accountHolderName	string	false	none	This is the name of a bank account holder.
connectionStatus	string	false	none	This is the status of a connection to a bank account from a third party authorization program.
provider	string	false	none	This is the third party authorization program used to authorize the bank account.
createdAt	string(date-time)	false	none	The timestamp for when this third party bank connection was created.
updatedAt	string(date-time)	false	none	The timestamp for when this third party bank connection was last updated.

Enumerated Values

Value
UNKNOWN_CONNECTION_STATUS
VERIFIED
UNVERIFIED
FAILED
UNKNOWN_PROVIDER
MANUAL
FLINKS