Lister les banques

curl --request POST \
  --url https://api.codaclean.io/v1/banks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "bic": "GEBA BE BB"
}
'

{
  "records": [
    {
      "name": "BNP Paribas Fortis",
      "country": "BE",
      "bicCodes": [
        "GEBA BE BB"
      ],
      "available": true
    }
  ],
  "recordsTotal": 1980,
  "recordsFiltered": 1
}

POST

banks

curl --request POST \
  --url https://api.codaclean.io/v1/banks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "bic": "GEBA BE BB"
}
'

{
  "records": [
    {
      "name": "BNP Paribas Fortis",
      "country": "BE",
      "bicCodes": [
        "GEBA BE BB"
      ],
      "available": true
    }
  ],
  "recordsTotal": 1980,
  "recordsFiltered": 1
}

Autorisations

x-api-key

string

header

requis

Identifies the partner software. Issued by Codaclean. Required on every call, including POST /token.

Authorization

string

header

requis

Identifies the user and their accounting firm. Send the idToken returned by POST /token as Authorization: Bearer <idToken>. Valid for 1 hour.

Corps

application/json

bic

string

Spaces are ignored.

country

string

Country code, case-insensitive.

available

boolean

limit

integer

défaut:50

Plage requise: x <= 200

offset

integer

défaut:0

Réponse

Matching banks.

records

object[]

Show child attributes

recordsTotal

integer

recordsFiltered

integer

Prise en main

Concepts

Guides

Authentification

Utilitaires

Clients

Comptes bancaires

Secrétariats sociaux du client

Mandats

Données de référence

Fichiers CODA

Fichiers CODB

Autorisations

Corps

Réponse