get/payment-requests/{paymentRequestResourceId}

Schema: PaymentRequestResource

• resourceIdResourceId

  API: Identifier assigned by the ASPSP for further use of the created resource through API calls.

  Schema: ResourceId

  API: Identifier assigned by the ASPSP for further use of the created resource through API calls. The API client cannot set or modify the value of this field. Since this value can be exchanged between the server and the client as an URL element or for support information, it must not contain sensitive value such as personal or business data.

  Type: string

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

• paymentInformationIdPaymentInformationIdrequired

  ISO20022 : Reference assigned by a sending party to unambiguously identify the payment information block within the message.

  Schema: PaymentInformationId

  ISO20022 : Reference assigned by a sending party to unambiguously identify the payment information block within the message.

  Type: string

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

• creationDateTimeCreationDateTimerequired

  ISO20022: Date and time at which a (group of) payment instruction(s) was created by the instructing party.

  Schema: CreationDateTime

  ISO20022: Date and time at which a (group of) payment instruction(s) was created by the instructing party.

  Type: string (date-time)

• numberOfTransactionsintegerrequired

  ISO20022: Number of individual transactions contained in the message.

  ISO20022: Number of individual transactions contained in the message. API: Each ASPSP will specify a maximum value for this field taking into accounts its specificities about payment request handling

• initiatingPartyPartyIdentificationrequired

  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

• paymentTypeInformationPaymentTypeInformationrequired

  ISO20022: Set of elements used to further specify the type of transaction.

  Schema: PaymentTypeInformation

  ISO20022: Set of elements used to further specify the type of transaction.

  • instructionPriorityPriorityCode

    ISO20022: Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.

    Schema: PriorityCode

    Code
    HIGH
    NORM

  • serviceLevelServiceLevelCode

    ISO20022: Agreement under which or rules under which the transaction should be processed. Specifies a pre-agreed service or level of service between the parties, as published in an external service level code list.

    Schema: ServiceLevelCode

    Code
    SEPA

  • localInstrumentLocalInstrumentCode

    ISO20022: User community specific instrument.

    Schema: LocalInstrumentCode

    ISO20022: User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level. API: "INST" value is to be used in order to ask for an SEPA instant Payment (SCTInst). For International payments, this field may be valued with one of the ISO20022 external code to specify with payment instrument should be used by the creditor's bank.

    Type: string

  • categoryPurposeCategoryPurposeCode

    ISO20022: Specifies the high level purpose of the instruction based on a set of pre-defined categories. This is used by the initiating party to provide information concerning the processing of the payment. It is likely to trigger special processing by any of the agents involved in the payment chain. API: The following values are allowed:

    Schema: CategoryPurposeCode

    Code	Name	Description
    CASH	CashManagementTransfer	Transaction is a general cash management instruction.
    CORT	TradeSettlementPayment	Transaction is related to settlement of a trade, eg a foreign exchange deal or a securities transaction.
    DVPM	DeliverAgainstPayment	Code used to pre-advise the account servicer of a forthcoming deliver against payment instruction.
    INTC	IntraCompanyPayment	Transaction is an intra-company payment, ie, a payment between two companies belonging to the same group.
    TREA	TreasuryPayment	Transaction is related to treasury operations. E.g. financial contract settlement.

• debtorPartyIdentification

  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

• debtorAccountAccountIdentification

  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}$`

• debtorAgentFinancialInstitutionIdentification

  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

• beneficiaryBeneficiary

  Specification of a beneficiary

  Schema: Beneficiary

  Specification of a 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}$`

• ultimateCreditorPartyIdentification

  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

• purposePurposeCode

  ISO20022: Underlying reason for the payment transaction, as published in an external purpose code list.

  Schema: PurposeCode

  Code
  ACCT
  CASH
  COMC
  CPKC
  TRPT

• chargeBearerChargeBearerCode

  ISO20022: Specifies which party/parties will bear the charges associated with the processing of the payment transaction. The following values are allowed:

  Schema: ChargeBearerCode

  Code	Name	Description
  DEBT	BorneByDebtor	All transaction charges are to be borne by the debtor.
  CRED	BorneByCreditor	All transaction charges are to be borne by the creditor.
  SHAR	Shared	In a credit transfer context, means that transaction charges on the sender side are to be borne by the debtor, transaction charges on the receiver side are to be borne by the creditor. In a direct debit context, means that transaction charges on the sender side are to be borne by the creditor, transaction charges on the receiver side are to be borne by the debtor.
  SLEV	FollowingServiceLevel	Charges are to be applied following the rules agreed in the service level and/or scheme.

