Retrieve a bank account

Retrieve bank account details (i.e. routing number or account type) associated with a specific Moov account.

Read our bank accounts guide to learn more.

To access this endpoint using an access token you’ll need to specify the /accounts/{accountID}/bank-accounts.read scope.

GET
/accounts/{accountID}/bank-accounts/{bankAccountID}
cURL Go
1
2
curl -X GET "https://api.moov.io/accounts/{accountID}/bank-accounts/{bankAccountID}" \
  -H "Authorization: Bearer {token}" \
1
2
3
4
5
6
mc, _ := moov.NewClient()

var accountID string
var BankAccountID string

mc.GetBankAccount(ctx, accountID, BankAccountID)
200 401 403 404 429 500 504
The request completed successfully.
Describes a bank account linked to a Moov account.
{
  "bankAccountID": "833fa3ef-14d3-4c97-ba45-6af66f739832",
  "bankAccountType": "checking",
  "bankName": "Gringotts Bank",
  "fingerprint": "dd4cbfe5fbaf47b392770b5b595bec604fd99394749b7d017153e2b9cfbea40e",
  "holderName": "John Doe",
  "holderType": "individual",
  "lastFourAccountNumber": "6789",
  "routingNumber": "123456780",
  "status": "new",
  "statusReason": "bank-account-created",
  "updatedOn": "2024-11-26T22:37:06Z"
}

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request contained missing or expired authentication.

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The user is not authorized to make the request.

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The requested resource was not found.

x-request-id

string <uuid> required
A unique identifier used to trace requests.
Request was refused due to rate limiting.

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request failed due to an unexpected error.

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request failed because a downstream service failed to respond.

x-request-id

string <uuid> required
A unique identifier used to trace requests.

Headers

x-moov-version

string
API version

Specify an API version.

API versioning follows the format vYYYY.QQ.BB, where

  • YYYY is the year
  • QQ is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)
  • BB is the build number, starting at .01, for subsequent builds in the same quarter.
    • For example, v2024.01.00 is the initial release of the first quarter of 2024.

The latest version represents the most recent development state. It may include breaking changes and should be treated as a beta release.

Default: v2024.01.00

Path parameters

accountID

string <uuid> required

bankAccountID

string <uuid> required

Response

application/json
Describes a bank account linked to a Moov account.

bankAccountID

string<uuid> required

bankAccountType

string<enum> required
The bank account type.
Possible values: checking, savings, general-ledger, loan

bankName

string required

fingerprint

string <=100 characters required

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 required

holderType

string<enum> required
The type of holder on a funding source.
Possible values: individual, business

lastFourAccountNumber

string required

routingNumber

string required

status

string<enum> required
Possible values: new, verified, verificationFailed, pending, errored

updatedOn

string<date-time> required

exceptionDetails

object
Reason for, and details related to, an errored or verificationFailed bank account status.
Show child attributes

achReturnCode

string<enum> required

The return code of an ACH transaction that caused the bank account status to change.

  • 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
  • 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 required
Details related to an errored or verificationFailed bank account status.

rtpRejectionCode

string<enum> required

The rejection code of an RTP transaction that caused the bank account status to change.

  • 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

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>
ID of the payment method.

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, push-to-card, pull-from-card, apple-pay, card-present-payment

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