ofOpen Finance Guide
GlosarioSTETBlogContacto
ISO20022object

ChargesRecord

ISO20022: Provides further individual record details on the charges related to the payment transaction.

  • The [amount] proprty specifies the transaction charges to be paid by the charge bearer.
  • The [creditDebitIndicator] property indicates whether the charges amount is a credit or a debit amount. A zero amount is considered to be a credit.
  • the [code] property is the charge type, in a coded form
  • the [rate] property is the rate used to calculate the amount of the charge or fee.
  • the [bearer] property specifies which party/parties will bear the charges associated with the processing of the payment transaction.
  • the [agent] property specifies the agent that takes the transaction charges or to which the transaction charges are due.
  • the [tax] property provides details on the tax applied to charges. API: Amounts must always be set as positive values.

Fields (8)

  • amountAmountType

    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

    CodeDescription
    CRDT
    		Credit type amount
    DBIT
    		Debit type amount
  • chargeIncludedIndicatorboolean

    Indicates whether the charge should be included in the amount or is added as pre-advice.

    Indicates whether the charge should be included in the amount or is added as pre-advice. One of the following values must be used:

    • Meaning When True: Included
    • Meaning When False: Pre-advised
  • codeCodeAndIssuer

    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

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

  • bearerChargeBearerCode

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

    Schema: ChargeBearerCode

    CodeNameDescription
    DEBT
    		BorneByDebtorAll transaction charges are to be borne by the debtor.
    CRED
    		BorneByCreditorAll transaction charges are to be borne by the creditor.
    SHAR
    		SharedIn 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
    		FollowingServiceLevelCharges are to be applied following the rules agreed in the service level and/or scheme.
  • agentFinancialInstitutionIdentification

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

    Schema: FinancialInstitutionIdentification

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

    • bicFistringrequired

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

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

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

    • clearingSystemMemberIdClearingSystemMemberIdentification

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

      Schema: ClearingSystemMemberIdentification

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

      • clearingSystemIdstringrequired

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

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

        Constraints: maxLength: 35

      • memberIdstringrequired

        ISO20022: Identification of a member of a clearing system.

        ISO20022: Identification of a member of a clearing system.

        Constraints: maxLength: 35

    • leiLeiIdentification

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

      Schema: LeiIdentification

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

      Type: string

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

    • namestring

      Name of the financial institution

      Constraints: maxLength: 140

    • postalAddressPostalAddress

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

      Schema: PostalAddress

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

      • addressTypestringenum · 6

        ISO20022: Identifies the nature of the postal address.

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

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

        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

  • taxTaxCharges

    ISO20022: Provides details on the tax applied to charges.

    Schema: TaxCharges

    ISO20022: Provides details on the tax applied to charges.

    • The [rate] property is the rate used to calculate the tax.
    • the [amount] property is the amount of money resulting from the calculation of the tax. API: Amounts must always be set as positive values.
    • identificationstring

      Unique reference to unambiguously identify the nature of the tax levied, such as Value Added Tax (VAT).

      Constraints: maxLength: 35

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

    • amountAmountType

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