• paymentInformationStatusPaymentInformationStatusCode

  ISO20022: Specifies the status of the payment information. API: Mandatory. The following values are allowed to provide the status of the Payment Request - ACCP (AcceptedCustomerProfile): Preceding check of technical validation was successful. Customer profile check was also successful. - ACSC (AcceptedSettlementCompleted): Settlement on the debtor's account has been completed. In the case of SCTInst, this status must not been set by the debtor's Bank before the reception of the positive confirmation. - ACSP (AcceptedSettlementInProcess): All preceding checks such as technical validation and customer profile were successful. Dynamic risk assessment is now also successful and therefore the Payment Request has been accepted for execution. - ACTC (AcceptedTechnicalValidation): Authentication and syntactical and semantical validation are successful. - ACWC (AcceptedWithChange): Instruction is accepted but a change will be made, such as date or remittance not sent. - ACWP (AcceptedWithoutPosting): Payment instruction included in the credit transfer is accepted without being posted to the creditor customer’s account. - PART (PartiallyAccepted): A number of transactions have been accepted, whereas another number of transactions have not yet achieved 'accepted' status. - RCVD (Received): Payment initiation has been received by the receiving agent. - PDNG (Pending): Payment request or individual transaction included in the Payment Request is pending. Further checks and status update will be performed. - RJCT (Rejected): Payment request has been rejected.

  Schema: PaymentInformationStatusCode

  Code
  ACCP
  ACSC
  ACSP
  ACTC
  ACWC
  ACWP
  PART
  RCVD
  PDNG
  RJCT

• statusReasonInformationStatusReasonInformation

  ISO20022: Provides detailed information on the status reason.

  Schema: StatusReasonInformation

  Code
  AC01
  AC04
  AC06
  AG01
  CH03
  CUST
  DS02
  FF01
  FRAD
  MS03
  NOAS
  RR01
  RR03
  RR04
  RR12

• fundsAvailabilityFundsAvailabilityInformation

  indicator that the payment can be covered or not by the funds available on the relevant account

  Schema: FundsAvailabilityInformation

  indicator that the payment can be covered or not by the funds available on the relevant account

  • true: payment is covered
  • false: payment is not covered

  Type: boolean

• bookingBookingInformation

  indicator that the payment can be immediately booked or not

  Schema: BookingInformation

  indicator that the payment can be immediately booked or not

  • true: payment is booked
  • false: payment is not booked

  Type: boolean

• requestedExecutionDatestring (date-time)ISO 8601

  ISO20022: Date at which the initiating party requests the clearing agent to process the payment.

  ISO20022: Date at which the initiating party requests the clearing agent to process the payment.

