Les supports que le dispositif autorise

GET

/v1/epargnants/{epargnant}/dispositifs/{dispositif}/offre-de-placement

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

L’offre est celle du dispositif en vigueur, servie sous la désignation de l’épargnant parce que c’est son droit d’accès qui est apprécié.

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

L’offre de placement du dispositif.

application/json

object

dispositif

required

string

supports

required

Array<object>

object

support

required

string

libelle

required

string

classification

La classification du support telle que le référentiel des instruments la publie.

string

ouvert_aux_versements

required

La valeur décidée : ce support accepte-t-il un versement aujourd’hui dans ce dispositif ? Le portail n’a pas à croiser une date de fermeture avec un paramétrage.

boolean

documents

required

Les documents réglementaires par lesquels le support doit être présenté — leur contenu se télécharge par le cas d’usage « documents ».

Array<object>

object

document

required

string

type

required

Le vocabulaire clos des documents servis à l’épargnant.

string

Allowed values: RELEVE_DE_SITUATION AVIS_D_OPERE DOCUMENT_D_INFORMATION_CLE REGLEMENT_DU_DISPOSITIF

Example

{
  "supports": [
    {
      "documents": [
        {
          "type": "RELEVE_DE_SITUATION"
        }
      ]
    }
  ]
}

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