GET
/
links
/
{id}
/
accounts
/
numbers
curl --request GET \
  --url http://localhost:8080/links/{id}/accounts/numbers \
  --header 'Authorization: Bearer <token>'
{
  "accounts": [
    {
      "account_id": "acc_6Tef269B6ZArSVpYrxtjBV",
      "account_type": "depository.checking",
      "name": "Premier Checking",
      "account_mask": "3748",
      "balances": {
        "currency": "USD",
        "available": 340.12,
        "current": 445.89,
        "limit": 500
      },
      "numbers": {
        "ach": [
          {
            "account_number": "<string>",
            "routing_number": "<string>",
            "wire_routing_number": "<string>"
          }
        ],
        "bacs": [
          {
            "account_number": "<string>",
            "sort_code": "<string>"
          }
        ],
        "eft": [
          {
            "account_number": "<string>",
            "institution_number": "<string>",
            "branch_number": "<string>"
          }
        ],
        "international": [
          {
            "iban": "<string>",
            "bic": "<string>"
          }
        ]
      }
    }
  ],
  "link": {
    "link_id": "mk_eqkWN34UEoa2NxyALG8pcV",
    "institution_id": "chase",
    "institution_name": "Chase",
    "provider": "mx",
    "state": "connected",
    "last_synced_at": "2023-02-16T09:14:11",
    "tags": [
      "user_type:admin"
    ],
    "products": {
      "accounts": {
        "refreshed_at": "2023-02-16T09:14:11",
        "last_attempted_at": "2023-02-16T09:14:11"
      },
      "identity": {
        "refreshed_at": "2023-02-16T09:14:11",
        "last_attempted_at": "2023-02-16T09:14:11",
        "settings": {
          "required": true,
          "prefetch": false
        }
      }
    }
  }
}

Note that this endpoint does not trigger a fetch of account numbers from the institution; it merely returns account numbers that have already been fetched, either because prefetch was requested when the link was created, or because of an on-demand update.

To force a check for new/updated account numbers, you must use the /products endpoint.

If you have requested prefetch or an on-demand update, you should check the refreshed_at date for this product in the returned response, and compare that against the previous refreshed_at date, which you can get from any previous response for this or any other account or link request.

If the refreshed_at date has not increased, then updated data is not yet available.

curl -i -X GET \
  'http://localhost:8080/links/{id}/accounts/numbers' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'moneykit-version: 2023-02-18'

{
  "accounts": [
    {
      "account_id": "a3ba443a-257c-490e-8242-03a84789d39f",
      "account_type": "checking",
      "name": "Premier Checking",
      "account_mask": "3748",
      "balances": {
        "currency": "USD",
        "available": 340.12,
        "current": 445.89,
        "limit": 500
      },
      "numbers": {
        "ach": [
          {
            "account_number": "string",
            "routing_number": "string",
            "wire_routing_number": "string"
          }
        ],
        "bacs": [
          {
            "account_number": "string",
            "sort_code": "string"
          }
        ],
        "eft": [
          {
            "account_number": "string",
            "institution_number": "string",
            "branch_number": "string"
          }
        ],
        "international": [
          {
            "iban": "string",
            "bic": "string"
          }
        ]
      }
    }
  ],
  "link": {
    "link_id": "mk_eqkWN34UEoa2NxyALG8pcV",
    "institution_id": "chase",
    "institution_name": "Chase",
    "provider": "mx",
    "state": "connected",
    "last_synced_at": "2023-02-16T09:14:11",
    "tags": [
      "user_type:admin"
    ],
    "products": {
      "accounts": {
        "refreshed_at": "2023-02-16T09:14:11",
        "last_attempted_at": "2023-02-16T09:14:11"
      },
      "identity": {
        "refreshed_at": "2023-02-16T09:14:11",
        "last_attempted_at": "2023-02-16T09:14:11",
        "settings": {
          "required": true,
          "prefetch": false
        }
      }
    }
  }
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
moneykit-version
string
default:2023-02-18

Path Parameters

​
id
string
required

The unique ID for this link.

Response

200
application/json

Successful Response

The response is of type object.