get/trusted-beneficiaries

Item: Beneficiary

• idstring

  Id of the beneficiary

  Constraints: pattern: `^([a-zA-Z0-9 /\-?:\()\.,']{1,35})$`

• isTrustedboolean

  The ASPSP having not implemented the trusted beneficiaries list must not set this flag.

  The ASPSP having not implemented the trusted beneficiaries list must not set this flag. Otherwise, the ASPSP indicates whether or not the beneficiary has been registered by the PSU within the trusted beneficiaries list.

  • true: the beneficiary is actually a trusted beneficiary
  • false: the beneficiary is not a trusted beneficiary
• creditorAgentFinancialInstitutionIdentification

  ISO20022: Unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.

  Schema: FinancialInstitutionIdentification

  ISO20022: Unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.

  • bicFistringrequired

    ISO20022: Code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 "Banking - Banking telecommunication messages - Business identification code (BIC)".

    ISO20022: Code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 "Banking - Banking telecommunication messages - Business identification code (BIC)".

    Constraints: pattern: `^[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}$`

  • clearingSystemMemberIdClearingSystemMemberIdentification

    ISO20022: Information used to identify a member within a clearing system.

    Schema: ClearingSystemMemberIdentification

    ISO20022: Information used to identify a member within a clearing system. API: to be used for some specific international credit transfers in order to identify the beneficiary bank

    • clearingSystemIdstring

      ISO20022: Specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.

      ISO20022: Specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.

      Constraints: maxLength: 35

    • memberIdstring

      ISO20022: Identification of a member of a clearing system.

      ISO20022: Identification of a member of a clearing system.

      Constraints: maxLength: 35

  • namestring

    Name of the financial institution

    Constraints: maxLength: 140

  • postalAddressPostalAddress

    ISO20022 : Information that locates and identifies a specific address, as defined by postal services.

    Schema: PostalAddress

    ISO20022 : Information that locates and identifies a specific address, as defined by postal services.

    • countrystringrequired

      ISO20022: Country in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.

      ISO20022: Country in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.

      Constraints: pattern: `^([A-Z]{2,2})$`

    • addressLinearray<string>required

      Unstructured address.

      Unstructured address. For SEPA payments, only two address lines are allowed.

      Type: array<string>

      Item: Address line

      Item constraints: maxLength: 70

• creditorPartyIdentificationrequired

  API : Description of a Party which can be either a person or an organization.

  Schema: PartyIdentification

  API : Description of a Party which can be either a person or an organization.

  • namestringrequired

    ISO20022: Name by which a party is known and which is usually used to identify that party.

    ISO20022: Name by which a party is known and which is usually used to identify that party.

    Constraints: maxLength: 140

  • postalAddressPostalAddress

    ISO20022 : Information that locates and identifies a specific address, as defined by postal services.

    Schema: PostalAddress

    ISO20022 : Information that locates and identifies a specific address, as defined by postal services.

    • countrystringrequired

      ISO20022: Country in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.

      ISO20022: Country in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.

      Constraints: pattern: `^([A-Z]{2,2})$`

    • addressLinearray<string>required

      Unstructured address.

      Unstructured address. For SEPA payments, only two address lines are allowed.

      Type: array<string>

      Item: Address line

      Item constraints: maxLength: 70

  • organisationIdGenericIdentification

    Unique and unambiguous way to identify an organisation.

    Schema: GenericIdentification

    ISO20022: Unique identification of an account, a person or an organisation, as assigned by an issuer. API: The ASPSP will document which account reference type it will support.

    • identificationstringrequired

      API: Identifier

      API: Identifier

      Constraints: maxLength: 70

    • schemeNamestringrequired

      Name of the identification scheme.

      Name of the identification scheme. Possible values for the scheme name, partially based on ISO20022 external code list, are the following:

      • BANK (BankPartyIdentification): Unique and unambiguous assignment made by a specific bank or similar financial institution to identify a relationship as defined between the bank and its client.
      • COID (CountryIdentificationCode) : Country authority given organisation identification (e.g., corporate registration number)
      • SREN (SIREN): The SIREN number is a 9 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation in France.
      • SRET (SIRET): The SIRET number is a 14 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation unit in France. It consists of the SIREN number, followed by a five digit classification number, to identify the local geographical unit of that entity.
      • NIDN (NationalIdentityNumber): Number assigned by an authority to identify the national identity number of a person. Other values are also permitted, for instance:
      • OAUT (OAUTH2): OAUTH2 access token that is owned by the PISP being also an AISP and that can be used in order to identify the PSU
      • CPAN (CardPan): Card PAN Each implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used

      Constraints: maxLength: 70

    • issuerstring

      ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties

      ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties

      Constraints: maxLength: 35

  • privateIdGenericIdentification

    Unique and unambiguous identification of a person.

    Schema: GenericIdentification

    ISO20022: Unique identification of an account, a person or an organisation, as assigned by an issuer. API: The ASPSP will document which account reference type it will support.

    • identificationstringrequired

      API: Identifier

      API: Identifier

      Constraints: maxLength: 70

    • schemeNamestringrequired

      Name of the identification scheme.

      Name of the identification scheme. Possible values for the scheme name, partially based on ISO20022 external code list, are the following:

      • BANK (BankPartyIdentification): Unique and unambiguous assignment made by a specific bank or similar financial institution to identify a relationship as defined between the bank and its client.
      • COID (CountryIdentificationCode) : Country authority given organisation identification (e.g., corporate registration number)
      • SREN (SIREN): The SIREN number is a 9 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation in France.
      • SRET (SIRET): The SIRET number is a 14 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation unit in France. It consists of the SIREN number, followed by a five digit classification number, to identify the local geographical unit of that entity.
      • NIDN (NationalIdentityNumber): Number assigned by an authority to identify the national identity number of a person. Other values are also permitted, for instance:
      • OAUT (OAUTH2): OAUTH2 access token that is owned by the PISP being also an AISP and that can be used in order to identify the PSU
      • CPAN (CardPan): Card PAN Each implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used

      Constraints: maxLength: 70

    • issuerstring

      ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties

      ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties

      Constraints: maxLength: 35

