List bank accounts
To use this endpoint from the browser, you’ll need to specify the
/accounts/{accountID}/bank-accounts.read
scope when generating a token.
GET
/accounts/{accountID}/bank-accounts
|
|
|
|
|
|
Successfully retrieved bank accounts.
[
{
"bankAccountID": "ec7e1848-dc80-4ab0-8827-dd7fc0737b43",
"bankAccountType": "checking",
"bankName": "Chase Bank",
"exceptionDetails": {
"achReturnCode": "R02",
"description": "string",
"rtpRejectionCode": "AC03"
},
"fingerprint": "9948962d92a1ce40c9f918cd9ece3a22bde62fb325a2f1fe2e833969de672ba3",
"holderName": "Jules Jackson",
"holderType": "individual",
"lastFourAccountNumber": "7000",
"paymentMethods": [
{
"paymentMethodID": "9506dbf6-4208-44c3-ad8a-e4431660e1f2",
"paymentMethodType": "ach-debit-fund"
},
{
"paymentMethodID": "3f9969cf-a1f3-4d83-8ddc-229a506651cf",
"paymentMethodType": "ach-debit-collect"
}
],
"routingNumber": "string",
"status": "new",
"statusReason": "bank-account-created",
"updatedOn": "2019-08-24T14:15:22Z"
}
]
No account with the specified accountID was found.
Request was refused due to rate limiting.
Response headers
Retry-After
number
Path parameters
accountID
string
<uuid>
required
ID of the account.
Response
application/json
bankAccountID
string<uuid>
<=36 characters
UUID
bankAccountType
string<enum>
The bank account type.
Possible values:
checking
,
savings
,
general-ledger
,
loan
bankName
string
exceptionDetails
object
Reason for, and details related to, an
errored
or verificationFailed
bank account status.
Show child attributes
achReturnCode
string<enum>
The return code of an ACH transaction that caused the bank account status to change.
Codes:
- R02 - Account Closed
- R03 - No Account/Unable to Locate Account
- R04 - Invalid Account Number
- R05 - Improper Debit to Consumer Account
- R07 - Authorization Revoked by Customer
- R08 - Payment Stopped
- R10 - Customer Advises Originator is Not Known or Authorized to Receiver and
- R11 - Customer Advises Entry Not in Accordance with the Terms of the Authorization
- R12 - Branch Sold to Another DFI
- R13 - RDFI not qualified to participate
- R14 - Representative payee deceased or unable to continue in that capacity
- R15 - Beneficiary or bank account holder
- R16 - Bank account frozen
- R17 - Entry with Invalid Account Number Initiated Under Questionable Circumstances
- R20 - Non-payment bank account
- R23 - Credit entry refused by receiver
- R29 - Corporate customer advises not authorized
- R34 - Limited participation RDFI
- R38 - Stop Payment on Source Document (Adjustment Entry)
- R39 - Improper Source Document
Possible values:
R02
,
R03
,
R04
,
R05
,
R07
,
R08
,
R10
,
R11
,
R12
,
R13
,
R14
,
R15
,
R16
,
R17
,
R20
,
R23
,
R29
,
R34
,
R38
,
R39
description
string
Details related to an
errored
or verificationFailed
bank account status.
rtpRejectionCode
string<enum>
The rejection code of an RTP transaction that caused the bank account status to change.
Codes:
- AC03 - Account Invalid
- AC04 - Account Closed
- AC06 - Account Blocked
- AC14 - Creditor Account Type Invalid
- AG01 - Transactions Forbidden On Account
- AG03 - Transaction Type Not Supported
- MD07 - Customer Deceased
Possible values:
AC03
,
AC04
,
AC06
,
AC14
,
AG01
,
AG03
,
MD07
fingerprint
string
<=100 characters
Once the bank account is linked, we don’t reveal the full bank account number. The fingerprint acts as a way to identify whether two linked bank accounts are the same.
holderName
string
holderType
string<enum>
The type of holder on a funding source.
Possible values:
individual
,
business
lastFourAccountNumber
string
paymentMethods
array
Includes any payment methods generated for a newly created bank account, removing the need to call the List Payment Methods endpoint following a successful Create BankAccount request.
NOTE: This field is only populated for Create BankAccount requests made with the X-Wait-For
header.
Show child attributes
paymentMethodID
string<uuid>
<=36 characters
UUID
paymentMethodType
string<enum>
The payment method type that represents a payment rail and directionality
Possible values:
moov-wallet
,
ach-debit-fund
,
ach-debit-collect
,
ach-credit-standard
,
ach-credit-same-day
,
rtp-credit
,
card-payment
,
apple-pay
,
push-to-card
,
pull-from-card
routingNumber
string
status
string<enum>
The bank account status.
Possible values:
new
,
verified
,
verificationFailed
,
pending
,
errored
statusReason
string<enum>
The reason the bank account status changed to the current value.
Possible values:
bank-account-created
,
verification-initiated
,
micro-deposit-attempts-exceeded
,
micro-deposit-expired
,
max-verification-failures
,
verification-attempts-exceeded
,
verification-expired
,
verification-successful
,
ach-debit-return
,
ach-credit-return
,
rtp-credit-failure
,
micro-deposit-return
,
admin-action
,
other
updatedOn
string<date-time>
<=24 characters