Bank Account

{
  "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"
  }
}

Details about a bank account payment method.

Properties

NameTypeRequiredRestrictionsDescription
idstring(uuid)falsenoneA unique bank account identifier.
bankNamestringfalsenoneIdentifies the institution that the account belongs to.
accountTypestringfalsenoneIdentifies the type of the account.
setupTypestringfalsenoneIdentifies the way funds are transferred.
accountNumberstringfalsenoneThe number assigned to the account by the institution.
routingNumberstringfalsenoneThe institution's identifying number.
countrystringfalsenoneThe country code for this bank account's location.
currencystringfalsenoneThe type of currency used with this bank account.
createdAtstring(date-time)falsenoneThe timestamp for when this bank account payment method was created.
updatedAtstring(date-time)falsenoneThe timestamp for when this bank account payment method was last updated.
connectionobjectfalsenoneDetails about a connection to a third party for this bank account.
➥ idstring(uuid)falsenoneA unique bank connection identifier.
➥ externalAccountIDstringfalsenoneThis is the identification number for a payment method within a customer account provided by a third party authorization program.
➥ connectionIDstringfalsenoneThis is a one-time identification number provided to lookup a newly created customer account in a third party authorization program.
➥ tokenstringfalsenoneThis is a token that is used to connect to a third party authorization program.
➥ organizationIDstringfalsenoneThis is the organization number the account is assigned to by a third party authorization program.
➥ externalOrganizationIDstringfalsenoneThis is the organization number the account is assigned to by a third party authorization program.
➥ accountHolderNamestringfalsenoneThis is the name of a bank account holder.
➥ connectionStatusstringfalsenoneThis is the status of a connection to a bank account from a third party authorization program.
➥ providerstringfalsenoneThis is the third party authorization program used to authorize the bank account.
➥ createdAtstring(date-time)falsenoneThe timestamp for when this third party bank connection was created.
➥ updatedAtstring(date-time)falsenoneThe timestamp for when this third party bank connection was last updated.

Enumerated Values

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