---
title: "Get the external accounts"
method: GET
path: "/externalAccounts"
tags: ["External Accounts"]
---

# Get the external accounts

`GET /externalAccounts`

## Request

- Base URL: `https://api.groupebpce.com/retail/moneyTransfer/v1`
- URL: `https://api.groupebpce.com/retail/moneyTransfer/v1/externalAccounts`
- Auth: OAuth 2
  - Authorization code: `/api/oauth/authorize`
  - Token URL: `/api/oauth/token` scopes: `moneyTransfer.externalAccounts:READ`

Get the external accounts (usable for credit within a transfer) of the current user

## Query parameters

- `designationLabel` string
- `accountStatus` 'DELETED' | 'ACTIVATION_IN_PROGRESS' | 'ACTIVATED': Status of the external account (beneficiary). <table><tr><td>Code</td> <td>Meaning</td></tr><tr><td>DELETED</td> <td>The external account has been canceled. It will not be usable anymore.</td></tr><tr><td>ACTIVATION_IN_PROGRESS</td> <td>The external account has been created but is not usable yet.</td></tr><tr><td>ACTIVATED</td> <td>The external account can be used for a new transfer.</td></tr></table>
- `pageSize` integer
- `pageNumber` integer
- `after` string

## Response `200`

OK Response, returning a paginated list of external accounts.

- object
  - `items` ExternalAccount[], required: List of available recipient accounts for transfers
    - `accountId` string, required: Identifier of the account
    - `label` string, required: Label of the account.
    - `accountNumber` string, required: Number of the account.
    - `iban` string: ISO 13616 format for a bank account.
    - `financialInstitution` FinancialInstitution: A financial Institution is a legitimate organization contributing to financial operations. It is not necessarily a Bank.
      - `id` string, required: Financial institution identifier.
      - `label` string, required: Financial institution label
      - `identifiers` object[], required: Financial institution identifier value and type.
        - `value` string
        - `type` 'SWIFT' | 'BIC' | 'BANQUE_DE_FRANCE' | 'ABA'
    - `currencies` Currency[]: Currencies of the account.
      - `code` string, required: An ISO 3166 3-char code for a currency.
      - `label` string: A human readable label for the currency.
    - `status` 'DELETED' | 'ACTIVATION_IN_PROGRESS' | 'ACTIVATED', required: Status of the external account (beneficiary). <table><tr><td>Code</td> <td>Meaning</td></tr><tr><td>DELETED</td> <td>The external account has been canceled. It will not be usable anymore.</td></tr><tr><td>ACTIVATION_IN_PROGRESS</td> <td>The external account has been created but is not usable yet.</td></tr><tr><td>ACTIVATED</td> <td>The external account can be used for a new transfer.</td></tr></table>
    - `activationDateTime` string, date-time: If the beneficiary account is being activated, indicates the date from which it will be usable.
    - `isHolder` boolean: Indicates whether the subscriber is the owner or co-owner of the beneficiary account. Declarative data.
    - `groupLabels` string[]: Name of the beneficiary groups to which the account is attached.
  - `page` union: A pagination structure. This may be a pagination by index or by cursor.
    - object: Pagination by index of page.
      - `pageSize` integer, required: Number of items by page
      - `pageNumber` integer, required: Page number requested.
      - `totalElements` integer: Number of items matching the query
      - `totalPages` integer: Number of pages of items matching the query
    - object: Pagination via cursor of the last element of the previous call.
      - `pageSize` integer, required: Number of items by page
      - `after` string, required: Cursor of the last element of the previous call. Used to get the next page.

## Other responses

- `400`: Bad Request - HTTP 400
- `401`: Unauthorized - HTTP 401
- `403`: Forbidden - HTTP 403
- `500`: Internal Server Error - HTTP 500.
- `503`: Service Unavailable - HTTP 503.

---

[API](https://skmtc.dev/groupebpce/apis/bpce-open-finance-transfer.md) - [All operations](https://skmtc.dev/groupebpce/apis/bpce-open-finance-transfer/llms.txt) - [OpenAPI document](https://skmtc.dev/groupebpce/apis/bpce-open-finance-transfer/revisions/b85ff7120f49?raw)