Skip to main content
GET
/
bank-linking
/
accounts
Search financial accounts
curl --request GET \
  --url https://api-sb.meld.io/bank-linking/accounts \
  --header 'Authorization: <api-key>'
{
  "count": 123,
  "financialAccounts": [
    {
      "accountId": "<string>",
      "balances": {
        "availableAmount": 123,
        "currency": "<string>",
        "currentAmount": 123,
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "connectionIds": [
        "<string>"
      ],
      "customerId": "<string>",
      "externalCustomerId": "<string>",
      "historicalAggregationSucceeded": true,
      "id": "<string>",
      "identifiers": {
        "ach": {
          "accountNumber": "<string>",
          "routingNumber": "<string>"
        },
        "bacs": {
          "accountNumber": "<string>",
          "sortCode": "<string>"
        },
        "eft": {
          "accountNumber": "<string>",
          "institutionNumber": "<string>",
          "branchNumber": "<string>"
        },
        "international": {
          "accountName": "<string>",
          "accountNumber": "<string>",
          "bban": "<string>",
          "bic": "<string>",
          "iban": "<string>",
          "sortCode": "<string>"
        }
      },
      "institutionId": "<string>",
      "institutionName": "<string>",
      "key": "<string>",
      "name": "<string>",
      "owners": [
        {
          "addresses": [
            {
              "data": {
                "city": "<string>",
                "country": "<string>",
                "full": "<string>",
                "postalCode": "<string>",
                "region": "<string>",
                "street": "<string>"
              }
            }
          ],
          "emails": [
            {
              "data": "<string>"
            }
          ],
          "names": [
            "<string>"
          ],
          "phoneNumbers": [
            {
              "data": "<string>"
            }
          ]
        }
      ],
      "serviceProviderDetails": [
        {}
      ],
      "truncatedAccountNumber": "<string>"
    }
  ],
  "remaining": 123
}

Authorizations

Authorization
string
header
default:BASIC <Meld API Key>
required

Query Parameters

customerId
string

Meld generated unique identifier for your customer. This should be used to track customer activity. Should not be provided in conjunction with externalCustomerId

externalCustomerId
string

Your unique identifier for your customer. If maintaining your own customer management system this can also be used for tracking customer activity. Should not be provided in conjunction with customerId

institutionId
string

Institution id

connectionId
string

Connection id

before
string

Unique key corresponding to a financial account's position in the paginated list of results -- used to indicate that only financial accounts residing before this key will be retrieved.

Each financial account carries a unique key. Reference Pagination

The before and after fields cannot be used in the same request.

after
string

Unique key corresponding to a financial account's position in the paginated list of results -- used to indicate that only financial accounts residing after this key will be retrieved.

Each financial account carries a unique key. Reference Pagination

The before and after fields cannot be used in the same request.

limit
integer<int32>

Limits number of returned financial accounts.

Default value: 10

Minimum value: 1

Maximum value: 100

Response

Financial accounts are returned

count
integer<int32>

Number of financial accounts returned.

financialAccounts
object[]

Financial accounts

remaining
integer<int32>

Number of remaining financial accounts before/after this page, depending on the direction this page was selected.