get/accounts/{accountResourceId}/overdrafts

Retrieval of an account overdraft (AISP)

Escopo OAuth2: 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. paragraph 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. paragraph 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.

Parâmetros (19)

Authorizationheaderstringobrigatório
Access token to be passed as a header
accountResourceIdpathstringobrigatório
Identification of account resource to fetch
Restrições: pattern: ^([a-zA-Z0-9_ /\-?:\()\.,']{1,100})$
PSU-IP-Addressheaderstring
IP address used by the PSU's terminal when connecting to the TPP
PSU-IP-Portheaderstring
IP port used by the PSU's terminal when connecting to the TPP
PSU-HTTP-Methodheaderstring
Http method for the most relevant PSU's terminal request to the TTP
PSU-Dateheaderstring
Timestamp of the most relevant PSU's terminal request to the TTP
PSU-GEO-Locationheaderstring
Geographical location of the PSU as provided by the PSU mobile terminal if any to the TPP
PSU-User-Agentheaderstring
"User-Agent" header field sent by the PSU terminal when connecting to the TPP
PSU-Refererheaderstring
"Referer" header field sent by the PSU terminal when connecting to the TPP. Notice that an initial typo in RFC 1945 specifies that "referer" (incorrect spelling) is to be used. The correct spelling "referrer" can be used but might not be understood.
PSU-Acceptheaderstring
"Accept" header field sent by the PSU terminal when connecting to the TPP
PSU-Accept-Charsetheaderstring
"Accept-Charset" header field sent by the PSU terminal when connecting to the TPP
PSU-Accept-Encodingheaderstring
"Accept-Encoding" header field sent by the PSU terminal when connecting to the TPP
PSU-Accept-Languageheaderstring
"Accept-Language" header field sent by the PSU terminal when connecting to the TPP
PSU-Device-IDheaderstring
UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of installation identification this ID need to be unaltered until removal from device.
Digestheaderstring
Digest of the body
Signatureheaderstring
http-signature of the request The keyId must specify the way to get the relevant qualified certificate. It is requested that this identifier is an URL aiming to provide the relevant Qualified Certificate.
X-Request-IDheaderstringobrigatório
Correlation header to be set in a request and retrieved in the relevant response
Restrições: maxLength: 70
workspacequerystring
Workspace to be used for processing an AISP request. If not provided, the default workspace is computed from the authentication that was used for getting the OAuth2 Access Token.
Restrições: maxLength: 32
X-JWS-Signatureheaderstring
JSON WEB signature of the request

Respostas

200

Overdraft response

Halobject

HalOverdrafts

HYPERMEDIA structure used for returning the list of the overdrafts that can apply on a given account to the AISP

Campos (2)

overdraftsOverdraftobrigatório
ISO20022: Overdraft characteristics
Esquema: Overdraft
ISO20022: Overdraft characteristics API: Amounts must always be set as positive values.
- allowedAmountAmountTypeobrigatório
  Structure aiming to embed the amount and the currency to be used.
  Esquema: AmountType
  Structure aiming to embed the amount and the currency to be used.
  amountnumber (float)obrigatório
  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.
  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.
  Restrições: pattern: `^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$`
  currencyCurrencyCodeISO 4217obrigatório
  Specifies the currency of the amount or of the account.
  Esquema: CurrencyCode
  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".
  Tipo: string
  Restrições: pattern: `^[A-Z]{3,3}$`

_linksOverdraftsLinksobrigatório

links that can be used for further navigation when browsing overdrafts Information at one account level

Esquema: OverdraftsLinks

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

selfGenericLinkobrigatório
hypertext reference
Esquema: GenericLink
hypertext reference
- hrefstringobrigatório
  URI to be used. HREF stands for Hypertext REFerence.
  Restrições: maxLength: 2000
- templatedboolean
  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.
  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-listGenericLink
hypertext reference
Esquema: GenericLink
Campos detalhados mais acima: responses.200._links.self
ownersGenericLink
hypertext reference
Esquema: GenericLink
Campos detalhados mais acima: responses.200._links.self
balancesGenericLink
hypertext reference
Esquema: GenericLink
Campos detalhados mais acima: responses.200._links.self
transactionsGenericLink
hypertext reference
Esquema: GenericLink
Campos detalhados mais acima: responses.200._links.self

204

No content.

Definição de resposta compartilhada: 204

400

Invalid status value

Technicalobject

ErrorModel

Generic error report structure

Campos (6)

timestampstring (date-time)ISO 8601
current timestamp
statusinteger (int32)obrigatório
HTTP error code
errorstring
HTTP error text
Restrições: maxLength: 140
messagestringobrigatório
HTTP textual reason phrase
Restrições: maxLength: 140
pathstring
Relevant path that was used
Restrições: maxLength: 140
detailsarray<ErrorDetail>
list of detailed errors that were encountered
Item: ErrorDetail
detailed error description
- locationstringenumeração · 2
  Location of the erroneous parameter when not in request body
  Código
  header
  query
- namestring
  Name of the erroneous parameter when not in request body
- pathstring
  JsonPath of the erroneous request body property
- erroneousValuestring
  Erroneous parameter value
- messagestring
  Relevant message for the erroneous parameter
- expectedPatternstring
  Expected pattern, if any, that the erroneous parameter does not match with
- expectedValueRangeobject
  Expected value range, if any, that the erroneous parameter does not match with
  minValueinteger
  maxValueinteger
- expectedValueCountobject
  Expected value count, in the case of an array item, that the erroneous parameter does not match with
  minValueinteger
  maxValueinteger
- expectedEnumerationarray<string>
  Expected enumeration, if any, that the erroneous parameter do not match with

Código
`header`
`query`

401

Unauthorized, authentication failure.

Technicalobject

ErrorModel

Generic error report structure

Campos (6)

Campos detalhados mais acima: responses.400

403

Forbidden, authentication successful but access to resource is not allowed.

Technicalobject

ErrorModel

Generic error report structure

Campos (6)

Campos detalhados mais acima: responses.400

404

Not found, no request available.

Technicalobject

ErrorModel

Generic error report structure

Campos (6)

Campos detalhados mais acima: responses.400

405

Method Not Allowed.

Technicalobject

ErrorModel

Generic error report structure

Campos (6)

Campos detalhados mais acima: responses.400

406

Not Acceptable.

Technicalobject

ErrorModel

Generic error report structure

Campos (6)

Campos detalhados mais acima: responses.400

408

Request Timeout.

Technicalobject

ErrorModel

Generic error report structure

Campos (6)

Campos detalhados mais acima: responses.400

429

Too many requests.

Technicalobject

ErrorModel

Generic error report structure

Campos (6)

Campos detalhados mais acima: responses.400

500

Internal server error.

Technicalobject

ErrorModel

Generic error report structure

Campos (6)

Campos detalhados mais acima: responses.400

503

Service unavailable.

Technicalobject

ErrorModel

Generic error report structure

Campos (6)

Campos detalhados mais acima: responses.400

Esquemas usados por este endpoint

Todas as estruturas referenciadas por esta operação, listadas uma única vez. As referências cruzadas levam a esta mesma página.

ISO20022object§ 4.1.2 · PDF p. 2

AmountType

Structure aiming to embed the amount and the currency to be used.

Campos (2)

Campos detalhados mais acima: responses.200.overdrafts.allowedAmount

ISO20022string

CurrencyCode

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

Technicalobject

ErrorDetail

detailed error description

Campos (9)

Campos detalhados mais acima: responses.400.details

Technicalobject

ErrorModel

Generic error report structure

Campos (6)

Campos detalhados mais acima: responses.400

Halobject§ 4.1.7 · PDF p. 15

GenericLink

hypertext reference

Campos (2)

Campos detalhados mais acima: responses.200._links.self

Halobject

HalOverdrafts

HYPERMEDIA structure used for returning the list of the overdrafts that can apply on a given account to the AISP

Campos (2)

Campos detalhados mais acima: responses.200

ISO20022object

Overdraft

ISO20022: Overdraft characteristics API: Amounts must always be set as positive values.

Campos (1)

Campos detalhados mais acima: responses.200.overdrafts

Halobject

OverdraftsLinks

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

Campos (5)

Campos detalhados mais acima: responses.200._links

Cabeçalhos

Campos

get/v1/accounts/{accountResourceId}/overdrafts

curl -X GET 'https://api.aspsp.example/v1/accounts/{accountResourceId}/overdrafts' \
  -H 'Authorization: Bearer {access_token}' \
  -H 'X-Request-ID: a1b2c3d4-e5f6-4a3b-8c2d-1e2f3a4b5c6d'

curl -X GET 'https://api.aspsp.example/v1/accounts/{accountResourceId}/overdrafts' \
  -H 'Authorization: Bearer {access_token}' \
  -H 'PSU-IP-Address: 192.0.2.1' \
  -H 'PSU-IP-Port: 443' \
  -H 'PSU-HTTP-Method: GET' \
  -H 'PSU-Date: Tue, 03 Oct 2022 10:15:30 GMT' \
  -H 'PSU-GEO-Location: {PSU-GEO-Location}' \
  -H 'PSU-User-Agent: {PSU-User-Agent}' \
  -H 'PSU-Referer: {PSU-Referer}' \
  -H 'PSU-Accept: {PSU-Accept}' \
  -H 'PSU-Accept-Charset: {PSU-Accept-Charset}' \
  -H 'PSU-Accept-Encoding: {PSU-Accept-Encoding}' \
  -H 'PSU-Accept-Language: {PSU-Accept-Language}' \
  -H 'PSU-Device-ID: {PSU-Device-ID}' \
  -H 'Digest: SHA-256=X48E9qOokqqrvdts8nOJRJN3OWDUoyWxBf7kbu9DBPE=' \
  -H 'Signature: keyId="...",algorithm="rsa-sha256",headers="(request-target) date digest",signature="..."' \
  -H 'X-Request-ID: a1b2c3d4-e5f6-4a3b-8c2d-1e2f3a4b5c6d' \
  -H 'X-JWS-Signature: {X-JWS-Signature}'

Resposta

Overdraft response

{
  "overdrafts": {
    "allowedAmount": {
      "amount": 30000,
      "currency": "EUR"
    }
  },
  "_links": {
    "self": {
      "href": "/v1/accounts/Alias1/overdrafts"
    },
    "parent-list": {
      "href": "/v1/accounts"
    },
    "balances": {
      "href": "/v1/accounts/Alias1/balances"
    },
    "transactions": {
      "href": "/v1/accounts/Alias1/transactions"
    }
  }
}

{
  "overdrafts": {
    "allowedAmount": {
      "amount": 30000,
      "currency": "EUR"
    }
  },
  "_links": {
    "self": {
      "href": "/v1/accounts/Alias1/overdrafts"
    }
  }
}

Invalid status value

{
  "timestamp": "2021-03-17T16:47:00.187248+01:00",
  "status": 400,
  "error": "Bad Request",
  "message": "This Authentication Approach is not available",
  "details": [
    {
      "path": "$.supplementaryData.acceptedAuthenticationApproach",
      "erroneousValue": "EMBEDDED",
      "expectedEnumeration": [
        "REDIRECT",
        "DECOUPLED"
      ]
    }
  ]
}

Unauthorized, authentication failure.

{
  "timestamp": "2021-03-17T16:47:00.187248+01:00",
  "status": 401,
  "error": "Unauthorized",
  "message": "Authentication failed; the access token is missing, invalid or expired."
}

Forbidden, authentication successful but access to resource is not allowed.

{
  "timestamp": "2021-03-17T16:47:00.187248+01:00",
  "status": 403,
  "error": "Forbidden",
  "message": "Authentication succeeded but access to the requested resource is not allowed."
}

Not found, no request available.

{
  "timestamp": "2021-03-17T16:47:00.187248+01:00",
  "status": 404,
  "error": "Not Found",
  "message": "The requested resource does not exist."
}

Method Not Allowed.

{
  "timestamp": "2021-03-17T16:47:00.187248+01:00",
  "status": 405,
  "error": "Method Not Allowed",
  "message": "The HTTP method is not supported for this resource."
}

Not Acceptable.

{
  "timestamp": "2021-03-17T16:47:00.187248+01:00",
  "status": 406,
  "error": "Not Acceptable",
  "message": "The requested representation is not available for this resource."
}

Request Timeout.

{
  "timestamp": "2021-03-17T16:47:00.187248+01:00",
  "status": 408,
  "error": "Request Timeout",
  "message": "The server timed out waiting for the request."
}

Too many requests.

{
  "timestamp": "2021-03-17T16:47:00.187248+01:00",
  "status": 429,
  "error": "Too Many Requests",
  "message": "The rate limit has been exceeded. Please retry later."
}

Internal server error.

{
  "timestamp": "2021-03-17T16:47:00.187248+01:00",
  "status": 500,
  "error": "Internal Server Error",
  "message": "An unexpected error occurred while processing the request."
}

Service unavailable.

{
  "timestamp": "2021-03-17T16:47:00.187248+01:00",
  "status": 503,
  "error": "Service Unavailable",
  "message": "The service is temporarily unavailable. Please retry later."
}