API docs by Redocly

EstablishmentAPI (1.0.3)

License: Copyright

API permettant de créer et gérer des établissements.

Authentification

Une authentification avec un bearerToken est obligatoire. Le token doit être générer avec l'AuthAPI. Le token doit avoir le scope "establishment" pour pouvoir être utilisé.

Liste des erreurs

Voici la liste des codes d'erreur internes, ces erreurs n'apparaissent que dans le cadre d'un statut HTTP 500.

Code Statut HTTP
EST-1 500
EST-4 500
EST-10 500
EST-12 500

Voici la liste des codes d'erreur

Code Description Statut HTTP
EST-2 Chemin invalide 404
EST-3 Un paramètre est manquant ou invalide dans le corps de la requête (ex: paramètre envoyé en string au lieu d'un integer) 422
EST-5 Token manquant 401
EST-6 Signature du token invalide 400
EST-7 Token expiré 400
EST-8 Token invalide 400
EST-9 Accès non authorisé au service (token invalide) 403
EST-11 Établissement non trouvé 404
EST-13 Le pays sélectionné n'est pas pris en charge 400
EST-14 Le code renseigné est invalide 400
EST-15 Erreur avec token AuthAPIServices 400
EST-16 Information n'est pas trouvé dans base de données 400
EST-17 Le dossier d'Onboarding n'a pas été trouvé dans la base 404
EST-18 Le dossier d'Onboarding avec statut en cours n'a pas été trouvé dans la base 404

Informations de l'établissement

Rechercher un établissement par son code et retourner les informations de cet établissement

Authorizations:
BearerToken
query Parameters
code
required
any

Code de l'établissement (SIRET, SIREN)

countryCode
required
any

Le code pays à deux lettres au format ISO 3166

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Codes établissement acceptés

Récupérer les codes acceptés pour un pays donné

Authorizations:
None
query Parameters
countryCode
required
any

Le code pays à deux lettres au format ISO 3166

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Création d'un groupe

Création d'un groupe

Authorizations:
None
Request Body schema: application/json
required

Ref de dossier onboarding, information concernant d'un groupe et sa banque

externalRef
required
string

Un folder_external_ref de file Onboarding

required
object (Establishment)
required
Array of objects (Bank)

Liste des banques

Responses

Request samples

Content type
application/json
{
  • "externalRef": "string",
  • "establishment": {
    },
  • "banks": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Le bearer token est manquant",
  • "code": "EST-5"
}

Récupération d'un onboarding par ref

Récupérer un onboarding par ref

Authorizations:
None
query Parameters
folderExternalRef
required
any

L'externalRef de l'OnboardingAPI

Responses

Response samples

Content type
application/json
{
  • "userId": 0,
  • "campaignName": "string",
  • "status": "IN_PROGRESS",
  • "folderExternalRef": "string",
  • "tableId": 0
}

Récupération d'un onboarding

Récupérer un onboarding en cours

Authorizations:
None
Request Body schema: application/json
required

User ID et type campaign

userId
required
integer >= 1

L'id d'utilisateur qui est en train de créer un groupe

campaignName
required
string
Enum: "GROUP" "POS"

Type campagne d'onboarding

Responses

Request samples

Content type
application/json
{
  • "userId": 1,
  • "campaignName": "GROUP"
}

Response samples

Content type
application/json
{
  • "userId": 0,
  • "campaignName": "string",
  • "status": "IN_PROGRESS",
  • "folderExternalRef": "string",
  • "tableId": 0
}