Un dispositif

GET

/v1/entreprises/{entreprise}/dispositifs/{dispositif}

const url = 'https://passerelle.teneur.exemple/v1/entreprises/example/dispositifs/example';
const options = {
  method: 'GET',
  headers: {'Correlation-Id': 'example', Authorization: 'Bearer <token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://passerelle.teneur.exemple/v1/entreprises/example/dispositifs/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Correlation-Id: example'

L’abondement est servi tel que le règlement le présente : ses règles en libellés, ses plafonds, sa période.

Autorisations

jetonPartenaire

Paramètres

Paramètres (path)

entreprise

required

string

>= 1 characters

L’identifiant publié de l’entreprise chez ce teneur de compte. Il désigne la ressource ; un identifiant d’entreprise dans une URL ne vaut jamais autorisation.

dispositif

required

string

>= 1 characters

L’identifiant publié du dispositif — plan d’épargne ou mécanisme de partage de la valeur.

Paramètres (header)

Correlation-Id

required

string

>= 1 characters <= 128 characters

L’identifiant que le teneur de compte donne à l’échange dans son journal. Obligatoire : notre trace dit qui a lu quoi, jamais pour qui, et ce champ est la seule jointure entre les deux journaux. Il est restitué dans la réponse.

Réponses

200

Le dispositif et son paramétrage en vigueur.

application/json

object

dispositif

required

string

libelle

required

string

type

required

string

cadre_legal

required

Le cadre légal dont relèvent les avoirs du dispositif — il se lit, il ne se déduit pas du type.

string

Allowed values: epargne-salariale plan-epargne-retraite

etat

required

string

periode

required

object

debut

required

string format: date

fin

Absente pour une période encore ouverte.

string format: date

derniere_alimentation

La date du dernier fait d’acquisition inscrit au dispositif — « le PERCO n’est plus alimenté depuis mars 2023 » se lit ici. Null pour un dispositif jamais alimenté, ce qui n’est pas la même chose qu’un dispositif clos.

string | null format: date

actes

Les actes qui fondent, modifient ou clôturent le dispositif — leurs métadonnées seulement ; le document vit dans la gestion documentaire.

Array<object>

object

acte

required

string

nature

required

Accord

string

role

required

string

Allowed values: FONDE MODIFIE CLOTURE

signe_le

required

string format: date

abondement

La politique d’abondement telle qu’elle se présente, pour être affichée et comprise. Elle n’est pas servie en portées, compteurs et paliers exécutables : la résolution d’un abondement pour un versement donné appartient au domaine qui la calcule.

object

periode

required

object

debut

required

string format: date

fin

Absente pour une période encore ouverte.

string format: date

empreinte

La signature du paramétrage en vigueur — elle permet au correspondant et au teneur de parler de la même version.

string

regles

required

Array<object>

object

libelle

required

string

enonce

required

La règle énoncée en clair, destinée à être affichée telle quelle.

string

plafond

La limite, énoncée en clair — montant, période et ce sur quoi elle se compte.

string

supports

Les supports que le dispositif autorise, dans son offre en vigueur.

Array<object>

object

support

required

string

libelle

required

string

classification

string

ouvert_aux_versements

required

boolean

Example

{
  "cadre_legal": "epargne-salariale",
  "actes": [
    {
      "role": "FONDE"
    }
  ]
}

Headers

Correlation-Id

string

>= 1 characters <= 128 characters

L’identifiant de corrélation reçu, restitué tel quel — la jointure entre le journal du teneur et le nôtre.

401

401 — aucune identité présentée, ou jeton invalide : signature, émetteur, dates, tenant, ou audience obtenue pour une autre surface. La réponse porte WWW-Authenticate: Bearer error="invalid_token".

application/json

object

code

required

Le code stable sur lequel un portail se branche — le motif, lui, est écrit pour être lu par une personne et peut changer sans rupture.

string

Allowed values: DEMANDE_MAL_FORMEE CHAMP_INVALIDE NON_AUTHENTIFIE HORS_PERIMETRE_SOUSCRIT RESSOURCE_INCONNUE REJEU_DIVERGENT ECRITURE_REFUSEE AGREGAT_RETENU

motif

required

Le motif, qui nomme le champ ou l’identifiant en cause.

string

champ

Le champ en cause, quand l’erreur en désigne un.

string

correlation

L’identifiant de corrélation de l’appel — le même que l’en-tête restitué.

string

Example

{
  "code": "DEMANDE_MAL_FORMEE"
}

Headers

WWW-Authenticate

string

Le défi d’authentification, au format des jetons porteurs.

403

403 — le cas d’usage n’est pas dans le périmètre souscrit de ce client. La réponse ne dit jamais si la ressource existe.

application/json

object

code

required

Le code stable sur lequel un portail se branche — le motif, lui, est écrit pour être lu par une personne et peut changer sans rupture.

string

Allowed values: DEMANDE_MAL_FORMEE CHAMP_INVALIDE NON_AUTHENTIFIE HORS_PERIMETRE_SOUSCRIT RESSOURCE_INCONNUE REJEU_DIVERGENT ECRITURE_REFUSEE AGREGAT_RETENU

motif

required

Le motif, qui nomme le champ ou l’identifiant en cause.

string

champ

Le champ en cause, quand l’erreur en désigne un.

string

correlation

L’identifiant de corrélation de l’appel — le même que l’en-tête restitué.

string

Example

{
  "code": "DEMANDE_MAL_FORMEE"
}

404

404 — inconnu de ce teneur de compte. Une entreprise, un dispositif ou une opération relevant d’un autre teneur est inexistant, jamais interdit : la muraille de Chine ne laisse pas fuir une existence.

application/json

object

code

required

Le code stable sur lequel un portail se branche — le motif, lui, est écrit pour être lu par une personne et peut changer sans rupture.

string

Allowed values: DEMANDE_MAL_FORMEE CHAMP_INVALIDE NON_AUTHENTIFIE HORS_PERIMETRE_SOUSCRIT RESSOURCE_INCONNUE REJEU_DIVERGENT ECRITURE_REFUSEE AGREGAT_RETENU

motif

required

Le motif, qui nomme le champ ou l’identifiant en cause.

string

champ

Le champ en cause, quand l’erreur en désigne un.

string

correlation

L’identifiant de corrélation de l’appel — le même que l’en-tête restitué.

string

Example

{
  "code": "DEMANDE_MAL_FORMEE"
}