| Twist |
Includes the tags used in the TWIST format. |
| header |
Displays the header ID. |
|
messageId |
|
|
inReplyTo |
|
|
sentBy |
|
|
typedPartyId |
|
|
partyId |
|
|
partyIdType |
|
|
creationTimestamp |
|
|
expiryTimestamp |
|
| electronicStatement |
Displays the details of the statement including the header
information. |
|
statementHeader |
|
| stmtSender |
Displays information about the sender person (i.e. financial
institution). Note: The sender person is derived from the SENDPER characteristic of the division to which the account
belongs.
|
|
industId |
|
|
industIdType |
|
|
industIdNum |
|
| name |
This tag appears within the following tags:
| If this tag is used within... |
Then the purpose of the name tag is... |
| stmtSender |
Displays the primary name of the financial institution. |
| countrySubDivision |
Indicates the state where the city is located. |
| individualContact |
Displays the primary name of the sender's or receiver's individual
contact person. |
| stmtReceiver |
Displays the primary name of the financial institution or
organization. |
|
| legalName |
This tag appears within the following tags:
| If this tag is used within... |
Then the purpose of the legalName tag is... |
| stmtSender |
Displays the legal name of the financial institution. |
| stmtReceiver |
Displays the legal name of the financial institution or organization. |
|
| contactInfo |
This tag appears within the following tags:
| If this tag is used within... |
Then the purpose of the contactInfo tag is... |
| stmtSender |
Displays the contact details of the financial institution. |
| stmtReceiver |
Displays the contact details of the financial institution
or organization. |
|
| departmentName |
This tag appears within the following tags:
| If this tag is used within... |
Then the purpose of the departmentName tag is... |
| postAddress |
At present, no information appears in this tag. The implementation
team can write the custom logic to display the required information
in this tag. |
|
|
otherCommunication |
|
|
channelCode |
|
|
value |
|
|
phoneNumber |
|
| postAddress |
This tag appears within the following tags:
| If this tag is used within... |
Then the purpose of the postAddress tag is... |
| contactInfo |
Displays the address details of the sender or receiver. |
|
| addressIdentifier |
This tag appears within the following tags:
| If this tag is used within... |
Then the purpose of the addressIdentifier tag is... |
| postAddress (Sender) |
At present, no information appears in this tag. The implementation
team can write the custom logic to display the required information
in this tag. |
| postAddress (Receiver) |
The information shown in this tag varies depending on the
bill address source. If the bill address source is PER, then the tag contains the string ‘Billing’. However, if the bill
address source is ACOV, then the tag contains
the string ‘Override’. |
|
| postBox |
This tag appears within the following tags:
| If this tag is used within... |
Then the purpose of the postBox tag is... |
| postAddress |
At present, no information appears in this tag. The implementation
team can write the custom logic to display the required information
in this tag. |
|
| floor |
This tag appears within the following tags:
| If this tag is used within... |
Then the purpose of the floor tag is... |
| postAddress |
At present, no information appears in this tag. The implementation
team can write the custom logic to display the required information
in this tag. |
|
| room |
This tag appears within the following tags:
| If this tag is used within... |
Then the purpose of the room tag is... |
| postAddress |
At present, no information appears in this tag. The implementation
team can write the custom logic to display the required information
in this tag. |
|
| addressLine |
This tag appears within the following tags:
| If this tag is used within... |
Then the purpose of the addressLine tag is... |
| postAddress |
Displays a concatenated string consisting of address line
1, 2, 3, and 4 separated by a comma. |
|
| streetName |
This tag appears within the following tags:
| If this tag is used within... |
Then the purpose of the streetName tag is... |
| postAddress |
At present, no information appears in this tag. The implementation
team can write the custom logic to display the required information
in this tag. |
|
| buildingName |
This tag appears within the following tags:
| If this tag is used within... |
Then the purpose of the buildingName tag is... |
| postAddress |
At present, no information appears in this tag. The implementation
team can write the custom logic to display the required information
in this tag. |
|
| buildingNum |
This tag appears within the following tags:
| If this tag is used within... |
Then the purpose of the buildingNum tag is... |
| postAddress |
At present, no information appears in this tag. The implementation
team can write the custom logic to display the required information
in this tag. |
|
| city |
This tag appears within the following tags:
| If this tag is used within... |
Then the purpose of the city tag is... |
| postAddress |
Displays the city name. |
|
| countrySubDivision |
This tag appears within the following tags:
| If this tag is used within... |
Then the purpose of the countrySubDivision tag is... |
| postAddress |
Displays the state where the city is located. |
|
|
code |
|
| country |
This tag appears within the following tags:
| If this tag is used within... |
Then the purpose of the country tag is... |
| postAddress |
Displays the country where the address is located. |
|
|
countryIdentification |
|
| postCode |
This tag appears within the following tags:
| If this tag is used within... |
Then the purpose of the postCode tag is... |
| postAddress |
Displays the zip or postal code of the address. |
|
|
prefMethod |
|
| individualContact |
This tag appears within the following tags:
| If this tag is used within... |
Then the purpose of the individualContact tag is... |
| stmtSender |
Displays the name of the sender's individual contact person. |
| stmtReceiver |
Displays the name of the receiver's individual contact person. |
|
| stmtReceiver |
Displays information about the receiver person (i.e. financial
institution or organization). The receiver is derived from the account
for which the bill is created. The system derives the person who is
the main customer of the account. |
| orgId |
This tag appears within the following tags:
| If this tag is used within... |
Then the purpose of the orgId tag is... |
| stmtSender |
Displays the identification details of the financial institution. |
| stmtReceiver |
Displays the identification details of the financial institution
or organization. |
|
|
orgIdType |
|
| orgIdNum |
This tag appears within the following tags:
| If this tag is used within... |
Then the purpose of the orgIdNum tag is... |
| orgId (Sender) |
Displays the bank identifier code of the financial institution. |
| orgId (Receiver) |
Displays the bank identifier code of the financial institution
or organization. |
|
|
phone |
This tag appears within the
following tags:
| If this tag is used within... |
Then the purpose of the phone tag is... |
| contactInfo |
Displays the business phone number of the sender's or receiver's
individual contact person. |
|
|
fax |
This tag appears within the
following tags:
| If this tag is used within... |
Then the purpose of the fax tag is... |
| contactInfo |
Displays the fax number of the sender's or receiver's individual
contact person. |
|
|
Email |
This tag appears within the
following tags:
| If this tag is used within... |
Then the purpose of the Email tag is... |
| contactInfo |
Displays the e-mail address of the sender's or receiver's
individual contact person. |
|
| statement |
Displays the details of the statement. A statement includes
all service charges that occurred during a statement cycle. |
| account |
Displays the details of the account for which the bills are
extracted. |
| accountLevel |
Contains a hard-coded string ‘DETL’. |
|
bban |
|
| iban |
Displays the international bank account number. |
| statementStartDate |
Displays the date from when the bills are considered for
extraction in the statement. Note: The system sets the from date to
the last processing date of the statement cycle plus one day.
|
| statementEndDate |
Displays the date till when the bills are considered for
extraction in the statement. Note: The system sets the to date to the
statement cycle's processing date which is earlier than the batch
business date and is in the Pending status.
|
| statementProductionDate |
Displays the date and time when the statement is created. |
| statementStatus |
Displays the status of the statement. The valid values are:
|
|
accountName |
|
|
domicileBankQualifier |
|
| domicileBankIdentifier |
Displays the bank identifier code of the account servicer. Note: The account servicer is a domicile bank (i.e. a branch) in which
the account actually resides. An account servicer is defined as a
person in ORMB. The account servicer for an account is derived from
the SRVPER characteristic of the division to
which the account belongs.
|
|
parentAccount |
|
|
parentLevel |
|
|
parentBankQualifier |
|
|
parentBankIdentifier |
|
|
parentAccountBBAN |
|
| compensationMethod |
If the automatic payment feature is not configured for the
account, the compensation method is set to INVD (i.e. Invoiced). However, if the automatic payment feature is configured
for the account and the automatic payment creation date is earlier
than the batch business date, the compensation method is set to DEBTD (i.e. Debited). And, if the automatic payment feature
is configured for the account and the automatic payment creation date
is later than the batch business date, the compensation method is
set to DDBT (i.e. Delayed Debit). |
| debitAccount |
Displays the international bank account number of the account
from where the charges and taxes should be automatically debited.
Usually, this account is different from the account which has availed
the services. |
| delayedDebitDate |
Displays the date when the charges and taxes are automatically
debited. |
| settlementAdvice |
Displays the message advising the customer about the settlement
of charges and taxes which are due. Note: Here, a bill message whose
bill message type is set to S appears in this
tag.
|
| accountBalanceCurrencyCode |
Displays the currency in which the account balance is shown. |
| settlementCurrencyCode |
Displays the currency in which the account is settled. |
| hostCurrencyCode |
Displays the division's base currency which is used during
currency conversion. |
| taxCalculationMethod |
Displays the calculation method which indicates how the taxes
are applied on the account. The valid value is Method C. |
| taxRegionCode |
Indicates the tax region in which the account resides. |
|
taxRegionResident |
|
| bankContactName |
Displays the primary name of the account servicer's contact
person. Note: The account servicer's contact person is an individual
whom you can contact at the financial institution's location regarding
problems of a business nature.
|
| bankContactPhone |
Displays the business or home phone number of the account
servicer's contact person. |
| bankContactEmail |
Displays the e-mail address of the account servicer's contact
person. |
| bankContactFax |
Displays the business or home phone number of the account
servicer's contact person. |
|
taxExplanation |
|
|
taxReason |
|
|
taxReasonCode |
|
|
taxReasonExplanation |
|
| currencyTranslation |
Displays the details of an exchange rate which is used in
the bill. |
| originalCurrency |
Displays the currency from which the amount is converted. |
| targetCurrency |
Displays the currency to which the amount is converted. |
| translationValue |
Displays the exchange rate. |
| basis |
Displays the currency in which the exchange rate is defined. |
|
compensation |
|
|
compensationIdentifier |
|
|
compensationValue |
|
| amount |
This tag appears within the following tags:
| If this tag is used within... |
Then the purpose of the amount tag is... |
| unitPrice |
Displays the rate per unit in the pricing currency. |
| originalChargeSettlement |
Displays the calculated charge in the invoice currency. |
| originalCharge |
Displays the sum of service charge lines in the bill excluding
the service charge lines with a tax distribution code (i.e. a distribution
code where the TAXRATE characteristic is defined).
The amount is expressed in the invoice currency of the account. |
| taxableServiceCharge |
Displays the sum of service charge lines with the same tax
distribution code (i.e. a distribution code where the TAXRATE characteristic is defined). The amount is expressed in the invoice
currency of the account. This calculated amount is used as a source
for calculating the tax. |
| taxableServiceChargeHost |
Displays the sum of service charge lines with the same tax
distribution code (i.e. a distribution code where the TAXRATE characteristic is defined). The amount is expressed in the division's
base currency. |
| totalTaxableSvcChargeHostAmount |
Displays the sum of all taxable service charge lines. The
amount is expressed in the division's base currency. |
| taxIdentifierTotalTaxAmount |
Displays the sum of taxes charged due to the same tax distribution
code. The amount is expressed in the division's base currency. |
| totalTaxAmount |
Displays the sum total of all taxes charged to the receiver
(i.e. customer). The amount is expressed in the division's base currency. |
| settlementAmount |
Displays the sum total of all service charges and taxes billed
to the receiver (i.e. customer). The amount is expressed in the invoice
currency of the account. |
| taxDueToRegion |
Displays the sum total of all taxes charged to the receiver
(i.e. customer). The amount is expressed in the invoice currency of
the account. |
| serviceAdjustmentAmt |
Displays the adjustment amount in the invoice currency. |
| newCharge |
Displays the adjustment amount billed to the customer. |
|
|
currency |
|
| service |
Displays the details of the service (i.e. price item) offered
by the financial institution. |
| bankServiceID |
This tag appears within the following tags:
| If this tag is used within... |
Then the purpose of the bankServiceID tag is... |
| service |
Displays the service (i.e. price item) offered to the customer. |
| serviceDetail |
Displays the service (i.e. price item) offered to the customer. |
|
| serviceDescription |
This tag appears within the following tags:
| If this tag is used within... |
Then the purpose of the serviceDescription tag is... |
| service |
Displays the description of the price item. |
| serviceDetail |
Displays the description of the price item. |
|
| serviceType |
Displays the parent price item to which the price item is
associated. |
| volume |
Displays the quantity of the service (i.e. price item) which
is charged in the bill. |
| pricingCurrencyCode |
Displays the details of the pricing which is used to the
charge the customer. |
| unitPrice |
Displays the price item pricing used per unit to calculate
the charge in the pricing currency. |
| priceMethod |
Indicates the type of price. The valid values are:
-
UPRC - Indicates that the price is a
unit price.
-
FCHG - Indicates that the price is a
flat price.
-
MCHG - Indicates that the price is a
minimum price.
-
MXRD - Indicates that the price is a
maximum price.
-
TIER - Indicates that the price is a
step tiered price.
-
TPRC - Indicates that the price is a
threshold tiered price.
|
| paymentMethod |
Displays the type of charge created for the service. The
valid values are:
-
FLAT - Indicates that the charge is
an SQI-based billable charge.
-
PVCH - Indicates that the charge is
a pass through memo charge.
-
INVS - Indicates that the charge is
a pass through billable charge.
-
FREE - Indicates that the charge is
a 100% discounted charge.
|
|
currencyCode |
This tag appears within the
following tags:
| If this tag is used within... |
Then the purpose of the currencyCode tag is... |
| unitPrice |
Indicates the currency in which the rate is defined. |
| originalChargeSettlement |
Indicates the currency in which the amount is calculated. |
| originalCharge |
Indicates the currency in which the amount is calculated. |
| taxableServiceCharge |
Indicates the currency in which the amount is calculated. |
| taxableServiceChargeHost |
Indicates the currency in which the amount is calculated. |
| totalTaxableSvcChargeHostAmount |
Indicates the currency in which the amount is calculated. |
| taxIdentifierTotalTaxAmount |
Indicates the currency in which the amount is calculated. |
| totalTaxAmount |
Indicates the currency in which the amount is calculated. |
| settlementAmount |
Indicates the currency in which the amount is calculated. |
| taxDueToRegion |
Indicates the currency in which the amount is calculated. |
| serviceAdjustmentAmt |
Indicates the currency in which the adjustment is created. |
| newCharge |
Indicates the currency in which the adjustment is created. |
|
|
originalChargePrice |
|
| originalChargeSettlement |
Displays the details of the calculated charge. |
| taxDetails |
Displays the details about the tax which is calculated on
the charges. |
| taxRegion |
Displays the details of the tax region. |
| taxRegionNumber |
Displays the tax region in which the account resides. Note: The tax region is derived from the TAXREG characteristic
of the account.
|
| taxRegionName |
Displays the tax region in which the account resides. Note: The tax region is derived from the TAXREG characteristic
of the account.
|
| customerTaxId |
Displays the tax identification number of the receiver (i.e.
financial institution or organization). Note: The tax ID is derived
from the TAXID characteristic of the account.
|
| taxInvoiceNumber |
Displays the bill ID. |
| serviceDetail |
Displays the basic details of the price item. |
| originalCharge |
Displays the sum of service charge lines in the bill excluding
the service charge lines with a tax distribution code. |
| taxCalculation |
Displays the details of tax calculation. |
| hostCurCode |
Displays the division's base currency which is used as the
host currency. |
| taxHostConversion |
Displays the sum of service charge lines with a tax distribution
code. This tag is added multiple times in the statement when different
tax distribution codes are used for the service. |
|
taxableServiceChargeAmount |
Displays the sum of service
charge lines with the same tax distribution code. The amount is expressed
in the invoice currency. |
|
taxableServiceChargeHost |
Displays the sum of service
charge lines with the same tax distribution code. The amount is expressed
in the division's base currency. |
|
taxableSvcChargeHostAmount |
|
| totalTaxableSvcChargeHostAmount |
Displays the sum of all taxable service charge lines in the
division's base currency. |
| taxCalculationList |
Displays the details of the tax applied on the service. |
| taxIdentificationNumber |
Displays the distribution code where tax is applicable. In
ORMB terms, it is a distribution code where the TAXRATE characteristic is defined. |
| taxIdentifierDescription |
Displays the description of the distribution code. |
| taxIdentifierRate |
Displays the rate at which the tax is calculated. Note: The
tax rate is derived from the TAXRATE characteristic
of the distribution code.
|
| taxIdentifierTotalTaxAmount |
Displays the sum of taxes charged due to the tax distribution
code. |
| totalTaxAmount |
Displays the sum total of all taxes charged to the receiver
(i.e. customer). |
| settlementAmount |
Displays the sum total of all service charges and taxes billed
to the receiver (i.e. customer). |
| taxDueToRegion |
Displays the sum total of all taxes charged to the receiver
(i.e. customer). |
| serviceAdjustment |
Displays the details of the adjustment which is created for
the service and posted onto the bill. |
| serviceAdjustmentType |
Displays the adjustment type using which the adjustment is
created. |
| serviceAdjustmentDesc |
Displays the description of the adjustment type. |
| serviceAdjustmentAmt |
Displays the adjustment amount. |
| adjustmentErrorDate |
Displays the date when the adjustment is created. |
| serviceAdjustmentID |
Displays the adjustment ID. |
| newCharge |
Displays the adjustment amount billed to the customer. |
