Les avoirs tous dispositifs confondus

GET

/v1/epargnants/{epargnant}/situation

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

La page d’accueil d’un portail d’épargnant.

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.

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.

Paramètres (query)

inclure

Array<string>

Allowed values: dispositifs disponibilite

L’expansion demandée, dans la liste fermée du contrat.

Réponses

200

La situation d’ensemble, aux expansions demandées.

application/json

object

epargnant

required

string

valorise_au

required

La date des valeurs liquidatives appliquées. Une position passée ne se valorise jamais au dernier cours connu : la date sert à le dire au porteur.

string format: date

montant_total_ct

required

La valorisation totale, en centimes d’euro — jamais un flottant.

integer

montant_disponible_ct

required

integer

montant_indisponible_ct

required

integer

valeurs_manquantes

Les supports dont la valeur liquidative manque à la date servie, nommés. Leur montant n’entre dans aucun total : un total incomplet se dit, il ne s’arrondit pas.

Array<string>

dispositifs

Servi avec inclure=dispositifs.

Array<object>

object

dispositif

required

string

libelle

required

Le libellé d’usage du dispositif chez ce teneur.

string

type

required

Le type de dispositif — PEE, PEI, PERECO, participation, intéressement… — dans la nomenclature publiée par le domaine Entreprise.

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

L’entreprise dont le dispositif est issu ; le détail par entreprise n’est jamais mélangé.

string

montant_ct

required

integer

montant_disponible_ct

required

integer

disponibilite

Servi avec inclure=disponibilite.

object

epargnant

required

string

apprecie_au

required

L’instant auquel la disponibilité a été appréciée.

string format: date-time

montant_disponible_ct

required

integer

parts_indisponibles

required

Le tableau vide signifie « tout est disponible ».

Array<object>

object

dispositif

required

string

montant_ct

required

integer

motif

required

Le motif décidé, dans le vocabulaire clos que la tenue de compte publie. Il remplace les ingrédients — échéance de lot, mesure de conformité, réservation — que le portail recomposerait.

string

Allowed values: ECHEANCE_NON_ATTEINTE INDISPONIBLE_JUSQU_A_LA_RETRAITE AVOIRS_GELES RESERVE_PAR_UNE_OPERATION AUTRE_CONTRAINTE

disponible_le

La date à laquelle cette part cesse d’être indisponible, quand elle est datée. Absente pour un motif sans terme connu — un gel n’a pas d’échéance.

string format: date

precision

Une phrase destinée à être affichée telle quelle, quand le motif seul ne suffit pas à l’expliquer au porteur. Elle ne nomme jamais une mesure de conformité.

string

Example

{
  "dispositifs": [
    {
      "cadre_legal": "epargne-salariale"
    }
  ],
  "disponibilite": {
    "parts_indisponibles": [
      {
        "motif": "ECHEANCE_NON_ATTEINTE"
      }
    ]
  }
}

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.

400

400 — la demande est mal formée ; le motif nomme le champ en cause.

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

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