Bank Account

Details about a bank account payment method.

JSON

{
  "id": "dc0dc633-1760-4d43-ba1d-da94ed701f06",
  "bankName": "Bread National Bank",
  "accountType": "CHECKING",
  "setupType": "ACH",
  "accountNumber": "string",
  "routingNumber": "string",
  "country": "US",
  "currency": "USD",
  "createdAt": "2020-12-31T15:10:55Z",
  "updatedAt": "2020-12-31T15:10:55Z",
  "connection": {
    "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"
  },
  "changeReceived": true,
  "achBlocked": true,
  "returnCode": "string",
  "returnDescription": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	true	none	A unique bank account identifier.
bankName	string	true	none	Identifies the institution that the account belongs to.
accountType	string	true	none	Identifies the type of the account.
setupType	string	false	none	Identifies the way funds are transferred.
accountNumber	string	true	none	The number assigned to the account by the institution.
routingNumber	string	true	none	The institution's identifying number.
country	string	false	none	The country code for this bank account's location.
currency	string	false	none	The type of currency used with this bank account.
createdAt	string(date-time)	true	none	The timestamp for when this bank account payment method was created.
updatedAt	string(date-time)	true	none	The timestamp for when this bank account payment method was last updated.
connection	object	false	none	Details about a connection to a third party for this bank account.
➥ 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.
changeReceived	boolean	true	none	The Flag to indicate this payment method has related NOC.
achBlocked	boolean	true	none	The Flag to indicate this payment method has been blocked.
returnCode	string	true	none	The return code associated with account being blocked.
returnDescription	string	true	none	The description associated with the return code for blocked account.

Enumerated Values

Value
UNKNOWN_ACCOUNT_TYPE
CHECKING
SAVINGS
UNKNOWN_SETUP_TYPE
ACH
EFT
UNKNOWN_CONNECTION_STATUS
VERIFIED
UNVERIFIED
FAILED
UNKNOWN_PROVIDER
MANUAL
FLINKS