Halobject

HalOverdrafts

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

Fields (2)

overdraftsOverdraftrequired
ISO20022: Overdraft characteristics
Schema: Overdraft
ISO20022: Overdraft characteristics API: Amounts must always be set as positive values.
- allowedAmountAmountTyperequired
  Structure aiming to embed the amount and the currency to be used.
  Schema: AmountType
  Structure aiming to embed the amount and the currency to be used.
  amountnumber (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.
  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.
  Constraints: pattern: `^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$`
  currencyCurrencyCodeISO 4217required
  Specifies the currency of the amount or of the account.
  Schema: 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".
  Type: string
  Constraints: pattern: `^[A-Z]{3,3}$`

_linksOverdraftsLinksrequired

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

selfGenericLinkrequired
hypertext reference
Schema: GenericLink
hypertext reference
- hrefstringrequired
  URI to be used. HREF stands for Hypertext REFerence.
  Constraints: 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
Schema: GenericLink
hypertext reference
- hrefstringrequired
  URI to be used. HREF stands for Hypertext REFerence.
  Constraints: 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
ownersGenericLink
hypertext reference
Schema: GenericLink
hypertext reference
- hrefstringrequired
  URI to be used. HREF stands for Hypertext REFerence.
  Constraints: 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
balancesGenericLink
hypertext reference
Schema: GenericLink
hypertext reference
- hrefstringrequired
  URI to be used. HREF stands for Hypertext REFerence.
  Constraints: 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
transactionsGenericLink
hypertext reference
Schema: GenericLink
hypertext reference
- hrefstringrequired
  URI to be used. HREF stands for Hypertext REFerence.
  Constraints: 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