• creditTransferTransactionarray<CreditTransferTransaction>required

  ISO20022: Payment processes required to transfer cash from the debtor to the creditor.

  ISO20022: Payment processes required to transfer cash from the debtor to the creditor. API: Each ASPSP will specify a maxItems value for this field taking into accounts its specificities about payment request handling

  Item: CreditTransferTransaction

  ISO20022: Payment processes required to transfer cash from the debtor to the creditor. API:

  • paymentIdPaymentIdentificationrequired

    ISO20022: Set of elements used to reference a payment instruction.

    Schema: PaymentIdentification

    ISO20022: Set of elements used to reference a payment instruction.

    • resourceIdResourceId

      API: Identifier assigned by the ASPSP for further use of the created resource through API calls.

      Schema: ResourceId

      API: Identifier assigned by the ASPSP for further use of the created resource through API calls. The API client cannot set or modify the value of this field. Since this value can be exchanged between the server and the client as an URL element or for support information, it must not contain sensitive value such as personal or business data.

      Type: string

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

    • instructionIdstringrequired

      ISO20022: Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.

      ISO20022: Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.

      API: Unique identification shared between the PISP and the ASPSP

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

    • endToEndIdstring

      ISO20022: Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.

      ISO20022: Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.

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

  • requestedExecutionDateRequestedExecutionDate

    ISO20022: Date at which the initiating party requests the clearing agent to process the payment.

    Schema: RequestedExecutionDate

    ISO20022: Date at which the initiating party requests the clearing agent to process the payment. API:
    This field indicates the date at which the debtor account should be debited. In most of the cases, especially for international payments, the date of the credit on the credit account cannot be set. Only SCTInst can guarantee having the same date for this credit. This date can be used in the following cases:

    • the single requested execution date for a payment having several instructions. In this case, this field must be set at the payment level.
    • the requested execution date for a given instruction within a payment. In this case, this field must be set at each instruction level.
    • The first date of execution for a standing order. When the payment cannot be processed at this date, the ASPSP is allowed to shift the applied execution date to the next possible execution date for non-standing orders. For standing orders, the [executionRule] parameter helps to compute the execution date to be applied.

    Type: string (date-time)

  • endDateEndDate

    The last applicable day of execution for a given standing order.

    Schema: EndDate

    The last applicable day of execution for a given standing order. If not given, the standing order is considered as endless.

    Type: string (date-time)

  • executionRuleExecutionRule

    Execution date shifting rule for standing orders

    Schema: ExecutionRule

    Code
    FWNG
    PREC

  • frequencyFrequencyCode

    Frequency rule for standing orders.

    Schema: FrequencyCode

    Code
    DAIL
    WEEK
    TOWK
    MNTH
    TOMN
    QUTR
    SEMI
    YEAR

  • instructedAmountAmountTyperequired

    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.

    • 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}$`

    • amountstringrequired

      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}$`

  • beneficiaryBeneficiary

    Specification of a beneficiary

    Schema: Beneficiary

    Specification of a 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}$`

  • ultimateCreditorPartyIdentification

    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

  • regulatoryReportingCodesRegulatoryReportingCodes

    List of needed regulatory reporting codes for international payments

    Schema: RegulatoryReportingCodes

    Type: array<string>

    List of needed regulatory reporting codes for international payments

  • remittanceInformationUnstructuredRemittanceInformation

    ISO20022: Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.

    Schema: UnstructuredRemittanceInformation

    Type: array<string>

    ISO20022: Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system. API: Only one occurrence is allowed

    Item: Relevant information to the transaction

    Item constraints: maxLength: 140

  • transactionStatusTransactionIndividualStatusCode

    ISO20022: Specifies the status of the payment information group. API: Only the following values are allowed to provide the status of the subsequent CREDIT TRANSFER to the Payment Request - RJCT: Payment request or individual transaction included in the Payment Request has been rejected. - PDNG: (Pending): Payment request or individual transaction included in the Payment Request is pending. Further checks and status update will be performed. - ACSP: All preceding checks such as technical validation and customer profile were successful and therefore the Payment Request has been accepted for execution. - ACSC: Settlement on the debtor's account has been completed. In the case of SCTInst, this status must not been set by the debtor's Bank before the reception of the positive confirmation.

    Schema: TransactionIndividualStatusCode

    Code
    RJCT
    PDNG
    ACSP
    ACSC

  • statusReasonInformationStatusReasonInformation

    ISO20022: Provides detailed information on the status reason.

    Schema: StatusReasonInformation

    Code
    AC01
    AC04
    AC06
    AG01
    CH03
    CUST
    DS02
    FF01
    FRAD
    MS03
    NOAS
    RR01
    RR03
    RR04
    RR12

• supplementaryDataSupplementaryDatarequired

  ISO20022: Additional information that cannot be captured in the structured elements and/or any other specific block.

  Schema: SupplementaryData

  ISO20022: Additional information that cannot be captured in the structured elements and/or any other specific block.

  API: This structure is used to embed the relevant URLs for returning the status report to the PISP and to specify which authentication approaches are accepted by the PISP and which has been chosen by the ASPSP

  • acceptedAuthenticationApproacharray<string>

    can only be set by the PISP

    can only be set by the PISP authentication approaches that are supported by the PISP. The PISP can provide several choices separated by commas. REDIRECT: the PSU is redirected by the TPP to the ASPSP which processes identification and authentication DECOUPLED: the TPP identifies the PSU and forwards the identification to the ASPSP which processes the authentication through a decoupled device EMBEDDED: the TPP identifies the PSU and forwards the identification to the ASPSP which starts the authentication. The TPP forwards one authentication factor of the PSU (e.g. OTP or response to a challenge)

    Code
    REDIRECT
    DECOUPLED
    EMBEDDED

    Type: array<string>

    Item: combination of possible values for authentication approaches

  • appliedAuthenticationApproachAppliedAuthenticationApproach

    The ASPSP, based on the authentication approaches proposed by the PISP, choose the one that it can processed, in respect with the preferences and constraints of the PSU and indicates in this field which approach has been chosen

    Schema: AppliedAuthenticationApproach

    Code
    REDIRECT
    DECOUPLED
    EMBEDDED

  • scaHintstringenum · 2

    can only be set by the PISP

    can only be set by the PISP Hint given by the merchant and/or the PISP about an SCA exemption context

    Code
    noScaExemption
    scaExemption

  • successfulReportUrlstring

    URL to be used by the ASPSP in order to notify the PISP of the finalisation of the authentication and consent process in REDIRECT and DECOUPLED approach

    URL to be used by the ASPSP in order to notify the PISP of the finalisation of the authentication and consent process in REDIRECT and DECOUPLED approach

  • unsuccessfulReportUrlstring

    URL to be used by the ASPSP in order to notify the PISP of the failure of the authentication and consent process in REDIRECT and DECOUPLED approach

    URL to be used by the ASPSP in order to notify the PISP of the failure of the authentication and consent process in REDIRECT and DECOUPLED approach If this URL is not provided by the PISP, the ASPSP will use the "successfulReportUrl" even in case of failure of the Payment Request processing

Schema: PaymentRequestLinks

• requestGenericLink

  This link provides the payment-request URL for retrieving or modifying

  This link provides the payment-request URL for retrieving or modifying

  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

• confirmationGenericLink

  This link shall not be provided when the confirmation was already posted.

  This link shall not be provided when the confirmation was already posted.

  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