Le détail d'une opération

GET

/v1/epargnants/{epargnant}/operations/{operation}

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

C’est aussi la ressource que Location désigne après un versement ou un arbitrage : le portail y suit l’avancement de ce qu’il a engagé.

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.

operation

required

string

>= 1 characters

La référence de l’opération, telle que la plateforme l’a publiée.

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

La fiche de l’opération.

application/json

object

operation

required

string

nature

required

string

etat

required

string

date_demande

required

string format: date

date_execution

string format: date

dispositif

string

montant_brut_ct

integer

montant_net_ct

integer

prelevements

Les frais et taxes du brut au net, servis décidés avec leur libellé — jamais l’assiette et le taux dont un portail les recalculerait.

Array<object>

object

libelle

required

string

montant_ct

required

integer

mouvements

Les supports mouvementés par l’opération.

Array<object>

object

support

required

string

sens

required

string

Allowed values: ENTREE SORTIE

quantite

required

Dans l’unité de l’instrument

integer

montant_ct

integer

Example

{
  "mouvements": [
    {
      "sens": "ENTREE"
    }
  ]
}

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