--- title: "Retrieval of an account overdraft (AISP)" method: GET path: "/accounts/{accountResourceId}/overdrafts" tags: ["AISP"] --- # Retrieval of an account overdraft (AISP) `GET /accounts/{accountResourceId}/overdrafts` ## Request - Base URL: `https://www.10207.oba-bad-me-live-api.banquepopulaire.fr/stet/psd2/v1.6.2` - URL: `https://www.10207.oba-bad-me-live-api.banquepopulaire.fr/stet/psd2/v1.6.2/accounts/{accountResourceId}/overdrafts` - Auth: OAuth 2 - Authorization code: `/stet/psd2/oauth/authorize` - Token URL: `/stet/psd2/oauth/token` scopes: `aisp` ### Description This call returns the overdrafts that can be used for a given PSU account that is specified by the AISP through an account resource identification. The request may use some filter parameter in order to restrict the query ### Prerequisites - The TPP was registered by the Registration Authority for the AISP role - The TPP and the PSU have a contract that was enrolled by the ASPSP - At this step, the ASPSP has delivered an OAUTH2 "Authorization Code" or "Resource Owner Password" access token to the TPP (cf. § 3.4.2). - The TPP and the ASPSP have successfully processed a mutual check and authentication - The TPP has presented its OAUTH2 "Authorization Code" or "Resource Owner Password" access token which allows the ASPSP to identify the relevant PSU and retrieve the linked PSU context (cf. § 3.4.2) is any. - The ASPSP takes into account the access token that establishes the link between the PSU and the AISP. - The TPP has previously retrieved the list of available accounts for the PSU ### Business flow The AISP requests the ASPSP on one of the PSU’s accounts. The ASPSP answers by the overdraft that can be applied. ## Path parameters - `accountResourceId` string, required ## Query parameters - `workspace` string ## Headers - `Authorization` string, required - `PSU-IP-Address` string - `PSU-IP-Port` string - `PSU-HTTP-Method` string - `PSU-Date` string - `PSU-GEO-Location` string - `PSU-User-Agent` string - `PSU-Referer` string - `PSU-Accept` string - `PSU-Accept-Charset` string - `PSU-Accept-Encoding` string - `PSU-Accept-Language` string - `PSU-Device-ID` string - `Digest` string - `Signature` string, required - `X-Request-ID` string, required ## Response `200` Overdraft response - HalOverdrafts: HYPERMEDIA structure used for returning the list of the overdrafts that can apply on a given account to the AISP - `overdrafts` Overdraft, required: ISO20022: Overdraft characteristics API: Amounts must always be set as positive values. - `allowedAmount` AmountType, required: Structure aiming to embed the amount and the currency to be used. - `amount` number, float, required: ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. - `currency` string, required: Specifies the currency of the amount or of the account. A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". - `_links` OverdraftsLinks, required: links that can be used for further navigation when browsing overdrafts Information at one account level | Link | Description | | ---- | ----------- | | self | link to the overdrafts of a given account | | parent-list | link to the list of all available accounts | | owners | link to the owners identities for a given account | | balances | link to the balances of a given account | | transactions | link to the transactions of a given account | - `self` GenericLink, required: hypertext reference - `href` string, required: URI to be used. HREF stands for Hypertext REFerence. - `templated` boolean: This field must be set with "true" when [href] is an URI template, i.e. with parameters that will be set by the client afterwards. Parameter fields must be included by the API server according to RFC6570. Otherwise, this property must be absent or set to false default value: false - `parent-list` GenericLink: hypertext reference - `href` string, required: URI to be used. HREF stands for Hypertext REFerence. - `templated` boolean: This field must be set with "true" when [href] is an URI template, i.e. with parameters that will be set by the client afterwards. Parameter fields must be included by the API server according to RFC6570. Otherwise, this property must be absent or set to false default value: false - `owners` GenericLink: hypertext reference - `href` string, required: URI to be used. HREF stands for Hypertext REFerence. - `templated` boolean: This field must be set with "true" when [href] is an URI template, i.e. with parameters that will be set by the client afterwards. Parameter fields must be included by the API server according to RFC6570. Otherwise, this property must be absent or set to false default value: false - `balances` GenericLink: hypertext reference - `href` string, required: URI to be used. HREF stands for Hypertext REFerence. - `templated` boolean: This field must be set with "true" when [href] is an URI template, i.e. with parameters that will be set by the client afterwards. Parameter fields must be included by the API server according to RFC6570. Otherwise, this property must be absent or set to false default value: false - `transactions` GenericLink: hypertext reference - `href` string, required: URI to be used. HREF stands for Hypertext REFerence. - `templated` boolean: This field must be set with "true" when [href] is an URI template, i.e. with parameters that will be set by the client afterwards. Parameter fields must be included by the API server according to RFC6570. Otherwise, this property must be absent or set to false default value: false ## Other responses - `204`: No content. - `400`: Invalid status value - `401`: Unauthorized, authentication failure. - `403`: Forbidden, authentication successful but access to resource is not allowed. - `404`: Not found, no request available. - `405`: Method Not Allowed. - `406`: Not Acceptable. - `408`: Request Timeout. - `429`: Too many requests. - `500`: Internal server error. - `503`: Service unavailable. --- [API](https://skmtc.dev/groupebpce/apis/accounts-information.md) - [All operations](https://skmtc.dev/groupebpce/apis/accounts-information/llms.txt) - [OpenAPI document](https://skmtc.dev/groupebpce/apis/accounts-information/revisions/1e8366574497?raw)