Get External Accounts
Get external accounts linked to a business
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Required when using a Platform API token. The tenant key identifying which business to operate on.
Path Parameters
The unique identifier for the business
Response
List of external accounts linked to a business
Unique identifier for the external account
"d43eaff3-bc75-44f6-ac37-3a305192ead6"
Last 4 digits of the account number
"0000"
Name of the bank
"Example Bank"
Status of the external account. active accounts are verified and ready to use for deposits. needs_confirmation accounts were linked with micro-deposits and must be verified before they can be used. restricted accounts are verified, but direct debits from them are restricted until the restriction is lifted, when they return to active.
active, needs_confirmation, restricted "active"
Hosted page for completing micro-deposit verification. Returned only while the account is awaiting verification. Prefer generating a link with mode set to verification, which keeps the account holder in your branded flow.
"https://verify.example.com/microdeposit/1A2B3C"
Describes the micro-deposit an account is waiting on. Returned only while the account is awaiting verification.