Ask Moov Beta
Generative AI is experimental and can make mistakes.
Guides Dashboard Use cases API Changelog
  1. API reference
  2. Sources
  3. Bank accounts

List bank accounts

List all the bank accounts associated with a particular 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
cURL Go Python TypeScript Java PHP 
1
2

curl -X GET "https://api.moov.io/accounts/{accountID}/bank-accounts" \
  -H "Authorization: Bearer {token}" \

1
2
3
4
5

mc, _ := moov.NewClient()

var accountID string

mc.ListBankAccounts(ctx, accountID)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

from  import Moov
from .models import components


with Moov(
    security=components.Security(
        username="",
        password="",
    ),
) as moov:

    res = moov.bank_accounts.list(account_id="c8a232aa-0b11-4b8a-b005-71e9e705d0e6")

    # Handle response
    print(res)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19

import { Moov } from "@moovio/sdk";

const moov = new Moov({
  security: {
    username: "",
    password: "",
  },
});

async function run() {
  const result = await moov.bankAccounts.list({
    accountID: "c8a232aa-0b11-4b8a-b005-71e9e705d0e6",
  });

  // Handle the result
  console.log(result);
}

run();
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

package hello.world;

import io.moov.sdk.Moov;
import io.moov.sdk.models.components.Security;
import io.moov.sdk.models.operations.ListBankAccountsResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        Moov sdk = Moov.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        ListBankAccountsResponse res = sdk.bankAccounts().list()
                .accountID("c8a232aa-0b11-4b8a-b005-71e9e705d0e6")
                .call();

        if (res.bankAccounts().isPresent()) {
            // handle response
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

declare(strict_types=1);

require 'vendor/autoload.php';

use Moov\MoovPhp;
use Moov\MoovPhp\Models\Components;

$sdk = MoovPhp\Moov::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();



$response = $sdk->bankAccounts->list(
    accountID: 'c8a232aa-0b11-4b8a-b005-71e9e705d0e6',
    xMoovVersion: 'v2024.01.00'

);

if ($response->bankAccounts !== null) {
    // handle response
}
200 401 403 429 500 504
The request completed successfully.
schema
{
  "items": {
    "description": "Describes a bank account linked to a Moov account.",
    "example": {
      "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"
    },
    "properties": {
      "bankAccountID": {
        "format": "uuid",
        "type": "string"
      },
      "bankAccountType": {
        "description": "The bank account type.",
        "enum": [
          "checking",
          "savings",
          "general-ledger",
          "loan"
        ],
        "type": "string"
      },
      "bankName": {
        "type": "string"
      },
      "exceptionDetails": {
        "description": "Reason for, and details related to, an `errored` or `verificationFailed` bank account status.",
        "properties": {
          "achReturnCode": {
            "description": "The return code of an ACH transaction that caused the bank account status to change.\n\n- R02: Account Closed\n- R03: No Account/Unable to Locate Account\n- R04: Invalid Account Number\n- R05: Improper Debit to Consumer Account\n- R07: Authorization Revoked by Customer\n- R08: Payment Stopped\n- R10: Customer Advises Originator is Not Known or Authorized to Receiver\n- R11: Customer Advises Entry Not in Accordance with the Terms of the Authorization\n- R12: Branch Sold to Another DFI\n- R13: RDFI not qualified to participate\n- R14: Representative payee deceased or unable to continue in that capacity\n- R15: Beneficiary or bank account holder\n- R16: Bank account frozen\n- R17: Entry with Invalid Account Number Initiated Under Questionable Circumstances\n- R20: Non-payment bank account\n- R23: Credit entry refused by receiver\n- R29: Corporate customer advises not authorized\n- R34: Limited participation RDFI\n- R38: Stop Payment on Source Document (Adjustment Entry)\n- R39: Improper Source Document",
            "enum": [
              "R02",
              "R03",
              "R04",
              "R05",
              "R07",
              "R08",
              "R10",
              "R11",
              "R12",
              "R13",
              "R14",
              "R15",
              "R16",
              "R17",
              "R20",
              "R23",
              "R29",
              "R34",
              "R38",
              "R39"
            ],
            "type": "string"
          },
          "description": {
            "description": "Details related to an `errored` or `verificationFailed` bank account status.",
            "type": "string"
          },
          "rtpRejectionCode": {
            "description": "The rejection code of an RTP transaction that caused the bank account status to change.\n\n- AC03: Account Invalid\n- AC04: Account Closed\n- AC06: Account Blocked\n- AC14: Creditor Account Type Invalid\n- AG01: Transactions Forbidden On Account\n- AG03: Transaction Type Not Supported\n- MD07: Customer Deceased",
            "enum": [
              "AC03",
              "AC04",
              "AC06",
              "AC14",
              "AG01",
              "AG03",
              "MD07"
            ],
            "type": "string"
          }
        },
        "required": [
          "achReturnCode",
          "rtpRejectionCode",
          "description"
        ],
        "type": "object"
      },
      "fingerprint": {
        "description": "Once the bank account is linked, we don't reveal the full bank account number. \n\nThe fingerprint acts as a way to identify whether two linked bank accounts are the same.",
        "maxLength": 100,
        "type": "string"
      },
      "holderName": {
        "type": "string"
      },
      "holderType": {
        "description": "The type of holder on a funding source.",
        "enum": [
          "individual",
          "business"
        ],
        "type": "string"
      },
      "lastFourAccountNumber": {
        "type": "string"
      },
      "paymentMethods": {
        "description": "Includes any payment methods generated for a newly created bank account, removing the need to\ncall the List Payment Methods endpoint following a successful Create BankAccount request.\n\n**NOTE: This field is only populated for Create BankAccount requests made with the `X-Wait-For` header.**",
        "items": {
          "properties": {
            "paymentMethodID": {
              "description": "ID of the payment method.",
              "format": "uuid",
              "type": "string"
            },
            "paymentMethodType": {
              "description": "The payment method type that represents a payment rail and directionality",
              "enum": [
                "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"
              ],
              "type": "string"
            }
          },
          "required": [
            "paymentMethodID",
            "paymentMethodType"
          ],
          "type": "object"
        },
        "type": "array"
      },
      "routingNumber": {
        "type": "string"
      },
      "status": {
        "enum": [
          "new",
          "verified",
          "verificationFailed",
          "pending",
          "errored"
        ],
        "type": "string"
      },
      "statusReason": {
        "description": "The reason the bank account status changed to the current value.",
        "enum": [
          "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"
        ],
        "type": "string"
      },
      "updatedOn": {
        "format": "date-time",
        "type": "string"
      }
    },
    "required": [
      "bankAccountID",
      "fingerprint",
      "status",
      "holderName",
      "holderType",
      "bankName",
      "bankAccountType",
      "routingNumber",
      "lastFourAccountNumber",
      "updatedOn"
    ],
    "type": "object"
  },
  "type": "array"
}

Response headers

x-request-id

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

Response headers

x-request-id

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

Response headers

x-request-id

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

Response headers

x-request-id

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

Response headers

x-request-id

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

Response headers

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

Response

application/json

bankAccountID

string<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> 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

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>
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

routingNumber

string

status

string<enum>
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>
OSZAR »