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.
Fields (6)
- 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
- 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. the [type] property must be used for specifying the type of referred document type.
- 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 line.
Constraints: maxLength: 35
- descriptionstring
Description associated with the document line.
Constraints: maxLength: 2048
- amountRemittanceAmount
ISO20022: Provides details on the amounts of the document line.
Schema: RemittanceAmount
ISO20022: Provides details on the amounts of the document line. API: Amounts must always be set as positive values.
Property Description duePayableAmount Amount specified is the exact amount due and payable to the creditor. discountAppliedAmount Amount of discount to be applied to the amount due and payable to the creditor. creditNoteAmount Amount of a credit note. taxAmount Amount of the tax. adjustmentAmountAndReason Specifies detailed information on the amount and reason of the adjustment. remittedAmount Amount of money remitted. - duePayableAmountAmountType
Structure aiming to embed the amount and the currency to be used.
Schema: AmountType
Structure aiming to embed the amount and the currency to be used.
- amountnumber (float)required
ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
Constraints: pattern: `^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$`
Specifies the currency of the amount or of the account.
Schema: CurrencyCode
Specifies the currency of the amount or of the account. A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Type: string
Constraints: pattern: `^[A-Z]{3,3}$`
- discountAppliedAmountTypedAmount
ISO20022: Typed Amount
Schema: TypedAmount
ISO20022: Typed Amount API: Amounts must always be set as positive values.
- typestring
Type of the amount
Constraints: maxLength: 35
- amountAmountTyperequired
Structure aiming to embed the amount and the currency to be used.
Schema: AmountType
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}$`
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
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}$`
Specifies the currency of the amount or of the account.
Schema: CurrencyCode
Specifies the currency of the amount or of the account. A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Type: string
Constraints: pattern: `^[A-Z]{3,3}$`
- taxAmountTypedAmount
ISO20022: Typed Amount
Schema: TypedAmount
ISO20022: Typed Amount API: Amounts must always be set as positive values.
- typestring
Type of the amount
Constraints: maxLength: 35
- amountAmountTyperequired
Structure aiming to embed the amount and the currency to be used.
Schema: AmountType
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}$`
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
ISO20022: Specifies detailed information on the amount and reason of the adjustment.
Schema: DocumentAdjustment
ISO20022: Specifies detailed information on the amount and reason of the adjustment. API: Amounts must always be set as positive values.
- amountAmountTyperequired
Structure aiming to embed the amount and the currency to be used.
Schema: AmountType
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}$`
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 CRDTCredit type amount DBITDebit type amount - reasonstring
Specifies the reason for the adjustment.
Constraints: maxLength: 4
- additionalInformationstring
Provides further details on the document adjustment.
Constraints: maxLength: 140
- remittedAmountAmountType
Structure aiming to embed the amount and the currency to be used.
Schema: AmountType
Structure aiming to embed the amount and the currency to be used.
- amountnumber (float)required
ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
Constraints: pattern: `^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$`
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}$`
- referredDocumentAmountRemittanceAmount
ISO20022: Provides details on the amounts of the document line.
Schema: RemittanceAmount
ISO20022: Provides details on the amounts of the document line. API: Amounts must always be set as positive values.
Property Description duePayableAmount Amount specified is the exact amount due and payable to the creditor. discountAppliedAmount Amount of discount to be applied to the amount due and payable to the creditor. creditNoteAmount Amount of a credit note. taxAmount Amount of the tax. adjustmentAmountAndReason Specifies detailed information on the amount and reason of the adjustment. remittedAmount Amount of money remitted. - duePayableAmountAmountType
Structure aiming to embed the amount and the currency to be used.
Schema: AmountType
Structure aiming to embed the amount and the currency to be used.
- amountnumber (float)required
ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
Constraints: pattern: `^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$`
Specifies the currency of the amount or of the account.
Schema: CurrencyCode
Specifies the currency of the amount or of the account. A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Type: string
Constraints: pattern: `^[A-Z]{3,3}$`
- discountAppliedAmountTypedAmount
ISO20022: Typed Amount
Schema: TypedAmount
ISO20022: Typed Amount API: Amounts must always be set as positive values.
- typestring
Type of the amount
Constraints: maxLength: 35
- amountAmountTyperequired
Structure aiming to embed the amount and the currency to be used.
Schema: AmountType
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}$`
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
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}$`
Specifies the currency of the amount or of the account.
Schema: CurrencyCode
Specifies the currency of the amount or of the account. A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Type: string
Constraints: pattern: `^[A-Z]{3,3}$`
- taxAmountTypedAmount
ISO20022: Typed Amount
Schema: TypedAmount
ISO20022: Typed Amount API: Amounts must always be set as positive values.
- typestring
Type of the amount
Constraints: maxLength: 35
- amountAmountTyperequired
Structure aiming to embed the amount and the currency to be used.
Schema: AmountType
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}$`
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
ISO20022: Specifies detailed information on the amount and reason of the adjustment.
Schema: DocumentAdjustment
ISO20022: Specifies detailed information on the amount and reason of the adjustment. API: Amounts must always be set as positive values.
- amountAmountTyperequired
Structure aiming to embed the amount and the currency to be used.
Schema: AmountType
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}$`
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 CRDTCredit type amount DBITDebit type amount - reasonstring
Specifies the reason for the adjustment.
Constraints: maxLength: 4
- additionalInformationstring
Provides further details on the document adjustment.
Constraints: maxLength: 140
- remittedAmountAmountType
Structure aiming to embed the amount and the currency to be used.
Schema: AmountType
Structure aiming to embed the amount and the currency to be used.
- amountnumber (float)required
ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
Constraints: pattern: `^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$`
Specifies the currency of the amount or of the account.
Schema: CurrencyCode
Specifies the currency of the amount or of the account. A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Type: string
Constraints: pattern: `^[A-Z]{3,3}$`
- creditorReferenceInformationCreditorReferenceInformation
Reference information provided by the creditor to allow the identification of the underlying documents.
Schema: CreditorReferenceInformation
Reference information provided by the creditor to allow the identification of the underlying documents.
- typeCodeAndIssuer
Specifies a code and the issuer of this code.
Schema: CodeAndIssuer
Specifies a code and the issuer of this code.
- codestringrequired
Provides the code.
Constraints: maxLength: 4
- issuerstring
Identification of the issuer of the code.
Constraints: maxLength: 35
- referencestring
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.
Constraints: maxLength: 35
- invoicerPartyIdentification
API : Description of a Party which can be either a person or an organization.
Schema: PartyIdentification
API : Description of a Party which can be either a person or an organization.
- namestringrequired
ISO20022: Name by which a party is known and which is usually used to identify that party.
ISO20022: Name by which a party is known and which is usually used to identify that party. The [organisationId] property allows the specification of an unique and unambiguous way to identify an organisation. The [privateId] property allows the specification of an unique and unambiguous way to identify a person.
Constraints: maxLength: 140
- dateAndPlaceOfBirthDateAndPlaceOfBirth
Date and place of birth of a person.
Schema: DateAndPlaceOfBirth
Date and place of birth of a person. This information must be requested for detection of Fraud, Money-Laundering and Terrorism Financing in case of international payment.
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 BIZZBusiness Address is the business address DLVYDelivery Address is the address to which delivery is to take place MLTOMail To Address is the address to which mail is sent PBOXPO Box Address is is a postal office (PO) box ADDRPostal Address is the complete postal address HOMEHome Address is the home address - departmentstring
ISO20022: Identification of a division of a large organisation or building.
ISO20022: Identification of a division of a large organisation or building. API: Cannot be used for SEPA payments.
Constraints: maxLength: 70
- subDepartmentstring
ISO20022: Identification of a sub-division of a large organisation or building.
ISO20022: Identification of a sub-division of a large organisation or building. API: Cannot be used for SEPA payments.
Constraints: maxLength: 70
- streetNamestring
ISO20022: Name of a street or thoroughfare.
ISO20022: Name of a street or thoroughfare. API: Cannot be used for SEPA payments.
Constraints: maxLength: 70
- buildingNumberstring
ISO20022: Number that identifies the position of a building on a street.
ISO20022: Number that identifies the position of a building on a street. API: Cannot be used for SEPA payments.
Constraints: maxLength: 16
- buildingNamestring
ISO20022: Name of the building or house.
ISO20022: Name of the building or house. API: Cannot be used for SEPA payments.
Constraints: maxLength: 16
- postCodestring
ISO20022: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
ISO20022: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. API: Cannot be used for SEPA payments.
Constraints: maxLength: 16
- townNamestring
ISO20022: Name of a built-up area, with defined boundaries, and a local government.
ISO20022: Name of a built-up area, with defined boundaries, and a local government. API: Cannot be used for SEPA payments.
Constraints: maxLength: 35
- countrySubDivisionstring
ISO20022: Identifies a subdivision of a country such as state, region, county.
ISO20022: Identifies a subdivision of a country such as state, region, county. API: Cannot be used for SEPA payments.
Constraints: maxLength: 35
- countrystringrequired
ISO20022: Country in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.
ISO20022: Country in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.
Constraints: pattern: `^([A-Z]{2,2})$`
- addressLinearray<string>
Unstructured address. The lines must embed zip code and town name.
Unstructured address. The lines must embed zip code and town name. For SEPA payments, only two address lines are allowed.
Type: array<string>
Item: Address line
Item constraints: maxLength: 70
- contactDetailsContactDetails
Indicates how to contact the party.
Schema: ContactDetails
Indicates how to contact the party.
- phoneNumberPhoneNumber
The collection of information which identifies a specific phone or FAX number as defined by telecom services.
Schema: PhoneNumber
The collection of information which identifies a specific phone or FAX number as defined by telecom services. It consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Type: string
Constraints: pattern: `^\+[0-9]{1,3}-[0-9()+\-]{1,30}$`
- faxNumberPhoneNumber
The collection of information which identifies a specific phone or FAX number as defined by telecom services.
Schema: PhoneNumber
The collection of information which identifies a specific phone or FAX number as defined by telecom services. It consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Type: string
Constraints: pattern: `^\+[0-9]{1,3}-[0-9()+\-]{1,30}$`
- emailAddressstring
email address of the contact
Constraints: maxLength: 2048 · pattern: `^.+@.+$`
- organisationIdGenericIdentification
ISO20022: Unique identification of an account, a person or an organisation, as assigned by an issuer.
Schema: GenericIdentification
ISO20022: Unique identification of an account, a person or an organisation, as assigned by an issuer. API: The ASPSP will document which account reference type it will support.
- identificationstringrequired
API: Identifier
API: Identifier
Constraints: maxLength: 70
- schemeNamestringrequired
Name of the identification scheme.
Name of the identification scheme. Possible values for the scheme name, partially based on ISO20022 external code list, are the following:
Code Name Description BANK BankPartyIdentification Unique and unambiguous assignment made by a specific bank or similar financial institution to identify a relationship as defined between the bank and its client. BBAN BBANIdentifier Basic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer. COID CountryIdentificationCode) : Country authority given organisation identification (e.g., corporate registration number) SREN SIREN The SIREN number is a 9 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation in France. SRET SIRET The SIRET number is a 14 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation unit in France. It consists of the SIREN number, followed by a five digit classification number, to identify the local geographical unit of that entity. NIDN NationalIdentityNumber Number assigned by an authority to identify the national identity number of a person. Other values are also permitted, for instance: Code Name Description ---- ---- ----------- OAUT OAUTH2 OAUTH2 access token that is owned by the PISP being also an AISP and that can be used in order to identify the PSU CPAN CardPan Card PAN MPAN MaskedPan Card PAN where some digits were replaced for security reason TPAN TokenizedPan Token which was provided by a Token Service Provider (TSP) in order to obfuscate a real card PAN. The TSP must be identified in the issuer field TBAN TokenizedIBAN Token which was provided by a Token Service Provider (TSP) in order to obfuscate an IBAN. The TSP must be identified in the issuer field Each implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used Constraints: maxLength: 70
- issuerstring
ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties
ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties
Constraints: maxLength: 35
- privateIdGenericIdentification
ISO20022: Unique identification of an account, a person or an organisation, as assigned by an issuer.
Schema: GenericIdentification
ISO20022: Unique identification of an account, a person or an organisation, as assigned by an issuer. API: The ASPSP will document which account reference type it will support.
- identificationstringrequired
API: Identifier
API: Identifier
Constraints: maxLength: 70
- schemeNamestringrequired
Name of the identification scheme.
Name of the identification scheme. Possible values for the scheme name, partially based on ISO20022 external code list, are the following:
Code Name Description BANK BankPartyIdentification Unique and unambiguous assignment made by a specific bank or similar financial institution to identify a relationship as defined between the bank and its client. BBAN BBANIdentifier Basic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer. COID CountryIdentificationCode) : Country authority given organisation identification (e.g., corporate registration number) SREN SIREN The SIREN number is a 9 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation in France. SRET SIRET The SIRET number is a 14 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation unit in France. It consists of the SIREN number, followed by a five digit classification number, to identify the local geographical unit of that entity. NIDN NationalIdentityNumber Number assigned by an authority to identify the national identity number of a person. Other values are also permitted, for instance: Code Name Description ---- ---- ----------- OAUT OAUTH2 OAUTH2 access token that is owned by the PISP being also an AISP and that can be used in order to identify the PSU CPAN CardPan Card PAN MPAN MaskedPan Card PAN where some digits were replaced for security reason TPAN TokenizedPan Token which was provided by a Token Service Provider (TSP) in order to obfuscate a real card PAN. The TSP must be identified in the issuer field TBAN TokenizedIBAN Token which was provided by a Token Service Provider (TSP) in order to obfuscate an IBAN. The TSP must be identified in the issuer field Each implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used Constraints: maxLength: 70
- issuerstring
ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties
ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties
Constraints: maxLength: 35
- leiLeiIdentification
Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
Schema: LeiIdentification
Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
Type: string
Constraints: pattern: `^[A-Z0-9]{18,18}[0-9]{2,2}$`
- invoiceePartyIdentification
API : Description of a Party which can be either a person or an organization.
Schema: PartyIdentification
API : Description of a Party which can be either a person or an organization.
- namestringrequired
ISO20022: Name by which a party is known and which is usually used to identify that party.
ISO20022: Name by which a party is known and which is usually used to identify that party. The [organisationId] property allows the specification of an unique and unambiguous way to identify an organisation. The [privateId] property allows the specification of an unique and unambiguous way to identify a person.
Constraints: maxLength: 140
- dateAndPlaceOfBirthDateAndPlaceOfBirth
Date and place of birth of a person.
Schema: DateAndPlaceOfBirth
Date and place of birth of a person. This information must be requested for detection of Fraud, Money-Laundering and Terrorism Financing in case of international payment.
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 BIZZBusiness Address is the business address DLVYDelivery Address is the address to which delivery is to take place MLTOMail To Address is the address to which mail is sent PBOXPO Box Address is is a postal office (PO) box ADDRPostal Address is the complete postal address HOMEHome Address is the home address - departmentstring
ISO20022: Identification of a division of a large organisation or building.
ISO20022: Identification of a division of a large organisation or building. API: Cannot be used for SEPA payments.
Constraints: maxLength: 70
- subDepartmentstring
ISO20022: Identification of a sub-division of a large organisation or building.
ISO20022: Identification of a sub-division of a large organisation or building. API: Cannot be used for SEPA payments.
Constraints: maxLength: 70
- streetNamestring
ISO20022: Name of a street or thoroughfare.
ISO20022: Name of a street or thoroughfare. API: Cannot be used for SEPA payments.
Constraints: maxLength: 70
- buildingNumberstring
ISO20022: Number that identifies the position of a building on a street.
ISO20022: Number that identifies the position of a building on a street. API: Cannot be used for SEPA payments.
Constraints: maxLength: 16
- buildingNamestring
ISO20022: Name of the building or house.
ISO20022: Name of the building or house. API: Cannot be used for SEPA payments.
Constraints: maxLength: 16
- postCodestring
ISO20022: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
ISO20022: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. API: Cannot be used for SEPA payments.
Constraints: maxLength: 16
- townNamestring
ISO20022: Name of a built-up area, with defined boundaries, and a local government.
ISO20022: Name of a built-up area, with defined boundaries, and a local government. API: Cannot be used for SEPA payments.
Constraints: maxLength: 35
- countrySubDivisionstring
ISO20022: Identifies a subdivision of a country such as state, region, county.
ISO20022: Identifies a subdivision of a country such as state, region, county. API: Cannot be used for SEPA payments.
Constraints: maxLength: 35
- countrystringrequired
ISO20022: Country in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.
ISO20022: Country in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.
Constraints: pattern: `^([A-Z]{2,2})$`
- addressLinearray<string>
Unstructured address. The lines must embed zip code and town name.
Unstructured address. The lines must embed zip code and town name. For SEPA payments, only two address lines are allowed.
Type: array<string>
Item: Address line
Item constraints: maxLength: 70
- contactDetailsContactDetails
Indicates how to contact the party.
Schema: ContactDetails
Indicates how to contact the party.
- phoneNumberPhoneNumber
The collection of information which identifies a specific phone or FAX number as defined by telecom services.
Schema: PhoneNumber
The collection of information which identifies a specific phone or FAX number as defined by telecom services. It consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Type: string
Constraints: pattern: `^\+[0-9]{1,3}-[0-9()+\-]{1,30}$`
- faxNumberPhoneNumber
The collection of information which identifies a specific phone or FAX number as defined by telecom services.
Schema: PhoneNumber
The collection of information which identifies a specific phone or FAX number as defined by telecom services. It consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Type: string
Constraints: pattern: `^\+[0-9]{1,3}-[0-9()+\-]{1,30}$`
- emailAddressstring
email address of the contact
Constraints: maxLength: 2048 · pattern: `^.+@.+$`
- organisationIdGenericIdentification
ISO20022: Unique identification of an account, a person or an organisation, as assigned by an issuer.
Schema: GenericIdentification
ISO20022: Unique identification of an account, a person or an organisation, as assigned by an issuer. API: The ASPSP will document which account reference type it will support.
- identificationstringrequired
API: Identifier
API: Identifier
Constraints: maxLength: 70
- schemeNamestringrequired
Name of the identification scheme.
Name of the identification scheme. Possible values for the scheme name, partially based on ISO20022 external code list, are the following:
Code Name Description BANK BankPartyIdentification Unique and unambiguous assignment made by a specific bank or similar financial institution to identify a relationship as defined between the bank and its client. BBAN BBANIdentifier Basic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer. COID CountryIdentificationCode) : Country authority given organisation identification (e.g., corporate registration number) SREN SIREN The SIREN number is a 9 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation in France. SRET SIRET The SIRET number is a 14 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation unit in France. It consists of the SIREN number, followed by a five digit classification number, to identify the local geographical unit of that entity. NIDN NationalIdentityNumber Number assigned by an authority to identify the national identity number of a person. Other values are also permitted, for instance: Code Name Description ---- ---- ----------- OAUT OAUTH2 OAUTH2 access token that is owned by the PISP being also an AISP and that can be used in order to identify the PSU CPAN CardPan Card PAN MPAN MaskedPan Card PAN where some digits were replaced for security reason TPAN TokenizedPan Token which was provided by a Token Service Provider (TSP) in order to obfuscate a real card PAN. The TSP must be identified in the issuer field TBAN TokenizedIBAN Token which was provided by a Token Service Provider (TSP) in order to obfuscate an IBAN. The TSP must be identified in the issuer field Each implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used Constraints: maxLength: 70
- issuerstring
ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties
ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties
Constraints: maxLength: 35
- privateIdGenericIdentification
ISO20022: Unique identification of an account, a person or an organisation, as assigned by an issuer.
Schema: GenericIdentification
ISO20022: Unique identification of an account, a person or an organisation, as assigned by an issuer. API: The ASPSP will document which account reference type it will support.
- identificationstringrequired
API: Identifier
API: Identifier
Constraints: maxLength: 70
- schemeNamestringrequired
Name of the identification scheme.
Name of the identification scheme. Possible values for the scheme name, partially based on ISO20022 external code list, are the following:
Code Name Description BANK BankPartyIdentification Unique and unambiguous assignment made by a specific bank or similar financial institution to identify a relationship as defined between the bank and its client. BBAN BBANIdentifier Basic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer. COID CountryIdentificationCode) : Country authority given organisation identification (e.g., corporate registration number) SREN SIREN The SIREN number is a 9 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation in France. SRET SIRET The SIRET number is a 14 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation unit in France. It consists of the SIREN number, followed by a five digit classification number, to identify the local geographical unit of that entity. NIDN NationalIdentityNumber Number assigned by an authority to identify the national identity number of a person. Other values are also permitted, for instance: Code Name Description ---- ---- ----------- OAUT OAUTH2 OAUTH2 access token that is owned by the PISP being also an AISP and that can be used in order to identify the PSU CPAN CardPan Card PAN MPAN MaskedPan Card PAN where some digits were replaced for security reason TPAN TokenizedPan Token which was provided by a Token Service Provider (TSP) in order to obfuscate a real card PAN. The TSP must be identified in the issuer field TBAN TokenizedIBAN Token which was provided by a Token Service Provider (TSP) in order to obfuscate an IBAN. The TSP must be identified in the issuer field Each implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used Constraints: maxLength: 70
- issuerstring
ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties
ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties
Constraints: maxLength: 35
- leiLeiIdentification
Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
Schema: LeiIdentification
Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
Type: string
Constraints: pattern: `^[A-Z0-9]{18,18}[0-9]{2,2}$`
- taxRemittanceTaxInformation
ISO20022: Details about tax paid, or to be paid, to the government in accordance with the law, including pre-defined parameters such as thresholds and type of account.
Schema: TaxInformation
ISO20022: Details about tax paid, or to be paid, to the government in accordance with the law, including pre-defined parameters such as thresholds and type of account. API: Amounts must always be set as positive values. The [totalTaxableBaseAmount] property indicates the total amount of money on which the tax is based. The [totalTaxAmount] property indicates the total amount of money as result of the calculation of the tax.
- creditorTaxParty
Set of elements used to identify a party of the transaction to which the tax applies.
Schema: TaxParty
Set of elements used to identify a party of the transaction to which the tax applies. The [authorization] property aims to provide the details of the authorised tax paying party.
- taxIdentificationstring
Tax identification number of the party.
Constraints: maxLength: 35
- registrationIdentificationstring
Unique identification, as assigned by an organisation, to unambiguously identify a party.
Constraints: maxLength: 35
- taxTypestring
Type of tax payer.
Constraints: maxLength: 35
- debtorTaxParty
Set of elements used to identify a party of the transaction to which the tax applies.
Schema: TaxParty
Set of elements used to identify a party of the transaction to which the tax applies. The [authorization] property aims to provide the details of the authorised tax paying party.
- taxIdentificationstring
Tax identification number of the party.
Constraints: maxLength: 35
- registrationIdentificationstring
Unique identification, as assigned by an organisation, to unambiguously identify a party.
Constraints: maxLength: 35
- taxTypestring
Type of tax payer.
Constraints: maxLength: 35
- ultimateDebtorTaxParty
Set of elements used to identify a party of the transaction to which the tax applies.
Schema: TaxParty
Set of elements used to identify a party of the transaction to which the tax applies. The [authorization] property aims to provide the details of the authorised tax paying party.
- taxIdentificationstring
Tax identification number of the party.
Constraints: maxLength: 35
- registrationIdentificationstring
Unique identification, as assigned by an organisation, to unambiguously identify a party.
Constraints: maxLength: 35
- taxTypestring
Type of tax payer.
Constraints: maxLength: 35
- administrationZonestring
Territorial part of a country to which the tax payment is related.
Constraints: maxLength: 35
- referenceNumberstring
Tax reference information that is specific to a taxing agency.
Constraints: maxLength: 140
- methodstring
Method used to indicate the underlying business or how the tax is paid.
Constraints: maxLength: 35
- totalTaxableBaseAmountAmountType
Structure aiming to embed the amount and the currency to be used.
Schema: AmountType
Structure aiming to embed the amount and the currency to be used.
- amountnumber (float)required
ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
Constraints: pattern: `^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$`
Specifies the currency of the amount or of the account.
Schema: CurrencyCode
Specifies the currency of the amount or of the account. A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Type: string
Constraints: pattern: `^[A-Z]{3,3}$`
- totalTaxAmountAmountType
Structure aiming to embed the amount and the currency to be used.
Schema: AmountType
Structure aiming to embed the amount and the currency to be used.
- amountnumber (float)required
ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
Constraints: pattern: `^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$`
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}$`
Date by which tax is due.
- sequenceNumberinteger (int32)
Sequential number of the tax report.
- recordarray<TaxRecord>
Records of tax details
Item: TaxRecord
Record of tax details the [period] property embbeds the set of elements used to provide details on the period of time related to the tax payment. the [amount] property embbeds the set of elements used to provide information on the amount of the tax record.
- typestring
High level code to identify the type of tax details.
Constraints: maxLength: 35
- categorystring
Specifies the tax code as published by the tax authority.
Constraints: maxLength: 35
- categoryDetailsstring
Provides further details of the category tax code.
Constraints: maxLength: 35
- debtorStatusstring
Code provided by local authority to identify the status of the party that has drawn up the settlement document.
Constraints: maxLength: 35
- certificateIdentificationstring
Identification number of the tax report as assigned by the taxing authority.
Constraints: maxLength: 35
- formsCodestring
Identifies, in a coded form, on which template the tax report is to be provided.
Constraints: maxLength: 35
- periodTaxPeriod
Set of elements used to provide details on the period of time related to the tax payment.
Schema: TaxPeriod
Set of elements used to provide details on the period of time related to the tax payment. The [type] property aims to identify the period related to the tax payment.
- yearstring
Year related to the tax payment.
Constraints: pattern: `^[0-9]{4,4}$`
- typeTaxRecordPeriodCode
Identification of the period related to the tax payment.
Schema: TaxRecordPeriodCode
Code Description MM01FirstMonth Tax is related to the second month of the period. MM02SecondMonth Tax is related to the first month of the period. MM03ThirdMonth Tax is related to the third month of the period. MM04FourthMonth Tax is related to the fourth month of the period. MM05FifthMonth Tax is related to the fifth month of the period. MM06SixthMonth Tax is related to the sixth month of the period. MM07SeventhMonth Tax is related to the seventh month of the period. MM08EighthMonth Tax is related to the eighth month of the period. MM09NinthMonth Tax is related to the ninth month of the period. MM10TenthMonth Tax is related to the tenth month of the period. MM11EleventhMonth Tax is related to the eleventh month of the period. MM12TwelfthMonth Tax is related to the twelfth month of the period. QTR1FirstQuarter Tax is related to the first quarter of the period. QTR2SecondQuarter Tax is related to the second quarter of the period. QTR3ThirdQuarter Tax is related to the third quarter of the period. QTR4FourthQuarter Tax is related to the fourth quarter of the period. HLF1FirstHalf Tax is related to the first half of the period. HLF2SecondHalf Tax is related to the second half of the period. Start date of the range.
End date of the range.
- taxAmountTaxAmount
ISO20022: Set of elements used to provide information on the amount of the tax record.
Schema: TaxAmount
ISO20022: Set of elements used to provide information on the amount of the tax record. API: Amounts must always be set as positive values.
Property Description rate Rate used to calculate the tax. taxableBaseAmount Amount of money on which the tax is based. totalAmount Total amount that is the result of the calculation of the tax for the record. details Set of elements used to provide details on the tax period and amount. - ratePercentageRate
Rate expressed as a percentage, ie, in hundredths, eg, 0.7 is 7/10 of a percent, and 7.0 is 7%.
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
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}$`
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}$`
- totalAmountAmountType
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}$`
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}$`
- detailsarray<TaxRecordDetails>
Set of elements used to provide details on the tax period and amount.
Item: TaxRecordDetails
ISO20022: Elements used to provide details on the tax period and amount. API: Amounts must always be set as positive values.
Property Description period Set of elements used to provide details on the period of time related to the tax payment. amount Underlying tax amount related to the specified period. - 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. The [type] property aims to identify the period related to the tax payment.
- yearstring
Year related to the tax payment.
Constraints: pattern: `^[0-9]{4,4}$`
- typeTaxRecordPeriodCode
Identification of the period related to the tax payment.
Schema: TaxRecordPeriodCode
Code Description MM01FirstMonth Tax is related to the second month of the period. MM02SecondMonth Tax is related to the first month of the period. MM03ThirdMonth Tax is related to the third month of the period. MM04FourthMonth Tax is related to the fourth month of the period. MM05FifthMonth Tax is related to the fifth month of the period. MM06SixthMonth Tax is related to the sixth month of the period. MM07SeventhMonth Tax is related to the seventh month of the period. MM08EighthMonth Tax is related to the eighth month of the period. MM09NinthMonth Tax is related to the ninth month of the period. MM10TenthMonth Tax is related to the tenth month of the period. MM11EleventhMonth Tax is related to the eleventh month of the period. MM12TwelfthMonth Tax is related to the twelfth month of the period. QTR1FirstQuarter Tax is related to the first quarter of the period. QTR2SecondQuarter Tax is related to the second quarter of the period. QTR3ThirdQuarter Tax is related to the third quarter of the period. QTR4FourthQuarter Tax is related to the fourth quarter of the period. HLF1FirstHalf Tax is related to the first half of the period. HLF2SecondHalf Tax is related to the second half of the period. Start date of the range.
End date of the range.
- 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}$`
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}$`
- additionalInformationstring
Further details of the tax record.
Constraints: maxLength: 140