ISO20022object

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.

Campos (2)

  • unstructuredarray<string>

    Unstructured remittance information.

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

    Tipo: array<string>

    Elemento: Relevant information to the transaction

    Restricciones de los elementos: maxLength: 140

  • structuredarray<StructuredRemittanceInformation>

    Structured remittance information

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

      Elemento: ReferredDocumentInformation

      Provides the identification and the content of the referred document.

      • typeCodeAndIssuer

        Specifies a code and the issuer of this code.

        Esquema: CodeAndIssuer

        Specifies a code and the issuer of this code.

        • codestringobligatorio

          Provides the code.

          Restricciones: maxLength: 4

        • issuerstring

          Identification of the issuer of the code.

          Restricciones: maxLength: 35

      • numberstring

        Unique and unambiguous identification of the referred document.

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

        Elemento: LineDetail

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

        • identificationDocumentLineIdentification

          Provides identification of the document line.

          Esquema: DocumentLineIdentification

          Provides identification of the document line. the [type] property must be used for specifying the type of referred document type.

        • descriptionstring

          Description associated with the document line.

          Restricciones: maxLength: 2048

        • amountRemittanceAmount

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

          Esquema: RemittanceAmount

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

          PropertyDescription
          duePayableAmountAmount specified is the exact amount due and payable to the creditor.
          discountAppliedAmountAmount of discount to be applied to the amount due and payable to the creditor.
          creditNoteAmountAmount of a credit note.
          taxAmountAmount of the tax.
          adjustmentAmountAndReasonSpecifies detailed information on the amount and reason of the adjustment.
          remittedAmountAmount of money remitted.
    • referredDocumentAmountRemittanceAmount

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

      Esquema: RemittanceAmount

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

      PropertyDescription
      duePayableAmountAmount specified is the exact amount due and payable to the creditor.
      discountAppliedAmountAmount of discount to be applied to the amount due and payable to the creditor.
      creditNoteAmountAmount of a credit note.
      taxAmountAmount of the tax.
      adjustmentAmountAndReasonSpecifies detailed information on the amount and reason of the adjustment.
      remittedAmountAmount of money remitted.
    • creditorReferenceInformationCreditorReferenceInformation

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

      Esquema: CreditorReferenceInformation

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

    • invoicerPartyIdentification

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

      Esquema: PartyIdentification

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

      • namestringobligatorio

        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.

        Restricciones: maxLength: 140

      • dateAndPlaceOfBirthDateAndPlaceOfBirth

        Date and place of birth of a person.

        Esquema: 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 8601obligatorio

          Date on which a person is born.

        • cityOfBirthstringobligatorio

          City where a person was born.

          Restricciones: maxLength: 35

        • countryOfBirthstringobligatorio

          Country where a person was born.

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

      • postalAddressPostalAddress

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

        Esquema: PostalAddress

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

        • addressTypestringenumeración · 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.

          CódigoNombreDescripción
          BIZZ
          BusinessAddress is the business address
          DLVY
          DeliveryAddress is the address to which delivery is to take place
          MLTO
          Mail ToAddress is the address to which mail is sent
          PBOX
          PO BoxAddress is is a postal office (PO) box
          ADDR
          PostalAddress is the complete postal address
          HOME
          HomeAddress 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.

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

          Restricciones: maxLength: 70

        • streetNamestring

          ISO20022: Name of a street or thoroughfare.

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

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

          Restricciones: maxLength: 16

        • buildingNamestring

          ISO20022: Name of the building or house.

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

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

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

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

          Restricciones: maxLength: 35

        • countrystringobligatorio

          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.

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

          Tipo: array<string>

          Elemento: Address line

          Restricciones de los elementos: maxLength: 70

      • contactDetailsContactDetails

        Indicates how to contact the party.

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

          Esquema: 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).

          Tipo: string

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

          Esquema: 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).

          Tipo: string

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

        • emailAddressstring

          email address of the contact

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

      • organisationIdGenericIdentification

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

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

        • identificationstringobligatorio

          API: Identifier

          API: Identifier

          Restricciones: maxLength: 70

        • schemeNamestringobligatorio

          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:

          CodeNameDescription
          BANKBankPartyIdentificationUnique and unambiguous assignment made by a specific bank or similar financial institution to identify a relationship as defined between the bank and its client.
          BBANBBANIdentifierBasic 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.
          COIDCountryIdentificationCode) : Country authority given organisation identification (e.g., corporate registration number)
          SRENSIRENThe 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.
          SRETSIRETThe 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.
          NIDNNationalIdentityNumberNumber assigned by an authority to identify the national identity number of a person.
          Other values are also permitted, for instance:
          CodeNameDescription
          -------------------
          OAUTOAUTH2OAUTH2 access token that is owned by the PISP being also an AISP and that can be used in order to identify the PSU
          CPANCardPanCard PAN
          MPANMaskedPanCard PAN where some digits were replaced for security reason
          TPANTokenizedPanToken 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
          TBANTokenizedIBANToken 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

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

          Restricciones: maxLength: 35

      • privateIdGenericIdentification

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

      • leiLeiIdentification

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

        Esquema: LeiIdentification

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

        Tipo: string

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

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

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

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

          Restricciones: maxLength: 35

        • registrationIdentificationstring

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

          Restricciones: maxLength: 35

        • taxTypestring

          Type of tax payer.

          Restricciones: maxLength: 35

        • authorisationTitleAndName

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

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

            Restricciones: maxLength: 35

          • namestring

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

            Restricciones: maxLength: 140

      • debtorTaxParty

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

      • ultimateDebtorTaxParty

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

      • administrationZonestring

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

        Restricciones: maxLength: 35

      • referenceNumberstring

        Tax reference information that is specific to a taxing agency.

        Restricciones: maxLength: 140

      • methodstring

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

        Restricciones: maxLength: 35

      • totalTaxableBaseAmountAmountType

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

      • totalTaxAmountAmountType

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

      • datestring (date)ISO 8601

        Date by which tax is due.

      • sequenceNumberinteger (int32)

        Sequential number of the tax report.

      • recordarray<TaxRecord>

        Records of tax details

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

          Restricciones: maxLength: 35

        • categorystring

          Specifies the tax code as published by the tax authority.

          Restricciones: maxLength: 35

        • categoryDetailsstring

          Provides further details of the category tax code.

          Restricciones: maxLength: 35

        • debtorStatusstring

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

          Restricciones: maxLength: 35

        • certificateIdentificationstring

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

          Restricciones: maxLength: 35

        • formsCodestring

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

          Restricciones: maxLength: 35

        • periodTaxPeriod

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

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

            Restricciones: pattern: `^[0-9]{4,4}$`

          • typeTaxRecordPeriodCode

            Identification of the period related to the tax payment.

            Esquema: TaxRecordPeriodCode

            CódigoDescripción
            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

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

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

          PropertyDescription
          rateRate used to calculate the tax.
          taxableBaseAmountAmount of money on which the tax is based.
          totalAmountTotal amount that is the result of the calculation of the tax for the record.
          detailsSet of elements used to provide details on the tax period and amount.
        • additionalInformationstring

          Further details of the tax record.

          Restricciones: maxLength: 140