Loans API icon

Loans API

1.0.x
(0 reviews)

NextGenPSD2 XS2A Framework Implementation Guidelines Extended Services AIS for Savings and Loans Accounts

Summary

Like a (regular payment) account, specific savings accounts can be addressed in a consent request by identifying the account by its IBAN. In some cases, a savings / loan accountmight not be connected to any globally defined identifier. Therefore, the additional element "other" is used, which might be provided instead of or in addition to an IBAN thereby identifying the specific account, for which a consent is requested.

Additionally, a savings account can be addressed by an Account Access Object containing an identifier of the savings account / loan account accompanied by the specification of the cashAccountType to Type "SVGS"/ "LOAN". A consent of this type will grant the access to the related savingsaccount/ loan account, if the ASPSP supports the corresponding endpoints at all.

As a third / fourth way to establish a savings specific consent, the TPP can request a bank-offered consent or a global consent but restricting the requested access to a certain cashAccountType e.g. "SVGS" or "LOAN". A consent of this type grant the access to accounts of only the related type (e.g. savings account/ loan account),if the ASPSP supports the corresponding endpoints at all.

/v1/loans:
get:
  summary: Read list of loans accounts
  description: |
    Reads a list of loan accounts potentially with additional information, e.g. balance information.
    It is assumed that a consent of the PSU to this access is already given and stored on the ASPSP system.
    The addressed list of savings accounts depends then on the stored consent addressed by consentId,
    respectively the OAuth2 accesstoken.
/v1/loans/{loan-account-id}:
get:
  summary: Read loan account details
  description: |
    Reads details about a loan account.
    It is assumed that a consent of the PSU to
    this access is already given and stored on the ASPSP system.
    The addressed details of this account depend then on the stored consent addressed by consentId,
    respectively the OAuth2 access token.
/v1/loans/{loan-account-id}/balances:
get:
  summary: Read Loan Account Balances
  description: |
    Reads balance data from a given loan account addressed by "loan-account-id".

    The loan-account-id is constant at least throughout the lifecycle of a given consent.

Reviews