post/payment-requests

Fields (21)

• resourceIdResourceId

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

  Schema: ResourceId

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

  Type: string

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

• paymentInformationIdPaymentInformationIdrequired

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

  Schema: PaymentInformationId

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

  Type: string

  Constraints: pattern: `^([a-zA-Z0-9 /\-?:\()\.,']{1,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.

  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.

    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	Business	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>required

      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

  • organisationIdGenericIdentification

    Unique and unambiguous way to identify an organisation.

    Schema: GenericIdentification

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

    • identificationstringrequired

      API: Identifier

      API: Identifier

      Constraints: maxLength: 70

    • schemeNamestringrequired

      Name of the identification scheme.

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

      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.
      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
      Each implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used

      Constraints: maxLength: 70

    • issuerstring

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

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

      Constraints: maxLength: 35

  • privateIdGenericIdentification

    Unique and unambiguous identification of a person.

    Schema: GenericIdentification

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

    • identificationstringrequired

      API: Identifier

      API: Identifier

      Constraints: maxLength: 70

    • schemeNamestringrequired

      Name of the identification scheme.

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

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

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

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

  Schema: PaymentTypeInformation

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

  • instructionPriorityPriorityCode

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

    Schema: PriorityCode

    Code
    HIGH
    NORM

  • serviceLevelServiceLevelCode

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

    Schema: ServiceLevelCode

    Code
    SEPA

  • localInstrumentLocalInstrumentCode

    ISO20022: User community specific instrument.

    Schema: LocalInstrumentCode

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

    Type: string

  • categoryPurposeCategoryPurposeCode

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

    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.
    TREA	TreasuryPayment	Transaction is related to treasury operations. E.g. financial contract settlement.

• debtorPartyIdentification

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

  Schema: PartyIdentification

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

  • namestringrequired

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

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

    Constraints: maxLength: 140

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

      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

  • organisationIdGenericIdentification

    Unique and unambiguous way to identify an organisation.

    Schema: GenericIdentification

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

    • identificationstringrequired

      API: Identifier

      API: Identifier

      Constraints: maxLength: 70

    • schemeNamestringrequired

      Name of the identification scheme.

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

      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.
      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
      Each implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used

      Constraints: maxLength: 70

    • issuerstring

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

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

      Constraints: maxLength: 35

  • privateIdGenericIdentification

    Unique and unambiguous identification of a person.

    Schema: GenericIdentification

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

    • identificationstringrequired

      API: Identifier

      API: Identifier

      Constraints: maxLength: 70

    • schemeNamestringrequired

      Name of the identification scheme.

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

      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.
      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
      Each implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used

      Constraints: maxLength: 70

    • issuerstring

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

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

      Constraints: maxLength: 35

• debtorAccountAccountIdentification

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

  Schema: AccountIdentification

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

  • ibanstring

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

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

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

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

  • otherGenericIdentification

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

    Schema: GenericIdentification

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

    • identificationstringrequired

      API: Identifier

      API: Identifier

      Constraints: maxLength: 70

    • schemeNamestringrequired

      Name of the identification scheme.

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

      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.
      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
      Each implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used

      Constraints: maxLength: 70

    • issuerstring

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

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

      Constraints: maxLength: 35

  • currencyCurrencyCodeISO 4217

    Currency used for the account

    Schema: CurrencyCode

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

    Type: string

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

• debtorAgentFinancialInstitutionIdentification

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

  Schema: FinancialInstitutionIdentification

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

  • bicFistringrequired

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

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

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

  • clearingSystemMemberIdClearingSystemMemberIdentification

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

    Schema: ClearingSystemMemberIdentification

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

    • clearingSystemIdstring

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

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

      Constraints: maxLength: 35

    • memberIdstring

      ISO20022: Identification of a member of a clearing system.

      ISO20022: Identification of a member of a clearing system.

      Constraints: maxLength: 35

  • namestring

    Name of the financial institution

    Constraints: maxLength: 140

  • postalAddressPostalAddress

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

    Schema: PostalAddress

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

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

      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

• beneficiaryBeneficiary

  Specification of a beneficiary

  Schema: Beneficiary

  Specification of a beneficiary

  • 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 has been registered by the PSU within the trusted beneficiaries list.

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

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

    Schema: FinancialInstitutionIdentification

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

    • bicFistringrequired

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

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

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

    • clearingSystemMemberIdClearingSystemMemberIdentification

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

      Schema: ClearingSystemMemberIdentification

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

      • clearingSystemIdstring

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

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

        Constraints: maxLength: 35

      • memberIdstring

        ISO20022: Identification of a member of a clearing system.

        ISO20022: Identification of a member of a clearing system.

        Constraints: maxLength: 35

    • namestring

      Name of the financial institution

      Constraints: maxLength: 140

    • postalAddressPostalAddress

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

      Schema: PostalAddress

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

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

        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.

      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	Business	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>required

        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

    • organisationIdGenericIdentification

      Unique and unambiguous way to identify an organisation.

      Schema: GenericIdentification

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

      • identificationstringrequired

        API: Identifier

        API: Identifier

        Constraints: maxLength: 70

      • schemeNamestringrequired

        Name of the identification scheme.

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

        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.
        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
        Each implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used

        Constraints: maxLength: 70

      • issuerstring

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

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

        Constraints: maxLength: 35

    • privateIdGenericIdentification

      Unique and unambiguous identification of a person.

      Schema: GenericIdentification

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

      • identificationstringrequired

        API: Identifier

        API: Identifier

        Constraints: maxLength: 70

      • schemeNamestringrequired

        Name of the identification scheme.

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

        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.
        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
        Each implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used

        Constraints: maxLength: 70

      • issuerstring

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

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

        Constraints: maxLength: 35

  • creditorAccountAccountIdentification

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

    Schema: AccountIdentification

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

    • ibanstring

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

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

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

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

    • otherGenericIdentification

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

      Schema: GenericIdentification

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

      • identificationstringrequired

        API: Identifier

        API: Identifier

        Constraints: maxLength: 70

      • schemeNamestringrequired

        Name of the identification scheme.

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

        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.
        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
        Each implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used

        Constraints: maxLength: 70

      • issuerstring

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

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

        Constraints: maxLength: 35

    • currencyCurrencyCodeISO 4217

      Currency used for the account

      Schema: CurrencyCode

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

      Type: string

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

• 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
  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 has been accepted for execution.
  ACTC	AcceptedTechnicalValidation	Authentication and syntactical and semantical validation are successful.
  ACWC	AcceptedWithChange	Instruction is accepted but a change will be made, such as date or remittance not sent.
  ACWP	AcceptedWithoutPosting	Payment instruction included in the credit transfer is accepted without being posted to the creditor customer’s account.
  CANC	Cancelled	Payment initiation has been successfully cancelled after having received a request for cancellation.
  PART	PartiallyAccepted	A number of transactions have been 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 have been performed. Syntactical and semantical validations are successful.
  RCVD	Received	Payment initiation has been received by the receiving agent.
  PDNG	Pending	Payment request or individual transaction included in the Payment Request is pending. Further checks and status update will be performed.
  RJCT	Rejected	Payment request has been rejected.

• 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	Transaction forbidden	Transaction forbidden on this type of account
  AM18	InvalidNumberOfTransactions	the number of transactions exceeds the ASPSP acceptance limit
  CH03	RequestedExecutionDateOrRequestedCollectionDateTooFarInFuture	The requested execution date is too far in the future
  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

  Type: boolean

• bookingBookingInformation

  indicator that the payment can be immediately booked or not

  Schema: BookingInformation

  indicator that the payment can be immediately booked or not

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

  Type: boolean

• requestedExecutionDatestring (date-time)ISO 8601

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

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

• creditTransferTransactionarray<CreditTransferTransaction>required

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

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

  Item: CreditTransferTransaction

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

  • paymentIdPaymentIdentificationrequired

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

    Schema: PaymentIdentification

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

    • resourceIdResourceId

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

      Schema: ResourceId

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

      Type: string

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

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

    • endToEndIdstring

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

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

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

  • requestedExecutionDateRequestedExecutionDate

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

    Schema: RequestedExecutionDate

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

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

    Type: string (date-time)

  • endDateEndDate

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

    Schema: EndDate

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

    Type: string (date-time)

  • executionRuleExecutionRule

    Execution date shifting rule for standing orders

    Schema: ExecutionRule

    Code	Description
    FWNG	following
    PREC	preceding

  • frequencyFrequencyCode

    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

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

    Schema: EquivalentAmountType

    Structure aiming to embed the amount and the currency to be used. The currency of transfer should be set.

    • 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

    Provides details on the currency exchange rate and contract.

    Schema: ExchangeRate

    Provides details on the currency exchange rate and contract.

    • unitCurrencyCurrencyCode

      Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.

      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.

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

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

      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	Business	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>required

        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

    • organisationIdGenericIdentification

      Unique and unambiguous way to identify an organisation.

      Schema: GenericIdentification

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

      • identificationstringrequired

        API: Identifier

        API: Identifier

        Constraints: maxLength: 70

      • schemeNamestringrequired

        Name of the identification scheme.

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

        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.
        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
        Each implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used

        Constraints: maxLength: 70

      • issuerstring

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

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

        Constraints: maxLength: 35

    • privateIdGenericIdentification

      Unique and unambiguous identification of a person.

      Schema: GenericIdentification

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

      • identificationstringrequired

        API: Identifier

        API: Identifier

        Constraints: maxLength: 70

      • schemeNamestringrequired

        Name of the identification scheme.

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

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

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

        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	Business	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>required

          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

      • organisationIdGenericIdentification

        Unique and unambiguous way to identify an organisation.

        Schema: GenericIdentification

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

        • identificationstringrequired

          API: Identifier

          API: Identifier

          Constraints: maxLength: 70

        • schemeNamestringrequired

          Name of the identification scheme.

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

          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.
          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
          Each implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used

          Constraints: maxLength: 70

        • issuerstring

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

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

          Constraints: maxLength: 35

      • privateIdGenericIdentification

        Unique and unambiguous identification of a person.

        Schema: GenericIdentification

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

        • identificationstringrequired

          API: Identifier

          API: Identifier

          Constraints: maxLength: 70

        • schemeNamestringrequired

          Name of the identification scheme.

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

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

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

      • 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.
          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
          Each implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used

          Constraints: maxLength: 70

        • issuerstring

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

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

          Constraints: maxLength: 35

      • currencyCurrencyCodeISO 4217

        Currency used for the account

        Schema: CurrencyCode

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

        Type: string

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

  • beneficiaryBeneficiary

    Specification of a beneficiary

    Schema: Beneficiary

    Specification of a beneficiary

    • 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 has been registered by the PSU within the trusted beneficiaries list.

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

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

      Schema: FinancialInstitutionIdentification

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

      • bicFistringrequired

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

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

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

      • clearingSystemMemberIdClearingSystemMemberIdentification

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

        Schema: ClearingSystemMemberIdentification

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

        • clearingSystemIdstring

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

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

          Constraints: maxLength: 35

        • memberIdstring

          ISO20022: Identification of a member of a clearing system.

          ISO20022: Identification of a member of a clearing system.

          Constraints: maxLength: 35

      • namestring

        Name of the financial institution

        Constraints: maxLength: 140

      • postalAddressPostalAddress

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

        Schema: PostalAddress

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

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

          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.

        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	Business	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>required

          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

      • organisationIdGenericIdentification

        Unique and unambiguous way to identify an organisation.

        Schema: GenericIdentification

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

        • identificationstringrequired

          API: Identifier

          API: Identifier

          Constraints: maxLength: 70

        • schemeNamestringrequired

          Name of the identification scheme.

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

          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.
          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
          Each implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used

          Constraints: maxLength: 70

        • issuerstring

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

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

          Constraints: maxLength: 35

      • privateIdGenericIdentification

        Unique and unambiguous identification of a person.

        Schema: GenericIdentification

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

        • identificationstringrequired

          API: Identifier

          API: Identifier

          Constraints: maxLength: 70

        • schemeNamestringrequired

          Name of the identification scheme.

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

          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.
          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
          Each implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used

          Constraints: maxLength: 70

        • issuerstring

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

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

          Constraints: maxLength: 35

    • creditorAccountAccountIdentification

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

      Schema: AccountIdentification

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

      • ibanstring

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

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

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

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

      • otherGenericIdentification

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

        Schema: GenericIdentification

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

        • identificationstringrequired

          API: Identifier

          API: Identifier

          Constraints: maxLength: 70

        • schemeNamestringrequired

          Name of the identification scheme.

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

          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.
          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
          Each implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used

          Constraints: maxLength: 70

        • issuerstring

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

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

          Constraints: maxLength: 35

      • currencyCurrencyCodeISO 4217

        Currency used for the account

        Schema: CurrencyCode

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

        Type: string

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

  • ultimateCreditorPartyIdentification

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

    Schema: PartyIdentification

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

    • namestringrequired

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

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

      Constraints: maxLength: 140

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

        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

    • organisationIdGenericIdentification

      Unique and unambiguous way to identify an organisation.

      Schema: GenericIdentification

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

      • identificationstringrequired

        API: Identifier

        API: Identifier

        Constraints: maxLength: 70

      • schemeNamestringrequired

        Name of the identification scheme.

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

        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.
        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
        Each implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used

        Constraints: maxLength: 70

      • issuerstring

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

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

        Constraints: maxLength: 35

    • privateIdGenericIdentification

      Unique and unambiguous identification of a person.

      Schema: GenericIdentification

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

      • identificationstringrequired

        API: Identifier

        API: Identifier

        Constraints: maxLength: 70

      • schemeNamestringrequired

        Name of the identification scheme.

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

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

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

      Code
      CHQB
      HOLD
      PHOB
      TELB

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

      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

            Provides identification of the document line.

            • typeCodeAndIssuer

              Specifies the type of referred document type.

              Specifies the type of referred document type.

              Schema: CodeAndIssuer

            • numberstring

              Unique and unambiguous identification of the referred document line.

              Constraints: maxLength: 35

            • relatedDatestring (date)ISO 8601

              Date associated with the referred document line.

          • descriptionstring

            Description associated with the document line.

            Constraints: maxLength: 2048

          • amountRemittanceAmount

            Provides details on the amounts of the document line.

            Schema: RemittanceAmount

            Provides details on the amounts of the document line.

            • duePayableAmountAmountType

              Amount specified is the exact amount due and payable to the creditor.

              Schema: AmountType

            • discountAppliedAmountTypedAmount

              Amount of discount to be applied to the amount due and payable to the creditor.

              Schema: TypedAmount

            • creditNoteAmountAmountType

              Amount of a credit note.

              Schema: AmountType

            • taxAmountTypedAmount

              Amount of the tax.

              Schema: TypedAmount

            • adjustmentAmountAndReasonDocumentAdjustment

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

              Schema: DocumentAdjustment

            • remittedAmountAmountType

              Amount of money remitted.

              Schema: AmountType

      • referredDocumentAmountRemittanceAmount

        Provides details on the amounts of the document line.

        Schema: RemittanceAmount

        Provides details on the amounts of the document line.

        • duePayableAmountAmountType

          Amount specified is the exact amount due and payable to the creditor.

          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

          Amount of discount to be applied to the amount due and payable to the creditor.

          Schema: TypedAmount

          Typed Amount

          • typestring

            Type of the amount

            Constraints: maxLength: 35

          • amountAmountTyperequired

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

        • creditNoteAmountAmountType

          Amount of a credit note.

          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

          Amount of the tax.

          Schema: TypedAmount

          Typed Amount

          • typestring

            Type of the amount

            Constraints: maxLength: 35

          • amountAmountTyperequired

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

        • adjustmentAmountAndReasonDocumentAdjustment

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

          Schema: DocumentAdjustment

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

          • amountAmountTyperequired

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

          • 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

          Amount of money remitted.

          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.

          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	Business	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>required

            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

        • organisationIdGenericIdentification

          Unique and unambiguous way to identify an organisation.

          Schema: GenericIdentification

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

          • identificationstringrequired

            API: Identifier

            API: Identifier

            Constraints: maxLength: 70

          • schemeNamestringrequired

            Name of the identification scheme.

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

            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.
            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
            Each implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used

            Constraints: maxLength: 70

          • issuerstring

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

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

            Constraints: maxLength: 35

        • privateIdGenericIdentification

          Unique and unambiguous identification of a person.

          Schema: GenericIdentification

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

          • identificationstringrequired

            API: Identifier

            API: Identifier

            Constraints: maxLength: 70

          • schemeNamestringrequired

            Name of the identification scheme.

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

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

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

          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	Business	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>required

            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

        • organisationIdGenericIdentification

          Unique and unambiguous way to identify an organisation.

          Schema: GenericIdentification

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

          • identificationstringrequired

            API: Identifier

            API: Identifier

            Constraints: maxLength: 70

          • schemeNamestringrequired

            Name of the identification scheme.

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

            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.
            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
            Each implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used

            Constraints: maxLength: 70

          • issuerstring

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

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

            Constraints: maxLength: 35

        • privateIdGenericIdentification

          Unique and unambiguous identification of a person.

          Schema: GenericIdentification

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

          • identificationstringrequired

            API: Identifier

            API: Identifier

            Constraints: maxLength: 70

          • schemeNamestringrequired

            Name of the identification scheme.

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

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

      • taxRemittanceTaxInformation

        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

        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.

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

          • 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

            Details of the authorised tax paying party.

            Schema: TitleAndName

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

            • titlestring

              Title or position of the party or the party's authorised reprensentative.

              Constraints: maxLength: 35

            • namestring

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

              Constraints: maxLength: 140

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

          • 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

            Details of the authorised tax paying party.

            Schema: TitleAndName

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

            • titlestring

              Title or position of the party or the party's authorised reprensentative.

              Constraints: maxLength: 35

            • namestring

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

              Constraints: maxLength: 140

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

          • 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

            Details of the authorised tax paying party.

            Schema: TitleAndName

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

            • titlestring

              Title or position of the party or the party's authorised reprensentative.

              Constraints: maxLength: 35

            • namestring

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

              Constraints: maxLength: 140

        • 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

          Total amount of money on which the tax is based.

          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

          Total amount of money as result of the calculation of the tax.

          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.

        • sequenceNumbernumber (int32)

          Sequential number of the tax report.

        • recordarray<TaxRecord>

          Records of tax details

          Item: TaxRecord

          Record of tax details

          • 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

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

            • yearstring (int32)

              Year related to the tax payment.

            • typeTaxRecordPeriodCode

              Identification of the period related to the tax payment.

              Schema: TaxRecordPeriodCode

              Code	Description
              MM01	FirstMonth Tax is related to the second month of the period.
              MM02	SecondMonth Tax is related to the first month of the period.
              MM03	ThirdMonth Tax is related to the third month of the period.
              MM04	FourthMonth Tax is related to the fourth month of the period.
              MM05	FifthMonth Tax is related to the fifth month of the period.
              MM06	SixthMonth Tax is related to the sixth month of the period.
              MM07	SeventhMonth Tax is related to the seventh month of the period.
              MM08	EighthMonth Tax is related to the eighth month of the period.
              MM09	NinthMonth Tax is related to the ninth month of the period.
              MM10	TenthMonth Tax is related to the tenth month of the period.
              MM11	EleventhMonth Tax is related to the eleventh month of the period.
              MM12	TwelfthMonth Tax is related to the twelfth month of the period.
              QTR1	FirstQuarter Tax is related to the first quarter of the period.
              QTR2	SecondQuarter Tax is related to the second quarter of the period.
              QTR3	ThirdQuarter Tax is related to the third quarter of the period.
              QTR4	FourthQuarter Tax is related to the fourth quarter of the period.
              HLF1	FirstHalf Tax is related to the first half of the period.
              HLF2	SecondHalf Tax is related to the second half of the period.

            • fromDatestring (date)ISO 8601

              Start date of the range.

            • toDatestring (date)ISO 8601

              End date of the range.

          • taxAmountTaxAmount

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

            Schema: TaxAmount

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

            • ratePercentageRate

              Rate used to calculate the tax.

              Schema: PercentageRate

              Rate expressed as a percentage, ie, in hundredths, eg, 0.7 is 7/10 of a percent, and 7.0 is 7%.

              Type: number (float)

            • taxableBaseAmountAmountType

              Amount of money on which the tax is based.

              Schema: AmountType

            • totalAmountAmountType

              Total amount that is the result of the calculation of the tax for the record.

              Schema: AmountType

            • detailsarray<TaxRecordDetails>

              Set of elements used to provide details on the tax period and amount.

              Item: TaxRecordDetails

          • 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.
    ACSP	AcceptedSettlementInProcess	All preceding checks such as technical validation and customer profile were successful and therefore the Payment Request has been accepted for execution.
    ACTC	AcceptedTechnicalValidation	Authentication and syntactical and semantical validation are successful.
    CANC	Cancelled	Payment initiation has been 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.
    RJCT	Rejected	Payment request or individual transaction included in the Payment Request has been 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	Transaction forbidden	Transaction forbidden on this type of account
    AM18	InvalidNumberOfTransactions	the number of transactions exceeds the ASPSP acceptance limit
    CH03	RequestedExecutionDateOrRequestedCollectionDateTooFarInFuture	The requested execution date is too far in the future
    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.

• supplementaryDataSupplementaryDatarequired

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

  Schema: SupplementaryData

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

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

  • acceptedAuthenticationApproacharray<string>

    can only be set by the PISP

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

    Code
    REDIRECT
    DECOUPLED
    EMBEDDED-1-FACTOR

    Type: array<string>

    Item: combination of possible values for authentication approaches

  • appliedAuthenticationApproachAppliedAuthenticationApproach

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

    Schema: AppliedAuthenticationApproach

    Code
    REDIRECT
    DECOUPLED
    EMBEDDED-1-FACTOR
    NONE

  • 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