get/payment-requests/{paymentRequestResourceId}

Fields (2)

• paymentRequestPaymentRequestResourcerequired

  ISO20022: The PaymentRequestResource message is sent by the Creditor sending party to the Debtor receiving party, directly or through agents. It is used by a Creditor to request movement of funds from the debtor account to a creditor.

  Schema: PaymentRequestResource

  ISO20022: The PaymentRequestResource message is sent by the Creditor sending party to the Debtor receiving party, directly or through agents. It is used by a Creditor to request movement of funds from the debtor account to a creditor. API: Information about the creditor (Id, account and agent) must be placed at instruction level. Thus multi-beneficiary payments can be handled. The requested execution date must be placed at payment level even when all instructions are requested to be executed at the same date. The latest case includes:

  • multiple instructions having different requested execution dates
  • standing orders settings

  • 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. However it is the duty of each ASPSP to perform its own risk analysis on this topic.

    Type: string

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

  • 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. API: This field is a clue for idempotency check by the ASPSP in order to avoid duplicate SCA or payment execution. However the ASPSP may use other mechanisms.

    Type: string

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

  • batchBookingBatchBookingIndicator

    Identifies whether a single entry per individual transaction or a batch entry for the sum of the amounts of all transactions within the group of a message is requested.

    Schema: BatchBookingIndicator

    Identifies whether a single entry per individual transaction or a batch entry for the sum of the amounts of all transactions within the group of a message is requested. Meaning When True: Identifies that a batch entry for the sum of the amounts of all transactions in the batch or message is requested. Meaning When False: Identifies that a single entry for each of the transactions in the batch or message is requested. Default value: each ASPSP must be able to specify its own default value.

    Type: boolean

  • 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. The [organisationId] property allows the specification of an unique and unambiguous way to identify an organisation. The [privateId] property allows the specification of an unique and unambiguous way to identify a person.

      Constraints: maxLength: 140

    • dateAndPlaceOfBirthDateAndPlaceOfBirth

      Date and place of birth of a person.

      Schema: DateAndPlaceOfBirth

      Date and place of birth of a person. This information must be requested for detection of Fraud, Money-Laundering and Terrorism Financing in case of international payment.

      • birthDatestring (date)ISO 8601required

        Date on which a person is born.

      • cityOfBirthstringrequired

        City where a person was born.

        Constraints: maxLength: 35

      • countryOfBirthstringrequired

        Country where a person was born.

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

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

      • addressTypestringenum · 6

        ISO20022: Identifies the nature of the postal address.

        ISO20022: Identifies the nature of the postal address. API: Cannot be used for SEPA payments. Proprietary codes can be specified and documented if needed.

        Code	Name	Description
        BIZZ	Business	Address is the business address
        DLVY	Delivery	Address is the address to which delivery is to take place
        MLTO	Mail To	Address is the address to which mail is sent
        PBOX	PO Box	Address is is a postal office (PO) box
        ADDR	Postal	Address is the complete postal address
        HOME	Home	Address is the home address

      • departmentstring

        ISO20022: Identification of a division of a large organisation or building.

        ISO20022: Identification of a division of a large organisation or building. API: Cannot be used for SEPA payments.

        Constraints: maxLength: 70

      • subDepartmentstring

        ISO20022: Identification of a sub-division of a large organisation or building.

        ISO20022: Identification of a sub-division of a large organisation or building. API: Cannot be used for SEPA payments.

        Constraints: maxLength: 70

      • streetNamestring

        ISO20022: Name of a street or thoroughfare.

        ISO20022: Name of a street or thoroughfare. API: Cannot be used for SEPA payments.

        Constraints: maxLength: 70

      • buildingNumberstring

        ISO20022: Number that identifies the position of a building on a street.

        ISO20022: Number that identifies the position of a building on a street. API: Cannot be used for SEPA payments.

        Constraints: maxLength: 16

      • buildingNamestring

        ISO20022: Name of the building or house.

        ISO20022: Name of the building or house. API: Cannot be used for SEPA payments.

        Constraints: maxLength: 16

      • postCodestring

        ISO20022: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

        ISO20022: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. API: Cannot be used for SEPA payments.

        Constraints: maxLength: 16

      • townNamestring

        ISO20022: Name of a built-up area, with defined boundaries, and a local government.

        ISO20022: Name of a built-up area, with defined boundaries, and a local government. API: Cannot be used for SEPA payments.

        Constraints: maxLength: 35

      • countrySubDivisionstring

        ISO20022: Identifies a subdivision of a country such as state, region, county.

        ISO20022: Identifies a subdivision of a country such as state, region, county. API: Cannot be used for SEPA payments.

        Constraints: maxLength: 35

      • 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>

        Unstructured address. The lines must embed zip code and town name.

        Unstructured address. The lines must embed zip code and town name. For SEPA payments, only two address lines are allowed.

        Type: array<string>

        Item: Address line

        Item constraints: maxLength: 70

    • contactDetailsContactDetails

      Indicates how to contact the party.

      Schema: ContactDetails

      Indicates how to contact the party.

      • phoneNumberPhoneNumber

        The collection of information which identifies a specific phone or FAX number as defined by telecom services.

        Schema: PhoneNumber

        The collection of information which identifies a specific phone or FAX number as defined by telecom services. It consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).

        Type: string

        Constraints: pattern: `^\+[0-9]{1,3}-[0-9()+\-]{1,30}$`

      • faxNumberPhoneNumber

        The collection of information which identifies a specific phone or FAX number as defined by telecom services.

        Schema: PhoneNumber

        The collection of information which identifies a specific phone or FAX number as defined by telecom services. It consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).

        Type: string

        Constraints: pattern: `^\+[0-9]{1,3}-[0-9()+\-]{1,30}$`

      • emailAddressstring

        email address of the contact

        Constraints: maxLength: 2048 · pattern: `^.+@.+$`

    • organisationIdGenericIdentification

      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:

        Code	Name	Description
        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.
        BBAN	BBANIdentifier	Basic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer.
        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:
        Code	Name	Description
        ----	----	-----------
        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
        MPAN	MaskedPan	Card PAN where some digits were replaced for security reason
        TPAN	TokenizedPan	Token which was provided by a Token Service Provider (TSP) in order to obfuscate a real card PAN. The TSP must be identified in the issuer field
        TBAN	TokenizedIBAN	Token which was provided by a Token Service Provider (TSP) in order to obfuscate an IBAN. The TSP must be identified in the issuer field
        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

      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:

        Code	Name	Description
        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.
        BBAN	BBANIdentifier	Basic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer.
        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:
        Code	Name	Description
        ----	----	-----------
        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
        MPAN	MaskedPan	Card PAN where some digits were replaced for security reason
        TPAN	TokenizedPan	Token which was provided by a Token Service Provider (TSP) in order to obfuscate a real card PAN. The TSP must be identified in the issuer field
        TBAN	TokenizedIBAN	Token which was provided by a Token Service Provider (TSP) in order to obfuscate an IBAN. The TSP must be identified in the issuer field
        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

    • leiLeiIdentification

      Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

      Schema: LeiIdentification

      Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

      Type: string

      Constraints: pattern: `^[A-Z0-9]{18,18}[0-9]{2,2}$`

  • acceptDebtorAccountChangeboolean

    indicator that the debtor account can be changed in the payment request by the ASPSP if needed

    indicator that the debtor account can be changed in the payment request by the ASPSP if needed

    • true: debtor account can be changed (default value)
    • false: debtor account cannot be changed
  • acceptChargeHandlingChangeboolean

    indicator that the charge handling can be changed in the payment request by the ASPSP if needed

    indicator that the charge handling can be changed in the payment request by the ASPSP if needed

    • true: charge handling can be changed (default value)
    • false: charge handling cannot be changed
  • acceptInstantPaymentDowngradeboolean

    Indicator that the requested instant SEPA Credit Transfer method can be downgraded by the ASPSP into a plain-vanilla SEPA Credit Transfer, when Instant SCT cannot apply or is refused by the PSU.

    Indicator that the requested instant SEPA Credit Transfer method can be downgraded by the ASPSP into a plain-vanilla SEPA Credit Transfer, when Instant SCT cannot apply or is refused by the PSU. Eventually, it is up to the ASPSP to downgrade or reject the payment. In case of a downgrade, the ASPSP will have to update de relevant field [LocalInstrument] and remove the "INST" value in order to keep the PISP informed.

    • true: payment method can be downgraded
    • false: payment method cannot be downgraded (default value)
  • 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 which 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.

      Schema: CategoryPurposeCode

      Code	Name	Description
      CASH	CashManagementTransfer	Transaction is a general cash management instruction.
      CORT	TradeSettlementPayment	Transaction is related to settlement of a trade, e.g. 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, i.e. a payment between two companies belonging to the same group.
      SALA	SalaryPayment	Transaction is the payment of salaries.
      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. The [organisationId] property allows the specification of an unique and unambiguous way to identify an organisation. The [privateId] property allows the specification of an unique and unambiguous way to identify a person.

      Constraints: maxLength: 140

    • dateAndPlaceOfBirthDateAndPlaceOfBirth

      Date and place of birth of a person.

      Schema: DateAndPlaceOfBirth

      Date and place of birth of a person. This information must be requested for detection of Fraud, Money-Laundering and Terrorism Financing in case of international payment.

      • birthDatestring (date)ISO 8601required

        Date on which a person is born.

      • cityOfBirthstringrequired

        City where a person was born.

        Constraints: maxLength: 35

      • countryOfBirthstringrequired

        Country where a person was born.

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

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

      • addressTypestringenum · 6

        ISO20022: Identifies the nature of the postal address.

        ISO20022: Identifies the nature of the postal address. API: Cannot be used for SEPA payments. Proprietary codes can be specified and documented if needed.

        Code	Name	Description
        BIZZ	Business	Address is the business address
        DLVY	Delivery	Address is the address to which delivery is to take place
        MLTO	Mail To	Address is the address to which mail is sent
        PBOX	PO Box	Address is is a postal office (PO) box
        ADDR	Postal	Address is the complete postal address
        HOME	Home	Address is the home address

      • departmentstring

        ISO20022: Identification of a division of a large organisation or building.

        ISO20022: Identification of a division of a large organisation or building. API: Cannot be used for SEPA payments.

        Constraints: maxLength: 70

      • subDepartmentstring

        ISO20022: Identification of a sub-division of a large organisation or building.

        ISO20022: Identification of a sub-division of a large organisation or building. API: Cannot be used for SEPA payments.

        Constraints: maxLength: 70

      • streetNamestring

        ISO20022: Name of a street or thoroughfare.

        ISO20022: Name of a street or thoroughfare. API: Cannot be used for SEPA payments.

        Constraints: maxLength: 70

      • buildingNumberstring

        ISO20022: Number that identifies the position of a building on a street.

        ISO20022: Number that identifies the position of a building on a street. API: Cannot be used for SEPA payments.

        Constraints: maxLength: 16

      • buildingNamestring

        ISO20022: Name of the building or house.

        ISO20022: Name of the building or house. API: Cannot be used for SEPA payments.

        Constraints: maxLength: 16

      • postCodestring

        ISO20022: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

        ISO20022: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. API: Cannot be used for SEPA payments.

        Constraints: maxLength: 16

      • townNamestring

        ISO20022: Name of a built-up area, with defined boundaries, and a local government.

        ISO20022: Name of a built-up area, with defined boundaries, and a local government. API: Cannot be used for SEPA payments.

        Constraints: maxLength: 35

      • countrySubDivisionstring

        ISO20022: Identifies a subdivision of a country such as state, region, county.

        ISO20022: Identifies a subdivision of a country such as state, region, county. API: Cannot be used for SEPA payments.

        Constraints: maxLength: 35

      • 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>

        Unstructured address. The lines must embed zip code and town name.

        Unstructured address. The lines must embed zip code and town name. For SEPA payments, only two address lines are allowed.

        Type: array<string>

        Item: Address line

        Item constraints: maxLength: 70

    • contactDetailsContactDetails

      Indicates how to contact the party.

      Schema: ContactDetails

      Indicates how to contact the party.

      • phoneNumberPhoneNumber

        The collection of information which identifies a specific phone or FAX number as defined by telecom services.

        Schema: PhoneNumber

        The collection of information which identifies a specific phone or FAX number as defined by telecom services. It consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).

        Type: string

        Constraints: pattern: `^\+[0-9]{1,3}-[0-9()+\-]{1,30}$`

      • faxNumberPhoneNumber

        The collection of information which identifies a specific phone or FAX number as defined by telecom services.

        Schema: PhoneNumber

        The collection of information which identifies a specific phone or FAX number as defined by telecom services. It consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).

        Type: string

        Constraints: pattern: `^\+[0-9]{1,3}-[0-9()+\-]{1,30}$`

      • emailAddressstring

        email address of the contact

        Constraints: maxLength: 2048 · pattern: `^.+@.+$`

    • organisationIdGenericIdentification

      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:

        Code	Name	Description
        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.
        BBAN	BBANIdentifier	Basic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer.
        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:
        Code	Name	Description
        ----	----	-----------
        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
        MPAN	MaskedPan	Card PAN where some digits were replaced for security reason
        TPAN	TokenizedPan	Token which was provided by a Token Service Provider (TSP) in order to obfuscate a real card PAN. The TSP must be identified in the issuer field
        TBAN	TokenizedIBAN	Token which was provided by a Token Service Provider (TSP) in order to obfuscate an IBAN. The TSP must be identified in the issuer field
        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

      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:

        Code	Name	Description
        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.
        BBAN	BBANIdentifier	Basic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer.
        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:
        Code	Name	Description
        ----	----	-----------
        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
        MPAN	MaskedPan	Card PAN where some digits were replaced for security reason
        TPAN	TokenizedPan	Token which was provided by a Token Service Provider (TSP) in order to obfuscate a real card PAN. The TSP must be identified in the issuer field
        TBAN	TokenizedIBAN	Token which was provided by a Token Service Provider (TSP) in order to obfuscate an IBAN. The TSP must be identified in the issuer field
        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

    • leiLeiIdentification

      Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

      Schema: LeiIdentification

      Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

      Type: string

      Constraints: pattern: `^[A-Z0-9]{18,18}[0-9]{2,2}$`

  • 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. Card accounts must provide the identification of the card through the "other" substructure by giving, for instance, the masked PAN (MPAN). The currency used for the account, when needed, can be specified through the [currency] field.

    • workspacestring

      Workspace to which the account is linked.

      Workspace to which the account is linked. This workspace might be specified by the AISP when forwarding the consent on accounts. If not provided, the default workspace is computed from the authentication that was used for getting the OAuth2 Access Token.

      Constraints: maxLength: 32

    • 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:

        Code	Name	Description
        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.
        BBAN	BBANIdentifier	Basic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer.
        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:
        Code	Name	Description
        ----	----	-----------
        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
        MPAN	MaskedPan	Card PAN where some digits were replaced for security reason
        TPAN	TokenizedPan	Token which was provided by a Token Service Provider (TSP) in order to obfuscate a real card PAN. The TSP must be identified in the issuer field
        TBAN	TokenizedIBAN	Token which was provided by a Token Service Provider (TSP) in order to obfuscate an IBAN. The TSP must be identified in the issuer field
        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

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

  • 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

      • clearingSystemIdstringrequired

        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

      • memberIdstringrequired

        ISO20022: Identification of a member of a clearing system.

        ISO20022: Identification of a member of a clearing system.

        Constraints: maxLength: 35

    • leiLeiIdentification

      Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

      Schema: LeiIdentification

      Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

      Type: string

      Constraints: pattern: `^[A-Z0-9]{18,18}[0-9]{2,2}$`

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

      • addressTypestringenum · 6

        ISO20022: Identifies the nature of the postal address.

        ISO20022: Identifies the nature of the postal address. API: Cannot be used for SEPA payments. Proprietary codes can be specified and documented if needed.

        Code	Name	Description
        BIZZ	Business	Address is the business address
        DLVY	Delivery	Address is the address to which delivery is to take place
        MLTO	Mail To	Address is the address to which mail is sent
        PBOX	PO Box	Address is is a postal office (PO) box
        ADDR	Postal	Address is the complete postal address
        HOME	Home	Address is the home address

      • departmentstring

        ISO20022: Identification of a division of a large organisation or building.

        ISO20022: Identification of a division of a large organisation or building. API: Cannot be used for SEPA payments.

        Constraints: maxLength: 70

      • subDepartmentstring

        ISO20022: Identification of a sub-division of a large organisation or building.

        ISO20022: Identification of a sub-division of a large organisation or building. API: Cannot be used for SEPA payments.

        Constraints: maxLength: 70

      • streetNamestring

        ISO20022: Name of a street or thoroughfare.

        ISO20022: Name of a street or thoroughfare. API: Cannot be used for SEPA payments.

        Constraints: maxLength: 70

      • buildingNumberstring

        ISO20022: Number that identifies the position of a building on a street.

        ISO20022: Number that identifies the position of a building on a street. API: Cannot be used for SEPA payments.

        Constraints: maxLength: 16

      • buildingNamestring

        ISO20022: Name of the building or house.

        ISO20022: Name of the building or house. API: Cannot be used for SEPA payments.

        Constraints: maxLength: 16

      • postCodestring

        ISO20022: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

        ISO20022: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. API: Cannot be used for SEPA payments.

        Constraints: maxLength: 16

      • townNamestring

        ISO20022: Name of a built-up area, with defined boundaries, and a local government.

        ISO20022: Name of a built-up area, with defined boundaries, and a local government. API: Cannot be used for SEPA payments.

        Constraints: maxLength: 35

      • countrySubDivisionstring

        ISO20022: Identifies a subdivision of a country such as state, region, county.

        ISO20022: Identifies a subdivision of a country such as state, region, county. API: Cannot be used for SEPA payments.

        Constraints: maxLength: 35

      • 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>

        Unstructured address. The lines must embed zip code and town name.

        Unstructured address. The lines must embed zip code and town name. For SEPA payments, only two address lines are allowed.

        Type: array<string>

        Item: Address line

        Item constraints: maxLength: 70

  • chargeBearerChargeBearerCode

    ISO20022: Specifies which party/parties will bear the charges associated with the processing of the payment transaction.

    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.

    Schema: PaymentInformationStatusCode

    Code	Name	Description
    ACCO	AcceptedCustomerCOnfirmed	The customer, during his/her authentication, has confirmed 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 was 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 was 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.
    CANC	Cancelled	Payment initiation was successfully cancelled after having received a request for cancellation.
    PART	PartiallyAccepted	A number of transactions were accepted, whereas another number of transactions have not yet achieved 'accepted' status.
    PATC	PartiallyAcceptedTechnicalCorrect	Payment initiation needs multiple authentications, where some but not yet all were performed. Syntactical and semantical validations are successful.
    RCVD	Received	Payment initiation was 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 was rejected.

  • statusReasonInformationStatusReasonInformation

    ISO20022: Provides detailed information on the status reason.

    Schema: StatusReasonInformation

    Code	Name	Description
    AC01	IncorectAccountNumber	the account number is either invalid or does not exist
    AC04	ClosedAccountNumber	the account is closed and cannot be used
    AC06	BlockedAccount	the account is blocked and cannot be used
    AG01	TransactionForbidden	Transaction forbidden on this type of account
    AG03	TransactionNotSupported	Transaction type not supported/authorized on this account
    AM02	NotAllowedAccount	SPecific transaction/message amount is greater than allowed maximum
    AM04	InsufficientFunds	Amount of funds available to cover specified message amount is insufficient
    AM18	InvalidNumberOfTransactions	the number of transactions exceeds the ASPSP acceptance limit
    CH03	RequestedExecutionDateOrRequestedCollectionDateTooFarInFuture	The requested execution date is too far in the future
    CH04	RequestedExecutionDateOrRequestedCollectionDateTooFarInPast	Value in Requested Execution Date or Requested Collection Date is too far in the past
    CNOR	CreditorBankIsNotRegistered	Creditor bank is not registered under this BIC in the CSM
    CUST	RequestedByCustomer	The reject is due to the debtor: refusal or lack of liquidity
    DS02	OrderCancelled	An authorized user has cancelled the order
    DUPL	DuplicatePayment	Payment is a duplicate of another payment. Can only be set by a PISP for a payment request cancellation.
    FF01	InvalidFileFormat	The reject is due to the original Payment Request which is invalid (syntax, structure or values)
    FRAD	FraudulentOriginated	the Payment Request is considered as fraudulent
    MS03	NotSpecifiedReasonAgentGenerated	No reason specified by the ASPSP
    NOAS	NoAnswerFromCustomer	The PSU has neither accepted nor rejected the Payment Request and a time-out has occurred
    RR01	MissingDebtorAccountOrIdentification	The Debtor account and/or Identification are missing or inconsistent
    RR03	MissingCreditorNameOrAddress	Specification of the creditor's name and/or address needed for regulatory requirements is insufficient or missing.
    RR04	RegulatoryReason	Reject from regulatory reason
    RR12	InvalidPartyID	Invalid or missing identification required within a particular country or payment type.
    TECH	TechnicalProblem	Technical problems resulting in an erroneous transaction. Can only be set by a PISP for a payment request cancellation.

  • 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 This indicator must be provided by the ASPSP when the Booking Information is present and set to "False". This indicator will not be provided if the Booking Information is absent or set to "True".

    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 Booking a transaction means that the funds required by this transaction are immediatly reserved and that a subsequent transaction will not interfere with the proper execution of the payment. However, usual fraud detection mechanisms might still be triggered and result as a rejection of the payment. This indicator must be provided when the relevant Credit Transfer will be executed as soon as possible but not as an instant payment. This indicator is irrelevant and will not be provided for delayed payments. This indicator is only relevant for the first occurrence of a standing order when this occurrence is not delayed and will be executed as soon as possible.

    Case the Information System cannot handle this immediate booking, the ASPSP will have to provide the funds availability information.

    Type: boolean

  • creditTransferTransactionarray<CreditTransferTransactionResource>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: CreditTransferTransactionResource

    ISO20022: Payment processes required to transfer cash from the debtor to the creditor. The [instructedAmount] property indicates 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. Usage: This amount has to be transported unchanged through the transaction chain. API: Amounts must always be set as positive values.

    • paymentIdPaymentIdentificationrequired

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

      Schema: PaymentIdentification

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

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

      • endToEndIdEndToEndId

        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.

        Schema: EndToEndId

        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.

        Type: string

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

      • uetrstring

        ISO20022: Universally unique identifier to provide an end-to-end reference of a payment transaction.

        ISO20022: Universally unique identifier to provide an end-to-end reference of a payment transaction.

        Constraints: pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$`

    • 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. However it is the duty of each ASPSP to perform its own risk analysis on this topic.

      Type: string

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

    • 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: When set by the PISP, this field indicates the future date at which the payment instruction should be executed and the debtor account should be debited. if this field is not set by the PISP, the ASPSP is requested to execute the payment instruction as soon as possible. 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. When the payment cannot be processed at the requested date, the ASPSP is allowed to shift the applied execution date to the next possible execution date for non-standing orders. For standing orders, this field is useless since the [startDate] parameter already provides the needed information for the first payment instruction to be executed.

      Type: string (date-time)

    • cancellableTillstring (date-time)ISO 8601

      This field may allow the PISP to get information on the limit timestamp for requesting cancelation of the transaction.

      This field may allow the PISP to get information on the limit timestamp for requesting cancelation of the transaction. When this field is not provided by the ASPSP, the PISP must rely on the status of the transaction [transactionStatus] in order to estimate if the transaction is actually cancellable.

    • acceptanceDateTimestring (date-time)ISO 8601

      ISO20022: Date and time at which all processing conditions for execution of the payment are met and adequate financial cover is available at the account servicing agent.

      ISO20022: Date and time at which all processing conditions for execution of the payment are met and adequate financial cover is available at the account servicing agent.

    • debtorDecisionDatestring (date-time)ISO 8601

      ISO20022: Date and time on when the debtor has accepted or rejected the request.

      ISO20022: Date and time on when the debtor has accepted or rejected the request.

    • appliedExecutionDatestring (date-time)ISO 8601

      ISO20022: Date and time on when the payment was executed.

      ISO20022: Date and time on when the payment was executed.

    • standingOrderCharacteristicsStandingOrderCharacteristics

      Specifies the characteristics of a standing order.

      Schema: StandingOrderCharacteristics

      Specifies the characteristics of a standing order.

      • startDateStartDaterequired

        The first applicable day of execution for a given period.

        Schema: StartDate

        The first applicable day of execution for a given period.

        Type: string (date-time)

      • endDateEndDate

        The last applicable day of execution for a given period.

        Schema: EndDate

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

        Type: string (date-time)

      • executionRuleExecutionRulerequired

        Execution date shifting rule for standing orders

        Schema: ExecutionRule

        Code	Description
        FWNG	following
        PREC	preceding

      • frequencyFrequencyCoderequired

        Frequency rule for standing orders.

        Schema: FrequencyCode

        Code	Description
        DAIL	Daily
        WEEK	Weekly
        TOWK	EveryTwoWeeks
        MNTH	Monthly
        TOMN	EveryTwoMonths
        QUTR	Quarterly
        SEMI	SemiAnnual
        YEAR	Annual

    • instructedAmountAmountType

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

      Schema: AmountType

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

      • amountnumber (float)required

        ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.

        ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.

        Constraints: pattern: `^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$`

      • currencyCurrencyCodeISO 4217required

        Specifies the currency of the amount or of the account.

        Schema: CurrencyCode

        Specifies the currency of the amount or of the account. A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

        Type: string

        Constraints: pattern: `^[A-Z]{3,3}$`

    • equivalentAmountEquivalentAmountType

      Amount of money to be moved between debtor and creditor, before deduction of charges, expressed in the currency of the debtor's account, and to be moved in a different currency.

      Schema: EquivalentAmountType

      Amount of money to be moved between debtor and creditor, before deduction of charges, expressed in the currency of the debtor's account, and to be moved in a different currency. Usage: The first agent will convert the equivalent amount into the amount to be moved.

      • amountnumber (float)required

        ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.

        ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.

        Constraints: pattern: `^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$`

      • currencyCurrencyCodeISO 4217required

        Specifies the currency of the amount or of the account.

        Schema: CurrencyCode

        Specifies the currency of the amount or of the account. A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

        Type: string

        Constraints: pattern: `^[A-Z]{3,3}$`

      • currencyOfTransferCurrencyCoderequired

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

    • exchangeRateInformationExchangeRate

      ISO20022: Provides details on the currency exchange rate and contract.

      Schema: ExchangeRate

      ISO20022: Provides details on the currency exchange rate and contract. The [unitCurrency] property specifies the currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP. The [estimatedPayerAmount] gives an estimation of the amount that will be debited on the payer's account, including transaction and change fees. The [estimatedPayeeAmunt] gives an estimation of the amount that will be credited on the payee's account. API: Amounts must always be set as positive values.

      • unitCurrencyCurrencyCode

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

      • exchangeRatenumber (float)

        The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.

        The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.

      • rateTypestringrequiredenum · 3

        Specifies the type used to complete the currency exchange.

        Code	Name	Description
        SPOT	Spot	Exchange rate applied is the spot rate.
        SALE	Sale	Exchange rate applied is the market rate at the time of the sale.
        AGRD	Agreed	Exchange rate applied is the rate agreed between the parties.

      • contractIdentificationstring

        Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.

        Constraints: maxLength: 35

      • estimatedPayerAmountAmountType

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

        Schema: AmountType

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

        • amountnumber (float)required

          ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.

          ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.

          Constraints: pattern: `^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$`

        • currencyCurrencyCodeISO 4217required

          Specifies the currency of the amount or of the account.

          Schema: CurrencyCode

          Specifies the currency of the amount or of the account. A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

          Type: string

          Constraints: pattern: `^[A-Z]{3,3}$`

      • estimatedPayeeAmountAmountType

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

        Schema: AmountType

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

        • amountnumber (float)required

          ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.

          ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.

          Constraints: pattern: `^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$`

        • currencyCurrencyCodeISO 4217required

          Specifies the currency of the amount or of the account.

          Schema: CurrencyCode

          Specifies the currency of the amount or of the account. A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

          Type: string

          Constraints: pattern: `^[A-Z]{3,3}$`

    • ultimateDebtorPartyIdentification

      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. The [organisationId] property allows the specification of an unique and unambiguous way to identify an organisation. The [privateId] property allows the specification of an unique and unambiguous way to identify a person.

        Constraints: maxLength: 140

      • dateAndPlaceOfBirthDateAndPlaceOfBirth

        Date and place of birth of a person.

        Schema: DateAndPlaceOfBirth

        Date and place of birth of a person. This information must be requested for detection of Fraud, Money-Laundering and Terrorism Financing in case of international payment.

        • birthDatestring (date)ISO 8601required

          Date on which a person is born.

        • cityOfBirthstringrequired

          City where a person was born.

          Constraints: maxLength: 35

        • countryOfBirthstringrequired

          Country where a person was born.

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

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

        • addressTypestringenum · 6

          ISO20022: Identifies the nature of the postal address.

          ISO20022: Identifies the nature of the postal address. API: Cannot be used for SEPA payments. Proprietary codes can be specified and documented if needed.

          Code	Name	Description
          BIZZ	Business	Address is the business address
          DLVY	Delivery	Address is the address to which delivery is to take place
          MLTO	Mail To	Address is the address to which mail is sent
          PBOX	PO Box	Address is is a postal office (PO) box
          ADDR	Postal	Address is the complete postal address
          HOME	Home	Address is the home address

        • departmentstring

          ISO20022: Identification of a division of a large organisation or building.

          ISO20022: Identification of a division of a large organisation or building. API: Cannot be used for SEPA payments.

          Constraints: maxLength: 70

        • subDepartmentstring

          ISO20022: Identification of a sub-division of a large organisation or building.

          ISO20022: Identification of a sub-division of a large organisation or building. API: Cannot be used for SEPA payments.

          Constraints: maxLength: 70

        • streetNamestring

          ISO20022: Name of a street or thoroughfare.

          ISO20022: Name of a street or thoroughfare. API: Cannot be used for SEPA payments.

          Constraints: maxLength: 70

        • buildingNumberstring

          ISO20022: Number that identifies the position of a building on a street.

          ISO20022: Number that identifies the position of a building on a street. API: Cannot be used for SEPA payments.

          Constraints: maxLength: 16

        • buildingNamestring

          ISO20022: Name of the building or house.

          ISO20022: Name of the building or house. API: Cannot be used for SEPA payments.

          Constraints: maxLength: 16

        • postCodestring

          ISO20022: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

          ISO20022: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. API: Cannot be used for SEPA payments.

          Constraints: maxLength: 16

        • townNamestring

          ISO20022: Name of a built-up area, with defined boundaries, and a local government.

          ISO20022: Name of a built-up area, with defined boundaries, and a local government. API: Cannot be used for SEPA payments.

          Constraints: maxLength: 35

        • countrySubDivisionstring

          ISO20022: Identifies a subdivision of a country such as state, region, county.

          ISO20022: Identifies a subdivision of a country such as state, region, county. API: Cannot be used for SEPA payments.

          Constraints: maxLength: 35

        • 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>

          Unstructured address. The lines must embed zip code and town name.

          Unstructured address. The lines must embed zip code and town name. For SEPA payments, only two address lines are allowed.

          Type: array<string>

          Item: Address line

          Item constraints: maxLength: 70

      • contactDetailsContactDetails

        Indicates how to contact the party.

        Schema: ContactDetails

        Indicates how to contact the party.

        • phoneNumberPhoneNumber

          The collection of information which identifies a specific phone or FAX number as defined by telecom services.

          Schema: PhoneNumber

          The collection of information which identifies a specific phone or FAX number as defined by telecom services. It consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).

          Type: string

          Constraints: pattern: `^\+[0-9]{1,3}-[0-9()+\-]{1,30}$`

        • faxNumberPhoneNumber

          The collection of information which identifies a specific phone or FAX number as defined by telecom services.

          Schema: PhoneNumber

          The collection of information which identifies a specific phone or FAX number as defined by telecom services. It consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).

          Type: string

          Constraints: pattern: `^\+[0-9]{1,3}-[0-9()+\-]{1,30}$`

        • emailAddressstring

          email address of the contact

          Constraints: maxLength: 2048 · pattern: `^.+@.+$`

      • organisationIdGenericIdentification

        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:

          Code	Name	Description
          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.
          BBAN	BBANIdentifier	Basic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer.
          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:
          Code	Name	Description
          ----	----	-----------
          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
          MPAN	MaskedPan	Card PAN where some digits were replaced for security reason
          TPAN	TokenizedPan	Token which was provided by a Token Service Provider (TSP) in order to obfuscate a real card PAN. The TSP must be identified in the issuer field
          TBAN	TokenizedIBAN	Token which was provided by a Token Service Provider (TSP) in order to obfuscate an IBAN. The TSP must be identified in the issuer field
          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

        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:

          Code	Name	Description
          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.
          BBAN	BBANIdentifier	Basic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer.
          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:
          Code	Name	Description
          ----	----	-----------
          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
          MPAN	MaskedPan	Card PAN where some digits were replaced for security reason
          TPAN	TokenizedPan	Token which was provided by a Token Service Provider (TSP) in order to obfuscate a real card PAN. The TSP must be identified in the issuer field
          TBAN	TokenizedIBAN	Token which was provided by a Token Service Provider (TSP) in order to obfuscate an IBAN. The TSP must be identified in the issuer field
          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

      • leiLeiIdentification

        Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

        Schema: LeiIdentification

        Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

        Type: string

        Constraints: pattern: `^[A-Z0-9]{18,18}[0-9]{2,2}$`

    • intermediaryAgentIntermediaryAgent

      Agent and agent account between the debtor's agent and the creditor's agent.

      Schema: IntermediaryAgent

      Agent and agent account between the debtor's agent and the creditor's agent.

      • agentPartyIdentification

        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. The [organisationId] property allows the specification of an unique and unambiguous way to identify an organisation. The [privateId] property allows the specification of an unique and unambiguous way to identify a person.

          Constraints: maxLength: 140

        • dateAndPlaceOfBirthDateAndPlaceOfBirth

          Date and place of birth of a person.

          Schema: DateAndPlaceOfBirth

          Date and place of birth of a person. This information must be requested for detection of Fraud, Money-Laundering and Terrorism Financing in case of international payment.

          • birthDatestring (date)ISO 8601required

            Date on which a person is born.

          • cityOfBirthstringrequired

            City where a person was born.

            Constraints: maxLength: 35

          • countryOfBirthstringrequired

            Country where a person was born.

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

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

          • addressTypestringenum · 6

            ISO20022: Identifies the nature of the postal address.

            ISO20022: Identifies the nature of the postal address. API: Cannot be used for SEPA payments. Proprietary codes can be specified and documented if needed.

            Code	Name	Description
            BIZZ	Business	Address is the business address
            DLVY	Delivery	Address is the address to which delivery is to take place
            MLTO	Mail To	Address is the address to which mail is sent
            PBOX	PO Box	Address is is a postal office (PO) box
            ADDR	Postal	Address is the complete postal address
            HOME	Home	Address is the home address

          • departmentstring

            ISO20022: Identification of a division of a large organisation or building.

            ISO20022: Identification of a division of a large organisation or building. API: Cannot be used for SEPA payments.

            Constraints: maxLength: 70

          • subDepartmentstring

            ISO20022: Identification of a sub-division of a large organisation or building.

            ISO20022: Identification of a sub-division of a large organisation or building. API: Cannot be used for SEPA payments.

            Constraints: maxLength: 70

          • streetNamestring

            ISO20022: Name of a street or thoroughfare.

            ISO20022: Name of a street or thoroughfare. API: Cannot be used for SEPA payments.

            Constraints: maxLength: 70

          • buildingNumberstring

            ISO20022: Number that identifies the position of a building on a street.

            ISO20022: Number that identifies the position of a building on a street. API: Cannot be used for SEPA payments.

            Constraints: maxLength: 16

          • buildingNamestring

            ISO20022: Name of the building or house.

            ISO20022: Name of the building or house. API: Cannot be used for SEPA payments.

            Constraints: maxLength: 16

          • postCodestring

            ISO20022: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

            ISO20022: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. API: Cannot be used for SEPA payments.

            Constraints: maxLength: 16

          • townNamestring

            ISO20022: Name of a built-up area, with defined boundaries, and a local government.

            ISO20022: Name of a built-up area, with defined boundaries, and a local government. API: Cannot be used for SEPA payments.

            Constraints: maxLength: 35

          • countrySubDivisionstring

            ISO20022: Identifies a subdivision of a country such as state, region, county.

            ISO20022: Identifies a subdivision of a country such as state, region, county. API: Cannot be used for SEPA payments.

            Constraints: maxLength: 35

          • 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>

            Unstructured address. The lines must embed zip code and town name.

            Unstructured address. The lines must embed zip code and town name. For SEPA payments, only two address lines are allowed.

            Type: array<string>

            Item: Address line

            Item constraints: maxLength: 70

        • contactDetailsContactDetails

          Indicates how to contact the party.

          Schema: ContactDetails

          Indicates how to contact the party.

          • phoneNumberPhoneNumber

            The collection of information which identifies a specific phone or FAX number as defined by telecom services.

            Schema: PhoneNumber

            The collection of information which identifies a specific phone or FAX number as defined by telecom services. It consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).

            Type: string

            Constraints: pattern: `^\+[0-9]{1,3}-[0-9()+\-]{1,30}$`

          • faxNumberPhoneNumber

            The collection of information which identifies a specific phone or FAX number as defined by telecom services.

            Schema: PhoneNumber

            The collection of information which identifies a specific phone or FAX number as defined by telecom services. It consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).

            Type: string

            Constraints: pattern: `^\+[0-9]{1,3}-[0-9()+\-]{1,30}$`

          • emailAddressstring

            email address of the contact

            Constraints: maxLength: 2048 · pattern: `^.+@.+$`

        • organisationIdGenericIdentification

          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:

            Code	Name	Description
            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.
            BBAN	BBANIdentifier	Basic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer.
            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:
            Code	Name	Description
            ----	----	-----------
            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
            MPAN	MaskedPan	Card PAN where some digits were replaced for security reason
            TPAN	TokenizedPan	Token which was provided by a Token Service Provider (TSP) in order to obfuscate a real card PAN. The TSP must be identified in the issuer field
            TBAN	TokenizedIBAN	Token which was provided by a Token Service Provider (TSP) in order to obfuscate an IBAN. The TSP must be identified in the issuer field
            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

          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:

            Code	Name	Description
            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.
            BBAN	BBANIdentifier	Basic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer.
            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:
            Code	Name	Description
            ----	----	-----------
            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
            MPAN	MaskedPan	Card PAN where some digits were replaced for security reason
            TPAN	TokenizedPan	Token which was provided by a Token Service Provider (TSP) in order to obfuscate a real card PAN. The TSP must be identified in the issuer field
            TBAN	TokenizedIBAN	Token which was provided by a Token Service Provider (TSP) in order to obfuscate an IBAN. The TSP must be identified in the issuer field
            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

        • leiLeiIdentification

          Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

          Schema: LeiIdentification

          Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

          Type: string

          Constraints: pattern: `^[A-Z0-9]{18,18}[0-9]{2,2}$`

      • agentAccountAccountIdentification

        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. Card accounts must provide the identification of the card through the "other" substructure by giving, for instance, the masked PAN (MPAN). The currency used for the account, when needed, can be specified through the [currency] field.

        • workspacestring

          Workspace to which the account is linked.

          Workspace to which the account is linked. This workspace might be specified by the AISP when forwarding the consent on accounts. If not provided, the default workspace is computed from the authentication that was used for getting the OAuth2 Access Token.

          Constraints: maxLength: 32

        • 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:

            Code	Name	Description
            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.
            BBAN	BBANIdentifier	Basic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer.
            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:
            Code	Name	Description
            ----	----	-----------
            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
            MPAN	MaskedPan	Card PAN where some digits were replaced for security reason
            TPAN	TokenizedPan	Token which was provided by a Token Service Provider (TSP) in order to obfuscate a real card PAN. The TSP must be identified in the issuer field
            TBAN	TokenizedIBAN	Token which was provided by a Token Service Provider (TSP) in order to obfuscate an IBAN. The TSP must be identified in the issuer field
            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

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

    • beneficiaryBeneficiaryrequired

      Specification of a beneficiary

      Schema: Beneficiary

      Specification of a beneficiary

      • workspaceWorkspace

        Some ASPSP may provide different user workspaces that can be accessed by the same authenticated PSU. In this case, the AISP is able to retrieve the different pieces of account information by specifying the relevant workspace as a QUERY parameter. Identification of the workspace to be used when processing the request. If not present, the default workspace to be used is the one that is linked to the authentication processed during the OAuth2 access token request.

        Schema: Workspace

        Some ASPSP may provide different user workspaces that can be accessed by the same authenticated PSU. In this case, the AISP is able to retrieve the different pieces of account information by specifying the relevant workspace as a QUERY parameter. Identification of the workspace to be used when processing the request. If not present, the default workspace to be used is the one that is linked to the authentication processed during the OAuth2 access token request.

        • identificationstringrequired

          identification of the workspace to be used as an optional query parameter for some AISP queries

          Constraints: maxLength: 32

        • labelstringrequired

          textual description of the workspace as specified by the ASPSP in relationship wth the PSU

          Constraints: maxLength: 128

      • idstring

        Id of the beneficiary

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

      • 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 was 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

          • clearingSystemIdstringrequired

            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

          • memberIdstringrequired

            ISO20022: Identification of a member of a clearing system.

            ISO20022: Identification of a member of a clearing system.

            Constraints: maxLength: 35

        • leiLeiIdentification

          Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

          Schema: LeiIdentification

          Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

          Type: string

          Constraints: pattern: `^[A-Z0-9]{18,18}[0-9]{2,2}$`

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

          • addressTypestringenum · 6

            ISO20022: Identifies the nature of the postal address.

            ISO20022: Identifies the nature of the postal address. API: Cannot be used for SEPA payments. Proprietary codes can be specified and documented if needed.

            Code	Name	Description
            BIZZ	Business	Address is the business address
            DLVY	Delivery	Address is the address to which delivery is to take place
            MLTO	Mail To	Address is the address to which mail is sent
            PBOX	PO Box	Address is is a postal office (PO) box
            ADDR	Postal	Address is the complete postal address
            HOME	Home	Address is the home address

          • departmentstring

            ISO20022: Identification of a division of a large organisation or building.

            ISO20022: Identification of a division of a large organisation or building. API: Cannot be used for SEPA payments.

            Constraints: maxLength: 70

          • subDepartmentstring

            ISO20022: Identification of a sub-division of a large organisation or building.

            ISO20022: Identification of a sub-division of a large organisation or building. API: Cannot be used for SEPA payments.

            Constraints: maxLength: 70

          • streetNamestring

            ISO20022: Name of a street or thoroughfare.

            ISO20022: Name of a street or thoroughfare. API: Cannot be used for SEPA payments.

            Constraints: maxLength: 70

          • buildingNumberstring

            ISO20022: Number that identifies the position of a building on a street.

            ISO20022: Number that identifies the position of a building on a street. API: Cannot be used for SEPA payments.

            Constraints: maxLength: 16

          • buildingNamestring

            ISO20022: Name of the building or house.

            ISO20022: Name of the building or house. API: Cannot be used for SEPA payments.

            Constraints: maxLength: 16

          • postCodestring

            ISO20022: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

            ISO20022: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. API: Cannot be used for SEPA payments.

            Constraints: maxLength: 16

          • townNamestring

            ISO20022: Name of a built-up area, with defined boundaries, and a local government.

            ISO20022: Name of a built-up area, with defined boundaries, and a local government. API: Cannot be used for SEPA payments.

            Constraints: maxLength: 35

          • countrySubDivisionstring

            ISO20022: Identifies a subdivision of a country such as state, region, county.

            ISO20022: Identifies a subdivision of a country such as state, region, county. API: Cannot be used for SEPA payments.

            Constraints: maxLength: 35

          • 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>

            Unstructured address. The lines must embed zip code and town name.

            Unstructured address. The lines must embed zip code and town name. 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. The [organisationId] property allows the specification of an unique and unambiguous way to identify an organisation. The [privateId] property allows the specification of an unique and unambiguous way to identify a person.

          Constraints: maxLength: 140

        • dateAndPlaceOfBirthDateAndPlaceOfBirth

          Date and place of birth of a person.

          Schema: DateAndPlaceOfBirth

          Date and place of birth of a person. This information must be requested for detection of Fraud, Money-Laundering and Terrorism Financing in case of international payment.

          • birthDatestring (date)ISO 8601required

            Date on which a person is born.

          • cityOfBirthstringrequired

            City where a person was born.

            Constraints: maxLength: 35

          • countryOfBirthstringrequired

            Country where a person was born.

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

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

          • addressTypestringenum · 6

            ISO20022: Identifies the nature of the postal address.

            ISO20022: Identifies the nature of the postal address. API: Cannot be used for SEPA payments. Proprietary codes can be specified and documented if needed.

            Code	Name	Description
            BIZZ	Business	Address is the business address
            DLVY	Delivery	Address is the address to which delivery is to take place
            MLTO	Mail To	Address is the address to which mail is sent
            PBOX	PO Box	Address is is a postal office (PO) box
            ADDR	Postal	Address is the complete postal address
            HOME	Home	Address is the home address

          • departmentstring

            ISO20022: Identification of a division of a large organisation or building.

            ISO20022: Identification of a division of a large organisation or building. API: Cannot be used for SEPA payments.

            Constraints: maxLength: 70

          • subDepartmentstring

            ISO20022: Identification of a sub-division of a large organisation or building.

            ISO20022: Identification of a sub-division of a large organisation or building. API: Cannot be used for SEPA payments.

            Constraints: maxLength: 70

          • streetNamestring

            ISO20022: Name of a street or thoroughfare.

            ISO20022: Name of a street or thoroughfare. API: Cannot be used for SEPA payments.

            Constraints: maxLength: 70

          • buildingNumberstring

            ISO20022: Number that identifies the position of a building on a street.

            ISO20022: Number that identifies the position of a building on a street. API: Cannot be used for SEPA payments.

            Constraints: maxLength: 16

          • buildingNamestring

            ISO20022: Name of the building or house.

            ISO20022: Name of the building or house. API: Cannot be used for SEPA payments.

            Constraints: maxLength: 16

          • postCodestring

            ISO20022: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

            ISO20022: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. API: Cannot be used for SEPA payments.

            Constraints: maxLength: 16

          • townNamestring

            ISO20022: Name of a built-up area, with defined boundaries, and a local government.

            ISO20022: Name of a built-up area, with defined boundaries, and a local government. API: Cannot be used for SEPA payments.

            Constraints: maxLength: 35

          • countrySubDivisionstring

            ISO20022: Identifies a subdivision of a country such as state, region, county.

            ISO20022: Identifies a subdivision of a country such as state, region, county. API: Cannot be used for SEPA payments.

            Constraints: maxLength: 35

          • 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>

            Unstructured address. The lines must embed zip code and town name.

            Unstructured address. The lines must embed zip code and town name. For SEPA payments, only two address lines are allowed.

            Type: array<string>

            Item: Address line

            Item constraints: maxLength: 70

        • contactDetailsContactDetails

          Indicates how to contact the party.

          Schema: ContactDetails

          Indicates how to contact the party.

          • phoneNumberPhoneNumber

            The collection of information which identifies a specific phone or FAX number as defined by telecom services.

            Schema: PhoneNumber

            The collection of information which identifies a specific phone or FAX number as defined by telecom services. It consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).

            Type: string

            Constraints: pattern: `^\+[0-9]{1,3}-[0-9()+\-]{1,30}$`

          • faxNumberPhoneNumber

            The collection of information which identifies a specific phone or FAX number as defined by telecom services.

            Schema: PhoneNumber

            The collection of information which identifies a specific phone or FAX number as defined by telecom services. It consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).

            Type: string

            Constraints: pattern: `^\+[0-9]{1,3}-[0-9()+\-]{1,30}$`

          • emailAddressstring

            email address of the contact

            Constraints: maxLength: 2048 · pattern: `^.+@.+$`

        • organisationIdGenericIdentification

          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:

            Code	Name	Description
            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.
            BBAN	BBANIdentifier	Basic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer.
            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:
            Code	Name	Description
            ----	----	-----------
            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
            MPAN	MaskedPan	Card PAN where some digits were replaced for security reason
            TPAN	TokenizedPan	Token which was provided by a Token Service Provider (TSP) in order to obfuscate a real card PAN. The TSP must be identified in the issuer field
            TBAN	TokenizedIBAN	Token which was provided by a Token Service Provider (TSP) in order to obfuscate an IBAN. The TSP must be identified in the issuer field
            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

          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:

            Code	Name	Description
            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.
            BBAN	BBANIdentifier	Basic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer.
            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:
            Code	Name	Description
            ----	----	-----------
            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
            MPAN	MaskedPan	Card PAN where some digits were replaced for security reason
            TPAN	TokenizedPan	Token which was provided by a Token Service Provider (TSP) in order to obfuscate a real card PAN. The TSP must be identified in the issuer field
            TBAN	TokenizedIBAN	Token which was provided by a Token Service Provider (TSP) in order to obfuscate an IBAN. The TSP must be identified in the issuer field
            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

        • leiLeiIdentification

          Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

          Schema: LeiIdentification

          Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

          Type: string

          Constraints: pattern: `^[A-Z0-9]{18,18}[0-9]{2,2}$`

      • 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. Card accounts must provide the identification of the card through the "other" substructure by giving, for instance, the masked PAN (MPAN). The currency used for the account, when needed, can be specified through the [currency] field.

        • workspacestring

          Workspace to which the account is linked.

          Workspace to which the account is linked. This workspace might be specified by the AISP when forwarding the consent on accounts. If not provided, the default workspace is computed from the authentication that was used for getting the OAuth2 Access Token.

          Constraints: maxLength: 32

        • 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:

            Code	Name	Description
            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.
            BBAN	BBANIdentifier	Basic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer.
            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:
            Code	Name	Description
            ----	----	-----------
            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
            MPAN	MaskedPan	Card PAN where some digits were replaced for security reason
            TPAN	TokenizedPan	Token which was provided by a Token Service Provider (TSP) in order to obfuscate a real card PAN. The TSP must be identified in the issuer field
            TBAN	TokenizedIBAN	Token which was provided by a Token Service Provider (TSP) in order to obfuscate an IBAN. The TSP must be identified in the issuer field
            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

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

    • 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. The [organisationId] property allows the specification of an unique and unambiguous way to identify an organisation. The [privateId] property allows the specification of an unique and unambiguous way to identify a person.

        Constraints: maxLength: 140

      • dateAndPlaceOfBirthDateAndPlaceOfBirth

        Date and place of birth of a person.

        Schema: DateAndPlaceOfBirth

        Date and place of birth of a person. This information must be requested for detection of Fraud, Money-Laundering and Terrorism Financing in case of international payment.

        • birthDatestring (date)ISO 8601required

          Date on which a person is born.

        • cityOfBirthstringrequired

          City where a person was born.

          Constraints: maxLength: 35

        • countryOfBirthstringrequired

          Country where a person was born.

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

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

        • addressTypestringenum · 6

          ISO20022: Identifies the nature of the postal address.

          ISO20022: Identifies the nature of the postal address. API: Cannot be used for SEPA payments. Proprietary codes can be specified and documented if needed.

          Code	Name	Description
          BIZZ	Business	Address is the business address
          DLVY	Delivery	Address is the address to which delivery is to take place
          MLTO	Mail To	Address is the address to which mail is sent
          PBOX	PO Box	Address is is a postal office (PO) box
          ADDR	Postal	Address is the complete postal address
          HOME	Home	Address is the home address

        • departmentstring

          ISO20022: Identification of a division of a large organisation or building.

          ISO20022: Identification of a division of a large organisation or building. API: Cannot be used for SEPA payments.

          Constraints: maxLength: 70

        • subDepartmentstring

          ISO20022: Identification of a sub-division of a large organisation or building.

          ISO20022: Identification of a sub-division of a large organisation or building. API: Cannot be used for SEPA payments.

          Constraints: maxLength: 70

        • streetNamestring

          ISO20022: Name of a street or thoroughfare.

          ISO20022: Name of a street or thoroughfare. API: Cannot be used for SEPA payments.

          Constraints: maxLength: 70

        • buildingNumberstring

          ISO20022: Number that identifies the position of a building on a street.

          ISO20022: Number that identifies the position of a building on a street. API: Cannot be used for SEPA payments.

          Constraints: maxLength: 16

        • buildingNamestring

          ISO20022: Name of the building or house.

          ISO20022: Name of the building or house. API: Cannot be used for SEPA payments.

          Constraints: maxLength: 16

        • postCodestring

          ISO20022: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

          ISO20022: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. API: Cannot be used for SEPA payments.

          Constraints: maxLength: 16

        • townNamestring

          ISO20022: Name of a built-up area, with defined boundaries, and a local government.

          ISO20022: Name of a built-up area, with defined boundaries, and a local government. API: Cannot be used for SEPA payments.

          Constraints: maxLength: 35

        • countrySubDivisionstring

          ISO20022: Identifies a subdivision of a country such as state, region, county.

          ISO20022: Identifies a subdivision of a country such as state, region, county. API: Cannot be used for SEPA payments.

          Constraints: maxLength: 35

        • 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>

          Unstructured address. The lines must embed zip code and town name.

          Unstructured address. The lines must embed zip code and town name. For SEPA payments, only two address lines are allowed.

          Type: array<string>

          Item: Address line

          Item constraints: maxLength: 70

      • contactDetailsContactDetails

        Indicates how to contact the party.

        Schema: ContactDetails

        Indicates how to contact the party.

        • phoneNumberPhoneNumber

          The collection of information which identifies a specific phone or FAX number as defined by telecom services.

          Schema: PhoneNumber

          The collection of information which identifies a specific phone or FAX number as defined by telecom services. It consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).

          Type: string

          Constraints: pattern: `^\+[0-9]{1,3}-[0-9()+\-]{1,30}$`

        • faxNumberPhoneNumber

          The collection of information which identifies a specific phone or FAX number as defined by telecom services.

          Schema: PhoneNumber

          The collection of information which identifies a specific phone or FAX number as defined by telecom services. It consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).

          Type: string

          Constraints: pattern: `^\+[0-9]{1,3}-[0-9()+\-]{1,30}$`

        • emailAddressstring

          email address of the contact

          Constraints: maxLength: 2048 · pattern: `^.+@.+$`

      • organisationIdGenericIdentification

        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:

          Code	Name	Description
          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.
          BBAN	BBANIdentifier	Basic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer.
          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:
          Code	Name	Description
          ----	----	-----------
          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
          MPAN	MaskedPan	Card PAN where some digits were replaced for security reason
          TPAN	TokenizedPan	Token which was provided by a Token Service Provider (TSP) in order to obfuscate a real card PAN. The TSP must be identified in the issuer field
          TBAN	TokenizedIBAN	Token which was provided by a Token Service Provider (TSP) in order to obfuscate an IBAN. The TSP must be identified in the issuer field
          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

        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:

          Code	Name	Description
          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.
          BBAN	BBANIdentifier	Basic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer.
          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:
          Code	Name	Description
          ----	----	-----------
          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
          MPAN	MaskedPan	Card PAN where some digits were replaced for security reason
          TPAN	TokenizedPan	Token which was provided by a Token Service Provider (TSP) in order to obfuscate a real card PAN. The TSP must be identified in the issuer field
          TBAN	TokenizedIBAN	Token which was provided by a Token Service Provider (TSP) in order to obfuscate an IBAN. The TSP must be identified in the issuer field
          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

      • leiLeiIdentification

        Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

        Schema: LeiIdentification

        Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

        Type: string

        Constraints: pattern: `^[A-Z0-9]{18,18}[0-9]{2,2}$`

    • instructionForCreditorAgentarray<InstructionForCreditorAgent>

      Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.

      Item: InstructionForCreditorAgent

      Further information related to the processing of the payment instruction that may need to be acted upon by the creditor's agent. The instruction may relate to a level of service, or may be an instruction that has to be executed by the creditor's agent, or may be information required by the creditor's agent.

      • codestringenum · 4

        Coded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.

        Code	Name	Description
        CHQB	PayCreditorByCheque	(Ultimate) creditor must be paid by cheque.
        HOLD	HoldCashForCreditor	Amount of money must be held for the (ultimate) creditor, who will call. Pay on identification.
        PHOB	PhoneBeneficiary	Please advise/contact (ultimate) creditor/claimant by phone.
        TELB	Telecom	Please advise/contact (ultimate) creditor/claimant by the most efficient means of telecommunication.

      • instructionInformationstring

        Further information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community.

        Constraints: maxLength: 140

    • purposePurposeCode

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

      Schema: PurposeCode

      Code	Name	Description
      ACCT	AccountManagement	Funds moved between 2 accounts of same account holder at the same bank)
      CASH	CashManagementTransfer	(general cash management instruction) may be used for Transfer Initiation
      COMC	CommercialPayment	Transaction is related to a payment of commercial credit or debit.
      CPKC	CarparkCharges	General Carpark Charges Transaction is related to carpark charges.
      SALA	SalaryPayment	Transaction is the payment of salaries.
      TRPT	RoadPricing	Transport RoadPricing Transaction is for the payment to top-up pre-paid card and electronic road pricing for the purpose of transportation.

    • regulatoryReportingCodesRegulatoryReportingCodes

      List of needed regulatory reporting codes for international payments

      Schema: RegulatoryReportingCodes

      Type: array<string>

      List of needed regulatory reporting codes for international payments

    • remittanceInformationRemittanceInformation

      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: RemittanceInformation

      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 of the unstructured information is allowed.
      • Only one occurrence of the structured information is allowed.
      • Structured and unstructured information can coexist.

      • unstructuredarray<string>

        Unstructured remittance information.

        Unstructured remittance information. Each implementation may add a pattern in order to specify its own character set constraints.

        Type: array<string>

        Item: Relevant information to the transaction

        Item constraints: maxLength: 140

      • structuredarray<StructuredRemittanceInformation>

        Structured remittance information

        Item: StructuredRemittanceInformation

        Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in a structured form.

        • referredDocumentInformationReferredDocumentInformations

          Provides the identification and the content of the referred documents.

          Item: ReferredDocumentInformation

          Provides the identification and the content of the referred document.

          • typeCodeAndIssuer

            Specifies a code and the issuer of this code.

            Schema: CodeAndIssuer

            Specifies a code and the issuer of this code.

            • codestringrequired

              Provides the code.

              Constraints: maxLength: 4

            • issuerstring

              Identification of the issuer of the code.

              Constraints: maxLength: 35

          • numberstring

            Unique and unambiguous identification of the referred document.

            Constraints: maxLength: 35

          • relatedDatestring (date)ISO 8601

            Date associated with the referred document.

          • lineDetailsarray<LineDetail>

            Sets of elements used to provide the content of the referred document line.

            Item: LineDetail

            Set of elements used to provide the content of the referred document line.

            • identificationDocumentLineIdentification

              Provides identification of the document line.

              Schema: DocumentLineIdentification

            • descriptionstring

              Description associated with the document line.

              Constraints: maxLength: 2048

            • amountRemittanceAmount

              ISO20022: Provides details on the amounts of the document line.

              Schema: RemittanceAmount

        • referredDocumentAmountRemittanceAmount

          ISO20022: Provides details on the amounts of the document line.

          Schema: RemittanceAmount

          ISO20022: Provides details on the amounts of the document line. API: Amounts must always be set as positive values.

          Property	Description
          duePayableAmount	Amount specified is the exact amount due and payable to the creditor.
          discountAppliedAmount	Amount of discount to be applied to the amount due and payable to the creditor.
          creditNoteAmount	Amount of a credit note.
          taxAmount	Amount of the tax.
          adjustmentAmountAndReason	Specifies detailed information on the amount and reason of the adjustment.
          remittedAmount	Amount of money remitted.

          • duePayableAmountAmountType

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

            Schema: AmountType

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

            • amountnumber (float)required

              ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.

              ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.

              Constraints: pattern: `^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$`

            • currencyCurrencyCodeISO 4217required

              Specifies the currency of the amount or of the account.

              Schema: CurrencyCode

              Specifies the currency of the amount or of the account. A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

              Type: string

              Constraints: pattern: `^[A-Z]{3,3}$`

          • discountAppliedAmountTypedAmount

            ISO20022: Typed Amount

            Schema: TypedAmount

            ISO20022: Typed Amount API: Amounts must always be set as positive values.

            • typestring

              Type of the amount

              Constraints: maxLength: 35

            • amountAmountTyperequired

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

              Schema: AmountType

          • creditNoteAmountAmountType

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

            Schema: AmountType

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

            • amountnumber (float)required

              ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.

              ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.

              Constraints: pattern: `^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$`

            • currencyCurrencyCodeISO 4217required

              Specifies the currency of the amount or of the account.

              Schema: CurrencyCode

              Specifies the currency of the amount or of the account. A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

              Type: string

              Constraints: pattern: `^[A-Z]{3,3}$`

          • taxAmountTypedAmount

            ISO20022: Typed Amount

            Schema: TypedAmount

            ISO20022: Typed Amount API: Amounts must always be set as positive values.

            • typestring

              Type of the amount

              Constraints: maxLength: 35

            • amountAmountTyperequired

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

              Schema: AmountType

          • adjustmentAmountAndReasonDocumentAdjustment

            ISO20022: Specifies detailed information on the amount and reason of the adjustment.

            Schema: DocumentAdjustment

            ISO20022: Specifies detailed information on the amount and reason of the adjustment. API: Amounts must always be set as positive values.

            • amountAmountTyperequired

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

              Schema: AmountType

            • creditDebitIndicatorCreditDebitIndicator

              Accounting flow of the amount

              Schema: CreditDebitIndicator

              Code	Description
              CRDT	Credit type amount
              DBIT	Debit type amount

            • reasonstring

              Specifies the reason for the adjustment.

              Constraints: maxLength: 4

            • additionalInformationstring

              Provides further details on the document adjustment.

              Constraints: maxLength: 140

          • remittedAmountAmountType

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

            Schema: AmountType

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

            • amountnumber (float)required

              ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.

              ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.

              Constraints: pattern: `^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$`

            • currencyCurrencyCodeISO 4217required

              Specifies the currency of the amount or of the account.

              Schema: CurrencyCode

              Specifies the currency of the amount or of the account. A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

              Type: string

              Constraints: pattern: `^[A-Z]{3,3}$`

        • creditorReferenceInformationCreditorReferenceInformation

          Reference information provided by the creditor to allow the identification of the underlying documents.

          Schema: CreditorReferenceInformation

          Reference information provided by the creditor to allow the identification of the underlying documents.

          • typeCodeAndIssuer

            Specifies a code and the issuer of this code.

            Schema: CodeAndIssuer

            Specifies a code and the issuer of this code.

            • codestringrequired

              Provides the code.

              Constraints: maxLength: 4

            • issuerstring

              Identification of the issuer of the code.

              Constraints: maxLength: 35

          • referencestring

            Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.

            Constraints: maxLength: 35

        • invoicerPartyIdentification

          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. The [organisationId] property allows the specification of an unique and unambiguous way to identify an organisation. The [privateId] property allows the specification of an unique and unambiguous way to identify a person.

            Constraints: maxLength: 140

          • dateAndPlaceOfBirthDateAndPlaceOfBirth

            Date and place of birth of a person.

            Schema: DateAndPlaceOfBirth

            Date and place of birth of a person. This information must be requested for detection of Fraud, Money-Laundering and Terrorism Financing in case of international payment.

            • birthDatestring (date)ISO 8601required

              Date on which a person is born.

            • cityOfBirthstringrequired

              City where a person was born.

              Constraints: maxLength: 35

            • countryOfBirthstringrequired

              Country where a person was born.

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

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

            • addressTypestringenum · 6

              ISO20022: Identifies the nature of the postal address.

              ISO20022: Identifies the nature of the postal address. API: Cannot be used for SEPA payments. Proprietary codes can be specified and documented if needed.

              Code	Name	Description
              BIZZ	Business	Address is the business address
              DLVY	Delivery	Address is the address to which delivery is to take place
              MLTO	Mail To	Address is the address to which mail is sent
              PBOX	PO Box	Address is is a postal office (PO) box
              ADDR	Postal	Address is the complete postal address
              HOME	Home	Address is the home address

            • departmentstring

              ISO20022: Identification of a division of a large organisation or building.

              ISO20022: Identification of a division of a large organisation or building. API: Cannot be used for SEPA payments.

              Constraints: maxLength: 70

            • subDepartmentstring

              ISO20022: Identification of a sub-division of a large organisation or building.

              ISO20022: Identification of a sub-division of a large organisation or building. API: Cannot be used for SEPA payments.

              Constraints: maxLength: 70

            • streetNamestring

              ISO20022: Name of a street or thoroughfare.

              ISO20022: Name of a street or thoroughfare. API: Cannot be used for SEPA payments.

              Constraints: maxLength: 70

            • buildingNumberstring

              ISO20022: Number that identifies the position of a building on a street.

              ISO20022: Number that identifies the position of a building on a street. API: Cannot be used for SEPA payments.

              Constraints: maxLength: 16

            • buildingNamestring

              ISO20022: Name of the building or house.

              ISO20022: Name of the building or house. API: Cannot be used for SEPA payments.

              Constraints: maxLength: 16

            • postCodestring

              ISO20022: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

              ISO20022: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. API: Cannot be used for SEPA payments.

              Constraints: maxLength: 16

            • townNamestring

              ISO20022: Name of a built-up area, with defined boundaries, and a local government.

              ISO20022: Name of a built-up area, with defined boundaries, and a local government. API: Cannot be used for SEPA payments.

              Constraints: maxLength: 35

            • countrySubDivisionstring

              ISO20022: Identifies a subdivision of a country such as state, region, county.

              ISO20022: Identifies a subdivision of a country such as state, region, county. API: Cannot be used for SEPA payments.

              Constraints: maxLength: 35

            • 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>

              Unstructured address. The lines must embed zip code and town name.

              Unstructured address. The lines must embed zip code and town name. For SEPA payments, only two address lines are allowed.

              Type: array<string>

              Item: Address line

              Item constraints: maxLength: 70

          • contactDetailsContactDetails

            Indicates how to contact the party.

            Schema: ContactDetails

            Indicates how to contact the party.

            • phoneNumberPhoneNumber

              The collection of information which identifies a specific phone or FAX number as defined by telecom services.

              Schema: PhoneNumber

              The collection of information which identifies a specific phone or FAX number as defined by telecom services. It consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).

              Type: string

              Constraints: pattern: `^\+[0-9]{1,3}-[0-9()+\-]{1,30}$`

            • faxNumberPhoneNumber

              The collection of information which identifies a specific phone or FAX number as defined by telecom services.

              Schema: PhoneNumber

              The collection of information which identifies a specific phone or FAX number as defined by telecom services. It consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).

              Type: string

              Constraints: pattern: `^\+[0-9]{1,3}-[0-9()+\-]{1,30}$`

            • emailAddressstring

              email address of the contact

              Constraints: maxLength: 2048 · pattern: `^.+@.+$`

          • organisationIdGenericIdentification

            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:

              Code	Name	Description
              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.
              BBAN	BBANIdentifier	Basic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer.
              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:
              Code	Name	Description
              ----	----	-----------
              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
              MPAN	MaskedPan	Card PAN where some digits were replaced for security reason
              TPAN	TokenizedPan	Token which was provided by a Token Service Provider (TSP) in order to obfuscate a real card PAN. The TSP must be identified in the issuer field
              TBAN	TokenizedIBAN	Token which was provided by a Token Service Provider (TSP) in order to obfuscate an IBAN. The TSP must be identified in the issuer field
              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

            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:

              Code	Name	Description
              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.
              BBAN	BBANIdentifier	Basic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer.
              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:
              Code	Name	Description
              ----	----	-----------
              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
              MPAN	MaskedPan	Card PAN where some digits were replaced for security reason
              TPAN	TokenizedPan	Token which was provided by a Token Service Provider (TSP) in order to obfuscate a real card PAN. The TSP must be identified in the issuer field
              TBAN	TokenizedIBAN	Token which was provided by a Token Service Provider (TSP) in order to obfuscate an IBAN. The TSP must be identified in the issuer field
              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

          • leiLeiIdentification

            Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

            Schema: LeiIdentification

            Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

            Type: string

            Constraints: pattern: `^[A-Z0-9]{18,18}[0-9]{2,2}$`

        • invoiceePartyIdentification

          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. The [organisationId] property allows the specification of an unique and unambiguous way to identify an organisation. The [privateId] property allows the specification of an unique and unambiguous way to identify a person.

            Constraints: maxLength: 140

          • dateAndPlaceOfBirthDateAndPlaceOfBirth

            Date and place of birth of a person.

            Schema: DateAndPlaceOfBirth

            Date and place of birth of a person. This information must be requested for detection of Fraud, Money-Laundering and Terrorism Financing in case of international payment.

            • birthDatestring (date)ISO 8601required

              Date on which a person is born.

            • cityOfBirthstringrequired

              City where a person was born.

              Constraints: maxLength: 35

            • countryOfBirthstringrequired

              Country where a person was born.

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

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

            • addressTypestringenum · 6

              ISO20022: Identifies the nature of the postal address.

              ISO20022: Identifies the nature of the postal address. API: Cannot be used for SEPA payments. Proprietary codes can be specified and documented if needed.

              Code	Name	Description
              BIZZ	Business	Address is the business address
              DLVY	Delivery	Address is the address to which delivery is to take place
              MLTO	Mail To	Address is the address to which mail is sent
              PBOX	PO Box	Address is is a postal office (PO) box
              ADDR	Postal	Address is the complete postal address
              HOME	Home	Address is the home address

            • departmentstring

              ISO20022: Identification of a division of a large organisation or building.

              ISO20022: Identification of a division of a large organisation or building. API: Cannot be used for SEPA payments.

              Constraints: maxLength: 70

            • subDepartmentstring

              ISO20022: Identification of a sub-division of a large organisation or building.

              ISO20022: Identification of a sub-division of a large organisation or building. API: Cannot be used for SEPA payments.

              Constraints: maxLength: 70

            • streetNamestring

              ISO20022: Name of a street or thoroughfare.

              ISO20022: Name of a street or thoroughfare. API: Cannot be used for SEPA payments.

              Constraints: maxLength: 70

            • buildingNumberstring

              ISO20022: Number that identifies the position of a building on a street.

              ISO20022: Number that identifies the position of a building on a street. API: Cannot be used for SEPA payments.

              Constraints: maxLength: 16

            • buildingNamestring

              ISO20022: Name of the building or house.

              ISO20022: Name of the building or house. API: Cannot be used for SEPA payments.

              Constraints: maxLength: 16

            • postCodestring

              ISO20022: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

              ISO20022: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. API: Cannot be used for SEPA payments.

              Constraints: maxLength: 16

            • townNamestring

              ISO20022: Name of a built-up area, with defined boundaries, and a local government.

              ISO20022: Name of a built-up area, with defined boundaries, and a local government. API: Cannot be used for SEPA payments.

              Constraints: maxLength: 35

            • countrySubDivisionstring

              ISO20022: Identifies a subdivision of a country such as state, region, county.

              ISO20022: Identifies a subdivision of a country such as state, region, county. API: Cannot be used for SEPA payments.

              Constraints: maxLength: 35

            • 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>

              Unstructured address. The lines must embed zip code and town name.

              Unstructured address. The lines must embed zip code and town name. For SEPA payments, only two address lines are allowed.

              Type: array<string>

              Item: Address line

              Item constraints: maxLength: 70

          • contactDetailsContactDetails

            Indicates how to contact the party.

            Schema: ContactDetails

            Indicates how to contact the party.

            • phoneNumberPhoneNumber

              The collection of information which identifies a specific phone or FAX number as defined by telecom services.

              Schema: PhoneNumber

              The collection of information which identifies a specific phone or FAX number as defined by telecom services. It consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).

              Type: string

              Constraints: pattern: `^\+[0-9]{1,3}-[0-9()+\-]{1,30}$`

            • faxNumberPhoneNumber

              The collection of information which identifies a specific phone or FAX number as defined by telecom services.

              Schema: PhoneNumber

              The collection of information which identifies a specific phone or FAX number as defined by telecom services. It consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).

              Type: string

              Constraints: pattern: `^\+[0-9]{1,3}-[0-9()+\-]{1,30}$`

            • emailAddressstring

              email address of the contact

              Constraints: maxLength: 2048 · pattern: `^.+@.+$`

          • organisationIdGenericIdentification

            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:

              Code	Name	Description
              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.
              BBAN	BBANIdentifier	Basic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer.
              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:
              Code	Name	Description
              ----	----	-----------
              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
              MPAN	MaskedPan	Card PAN where some digits were replaced for security reason
              TPAN	TokenizedPan	Token which was provided by a Token Service Provider (TSP) in order to obfuscate a real card PAN. The TSP must be identified in the issuer field
              TBAN	TokenizedIBAN	Token which was provided by a Token Service Provider (TSP) in order to obfuscate an IBAN. The TSP must be identified in the issuer field
              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

            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:

              Code	Name	Description
              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.
              BBAN	BBANIdentifier	Basic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer.
              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:
              Code	Name	Description
              ----	----	-----------
              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
              MPAN	MaskedPan	Card PAN where some digits were replaced for security reason
              TPAN	TokenizedPan	Token which was provided by a Token Service Provider (TSP) in order to obfuscate a real card PAN. The TSP must be identified in the issuer field
              TBAN	TokenizedIBAN	Token which was provided by a Token Service Provider (TSP) in order to obfuscate an IBAN. The TSP must be identified in the issuer field
              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

          • leiLeiIdentification

            Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

            Schema: LeiIdentification

            Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

            Type: string

            Constraints: pattern: `^[A-Z0-9]{18,18}[0-9]{2,2}$`

        • taxRemittanceTaxInformation

          ISO20022: Details about tax paid, or to be paid, to the government in accordance with the law, including pre-defined parameters such as thresholds and type of account.

          Schema: TaxInformation

          ISO20022: Details about tax paid, or to be paid, to the government in accordance with the law, including pre-defined parameters such as thresholds and type of account. API: Amounts must always be set as positive values. The [totalTaxableBaseAmount] property indicates the total amount of money on which the tax is based. The [totalTaxAmount] property indicates the total amount of money as result of the calculation of the tax.

          • creditorTaxParty

            Set of elements used to identify a party of the transaction to which the tax applies.

            Schema: TaxParty

            Set of elements used to identify a party of the transaction to which the tax applies. The [authorization] property aims to provide the details of the authorised tax paying party.

            • taxIdentificationstring

              Tax identification number of the party.

              Constraints: maxLength: 35

            • registrationIdentificationstring

              Unique identification, as assigned by an organisation, to unambiguously identify a party.

              Constraints: maxLength: 35

            • taxTypestring

              Type of tax payer.

              Constraints: maxLength: 35

            • authorisationTitleAndName

              Title and Name of the party or the party's authorised reprensentative.

              Schema: TitleAndName

          • debtorTaxParty

            Set of elements used to identify a party of the transaction to which the tax applies.

            Schema: TaxParty

            Set of elements used to identify a party of the transaction to which the tax applies. The [authorization] property aims to provide the details of the authorised tax paying party.

            • taxIdentificationstring

              Tax identification number of the party.

              Constraints: maxLength: 35

            • registrationIdentificationstring

              Unique identification, as assigned by an organisation, to unambiguously identify a party.

              Constraints: maxLength: 35

            • taxTypestring

              Type of tax payer.

              Constraints: maxLength: 35

            • authorisationTitleAndName

              Title and Name of the party or the party's authorised reprensentative.

              Schema: TitleAndName

          • ultimateDebtorTaxParty

            Set of elements used to identify a party of the transaction to which the tax applies.

            Schema: TaxParty

            Set of elements used to identify a party of the transaction to which the tax applies. The [authorization] property aims to provide the details of the authorised tax paying party.

            • taxIdentificationstring

              Tax identification number of the party.

              Constraints: maxLength: 35

            • registrationIdentificationstring

              Unique identification, as assigned by an organisation, to unambiguously identify a party.

              Constraints: maxLength: 35

            • taxTypestring

              Type of tax payer.

              Constraints: maxLength: 35

            • authorisationTitleAndName

              Title and Name of the party or the party's authorised reprensentative.

              Schema: TitleAndName

          • administrationZonestring

            Territorial part of a country to which the tax payment is related.

            Constraints: maxLength: 35

          • referenceNumberstring

            Tax reference information that is specific to a taxing agency.

            Constraints: maxLength: 140

          • methodstring

            Method used to indicate the underlying business or how the tax is paid.

            Constraints: maxLength: 35

          • totalTaxableBaseAmountAmountType

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

            Schema: AmountType

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

            • amountnumber (float)required

              ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.

              ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.

              Constraints: pattern: `^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$`

            • currencyCurrencyCodeISO 4217required

              Specifies the currency of the amount or of the account.

              Schema: CurrencyCode

              Specifies the currency of the amount or of the account. A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

              Type: string

              Constraints: pattern: `^[A-Z]{3,3}$`

          • totalTaxAmountAmountType

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

            Schema: AmountType

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

            • amountnumber (float)required

              ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.

              ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.

              Constraints: pattern: `^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$`

            • currencyCurrencyCodeISO 4217required

              Specifies the currency of the amount or of the account.

              Schema: CurrencyCode

              Specifies the currency of the amount or of the account. A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

              Type: string

              Constraints: pattern: `^[A-Z]{3,3}$`

          • datestring (date)ISO 8601

            Date by which tax is due.

          • sequenceNumberinteger (int32)

            Sequential number of the tax report.

          • recordarray<TaxRecord>

            Records of tax details

            Item: TaxRecord

            Record of tax details the [period] property embbeds the set of elements used to provide details on the period of time related to the tax payment. the [amount] property embbeds the set of elements used to provide information on the amount of the tax record.

            • typestring

              High level code to identify the type of tax details.

              Constraints: maxLength: 35

            • categorystring

              Specifies the tax code as published by the tax authority.

              Constraints: maxLength: 35

            • categoryDetailsstring

              Provides further details of the category tax code.

              Constraints: maxLength: 35

            • debtorStatusstring

              Code provided by local authority to identify the status of the party that has drawn up the settlement document.

              Constraints: maxLength: 35

            • certificateIdentificationstring

              Identification number of the tax report as assigned by the taxing authority.

              Constraints: maxLength: 35

            • formsCodestring

              Identifies, in a coded form, on which template the tax report is to be provided.

              Constraints: maxLength: 35

            • periodTaxPeriod

              Set of elements used to provide details on the period of time related to the tax payment.

              Schema: TaxPeriod

            • taxAmountTaxAmount

              ISO20022: Set of elements used to provide information on the amount of the tax record.

              Schema: TaxAmount

            • additionalInformationstring

              Further details of the tax record.

              Constraints: maxLength: 140

    • transactionStatusTransactionIndividualStatusCode

      ISO20022: Specifies the status of the payment information group.

      Schema: TransactionIndividualStatusCode

      Code	Name	Description
      ACSC	AcceptedSettlementCompleted	Settlement on the debtor's account was completed. In the case of SCTInst, this status must not been set by the debtor's Bank before the reception of the positive confirmation. The transaction cannot be cancelled.
      ACSP	AcceptedSettlementInProcess	All preceding checks such as technical validation and customer profile were successful and therefore the Payment Request was accepted for execution. The transaction cannot be cancelled.
      ACTC	AcceptedTechnicalValidation	Authentication and syntactical and semantical validation are successful. The transaction might be cancelled.
      CANC	Cancelled	Payment initiation was successfully cancelled after having received a request for cancellation.
      PDNG	Pending	Payment request or individual transaction included in the Payment Request is pending. Further checks and status update will be performed. The transaction might be cancelled.
      RJCT	Rejected	Payment request or individual transaction included in the Payment Request was rejected.

    • statusReasonInformationStatusReasonInformation

      ISO20022: Provides detailed information on the status reason.

      Schema: StatusReasonInformation

      Code	Name	Description
      AC01	IncorectAccountNumber	the account number is either invalid or does not exist
      AC04	ClosedAccountNumber	the account is closed and cannot be used
      AC06	BlockedAccount	the account is blocked and cannot be used
      AG01	TransactionForbidden	Transaction forbidden on this type of account
      AG03	TransactionNotSupported	Transaction type not supported/authorized on this account
      AM02	NotAllowedAccount	SPecific transaction/message amount is greater than allowed maximum
      AM04	InsufficientFunds	Amount of funds available to cover specified message amount is insufficient
      AM18	InvalidNumberOfTransactions	the number of transactions exceeds the ASPSP acceptance limit
      CH03	RequestedExecutionDateOrRequestedCollectionDateTooFarInFuture	The requested execution date is too far in the future
      CH04	RequestedExecutionDateOrRequestedCollectionDateTooFarInPast	Value in Requested Execution Date or Requested Collection Date is too far in the past
      CNOR	CreditorBankIsNotRegistered	Creditor bank is not registered under this BIC in the CSM
      CUST	RequestedByCustomer	The reject is due to the debtor: refusal or lack of liquidity
      DS02	OrderCancelled	An authorized user has cancelled the order
      DUPL	DuplicatePayment	Payment is a duplicate of another payment. Can only be set by a PISP for a payment request cancellation.
      FF01	InvalidFileFormat	The reject is due to the original Payment Request which is invalid (syntax, structure or values)
      FRAD	FraudulentOriginated	the Payment Request is considered as fraudulent
      MS03	NotSpecifiedReasonAgentGenerated	No reason specified by the ASPSP
      NOAS	NoAnswerFromCustomer	The PSU has neither accepted nor rejected the Payment Request and a time-out has occurred
      RR01	MissingDebtorAccountOrIdentification	The Debtor account and/or Identification are missing or inconsistent
      RR03	MissingCreditorNameOrAddress	Specification of the creditor's name and/or address needed for regulatory requirements is insufficient or missing.
      RR04	RegulatoryReason	Reject from regulatory reason
      RR12	InvalidPartyID	Invalid or missing identification required within a particular country or payment type.
      TECH	TechnicalProblem	Technical problems resulting in an erroneous transaction. Can only be set by a PISP for a payment request cancellation.

    • supplementaryDataSupplementaryData

      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 was chosen by the ASPSP The [acceptedAuthenticationApproach] property can only be set by the PISP.

      • Authentication approaches that are supported by the PISP. The PISP can provide several choices separated by commas.
      • Case of none of the accepted approaches is supported by the ASPSP, the latest will respond with HTTP400 (Bad request) and specify wich approaches are actually supported. The [appliedAuthentication] will be set by the ASPSP.
      • 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 was chosen.
      • It may happen that the ASPSP considers that, in case of payment cancellation request, there is no need for authentication and will then return "NONE".

      • acceptedAuthenticationApproachAuthenticationApproaches

        List of authentication approaches

        Schema: AuthenticationApproach

        Code
        REDIRECT
        DECOUPLED
        EMBEDDED-1-FACTOR
        NONE

      • appliedAuthenticationApproachAuthenticationApproach

        Authentication approaches that can be applied.

        Schema: AuthenticationApproach

        Code
        REDIRECT
        DECOUPLED
        EMBEDDED-1-FACTOR
        NONE

      • appliedAuthenticationstringenum · 3

        Can only be set by the ASPSP.

        Can only be set by the ASPSP. This field allows the ASPSP to inform the PISP about the way authentication was processed during the payment request confirmation.

        Code
        noAuthentication
        oneFactorAuthentication
        strongAuthentication

      • 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

      • nextStatusRequestHintstring (date-time)ISO 8601

        Date and time at which the PISP is suggested to ask again for the status of the payment request.

        Date and time at which the PISP is suggested to ask again for the status of the payment request.

      • loginHintTokenstring

        The LOGIN_HINT_TOKEN is a piece of data that may be provided to the API client by the API server, once a PSU has been identified and authenticated.

        The LOGIN_HINT_TOKEN is a piece of data that may be provided to the API client by the API server, once a PSU has been identified and authenticated.

        • through a response to a token introspection request (RFC7662)
        • through a status response to a Payment Request This LOGIN_HINT_TOKEN can then be sent back by the API client to the API server through the posting of a new Payment request. This will help the API server to identify the relevant PSU and ease the authentication process.
    • investigationStatusboolean

      Boolean indicator aiming to clarify that the relevant transaction is under dispute investigation.

      Boolean indicator aiming to clarify that the relevant transaction is under dispute investigation.

  • 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 was chosen by the ASPSP The [acceptedAuthenticationApproach] property can only be set by the PISP.

    • Authentication approaches that are supported by the PISP. The PISP can provide several choices separated by commas.
    • Case of none of the accepted approaches is supported by the ASPSP, the latest will respond with HTTP400 (Bad request) and specify wich approaches are actually supported. The [appliedAuthentication] will be set by the ASPSP.
    • 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 was chosen.
    • It may happen that the ASPSP considers that, in case of payment cancellation request, there is no need for authentication and will then return "NONE".

    • acceptedAuthenticationApproachAuthenticationApproaches

      List of authentication approaches

      Schema: AuthenticationApproach

      Code
      REDIRECT
      DECOUPLED
      EMBEDDED-1-FACTOR
      NONE

    • appliedAuthenticationApproachAuthenticationApproach

      Authentication approaches that can be applied.

      Schema: AuthenticationApproach

      Code
      REDIRECT
      DECOUPLED
      EMBEDDED-1-FACTOR
      NONE

    • appliedAuthenticationstringenum · 3

      Can only be set by the ASPSP.

      Can only be set by the ASPSP. This field allows the ASPSP to inform the PISP about the way authentication was processed during the payment request confirmation.

      Code
      noAuthentication
      oneFactorAuthentication
      strongAuthentication

    • 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

    • nextStatusRequestHintstring (date-time)ISO 8601

      Date and time at which the PISP is suggested to ask again for the status of the payment request.

      Date and time at which the PISP is suggested to ask again for the status of the payment request.

    • loginHintTokenstring

      The LOGIN_HINT_TOKEN is a piece of data that may be provided to the API client by the API server, once a PSU has been identified and authenticated.

      The LOGIN_HINT_TOKEN is a piece of data that may be provided to the API client by the API server, once a PSU has been identified and authenticated.

      • through a response to a token introspection request (RFC7662)
      • through a status response to a Payment Request This LOGIN_HINT_TOKEN can then be sent back by the API client to the API server through the posting of a new Payment request. This will help the API server to identify the relevant PSU and ease the authentication process.
• _linksPaymentRequestLinksrequired

  links that can be used for further navigation when having post a Payment Request in order to get the relevant status report.

  Schema: PaymentRequestLinks

  links that can be used for further navigation when having post a Payment Request in order to get the relevant status report.

  Link	Description
  request	This link provides the payment-request URL for retrieving or modifying
  confirmation	This link shall not be provided when the confirmation was already posted.
  transactions	The ASPSP might choose to provide the relevant transactions of a Payment Request through a specific link

  • requestGenericLink

    hypertext reference

    Schema: GenericLink

    hypertext reference

    • hrefstringrequired

      URI to be used. HREF stands for Hypertext REFerence.

      Constraints: maxLength: 2000

    • templatedboolean

      This field must be set with "true" when [href] is an URI template, i.e. with parameters that will be set by the client afterwards. Parameter fields must be included by the API server according to RFC6570.

      This field must be set with "true" when [href] is an URI template, i.e. with parameters that will be set by the client afterwards. Parameter fields must be included by the API server according to RFC6570. Otherwise, this property must be absent or set to false default value: false

  • confirmationGenericLink

    hypertext reference

    Schema: GenericLink

    hypertext reference

    • hrefstringrequired

      URI to be used. HREF stands for Hypertext REFerence.

      Constraints: maxLength: 2000

    • templatedboolean

      This field must be set with "true" when [href] is an URI template, i.e. with parameters that will be set by the client afterwards. Parameter fields must be included by the API server according to RFC6570.

      This field must be set with "true" when [href] is an URI template, i.e. with parameters that will be set by the client afterwards. Parameter fields must be included by the API server according to RFC6570. Otherwise, this property must be absent or set to false default value: false

  • transactionsGenericLink

    hypertext reference

    Schema: GenericLink

    hypertext reference

    • hrefstringrequired

      URI to be used. HREF stands for Hypertext REFerence.

      Constraints: maxLength: 2000

    • templatedboolean

      This field must be set with "true" when [href] is an URI template, i.e. with parameters that will be set by the client afterwards. Parameter fields must be included by the API server according to RFC6570.

      This field must be set with "true" when [href] is an URI template, i.e. with parameters that will be set by the client afterwards. Parameter fields must be included by the API server according to RFC6570. Otherwise, this property must be absent or set to false default value: false