• creditorAccountAccountIdentification

  Unique and unambiguous identification for the account between the account owner and the account servicer.

  Schema: AccountIdentification

  Unique and unambiguous identification for the account between the account owner and the account servicer.

  • ibanstring

    ISO20022: International Bank Account Number (IBAN) - identification used internationally by financial institutions to uniquely identify the account of a customer.

    ISO20022: International Bank Account Number (IBAN) - identification used internationally by financial institutions to uniquely identify the account of a customer.

    Further specifications of the format and content of the IBAN can be found in the standard ISO 13616 "Banking and related financial services - International Bank Account Number (IBAN)" version 1997-10-01, or later revisions.

    Constraints: pattern: `^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$`

  • otherGenericIdentification

    ISO20022: Unique identification of an account, a person or an organisation, as assigned by an issuer.

    Schema: GenericIdentification

    ISO20022: Unique identification of an account, a person or an organisation, as assigned by an issuer. API: The ASPSP will document which account reference type it will support.

    • identificationstringrequired

      API: Identifier

      API: Identifier

      Constraints: maxLength: 70

    • schemeNamestringrequired

      Name of the identification scheme.

      Name of the identification scheme. Possible values for the scheme name, partially based on ISO20022 external code list, are the following:

      • BANK (BankPartyIdentification): Unique and unambiguous assignment made by a specific bank or similar financial institution to identify a relationship as defined between the bank and its client.
      • COID (CountryIdentificationCode) : Country authority given organisation identification (e.g., corporate registration number)
      • SREN (SIREN): The SIREN number is a 9 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation in France.
      • SRET (SIRET): The SIRET number is a 14 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation unit in France. It consists of the SIREN number, followed by a five digit classification number, to identify the local geographical unit of that entity.
      • NIDN (NationalIdentityNumber): Number assigned by an authority to identify the national identity number of a person. Other values are also permitted, for instance:
      • OAUT (OAUTH2): OAUTH2 access token that is owned by the PISP being also an AISP and that can be used in order to identify the PSU
      • CPAN (CardPan): Card PAN Each implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used

      Constraints: maxLength: 70

    • issuerstring

      ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties

      ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties

      Constraints: maxLength: 35

  • currencyCurrencyCodeISO 4217

    Currency used for 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}$`

Schema: BeneficiariesLinks

• selfGenericLinkrequired

  hypertext reference

  Schema: GenericLink

  hypertext reference

  • hrefstringrequired

    URI to be used

    Constraints: maxLength: 140

  • templatedboolean

    specifies "true" if href is a URI template, i.e. with parameters. Otherwise, this property is absent or set to false

• parent-listGenericLink

  hypertext reference

  Schema: GenericLink

  hypertext reference

  • hrefstringrequired

    URI to be used

    Constraints: maxLength: 140

  • templatedboolean

    specifies "true" if href is a URI template, i.e. with parameters. Otherwise, this property is absent or set to false

• firstGenericLink

  hypertext reference

  Schema: GenericLink

  hypertext reference

  • hrefstringrequired

    URI to be used

    Constraints: maxLength: 140

  • templatedboolean

    specifies "true" if href is a URI template, i.e. with parameters. Otherwise, this property is absent or set to false

• lastGenericLink

  hypertext reference

  Schema: GenericLink

  hypertext reference

  • hrefstringrequired

    URI to be used

    Constraints: maxLength: 140

  • templatedboolean

    specifies "true" if href is a URI template, i.e. with parameters. Otherwise, this property is absent or set to false

• nextGenericLink

  hypertext reference

  Schema: GenericLink

  hypertext reference

  • hrefstringrequired

    URI to be used

    Constraints: maxLength: 140

  • templatedboolean

    specifies "true" if href is a URI template, i.e. with parameters. Otherwise, this property is absent or set to false

• prevGenericLink

  hypertext reference

  Schema: GenericLink

  hypertext reference

  • hrefstringrequired

    URI to be used

    Constraints: maxLength: 140

  • templatedboolean

    specifies "true" if href is a URI template, i.e. with parameters. Otherwise, this property is absent or set to false