Un dispositif détenu

GET

/v1/epargnants/{epargnant}/dispositifs/{dispositif}

const url = 'https://passerelle.teneur.exemple/v1/epargnants/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/epargnants/example/dispositifs/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Correlation-Id: example'

Le mot du référentiel est dispositif : il couvre les plans d’épargne comme les mécanismes de partage de la valeur dont les avoirs sont issus.

Autorisations

jetonPartenaire

Paramètres

Paramètres (path)

epargnant

required

string

>= 1 characters

L’identifiant publié de l’épargnant chez ce teneur de compte. Il désigne la ressource ; il n’est jamais le sujet de l’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 détail du dispositif détenu.

application/json

object

dispositif

required

string

libelle

required

string

type

required

string

cadre_legal

required

Le cadre légal dont relèvent les avoirs — c’est lui qui décide de ce qu’un épargnant peut demander, et il se lit sans être déduit du type de dispositif.

string

Allowed values: epargne-salariale plan-epargne-retraite

entreprise

string

valorise_au

required

string format: date

montant_ct

required

integer

supports

required

Array<object>

object

support

required

L’identifiant publié de l’instrument — le fonds, le titre.

string

libelle

required

string

quantite

required

La quantité détenue — toujours un entier, jamais un flottant. L’unité est celle de l’instrument, publiée par le référentiel des instruments : elle ne se devine pas, et deux instruments n’ont pas nécessairement la même.

integer

valeur_liquidative_ue6

La valeur liquidative appliquée, en micro-euros.

integer

valeur_liquidative_du

La date de cette valeur liquidative — absente si la valeur manque.

string format: date

montant_ct

required

La valorisation de la ligne, en centimes ; absente si la valeur liquidative manque.

integer

origines

required

L’origine des versements en cumuls — participation, intéressement, abondement, prime de partage de la valeur, versement volontaire, transfert. Jamais les lots de droits qui les composent.

Array<object>

object

origine

required

L’origine d’avoir, dans la nomenclature des dimensions de lot du référentiel.

string

libelle

required

string

montant_ct

required

integer

Example

{
  "cadre_legal": "epargne-salariale"
}

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

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

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. Un épargnant, 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

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"
}