GRgroupebpce
External Accounts

Get the external accounts

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

get/externalAccounts

Request

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

Query parameters

designationLabelstring

Designation of the account holder (partial search is allowed). The caller must provide for the complete entry of the label sought before calling this filtered search method (i.e. it is prohibited to call this service each time a character is entered in order to avoid abusive calls. Otherwise, an error is returned)

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>

Example:ACTIVATED

External account activation status : activated or activation in progress

pageSizeinteger

Number of elements per page

pageNumberinteger

Number of the current page

afterstring

Cursor of the last element of the previous call. Used to get the next page. Default value point to the first element

Response

OK Response, returning a paginated list of external accounts.

Example response

{
  "items": [
    {
      "accountId": "13807-1-CPT31719694553",
      "label": "DUPONT JEAN",
      "accountNumber": "31719694553",
      "iban": "FR7613807000343179999999943",
      "financialInstitution": {
        "id": "1-CCBPFRPPNAN",
        "label": "BANQUE POPULAIRE GRAND OUEST",
        "identifiers": [
          {
            "value": "CCBPFRPPNAN",
            "type": "BIC"
          }
        ]
      },
      "currencies": [
        {
          "code": "EUR",
          "label": "Euro"
        }
      ],
      "status": "ACTIVATED"
    }
  ],
  "page": {
    "pageSize": 50,
    "pageNumber": 1,
    "totalElements": 20,
    "totalPages": 1
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.