{"swagger":"2.0","host":"arkeapi","basePath":"/v1/","info":{"title":"Gestion des comptes bancaires","description":"API de gestion des comptes bancaires des personnes (légales ou physiques)","version":"1.0","license":{"name":"ARKEA","url":"https://developer.arkea.com/"},"contact":{"name":"Equipe ARKEA PI","email":"openbanking@arkea.com"},"x-logo":{"altText":"Monext logo","url":"https://i.ibb.co/RpLzMHS/accounts.png","backgroundColor":"#FFFFFF"}},"x-servers":[{"url":"https://api-arkea-monext.s.arkea.com:8443","description":"Production"},{"url":"https://api-arkea-monext.hml.s.arkea.com:8443","description":"Homologation"}],"schemes":["https"],"produces":["application/json"],"securityDefinitions":{"arkeaOAuth":{"type":"oauth2","description":"authentification oAuth2","flow":"accessCode","authorizationUrl":"https://d/oauth","tokenUrl":"https://d/token","scopes":{"Server":"Approche de type serveur","User":"Approche de type utilisateur"}}},"security":[{"arkeaOAuth":["Server"]}],"paths":{"/accounts/{accountId}":{"parameters":[{"type":"string","in":"path","required":true,"name":"accountId","description":"Identifiant du compte souhaité","pattern":"^[a-zA-Z0-9-]*$"}],"get":{"summary":"Renvoie les informations d'un compte bancaire","description":"# Paramètres\n* accountId: Identifiant du compte bancaire souhaité\n\n# Réponse\nLes détails du compte souhaité si le accountId fourni est valide, sinon retourne une erreur.","responses":{"200":{"description":"Objet retourné si réponse positive","examples":{"application/json":"{\n  \"id\": \"QWNtZQ==\",\n  \"label\": \"Acme Business Account\",\n  \"productId\": \"business-account\",\n  \"iban\": \"RlI3NjE0NDEwMDAwMDExMjM0NTY3ODkwMTYzCTAwMDAx\",\n  \"participants\": [\n    {\n      \"person\": {\n        \"id\": \"Sm9zZXBoIFJvYmlsbGFyZA==\",\n        \"type\": \"natural\",\n        \"label\": \"Manon Fugère\"\n      },\n      \"role\": \"holder\"\n    },\n    {\n      \"person\": {\n        \"id\": \"UGhpbGlwIEJlYXVjaGFtcA==\",\n        \"type\": \"natural\",\n        \"label\": \"Philip Beauchamp\"\n      },\n      \"role\": \"representative\"\n    }\n  ],\n  \"balances\": [\n    {\n      \"id\": \"NDY1NDEzMjU0NTIx\",\n      \"label\": \"Current\",\n      \"amount\": [\n        {\n          \"currency\": \"EUR\",\n          \"value\": \"457.45\"\n        }\n      ],\n      \"date\": \"2017-07-15\"\n    }\n  ],\n    \"createdAt\": \"2017-03-31T11:08:07.227Z\"\n}"},"schema":{"$ref":"#/definitions/accountAsShort"}},"400":{"$ref":"#/responses/400-BadRequest"},"401":{"$ref":"#/responses/401-Unauthorized"},"403":{"$ref":"#/responses/403-Forbidden"},"404":{"$ref":"#/responses/404-NotFound"},"429":{"$ref":"#/responses/429-TooManyRequests"},"500":{"$ref":"#/responses/500-InternalServerError"}}}},"/accounts/{accountId}/participants":{"parameters":[{"type":"string","in":"path","required":true,"name":"accountId","description":"Identifiant du compte souhaité","pattern":"^[a-zA-Z0-9-]*$"}],"get":{"summary":"Renvoie tous les participants d'un compte","description":"# Paramètres\n* accountId: Identifiant du compte à retrouver\n* range: Intervalle de pagination souhaité i.e les resources d'un index donné à un autre inclus (ex:de 10 à 25 => ?range = 10-25).\n\n# Réponse\nUn tableau de participants en relation avec le compte si le champ accountId fourni est valide, sinon une erreur est renvoyée.\nChaque élément du tableau est un object participant. Si aucun participant n'est associé alors un tableau vide est renvoyé.\n\nLes participants sont des personnes autorisées à agir sur un compte. Les rôles possibles sont les suivants:\n- holder: détenteur du compte\n- co-holder: co-détenteur du compte\n- representative: une personne physique majeure qui représente une personne physique mineure ou une personne physique non-capable au regard de la loi   (cas d'une tutelle) ou bien une personne morale.\n- fiscal-agent: une personne physique majeure ou une personne morale qui est autorisée contractuellement à agir pour le compte de tiers.","responses":{"200":{"description":"Tableau renvoyé si réponse positive","examples":{"application/json":"[\n  {\n    \"person\": {\n      \"id\": \"Sm9zZXBoIFJvYmlsbGFyZA==\",\n      \"type\": \"natural\",\n      \"label\": \"Manon Fugère\"\n    },\n    \"role\": \"holder\"\n  },\n  {\n    \"person\": {\n      \"id\": \"UGhpbGlwIEJlYXVjaGFtcA==\",\n      \"type\": \"natural\",\n      \"label\": \"Philip Beauchamp\"\n    },\n    \"role\": \"representative\"\n  }\n]"},"schema":{"type":"array","items":{"$ref":"#/definitions/accountParticipant"}}},"400":{"$ref":"#/responses/400-BadRequest"},"401":{"$ref":"#/responses/401-Unauthorized"},"403":{"$ref":"#/responses/403-Forbidden"},"404":{"$ref":"#/responses/404-NotFound"},"429":{"$ref":"#/responses/429-TooManyRequests"},"500":{"$ref":"#/responses/500-InternalServerError"}}}},"/accounts/{accountId}/balances":{"parameters":[{"type":"string","in":"path","required":true,"name":"accountId","description":"Identifiant du compte souhaité","pattern":"^[a-zA-Z0-9-]*$"}],"get":{"summary":"Renvoie tous les soldes associés au compte bancaire sélectionné","description":"# Paramètres\n* accountId: Identifiant du compte à retrouver\n* range: Intervalle de pagination souhaité i.e les resources d'un index donné à un autre inclus (ex:de 10 à 25 => ?range = 10-25).\n\n# Réponse\nUn tableau de soldes liés au compte si le accountId fourni est valide, sinon retourne une erreur.\nChaque entrée du tableau est un obket solde. Si aucun solde est présent, le tableau est vide.","responses":{"200":{"description":"Tableau renvoyé si réponse positive","examples":{"application/json":"[\n  {\n    \"id\": \"NDY1NDEzMjU0NTIx\",\n    \"label\": \"Current\",\n    \"amount\": {\n        \"currency\": \"EUR\",\n        \"value\": \"457.45\"\n      },\n    \"date\": \"2017-07-15\",\n    \"booked\": true,\n      \"bookedDate\": \"2019-03-29T07:11:53.112Z\",\n      \"valueDate\": \"2019-03-29T07:11:53.112Z\",\n    \"createdAt\": \"2017-03-31T11:08:07.227Z\"\n  },\n  {\n    \"id\": \"NDE2NTQxNTE=\",\n    \"label\": \"Enf of month\",\n    \"amount\": {\n        \"currency\": \"EUR\",\n        \"value\": \"193662440549.\"\n      },\n    \"date\": \"2017-07-31\",\n     \"booked\": false,\n      \"valueDate\": \"2017-03-24T11:08:07.227Z\",\n    \"createdAt\": \"2017-03-31T11:08:07.227Z\"\n  }\n]"},"schema":{"type":"array","items":{"$ref":"#/definitions/balanceAsShort"}}},"400":{"$ref":"#/responses/400-BadRequest"},"401":{"$ref":"#/responses/401-Unauthorized"},"403":{"$ref":"#/responses/403-Forbidden"},"404":{"$ref":"#/responses/404-NotFound"},"429":{"$ref":"#/responses/429-TooManyRequests"},"500":{"$ref":"#/responses/500-InternalServerError"}}}},"/accounts/{accountId}/balances/{balanceId}":{"parameters":[{"type":"string","in":"path","required":true,"name":"accountId","description":"Identifiant du compte souhaité","pattern":"^[a-zA-Z0-9-]*$"},{"type":"string","in":"path","required":true,"name":"balanceId","description":"Identifiant de solde souhaité"}],"get":{"summary":"Renvoie les informations d'une transaction donnée","description":"# Paramètres\n* accountId: Identifiant du compte souhaité\n* balanceId: Identifiant du solde souhaité\n\n# Réponse\nUn objet balance si les informations accountId et bamanceId fournis sont valides, sinon retourne une erreur.","responses":{"200":{"description":"Objet retourné si réponse positive","examples":{"application/json":"{\n  \"id\": \"dHJhbnNhY3Rpb240NTQyNDQ4\",\n  \"label\": \"Real time balance\",\n  \"type\": \"real-time\",\n  \"amount\": {\n    \"currency\": \"EUR\",\n    \"value\": \"-161.52\"\n  },\n  \"date\": \"2017-06-27T13:21:15.125Z\",\n  \"created_at\": \"2017-06-27T13:21:15.125Z\",\n  \"lastTransactionId\": \"8eJhbnNhY348b240NTQyNc4\"\n }"},"schema":{"$ref":"#/definitions/balance"}},"400":{"$ref":"#/responses/400-BadRequest"},"401":{"$ref":"#/responses/401-Unauthorized"},"403":{"$ref":"#/responses/403-Forbidden"},"404":{"$ref":"#/responses/404-NotFound"},"429":{"$ref":"#/responses/429-TooManyRequests"},"500":{"$ref":"#/responses/500-InternalServerError"}}}},"/accounts/{accountId}/transactions":{"parameters":[{"type":"string","in":"path","required":true,"name":"accountId","description":"Identifiant du compte souhaité","pattern":"^[a-zA-Z0-9-]*$"}],"get":{"summary":"Renvoie toutes les transactions d'un compte","description":"# Paramètres\n* accountId: Identifier of the account to retrieve\n* range: Pagination range, for example, resources from index 10 to the included index 25: ?range = 10-25.\n\n# Réponse\nUn tableau de transactions en rapport avec le compte si le accountId fourni est valide sinon une erreur est renvoyée.\nChaque élément du tableau est un objet transaction. Si aucune transaction n'est associée alors un tableau vide est retourné.\n\nUne transaction est un un mouvement d'argent entre deux entités.\n","parameters":[{"type":"string","in":"query","name":"range","description":"Intervalle de pagination d'une liste d'objets\n\nEx: les resources d'un index donné à un autre inclus (de 10 à 25 => ?range = 10-25)."},{"type":"string","in":"query","name":"timeInterval","description":"Intervalle de temps souhaité (filtrage sur valueDate).\n\nFormat attendu: date-time/date-time\n\nA cette date, le filtrage est uniquement effectué sur la date et non sur le time."}],"responses":{"200":{"description":"Tableau renvoyé si réponse positive","examples":{"application/json":"[\n  {\n    \"id\": \"dHJhbnNhY3Rpb240NTQyNDQ4\",\n    \"label\": \"Transaction 4542448\",\n    \"amount\": {\n      \"currency\": \"EUR\",\n      \"value\": \"-161.52\"\n    },\n    \"bookedDate\": \"2017-06-27T13:21:15.125Z\",\n    \"transactionDate\": \"2017-06-27T13:21:15.125Z\",\n    \"valueDate\": \"2017-06-27T13:21:15.125Z\",\n    \"type\": \"transfer\",\n    \"status\": \"booked\"\n   },\n  {\n    \"id\": \"4fJhbnNhY348b240NTQyNDE\",\n    \"label\": \"Transaction 2542474\",\n    \"amount\": {\n      \"currency\": \"EUR\",\n      \"value\": \"39.69\"\n    },\n    \"bookedDate\": \"2017-06-28T13:21:15.125Z\",\n    \"transactionDate\": \"2017-06-28T13:21:15.125Z\",\n    \"valueDate\": \"2017-06-28T13:21:15.125Z\",\n    \"type\": \"transfer\",\n    \"status\": \"booked\"\n  },\n  {\n    \"id\": \"8eJhbnNhY348b240NTQyNc4\",\n    \"label\": \"Transaction 7842465\",\n    \"amount\": {\n      \"currency\": \"EUR\",\n      \"value\": \"15.58\"\n    },\n    \"bookedDate\": \"2017-06-29T13:21:15.125Z\",\n    \"transactionDate\": \"2017-06-29T13:21:15.125Z\",\n    \"valueDate\": \"2017-06-29T13:21:15.125Z\",\n    \"type\": \"transfer\",\n    \"status\": \"booked\"\n}\n]"},"schema":{"type":"array","items":{"$ref":"#/definitions/transactionAsShort"}},"headers":{"Content-Range":{"type":"string","description":"Cet élément permet de filtrer le tableau à renvoyer pour n'en ramener qu'une partie. Il est à renseigner de la manière suivante:\noffset - limit / count\n\n* où:\noffset: est l'index du premier élément renvoyé par la requête\nlimit: est l'index du dernier élément renvoyé par la requête\ncount: est le nombre total d'objets"},"Accept-Range":{"type":"string","description":"Cet élément permet de préciser les éléments attendus. Il est à renseigner de la manière ci-après:\nresource max\n\n* où:\nresource: est le type de pagination (resource utilisée), ex: customer, order, account, ...\nmax: est le nombre maximal requêtable en une fois"},"Link":{"type":"string","description":"Liens de navigation\n\nCela vous permet d'ajouter des liens de navigation comme la page précédente, la page suivante, la première page, la dernière page, etc ..."}}},"206":{"description":"Tableau renvoyé si réponse positive (contenu partiel)","schema":{"type":"array","items":{"$ref":"#/definitions/transactionAsShort"}},"headers":{"Content-Range":{"type":"string","description":"Cet élément permet de filtrer le tableau à renvoyer pour n'en ramener qu'une partie. Il est à renseigner de la manière suivante:\noffset - limit / count\n\n* où:\noffset: est l'index du premier élément renvoyé par la requête\nlimit: est l'index du dernier élément renvoyé par la requête\ncount: est le nombre total d'objets"},"Accept-Range":{"type":"string","description":"Cet élément permet de préciser les éléments attendus. Il est à renseigner de la manière ci-après:\nresource max\n\n* où:\nresource: est le type de pagination (resource utilisée), ex: customer, order, account, ...\nmax: est le nombre maximal requêtable en une fois"},"Link":{"type":"string","description":"Liens de navigation\n\nCela vous permet d'ajouter des liens de navigation comme la page précédente, la page suivante, la première page, la dernière page, etc ..."}}},"400":{"$ref":"#/responses/400-BadRequest"},"401":{"$ref":"#/responses/401-Unauthorized"},"403":{"$ref":"#/responses/403-Forbidden"},"404":{"$ref":"#/responses/404-NotFound"},"429":{"$ref":"#/responses/429-TooManyRequests"},"500":{"$ref":"#/responses/500-InternalServerError"}}},"post":{"summary":"Impute une transaction sur un compte","description":"# Paramètres\n* transaction: la transaction à imputer\n* arkea-signature: une signature de la requête pour traçabilité\n\n# Réponse\nL'objet transaction qui a été créé avec son transactionId\n\nComme ce endpoint est critique, il est nécessaire qu'une signature soit associée à la requête. Aucune création ne sera effectuée si la signature associée n'est pas fournie.","parameters":[{"type":"string","in":"query","name":"arkea-signature","description":"La signature de la requête effectuée par Arkéa"},{"in":"body","name":"transactionRequest","schema":{"$ref":"#/definitions/transactionRequest"},"x-examples":{"application/json":" { \n   \"label\": \"Mon super label\", \n    \"amount\": {\n      \"currency\": \"EUR\",\n      \"value\": 350\n    }, \n   \"transactionDate\": \"2019-06-19T07:29:48.760Z\",\n   \"valueDate\": \"2019-06-23\"\n}"}}],"responses":{"201":{"description":"Objet renvoyé si réponse positive","schema":{"$ref":"#/definitions/transaction"}},"400":{"$ref":"#/responses/400-BadRequest"},"401":{"$ref":"#/responses/401-Unauthorized"},"403":{"$ref":"#/responses/403-Forbidden"},"404":{"$ref":"#/responses/404-NotFound"},"409":{"$ref":"#/responses/409-Conflict"},"429":{"$ref":"#/responses/429-TooManyRequests"},"500":{"$ref":"#/responses/500-InternalServerError"}}}},"/accounts/{accountId}/transactions/{transactionId}":{"parameters":[{"type":"string","in":"path","required":true,"name":"accountId","description":"Identifiant du compte souhaité","pattern":"^[a-zA-Z0-9-]*$"},{"type":"string","in":"path","required":true,"name":"transactionId","description":"Identifiant de transaction souhaité"}],"get":{"summary":"Renvoie les informations d'une transaction donnée","description":"# Paramètres\n* accountId: Identifiant du compte souhaité\n* transactionId: Identifiant de la transaction souhaitée\n\n# Réponse\nUn objet transaction si les informations accountId et transactionId fournis sont valides, sinon retourne une erreur.","responses":{"200":{"description":"Objet retourné si réponse positive","examples":{"application/json":"{\n  \"id\": \"dHJhbnNhY3Rpb240NTQyNDQ4\",\n  \"label\": \"Transaction 4542448\",\n  \"amount\": {\n    \"currency\": \"EUR\",\n    \"value\": \"-161.52\"\n  },\n  \"bookedDate\": \"2017-06-27T13:21:15.125Z\",\n  \"transactionDate\": \"2017-06-27T13:21:15.125Z\",\n  \"valueDate\": \"2017-06-27T13:21:15.125Z\",\n  \"type\": \"transfer\",\n  \"status\": \"booked\",\n  \"balanceBeforeBooked\": {\n        \"currency\": \"EUR\",\n        \"value\": \"5093.64\"\n      }\n }"},"schema":{"$ref":"#/definitions/transaction"}},"400":{"$ref":"#/responses/400-BadRequest"},"401":{"$ref":"#/responses/401-Unauthorized"},"403":{"$ref":"#/responses/403-Forbidden"},"404":{"$ref":"#/responses/404-NotFound"},"429":{"$ref":"#/responses/429-TooManyRequests"},"500":{"$ref":"#/responses/500-InternalServerError"}}}}},"responses":{"400-BadRequest":{"description":"","schema":{"$ref":"#/definitions/APIError"},"examples":{"application/json":"{\n  \"httpcode\": 400,\n  \"url\": \"/resource\",\n  \"errordate\": \"2019-08-10T17:32:32.983Z\",\n  \"fishtag\": \"OTg1NjQ4NDU0Nw\",\n  \"messages\": [\n    {\n      \"code\": \"missing_param\",\n      \"doc_url\": \"https://arkeaopenbanking.com/documentation/codes/missing_param\",\n      \"message\": \"Missing parameter: name\"\n    }\n  ]\n}"}},"401-Unauthorized":{"description":"","schema":{"$ref":"#/definitions/APIError"},"examples":{"application/json":"{\n  \"httpcode\": 401,\n  \"url\": \"/resource\",\n  \"errordate\": \"2019-08-10T15:21:32.983Z\",\n  \"fishtag\": \"NDU4Nzg1MjY\",\n  \"messages\": [\n    {\n      \"code\": \"invalid_token\",\n      \"doc_url\": \"https://arkeaopenbanking.com/documentation/auth\",\n      \"message\": \"Invalid token\"\n    }\n  ]\n}"}},"403-Forbidden":{"description":"","schema":{"$ref":"#/definitions/APIError"},"examples":{"application/json":"{\n  \"httpcode\": 403,\n  \"url\": \"/resource\",\n  \"errordate\": \"2019-08-10T17:47:48.983Z\",\n  \"fishtag\": \"NTg5NzQ1MTIzOQ\",\n  \"messages\": [\n    {\n      \"code\": \"forbiden\",\n      \"message\": \"Forbiden access\"\n    }\n  ]\n}"}},"404-NotFound":{"description":"","schema":{"$ref":"#/definitions/APIError"},"examples":{"application/json":"{\n  \"httpcode\": 404,\n  \"url\": \"/resource\",\n  \"errordate\": \"2019-08-10T17:12:32.983Z\",\n  \"fishtag\": \"NTU1ODc0OTU4Ng\",\n  \"messages\": [\n    {\n      \"code\": \"resource_not_found\",\n      \"message\": \"Specified resource does not exist\"\n    }\n  ]\n}"}},"409-Conflict":{"description":"","schema":{"$ref":"#/definitions/APIError"},"examples":{"application/json":"{\n  \"httpcode\": 409,\n  \"url\": \"/resource\",\n  \"errordate\": \"2019-08-10T10:12:32.983Z\",\n  \"fishtag\": \"Njk4NTY5ODU2Nw\",\n  \"messages\": [\n    {\n      \"code\": \"conflict\",\n      \"message\": \"A resource with the same name already exist\"\n    }\n  ]\n}"}},"429-TooManyRequests":{"description":"","schema":{"$ref":"#/definitions/APIError"},"examples":{"application/json":"{\n  \"httpcode\": 429,\n  \"url\": \"/resource\",\n  \"errordate\": \"2019-08-10T23:23:32.983Z\",\n  \"fishtag\": \"MjIyMjI1ODc0NQ\",\n  \"messages\": [\n    {\n      \"code\": \"too_many_request\",\n      \"message\": \"Too many request, wait and retry\"\n    }\n  ]\n}"}},"500-InternalServerError":{"description":"","schema":{"$ref":"#/definitions/APIError"},"examples":{"application/json":"{\n  \"httpcode\": 500,\n  \"url\": \"/resource\",\n  \"errordate\": \"2019-08-10T11:02:32.983Z\",\n  \"fishtag\": \"MzU3MzU3MzU3Mw\",\n  \"messages\": [\n    {\n      \"code\": \"internal_server_error\",\n      \"message\": \"Your request is surely right but an issue occures on Arkéa server side, try again later\"\n    }\n  ]\n}"}}},"definitions":{"accountAsShort":{"type":"object","properties":{"id":{"type":"string","description":"Identifiant unique de compte"},"label":{"$ref":"#/definitions/label"},"type":{"type":"string","description":"Type de compte","enum":["business-account"],"example":"business-account"},"productId":{"type":"string","description":"Identifiant unique de produit","example":"xDYTDyDT"},"iban":{"type":"string","description":"International Bank Account Number","example":"FR7615589009101234567890147"},"participants":{"type":"array","description":"Participants","items":{"$ref":"#/definitions/accountParticipant"}},"balances":{"type":"array","items":{"$ref":"#/definitions/balanceAsShort"}},"closingDate":{"type":"string","description":"Date de fermeture","format":"date","example":"2019-10-02T08:07:43.441Z"}},"title":"Compte","description":"Définition d'un compte"},"accountParticipant":{"type":"object","properties":{"person":{"$ref":"#/definitions/personAsShort"},"role":{"$ref":"#/definitions/accountRole"}},"title":"Participant de compte","description":"Défintion d'un participant de compte."},"balanceAsShort":{"type":"object","properties":{"id":{"type":"string","description":"Identifiant unique de solde"},"label":{"$ref":"#/definitions/label"},"type":{"$ref":"#/definitions/balanceType"},"amount":{"$ref":"#/definitions/amount"},"date":{"type":"string","description":"Date du solde","format":"date-time","example":"2019-10-02T08:07:45.163Z"},"createdAt":{"type":"string","description":"Date de création","format":"date-time","example":"2019-10-02T08:07:45.164Z"}},"title":"Solde d'un compte","description":"Définition du solde d'un compte."},"balance":{"type":"object","properties":{"id":{"type":"string","description":"Identifiant unique de solde"},"label":{"$ref":"#/definitions/label"},"type":{"$ref":"#/definitions/balanceType"},"amount":{"$ref":"#/definitions/amount"},"date":{"type":"string","description":"Date du solde","format":"date-time","example":"2019-10-02T08:07:46.082Z"},"lastTransactionId":{"type":"string","description":"Dernière transaction, sur solde en temps réel"}},"title":"Solde d'un compte","description":"Définition du solde d'un compte."},"transactionAsShort":{"type":"object","properties":{"id":{"type":"string","description":"Identifiant unique de la transaction"},"label":{"$ref":"#/definitions/label"},"amount":{"$ref":"#/definitions/amount"},"bookedDate":{"type":"string","description":"Date de clôture de la ransaction","format":"date-time","example":"2019-10-02T08:07:46.827Z"},"transactionDate":{"type":"string","description":"Date d'enregistrement de l'opération","format":"date-time","example":"2019-10-02T08:07:46.828Z"},"valueDate":{"type":"string","description":"Date de transaction souhaitée","format":"date-time","example":"2019-10-02T08:07:46.829Z"}},"title":"Transaction (simplifiée)","description":"Définition simplifiée de la transaction.\nUtilisé dans les listes."},"transactionRequest":{"type":"object","properties":{"label":{"$ref":"#/definitions/label"},"amount":{"$ref":"#/definitions/amount"},"transactionDate":{"type":"string","description":"Date de transaction","format":"date-time","example":"2019-10-02T08:07:47.618Z"},"valueDate":{"type":"string","description":"Date de valeur souhaitée","format":"date","example":"2019-10-2"}},"title":"Requête de transaction","description":"Définition de la structure de données à pousser pour création d'une transaction"},"transaction":{"type":"object","properties":{"id":{"type":"string","description":"Identifiant unique de la transaction"},"label":{"$ref":"#/definitions/label"},"amount":{"$ref":"#/definitions/amount"},"bookedDate":{"type":"string","description":"Date de comptabilisation de l'opération","format":"date-time","example":"2019-10-02T08:07:48.371Z"},"transactionDate":{"type":"string","description":"Date d'enregistrement de l'opération","format":"date-time","example":"2019-10-02T08:07:48.372Z"},"valueDate":{"type":"string","description":"Date d'opération souhaitée","format":"date-time","example":"2019-10-02T08:07:48.373Z"},"booked":{"type":"boolean","example":"true"},"balanceBeforeBooked":{"$ref":"#/definitions/amount"},"createdAt":{"type":"string","description":"Date de création","format":"date-time","example":"2019-10-02T08:07:48.376Z"}},"title":"Transaction","description":"Définition d'une transaction"},"APIError":{"type":"object","properties":{"httpcode":{"type":"integer","description":"Code statut HTTP","format":"int32","example":"500"},"url":{"type":"string","description":"URL appelée","example":"/accounts/NDU2NDE2ODc1NDU1MTg3NA/transactions"},"errordate":{"type":"string","description":"Date d'erreur de création","format":"date-time","example":"2019-10-02T08:07:49.219Z"},"fishtag":{"type":"string","description":"Identifiant unique de transaction","example":"RandomTextIdentifier564"},"messages":{"type":"array","description":"Message retourné par l'appel API","items":{"$ref":"#/definitions/APIMessage"}}},"title":"ErreurAPI","description":"Définition de la structure de message d'erreur standard API\nUtilisée pour le code de retour 400.","required":["httpcode","url"]},"label":{"type":"string","title":"Libellé","description":"Définition du label"},"personAsShort":{"type":"object","properties":{"id":{"type":"string","description":"Identifiant unique de la personne"},"type":{"type":"string","description":"Type de personne (physique ou morale)","example":"legal"},"label":{"$ref":"#/definitions/label"},"birthDate":{"type":"string","description":"Date de naissance de la personne","format":"date","example":"2019-10-2"}},"x-extendedDiscriminator":"type","title":"Personne (simplifiée)","description":"Définition d'une personne (physique ou morale)"},"accountRole":{"type":"string","title":"Rôle d'un compte (Enum)","description":"Description des rôles des personnes associées à un compte.\n\nLes types de rôles possible sont:\n* holder: Le titulaire\n* co-holder: Le co-titulaire\n* representative: Un représentant du compte. Il est habilité légalement à agir ou prendre des décisions au nom d'une autre personne ou d'un groupe de personnes.\n* trustee: Un mandataire du compte.  Il est habilité dans le cadre d'un mandat à agir ou prendre des décisions au nom d'une autre personne ou d'un groupe de personnes.\n* card-only: Une personne qui est habilitée à interagir avec le compte via une carte bancaire\n* web-only: Une personne qui est habilitée à interagir avec le compte via le site web de la banque","enum":["holder","co-holder","representative","trustee","card-only","web-only"]},"balanceType":{"type":"string","title":"Type de solde (enum)","description":"Le type de solde.\n\nTypes de soldes:\n* accounting\n* real-time\n* upcoming\n","enum":["accounting","real-time","upcoming"]},"amount":{"type":"object","properties":{"currency":{"type":"string","description":"Trois caractères basés sur la norme <a href=\"https://www.iso.org/fr/iso-4217-currency-codes.html\">ISO 4217</a>","pattern":"^[A-Z]{3,3}$","example":"EUR"},"value":{"type":"number","format":"double"}},"title":"Valeur monétaire","description":"Définition d'un montant","required":["currency","value"]},"APIMessage":{"type":"object","properties":{"code":{"type":"string","description":"Code de message d'erreur court","example":"missing_param"},"level":{"type":"string","description":"Lien vers la documentation détaillant l'erreur","enum":["INFO, WARNING, ERROR"],"example":"ERROR"},"message":{"type":"string","description":"Détail de l'erreur","example":"Missing parameter: currency"}},"title":"MessageAPI","description":"Définition de la structure de message standard API\nUtilisée pour tous les codes de retours à l'exception des 2XX."}}}