The unique access token value. This value must be provided in the Authorization HTTP header for all API calls.

The value of the refresh token that is used to obtain a new access token after it has expired.

The number of seconds remaining till the access token expires

The OAuth2 grant type. The value should always be either ‘client_credentials’ or ‘refresh_token’ and is present only in request body.

The new password for the user represented in the access token request from Authorization header. The new password must meet the following requirements for security:

• MUST contain at least seven characters
• MUST contain at least one uppercase letter
• MUST contain at least one lowercase letter
• MUST contain at least one number
• MUST contain at least one special character
• MUST NOT contain two consecutive identical characters
• MUST NOT contain username
• MUST NOT have been used in the previous 5 changes

Indicates the type of account.

Refer to API Data Mapping documentation for account definitions available for the institution.

Currency in SWIFT format of the account definition.

Example:

• EUR

• USD

• GBP

In cases where value consists of 3 digits:

• 998 means not applicable

• 999 means applicable to all currencies

Refer to API Data Mapping documentation for possible values.

The service contract ID under which the account definition is packaged. Refer to API Data Mapping documentation for possible values.

Account categorisation for information purposes.

Refer to API Data Mapping documentation for possible values.

The condition by which the account is created by the system in cases where the account is not yet available.

Refer to API Data Mapping documentation for possible values.

Binary value (Yes - 001 or No 000). Set to Yes in the case of shadow account types (accounts updated daily with retail balances).

Refer to API Data Mapping documentation for possible values.

Defines the sequence of sub-balances being replenished by payments.

Refer to API Data Mapping documentation for possible values.

Used in Individual Billing Cycles to determine at what level account balances are to be reset during end of Individual Close Cycle.

Refer to API Data Mapping documentation for possible values.

Denotes the default billing cycle applicable to accounts based on this account definition.

Refer to API Data Mapping documentation for possible values.

Indicates how the billing cycle is defined. For example, user defined or contract based. Refer to API Data Mapping documentation for possible values.

Assigned cycle start date for this definition.

Assigned cycle end date for this definition.

Account type ID of the cycle.

Refer to API Data Mapping documentation for possible values.

Account currency of the cycle.

Refer to API Data Mapping documentation for possible values.

Defines the conditions when a statement should be generated for the account definition.

Refer to API Data Mapping documentation for possible values.

The type of statement generated for the account definition.

Refer to API Data Mapping documentation for possible values.

The record creation date.

Defines whether payment history records are generated for the particular account type.

Refer to API Data Mapping documentation for possible values.

Defines whether value balance records are generated for the particular account type.

Refer to API Data Mapping documentation for possible values.

Defines the interest generation method for the account.

Refer to API Data Mapping documentation for possible values.

Defines whether capitalized interest is posted to the same account or another.

Refer to API Data Mapping documentation for possible values.

Defines the sequence of sub-balances being replenished by bonus transactions.

Refer to API Data Mapping documentation for possible values.

Defines the sequence of sub-balances being replenished by credit interest.

Refer to API Data Mapping documentation for possible values.

Defines the sequence of sub-balances being replenished by payments.

Refer to API Data Mapping documentation for possible values.

Identifies Prepayment Definition ID as in CHT_PREPAYMENT_ID (PrePayment, Default or N/A).

Returns the BankWORKS billing cycle definition linked to this resource.

Returns the applicable account limit type definition for this account definition.

Returns the applicable global limit for this account definition. The global limit is a limit on cardholder contract level and acts on top of the account level limit.

Defines the type of account on which the fees are applied.

Refer to API Data Mapping documentation for possible values.

Currency in SWIFT format of the account on which the account fees are applied. In cases where value consists of 3 digits:

• 998 means not applicable
• 999 means applicable to all currencies.

Refer to API Data Mapping documentation for possible values.

The type of fee such as a commission.

Refer to API Data Mapping documentation for possible values.

Boolean value indicating if the fee is a contract fee, i.e institution default setup or not, i.e a client specific override.

The service contract to which the account fee applies.

Refer to API Data Mapping documentation for possible values.

The transaction type of the generated fee, eg Card Subscription Fee, Account Maintenance Fee.

Refer to API Data Mapping documentation for possible values.

The date in ISO 8601 format when the account fee definition becomes effective.

The date in ISO 8601 format when the account fee definition can no longer be used.

Sign operator related to trigger source and trigger value.

Refer to API Data Mapping documentation for possible values.

Defines when and how often the fee process is run, eg Daily, End of Cycle etc.

Refer to API Data Mapping documentation for possible values.

Defines a set of rules related to the generic fee.

Refer to API Data Mapping documentation for possible values.

Defines the value or event that triggers the fee process, eg new account.

Refer to API Data Mapping documentation for possible values.

Used by trigger sources requiring values, for Overdue amount > 500. Note that all trigger amount currencies MUST match. Maximum allowed length (including decimal point) is 18.

Used by trigger sources requiring maximum values, for example tiered fees. Note that all trigger amount currencies MUST match. Maximum allowed length (including decimal point) is 18.

Used to determine the value date of the fee, eg Posting Date.

Refer to API Data Mapping documentation for possible values.

Sign operator related to fixedPeriod following the periodReference.

Refer to API Data Mapping documentation for possible values.

Tariff package for the account fee.

Refer to API Data Mapping documentation for possible values.

The standard amount generated for the account fee. Note that all fee amount currencies MUST match. Maximum allowed length (including decimal point) is 11.

Indicates the minimum value that can be charged for the account if the feeBase and feePercent values are LOWER than this value. Note that all fee amount currencies MUST match. Maximum allowed length (including decimal point) is 11.

Indicates the maximum value that can be charged for the account if the feeBase and feePercent values are GREATER than this value. Note that all fee amount currencies MUST match. Maximum allowed length (including decimal point) is 11.

Suppress or generate the fee.

Refer to API Data Mapping documentation for possible values.

The percentage value used to generate the fee for account fee trigger setup. Maximum allowed length (including decimal point) is 11.

The transaction type of the generated fee.

Refer to API Data Mapping documentation for possible values.

Number of days due after the periodReference.

maximum: 999

Defined for which level the application fee is being generated, eg Level, Group Level, First Service etc.

Refer to API Data Mapping documentation for possible values.

Enables the setting up of the same fee but with a different trigger value high and low.

Refer to API Data Mapping documentation for possible values.

Defines where the fee is posted to the account to which it is applied, select Yes or No. If value set to No, posting instructions are used to look up the real amount.

Refer to API Data Mapping documentation for possible values.

The cardholder’s card number. The value is returned in masked format.

To filter with this field, you will need to use the LIKE operator with wildcard(%25) and the last four digits of the card, together with a filter for other fields if needed.

• filter[cardNumber][LIKE]=%258906
  

Indicates the authorization transaction status.

• 005 - Pending
• 006 - Matched
• 009 - Cleared
• 013 - Purged

The expiry date of the card in YYMM format.

4-digit ISO code indicating the authorization message.

• 0100 - Authorization
• 0200 - Financial Request
• 0220 - Advice
• 0420 - Reversal Advice

Local date and time of the transaction originating at the point of service in ISO 8601 format.

The transaction date and time at point of service in UTC 0, expressed in ISO 8601 format.

Requested amount for this authorization.

A 2-digit code indicating the processing code of the transaction type.

• 00 - Purchase
• 20 - Refund

Indicates if the authorization is a pre-auth or a recurring as indicated in the below list. If the value is left empty, it indicates a normal authorization.

• R - Recurring Transaction
• A - Pre-authorization Incremental
• P - Pre-authorization Aggregate

2-digit ISO code value indicating the switch response.

2-digit ISO code value to indicate the reason code for reversal advice.

• 12 - User cancellation
• 68 - Timeout

The 6-character external authorization code (for example, from card schemes).

The System Trace Audit Number. A six digit code that must be unique for an online request. Used in conjunction with the transmissionDate and messageType ID to uniquely identify an authorisation.

A 12-digit identifier used as a transaction reference for retrieval purposes.

A client-specific external identifier value. The value of the externalReference must be unique for each transaction.

Object containing eCommerce related attributes, for eCommerce transactions.

Object containing point of service specific attributes.

Object containing Address Verification System attributes

Links an authorization to another authorization for specific scenarios such as reversal, where the reversal must cancel out an existing authorization. Refer to use cases for more specific information.

11-digit BankWORKS generated account identifier. Unique per institution

The balance brought forward from the previous cycle.

The current balance based on processed transactions. This balance amount does not consider pending authorisations.

The billing cycle start date.

The billing cycle end date.

Indicates the status of the cycle i.e. Current (004) or Closed (015).

Refer to API Data Mapping documentation for possible values.

Credit balances

Debit balances

The date this record was changed last.

Returns the BankWORKS client account linked to the balance record.

The billing cycle definition identifier.

Refer to API Data Mapping documentation for possible values.

Indicates the billing cycle start date.

Indicates the billing cycle end date.

Denotes the status of the billing cycle.

Refer to API Data Mapping documentation for possible values.

The record creation date.

Indicates the new billing cycle to be used following instruction execution.

Refer to API Data Mapping documentation for possible values.

Indicates the next cycle starting date.

Indicates the end date of the first billing cycle generated based on the newly selected billing cycle.

Indicates the current billing cycle applied to the account. Once the instruction is successfully executed, the billing cycle will be updated to the newBillingCycle value.

Refer to API Data Mapping documentation for possible values.

A date indicating the closure of the current active cycle. As part of the end of cycle processing, the billing cycle change instruction will be processed and the account billing cycle updated.

Indicates the current processing status of the instruction. Pending instructions have a status of (101 - Entered) and once processed will show a status of (102- Completed). One can also cancel an instruction provided the current status is not yet completed.

Refer to API Data Mapping documentation for possible values.

The record creation date.

An account for which the billing instruction applies to.

Billing cycle definition of the new billing cycle linked to this instruction.

Parameter type for this definition.

Example: 001 (eComm + MoTo), 003 (ATM), 005 (Ctls-woPIN).

Refer to API Data Mapping documentation for possible values.

The tariff assigned for the specific card type.

Refer to API Data Mapping documentation for possible values.

The transaction type for card limits and usages.

Example: 005 (Purchase), 006 (Refund (Credit)), 009 (ATM cash Withdrawal)

Refer to API Data Mapping documentation for possible values.

The date in ISO 8601 format when the card accumulator definition record becomes effective for the client. The value can be future dated and cannot be less than the posting date. If not provided, this will be defaulted to posting date.

Daily limit attributes.

Window limit attributes.

The minimum amount allowed for a single transaction. Note that all limit and usage amount currencies MUST match. Maximum allowed length for the value attribute (including decimal point) is 18.

The maximum amount allowed for a single transaction. Note that all limit and usage amount currencies MUST match. Maximum allowed length for the value attribute (including decimal point) is 18.

The maximum limit allowed for PIN entry.

Can be (003) Express or (100) Standard Application. Defaulted to standard if not provided.

Refer to API Data Mapping documentation for possible values.

The date in ISO 8601 format when the card accumulator definition record was created.

The accumulator record for a specific card to which this definition is linked to. Effective date needs to be taken into consideration as the relationship gives access to past, current and future effective data.

Card service definition related to this card parameter definition. Effective date needs to be taken into consideration as the relationship gives access to past, current and future effective data.

The service contract under which the card accumulator rule is grouped.

Related velocity parameters for which this setup is created.

Currency reference for card accumulator checks.BWT_CURRENCY, Taken from cardAccumulatorDefinitions passed during POST.

The date in ISO 8601 format when the card accumulator record becomes effective for the client. The value can be future dated and cannot be less than the posting date. If not provided, this will be defaulted to posting date.

The card accumulator expiry date in ISO 8601 format. This is defaulted to 9999-12-31 if not provided.

Daily limit attributes.

Window limit attributes.

Card accumulator usage information

Date in ISO 8601 format when the accumulator record was last modified.

The minimum amount allowed for a single transaction. Note that all limit and usage amount currencies MUST match. Maximum allowed length for the value attribute (including decimal point) is 18.

The maximum amount allowed for a single transaction. Note that all limit and usage amount currencies MUST match. Maximum allowed length for the value attribute (including decimal point) is 18.

Creation date of the card accumulator record.

The card affected by the accumulator rule.

The accumulator definition or business rule on which this accumulator record is based.

8-digit BankWORKS client number unique that is unique per institution. System generated if not provided during new cardholder definition. A unique number must be provided if user defined.

External cardholder reference number.

Indicates the current status of the cardholder in BankWORKS.

Refer to API Data Mapping documentation for possible values.

The national ID card number.

Cardholder’s salutation.

Refer to API Data Mapping documentation for possible values.

First name of the cardholder.

Last name of the cardholder.

Gender of the cardholder.

Refer to API Data Mapping documentation for possible values.

Date of birth in ISO 8601 format

Cardholder’s place of birth.

Cardholder’s birth name.

Cardholder’s short name.

Primary mobile phone number.

Secondary mobile phone number.

Name of cardholder’s father.

Cardholder’s language.

Refer to API Data Mapping documentation for possible values.

Nationality of the cardholder.

Refer to API Data Mapping documentation for possible values.

Indicates if the carhdolder is a resident of the hosting country. Defaulted to 001 if not provided indicating a Resident.

Refer to API Data Mapping documentation for possible values.

The date in ISO 8601 format relating to the client’s current residence state.

Defines the type of residence for the cardholder such as, own house or rented flat. Defaulted to 000 if not provided indicating Unknown.

Refer to API Data Mapping documentation for possible values.

Cardholder’s marital status.

Refer to API Data Mapping documentation for possible values.

Date in ISO 8601 format of last change in marital status.

The cardholder’s national passport number.

The cardholder’s national driving license number.

Cardholder’s employment company or individual.

Applicant’s date of employment in ISO 8601 format.

Cardholder’s current employment position.

Refer to API Data Mapping documentation for possible values.

Cardholder’s current employment status.

Refer to API Data Mapping documentation for possible values.

May contain extra additional numeric information related to the employment status (e.g. for part time employee, might be interpreted as no. of hrs worked weekly).

Income amount of applicant.

Income range of applicant.

Refer to API Data Mapping documentation for possible values.

Defines the processing region of the cardholder. Used for transaction processing.

Refer to API Data Mapping documentation for possible values.

Flag that indicates the cardholder’s Mastercard Automatic Billing Updater (ABU) registration status.

Refer to API Data Mapping documentation for possible values.

Sample values:

• 001 - N/A

• 003 - Registered

The record creation date.

BankWORKS account/s assigned to the cardholder.

The address linked to the cardholder. A cardholder may be linked to multiple addresses. Effective date needs to be taken into consideration as the relationship gives access to past, current and future effective data.

Card/s linked to the cardholder.

The contract or contracts that are assigned to the cardholder. Effective date needs to be taken into consideration as the relationship gives access to past, current and future effective data.

Cardholder bank account details for settlement purposes. A cardholder may have multiple settlement options.

Indicates the processing date.

Date and time of the transaction.

Indicates the current transaction status.

Refer to API Data Mapping documentation for possible values.

Auto-generated transaction slip as reference.

The BankWORKS 8-digit client number.

The account number where the transaction is posted.

Represents the merchant name shown on the cardholder statement.

For non card-based transactions this would show the transaction narrative.

The merchant city where the transaction occurred if available.

The merchant country where the transaction occurred if available.

Refer to API Data Mapping documentation for possible values.

Possible values:

• D - Debit
• C - Credit

Represents the destination sign based on the transaction type. The sign is reversed if the transaction is a reversal.

The gross transaction amount in the original transaction currency.

The net transaction amount in the original transaction currency.

The transaction amount converted to the cardholder’s account currency.

The transaction charge applied to the cardholder.

FX rate derived from the transaction and account amount values up to 5 decimal points.

The masked card number value showing the last 4-digits visible. Please use the cardAlias to filter by card.

An alternative card identification means. The cardAlias replaces the cardNumber for referencing the card without any use of sensitive details.

Indicates the business classification of the merchant where the transaction occurred.

Refer to API Data Mapping documentation for possible values.

The transaction ARN value. This will not be available for pending online transactions.

The authorisation code of the transaction. This would only be available for card based transactions.

3-digit code value indicating the switch response.

Indicates the kind of transaction that has taken place.

Refer to API Data Mapping documentation for possible values.

Indicates the transaction source channel.

Refer to API Data Mapping documentation for possible values.

The terminal capability for PAN PIN entry.

Refer to API Data Mapping documentation for possible values.

Describes how the transaction was generated from the data capture point of view. Example:

• 010 Manual
• 100 Electronic
• 001 Card swiped, signature
• etc…

Refer to API Data Mapping documentation for possible values.

3-digit code that is used to identify the point of service event of the authorization.

Refer to API Data Mapping documentation for possible values.

Numeric value of the card instruction.

Refer to BankWorks (API) Data Mapping documentation for possible values.

Textual description of the card instruction.

Card alias used instead of the card number.

Unique number to identify the pre-generated cards.

Encrypted PIN block.

Detail used for card embossing. Format: alphanumeric and special characters except for pipe (|) symbol.

Detail used for card embossing. Format: alphanumeric and special characters except for pipe (|) symbol.

Card alias used instead of the card number to retrieve data.

The attribute needed to be retrieved. Can be one of

• EXPIRY_DATE
• CARD_NUMBER
• CVV

An alternative card identification means. The cardAlias replaces the cardNumber for referencing the card without any use of sensitive details.

Indicates the current card status.

(For example: 000 (Inactive), 001 (Active), 004 (Permanent Block).

Refer to API Data Mapping documentation for possible values.

Detail used for card embossing. Format: alphanumeric and special characters except for pipe (|) symbol.

Detail used for card embossing. Format: alphanumeric and special characters except for pipe (|) symbol.

Detail used for card embossing.

Identifies the type of plastic to be generated by the embosser. In the case of virtual card only, plastic type of 500 needs to be provided.

Refer to API Data Mapping documentation for possible values.

The Service Category for this Card.

Refer to API Data Mapping documentation for possible values.

Indicates the card Service ID the card is based on.

This MAY be passed instead of the cardServiceDefinitions relationship in case the Service ID value is known.

Refer to API Data Mapping documentation for possible values.

Date in ISO 8601 format on which the card was last issued.

Indicates the card tariff package assigned for the card.

Refer to API Data Mapping documentation for possible values.

Date in ISO 8601 format indicating last card fee generation date.

The record creation date.

Applicable card acumulators. Effective date needs to be taken into consideration as the relationship gives access to past, current and future effective data.

Relationship to the client resource if a private cardholder contract.

Relationship to the client resource if a commercial contract.

Relationship to the card service definition resource.

The accounts where the card may post transactions to. These are determined by system posting rules.

Related client contract for this card. Effective date needs to be taken into consideration as the relationship gives access to past, current and future effective data.

Any installment instruction/s related to this card.

The card information linked to the card POI (point of interaction) setting.

A flag indicating if card’s eCommerce transactions are blocked.

Valid values:

• 000 - No (eCommerce Enabled)

• 001 - Yes (eCommerce Disabled)

A flag indicating if card’s contactless transactions are blocked.

Valid values:

• 000 - No (Contactless Enabled)

• 001 - Yes (Contactless Disabled)

A flag indicating if card’s swipe transactions are blocked.

Valid values:

• 000 - No (Swipe Card Enabled)

• 001 - Yes (Swipe Card Disabled)

A flag indicating if ATM withdrawals are blocked.

Valid values:

• 000 - No (ATM Enabled)

• 001 - Yes (ATM Disabled)

A flag indicating if all card’s activities are blocked.

Valid values:

• 000 - No (Allow Card Activities)

• 001 - Yes (Suspend Card Activities)

An array of countries provided in the ISO 3-letter format (ex: [“USA”,“MLT”,“ITA”]).

If null or 999 value, all countries available will be allowed.

If 000, all countries are blocked, meaning all transactions will be declined.

The list of countries provided must be valid values.

Please note: This feature does not override any existing Issuer Institution limitations such as velocity parameters.

An array of MCC groups provided in the BW index field format (ex: [“002”,“005”,“006”]).

If null or 999 value, all available MCC groups will be allowed (see /mccGroupRangeDefinitions, the values provided must map with the isoBussClassGroup setup available, refer to Retrieve MCC Group Ranges use case).

If 000, all MCC groups are blocked, meaning all transactions will be declined.

The list of mcc group provided must be valid values.

Please note: This feature does not override any existing Issuer Institution MCC restrictions.

The date and time when the setting was last updated. E.g. 2024-07-09T07:23:45

This is the creation date of the card POI setting.

The card resource for which this POI setting will be applied to.

The card service identifier.

Refer to API Data Mapping documentation for possible values.

The card brand of the card product resource.

Refer to API Data Mapping documentation for possible values.

The card organisation of the card based product.

Refer to API Data Mapping documentation for possible values.

The date in ISO 8601 format when the card service definition record becomes effective for the client.

A system defined index used in the Card Console process to determine the effective date for Card Accumulator and Card Status Change.

Example: 001 (Posting Date), 002 (Previous Expiry Plus 1).

Refer to API Data Mapping documentation for possible values.

Specifies the client level benefetting from the service, for example client client, billing level.

_one of 001 (Member Client), 002 (Billing level), 003 (not applicable), 004 (Grp Yes, Acct Yes), 005 (Grp Yes, Acct Option)__

Refer to API Data Mapping documentation for possible values.

Card service type (debit card, credit card, charge card).

Refer to API Data Mapping documentation for possible values.

A user specified label for a type of plastic used for card embossing.

Refer to API Data Mapping documentation for possible values.

Defines transaction destination for issuer services.

Refer to API Data Mapping documentation for possible values.

The total length of the card number (PAN).

maximum: 99

Defines the length of the card product BIN. Based on BIN values.

maximum: 99

The start BIN of the card product.

The end BIN of the card product.

A unique record key generated upon record update.

Based on PAN length entered.

maximum: 99

The sequence number counter used to generate card numbers.

User defined type of coding for card embossing.

Refer to API Data Mapping documentation for possible values.

Client specific. Identifies the type of encoding to which the service contract applies.

Refer to API Data Mapping documentation for possible values.

A user specified label for a card product or a group of card brands.

Refer to API Data Mapping documentation for possible values.

Specifies the generation of sequence numbers (Sequential, Random).

Refer to API Data Mapping documentation for possible values.

The default wrong pin limit counter for a card product.maximum: 999

Identifies if the wrong PIN limit should be reset daily or not. Possible values are 001 (YES) or 000 (NO) for the specific (card) service ID (type).

Application identifier.

Example: 002 (Authorization Controls), 003 (Cardholder Verification (PIN))

Refer to API Data Mapping documentation for possible values.

Field used to populate the member ID fo rthe respective transaction during BIN lookup processing. Applies for ONUS cards.

A user-specified label for a card product or a group of card brands.

Pin verification key index.

minimum: 1, maximum: 6

User specified track 3 data if applicable.

Refer to API Data Mapping documentation for possible values.

Select the period of time (in months) for which the the emergency card will expire.

Used to generate card expiry date for new cards.

Refer to API Data Mapping documentation for possible values.

Used to generate card expiry date for renewal cards.

Refer to API Data Mapping documentation for possible values.

Identifies how the generation of expiry date will be done for Card Reissue.

Refer to API Data Mapping documentation for possible values.

Identifies the period before card expiry for which replacement is ignored, e.g. one month, two months. If a replacement card is requested within the threshold then the cardholder must wait until the next renewal date for the card.

Defines the minimum number of months till card expiry allowing card replacement.

Identifies how the generation of expiry date will be done for Card Replacement.

Refer to API Data Mapping documentation for possible values.

Free text notes on the service definition.

maximum: 2000

The related card accumulator definitions for this card service setup. Effective date needs to be taken into consideration as the relationship gives access to past, current and future effective data.

Issued cards based on the card service definition.

The service contract definition under which the card service is grouped.

The velocity limit parameters related applicable to the card service definition. Effective date needs to be taken into consideration as the relationship gives access to past, current and future effective data.

BankWORKS 8-digit client number uniquely identifying the commercial client.

External commercial client reference number.

Indicates the current status of the cardholder.

Refer to API Data Mapping documentation for possible values.

Indicates the type for the client. For example, 006 - Commercial.

Refer to API Data Mapping documentation for possible values.

VAT number of the commercial client.

The commercial client registration number.

Commercial client date of registration.

Refer to BankWorks (API) Data Mapping documentation for possible values.

The date in ISO 8601 format relating to the Commercial client’s current residence state.

Main language of the commercial client.

Refer to BankWorks (API) Data Mapping documentation for possible values.

Short name.

Commercial client company name.

Related to the legal form of the merchant. Such as:

• 000 n/a
• 001 Limited
• 002 Joint Stock
• 003 Plc
• 004 GmbH
• 005 Societe Anonyme
• 006 Company
• 007 Corporation
• 029 Sole Proprietor

Refer to BankWorks (API) Data Mapping documentation for possible values.

The name under which the commercial client is trading.

The ISO 4-digit business classification code.

Refer to BankWorks (API) Data Mapping documentation for possible values.

Relationship to the client’s accounts.

Relationship to the client’s addresses.

Relationship to the client’s cards.

Relationship to the client’s contracts.

Relationship to the client’s settlement details.

Service contract package identifier.

Refer to API Data Mapping documentation for possible values.

Specification of the service contract from a business perspective such as issuer, acquirer, clearing or suspense.

Refer to API Data Mapping documentation for possible values.

Free text description of the service contract.

Specifies how frequently the serviceContract should be revised.

Refer to API Data Mapping documentation for possible values.

Accounts types that are linked to the service contract.

Issuing (card) service definitions linked to the service contract. Effective date needs to be taken into consideration as the relationship gives access to past, current and future effective data.

Client contracts that are based on the service contract definition. Effective date needs to be taken into consideration as the relationship gives access to past, current and future effective data.

Account limit definitions linked to the service contract.

Non issuing services definitions that are linked to the service contract. Effective date needs to be taken into consideration as the relationship gives access to past, current and future effective data.

The velocity parameters setup for the service contract. Effective date needs to be taken into consideration as the relationship gives access to past, current and future effective data.

The currency SWIFT code to which the rate information applies. In cases where value consists of 3 digits, 998 means not applicable and 999 means applicable to all currencies.

Refer to API Data Mapping documentation for possible values.

Defines the currency in SWIFT code format to which all rates of the same category are expressed. In cases where value consists of 3 digits, 998 means not applicable and 999 means applicable to all currencies.

Refer to API Data Mapping documentation for possible values.

Description of FX rate provider.

Refer to API Data Mapping documentation for possible values.

The date and time in ISO 8601 format when the currency rate becomes effective, in conjunction with effectiveTime. If the effective date is not specified, then the current date + 1 at 00:00:00 is assumed.

When a currency rate is effected through an API call the value of this field is all zeroes. When currency rates are uploaded through a batch file, the file number is inserted in this field. This enables the user to query all the currency rates pertaining to a particular file load.

Defines if the rate will be used as loaded, multiplied or divided.

Refer to API Data Mapping documentation for possible values.

Defines how the middle rate is being expressed, Standard, Inverted.

Refer to API Data Mapping documentation for possible values.

FX middle rate. Maximum allowed length (including decimal point) is 16.

FX buy rate. Maximum allowed length (including decimal point) is 16.

FX sell rate. Maximum allowed length (including decimal point) is 16.

The currency in SWIFT code format to which the rate information applies. In cases where value consists of 3 digits, 998 means not applicable and 999 means applicable to all currencies.

Refer to API Data Mapping documentation for possible values.

Defines the currency in SWIFT code format to which all rates of the same category are expressed. In cases where value consists of 3 digits, 998 means not applicable and 999 means applicable to all currencies.

Refer to API Data Mapping documentation for possible values.

Description of FX rate provider eg. Own, VISA etc.

Refer to API Data Mapping documentation for possible values.

The date in ISO 8601 format when the currency rate becomes effective. If an effective date is not provided, the current system date is assumed.

Defines whether percentage FX spread is applied for the particular FX rate category.

Refer to API Data Mapping documentation for possible values.

Value used to calculate purchase rate if spread is applied. Maximum allowed length (including decimal point) is 16.

Value used to calculate sales rate if spread applied. Maximum allowed length (including decimal point) is 16.

Percentage used to calculate sales rate if spread applied. Field open only if percentage FX spread flag set to Yes - 001. Maximum allowed length (including decimal point) is 9.

Percentage used to calculate purchase rate if spread is applied. Only applicable if percentFXSpread flag is Yes - 001. Maximum allowed length (including decimal point) is 9.

Tolerated fluctuation between the FX rate being input and the latest effective FX rate.

maximum: 999999999

The record creation date.

Slip reference of the original transaction to be converted to installments.

Example: 00300011314

Information on the original transaction to be converted to installments.

Regular installment amount to be paid after initial payment or first installment. This can be provided on POST/PATCH request or automatically calculated.

Initial payment for the installment.

Calculated amount last installment payment dependent on initial and regular payments.

Calculated amount for the transaction to be converted to installments with interest rate if applicable.

Interest percentage of loan amount.

Number of installments including the first and last installment.

Refer to API Data Mapping documentation for possible values.

3-digit reference of the instruction status.

One of 008 (Approved), 007 (Entered), 002 (Completed)

Refer to API Data Mapping documentation for possible values.

Merchant number reference for which the transaction originated. This will be automatically populated for On-Us merchants. For non-OnUs merchant, ID will need to be provided on request.

Descriptive name of the merchant for which the transaction occurred.

Free-text note for the installment instruction.

Date for when the instruction was created.

Including this will provide card details for the installment instruction.

This is the source account of the original transaction for which this instruction is created.

This is the installment account for which the installment amounts will be transferred to.

The contract related to the instruction.

System generated 11-digit unique transaction transfer instruction identifier.

Defines the type of transfer being effected.

Examples may include: 403 (Redemption Cash), 404 (Redemption Air Miles), 416 (Redemption Qualifying Miles), 950 (Misc. DR transaction), 951 (Misc. CR transaction).

Refer to API Data Mapping documentation for possible values.

The amount being transferred in the currency of the source account.

Indicates the current processing status of the balance transfer instruction.

Refer to API Data Mapping documentation for possible values.

A free-text transaction description, up to 100 characters.

Indicates the transfer instruction creation date based on the posting date at time of creation.

Relationship linking the instruction to the source account.

Relationship linking the instruction to the destination account.

BankWORKS 11-digit internal account number. Unique per institution.

Cardholder account alias.

Indicates the account type of the client account. When defining new accounts, this attribute along with the accountCurrency can be supplied as an alternative to the accountDefinitions relationship.

Refer to API Data Mapping documentation for possible values.

Indicates the currency of the account. The currency is represented in 3 letter SWIFT format such as EUR, USD etc.

When defining new accounts, this attribute along with the accountTypeId can be supplied as an alternative to the accountDefinitions relationship.

Refer to API Data Mapping documentation for possible values.

The current status of the account such as one of the following:

• 001 Active
• 002 Closed
• 003 Suspended.

Refer to API Data Mapping documentation for possible values.

External RBS account number reference.

Indicates the billing cycle applicable for the account.

Refer to API Data Mapping documentation for possible values.

Indicates if the cardholder account holds settlement responsibilities for the related sub-hierarchy.

• 001 Billing level
• 000 Not billing level

Indicates the statement generation rule applicable for this account.

Refer to API Data Mapping documentation for possible values.

The type of statement applicable for this account.

Refer to API Data Mapping documentation for possible values.

Last credit interest accrual date in ISO 8601 format.

Last debit interest accrual date in ISO 8601 format.

This is the calculated available amount for the account based on the account limit setup.

Last account fee generation date in ISO 8601 format.

Last statement generation date in ISO 8601 format.

The record creation date.

Relationship to the account definition resource.

Relationship to the client resource if a private cardholder client.

Relationship to the client resource if a commercial client.

Client contract resources linked to this account. Effective date needs to be taken into consideration as the relationship gives access to past, current and future effective data.

Bank account settlement information related to this BankWORKS account. Only billing level accounts require settlement details to be defined.

Account fees applicable for the cardholder account based on the client contract tariff assigned. Contract based account fees as well as individual client specific account fees overriding contract based fees are available. Effective date needs to be taken into consideration as the relationship gives access to past, current and future effective data.

Applicable account limits linked to the account. Effective date needs to be taken into consideration as the relationship gives access to past, current and future effective data.

Links to the global client account limit. The global client limit is a limit that acts on top of the account limit. Effective date needs to be taken into consideration as the relationship gives access to past, current and future effective data.

Cycle balances related to the account, includes past cycles and the current cycle.

Billing cycle instructions linked to the account.

The address category identifier for the returned client address resource are the following but not limited to:

• 001 Standard
• 006 Statement

A client must have at least one standard (001).

Refer to API Data Mapping documentation for possible values.

The date in ISO 8601 format when the address becomes effective. The value can be future dated and cannot be less than the posting date. If not provided, the current posting date is automatically assumed.

The date in ISO 8601 format when the address record is no longer taken into consideration. Can be used for temporary addresses. Date must be in the future.

Address line typically used for building information but not limited to house name, number, floor, unit and block number.

Address line typically used for street information such as street number and name.

Extra address properties that might be required and are not catered for by the attributes available.

Extra address properties that might be required and are not catered for by the attributes available.

Extra address properties that might be required and are not catered for by the attributes available.

Main contact name for the address.

Client’s city.

3 digit identifier for the client’s state/region.

Refer to API Data Mapping documentation for possible values.

The ISO 3-letter country code. In cases where value consists of 3 digits, 000 means not applicable and 999 means applicable to all countries.

Refer to API Data Mapping documentation for possible values.

Client’s postcode.

P.O. Box details.

Primary address fixed line number, for example, a client’s home or business telephone number.

Secondary address fixed line number for example a secondary business telephone number.

Office fax number.

3-digit identifier for the client language associated with the address.

Refer to API Data Mapping documentation for possible values.

3-digit value indicating the preferred delivery option for correspondence. Defaulted to not applicable (000) - Not applicable, if not provided.

Refer to API Data Mapping documentation for possible values.

Client’s e-mail address.

The record creation date.

Relationship to the cardholder linked to the address.

Relationship to the commercial client linked to the address.

The contract category determines the type of hierarchy.

• 001 - Private cardholder contracts
• 002 - Commercial cardholder contracts

Indicates the service contract ID linked to the client contract.

This MAY be passed instead of the contractDefinitions relationship in case the Service Contract ID value is known.

Refer to API Data Mapping documentation for possible values.

Indicates the client number of the parent client in the hierarchy. This is an optional attribute that can be provided instead of the parentContracts relationship when defining a lower level client in a hiearchy.

Indicates the status of the client contract.

Refer to API Data Mapping documentation for possible values.

8-digit number indicating a billing and settlement hiearchical group. In this case, the group number indicates the hierarchy the contract form parts of. This field’s value is auto-generated.

Indicates the position of the current node resource within the group hierarchy. The top most level is identified as the Group level, the bottom level is the Member level. Any level in between the group and member levels is referred to as a Sub-group level node. Required only when onboarding a new client.

Refer to API Data Mapping documentation for possible values.

The date in ISO 8601 format on which the hierarchy link record becomes effective for the client. The value can be future dated and cannot be less than the posting date. If not provided, posting date +1 value is assumed only post-boarding.

Indicates the method how the client will settle with the bank. Identifies how outstanding balances are settled. Required only when onboarding a new client.

Refer to API Data Mapping documentation for possible values.

The tariff under which the client falls when posting to the clients account.

Refer to API Data Mapping documentation for possible values.

Indicates the client tariff package assigned. Required only when onboarding a new client.

Enables setting up of the same fee with different value high and value low triggers.

Refer to API Data Mapping documentation for possible values.

Indicates the rebate tariff applicable for the contract.

Cardholder contract document reference.

External additional reference number of the cardholder with the bank.

Officer in charge of the client contract.

Refer to API Data Mapping documentation for possible values.

Contract application branch details. Related to the institutionAccountOfficer.

Refer to API Data Mapping documentation for possible values.

An identifier used to group a set of rates that need to be applied during tiered pricing generation.

Refer to API Data Mapping documentation for possible values.

The record creation date.

Relationship to the service contract definition resource.

Relationship to the client resource if a private cardholder contract.

Relationship to the client resource if a commercial contract.

Optional relationship to build a hierarchy. Links to the parent contract, one level up the client hierarchy. Effective date needs to be taken into consideration as the relationship gives access to past, current and future effective data.

Alternatively if the parent client number is known, the attribute can be used instead of this relationship.

Cardholder accounts linked to the contract.

Client service/s created under the client contract. Effective date needs to be taken into consideration as the relationship gives access to past, current and future effective data.

The BankWORKS 8-digit client number.

Indicates the client hierarchy group the service relates to. Refer to contracts relationship below for linking service to contract.

BankWORKS service identifier.

Refer to API Data Mapping documentation for possible values.

Indicates the service category of the client service.

Refer to API Data Mapping documentation for possible values.

Indicates the current status of the client service.

Refer to API Data Mapping documentation for possible values.

The date in ISO 8601 format when the client service becomes effective. The value can be future dated and cannot be less than the posting date. If not provided, posting date +1 value is assumed only post-boarding.

The date in ISO 8601 format when the client service expires and no longer applies.

Indicates the applicable transaction charge rules. Defaults to “000” if not provided. Applicable only to card based issuing services. For miscellaneous service tariff, refer to the contracts resource.

Refer to API Data Mapping documentation for possible values.

Indicates the service revision date in ISO 8601 format.

Airline loyalty program number.

The record creation date in ISO8601 format.

Institution’s service definition setup applicable for the client service. Effective date needs to be taken into consideration as the relationship gives access to past, current and future effective data.

Service contracts that this service relates to. Effective date needs to be taken into consideration as the relationship gives access to past, current and future effective data.

Miscellaneous service fees applicable to the client service based on the client contract tariff. Effective date needs to be taken into consideration as the relationship gives access to past, current and future effective data.

The currency of the counter bank account in SWIFT currency code format. In cases where value consists of 3 digits:

• 998 means not applicable
• 999 means applicable to all currencies.

Refer to API Data Mapping documentation for possible values.

Settlement information category descriptor such as Payable or Receivable.

Refer to API Data Mapping documentation for possible values.

Information regarding the account’s bank details.

The country where the bank account information is located. In cases where value consists of 3 digits:

• 000 means not applicable
• 999 means applicable to all countries.

Refer to API Data Mapping documentation for possible values.

The RBS account that is used in case the counter RBS bank account is not able to fullfil the RECEIVABLE obligation.

The NOSTRA/VOSTRO bank account of the affiliate institution.

The bank number of the affiliate institution where the counter bank Nostro/Vostro are domiciled.

The record creation date in ISO8601 format.

Accounts settled by this settlement package.

Cardholder who owns the settlement information.

Commercial client who owns the settlement information.

BankWORKS 11-digit number identifying the limit.

The limit level identifies the account level to which this limit pertains.

Refer to API Data Mapping documentation for possible values.

The date in ISO 8601 format on which the limit record becomes effective for the provided card. If left empty, the current system date is assumed.

The date in ISO 8601 format on which the limit is no longer effective. Expiry date must be greater than the effectiveDate.

The amount of credit the limit provides.

A calculated attribute that identifies the amount that the limit can be overriden.

A percentage, exceeding the limit, within which authorization approval is allowed.

A percentage in which authorization approval for Cash transactions is allowed.

Retail balance amount.

The record creation date.

BankWorks client account related to this resource.

Client contract related to this resource. Effective date needs to be taken into consideration as the relationship gives access to past, current and future effective data.

The limits definition for which this resource is created from.

Parent limit related to this resource.

Identifies the type of limit being used.

One of 000 (Not applicable), 001 (Revolving credit), 005 (Prepaid Card), 007 (Installment Loan), 999 (All)

Refer to API Data Mapping documentation for possible values.

Further categorisation of the limit for information purposes, such as Overdraft limit.

One of 001 (Overdraft), 002 (FX transaction), 003 (FX settlement), 004 (Guarantees), 005 (Letter of credit) _

Refer to API Data Mapping documentation for possible values.

The limit currency in SWIFT code format.

Example: USD

Refer to API Data Mapping documentation for possible values.

Defines how the limit is used by cardholders belonging to the same hierarchy, i.e. forming part of the same contracts group.

One of 001 (Shared), 002 (Allocated), 003 (User-defined), 004 (Group) _

Refer to API Data Mapping documentation for possible values.

A percentage, the accepted exceeding override amount limit, within accepted authorization.

Defines business categories allowing further override (e.g. T&E - Travel and Entertaining merchant group).

Refer to API Data Mapping documentation for possible values.

A percentage, exceeding category type, within accepted authorization.

Denotes to which billing cycle the account definition is assigned.

The record creation date in ISO8601 format.

BankWorks account definition for which this resource is linked to.

BankWorks contract definition related to this resource.

Record creation date.

Links a business class group under a category.

Refer to API Data Mapping documentation for account definitions available for the institution.

A grouping of MCCs that can be further classified by category (see mccGroupCategory).

Refer to API Data Mapping documentation for account definitions available for the institution.

The first Merchant Category Code included in the range.

The last Merchant Category Code included in the range.

Auto-generated transaction slip as reference.

Free text reference up to 11 characters. This field can be used to refer to an external (outside of BankWORKS) transaction. If this is null/empty, it will be generated similar with transactionSlip.

It will be determine on approval of the batch.

Either ‘950’ (Misc. DR transaction) or ‘951’ (Misc. CR transaction) depending on the overall balance after summing up the transactions in the batch which could result in an overall Debit or Credit amount.

The totalBatchAmount attribute documentation highlights how the overall balance of a batch can be determined.

The processing status indicates the current state of the batch. A batch initially has an Entered (007) status.

An Error (003) status indicates potential issues with the batch / transaction input. This would require amendment of the batch or transaction to correct the problem and re-approval of the batch to close it for processing.

Once a batch of transactions is successfully processed, the processingStatus will indicate a value of Loaded (005).

If it is 0, the totalBatchAmount can be calculated by calculating the Sum of transactionAmountGross values provided in the slips. This should be done upon sending a PATCH request to set the processingStatus to ‘008’, as this would indicate that all the required slips have been entered and linked to the batch.

In order to calculate this amount the following need to be considered: -Transaction amount of the individual slips -Transaction type of each slip. The transaction type determines the respective DR/CR indicator. To determine if a transaction is a debit or credit AT DESTINATION, the BWT_BATCH_TRANSACTIONS entry will need to be checked with the equivalent in BWT_BATCH_TRANSACTIONS in order to retrieve the DESTINATION_SIGN. The first character of the DESTINATION_SIGN field indicates whether the transaction will be a C (Credit) or D (Debit) at destination. -Finally once the amount is converted to the destination sign. The REVERSAL_FLAG value must be considered. A credit (plus) to the merchant account that is reversed (REVERSAL_FLAG = 001) results in a debit to the merchant account (minus) and vice versa.

Alternatively, if provided, the totalBatchAmount Value must match with the Sum of the slip amounts provided. This value would be validated when approving the transaction for processing by setting processingStatus to ‘008’.

Total Batch Amount currency, indicates the currency of the batch. Any transactions linked to the batch must match with this batch currency.

If not provided, the number of slips can be calculated on the number of individual transaction slips provided in the slips list.This should be done upon sending a PATCH request to set the processingStatus to ‘008’, as this would indicate that all the required slips have been entered and linked to the batch. Alternatively, if provided, the numberOfSlips value should match with the count of slips provided. This value would be validated when approving the transaction for processing by setting processingStatus to ‘008’

Date on which the batch was created.

Individual transactions linked to this batch.

Auto-generated transaction slip as reference.

Free text reference up to 11 characters. This field can be used to refer to an external (outside of BankWORKS) transaction. If this is null/empty, it will be generated similar with transactionSlip.

Type of transaction i.e. Miscellaneous Debit (950), Miscellaneous Credit (951), etc.

This value is used to identify what category the transaction belongs to, e.g Charges & Fees, Adjustments, etc.

Date of the transaction. Must be less than or equal to the current posting date.

The date from when action can be taken upon a transaction.

Indicator used to identify if the transaction is reversed or not. Defaulted to 000 (No).

A numeric combination used to mask card number. This attribute is used only to retrieve the alias of card number and cannot be used for post or patch.

Card number used for the individual transaction. This should only be used for adding or modifying a transaction. Upon resource retrieval, cardAlias is being displayed instead of the clear card number.

Auto-populated based on the related account provided.

The amount of the individual transaction. Must be greater than 0 and the currency value must match with the batch currency!

Free text reference. If not provided default to the transactionType TEXTUAL description.

Date on which transaction was created.

A transaction must always be linked to a batch.

Note, transaction can only be linked to a batch if changes are allowed, i.e processing status either Entered (007) or Error (003).

A transaction must either be linked to this account or via cardNumber.

A package of services to which the transaction charges apply.

Refer to API Data Mapping documentation for possible values.

Boolean value indicating if the fee is a contract fee, i.e institution default setup or not, i.e a client specific override.

Tariff enables to set up transaction charges within the service contract e.g. Regular, Visa Classic, VIP etc.

Refer to API Data Mapping documentation for possible values.

The type of fee such as Bonus, VAT, etc.

Refer to API Data Mapping documentation for possible values.

The type of transaction charge, e.g. Transaction Fee, VAT Additional charges.

Refer to API Data Mapping documentation for possible values.

The date in ISO 8601 format when the product charge definition becomes effective.

The date in ISO 8601 format when the product charge definition can no longer be used.

User specified labels for charge tiers.

Refer to API Data Mapping documentation for possible values.

The transaction type on which the charge can be applied. Can also indicate all transactions.

Refer to API Data Mapping documentation for possible values.

SWIFT value indicating the transaction currencies on which the product charge can be applied. In cases where value consists of 3 digits, 998 means not applicable and 999 means applicable to all currencies.

Refer to API Data Mapping documentation for possible values.

Refer to API Data Mapping documentation for possible values.

Defines where the transaction took place.

Refer to API Data Mapping documentation for possible values.

Describes how the transaction was generated from the data capture point of view. Example:

• 010 Manual
• 100 Electronic
• 001 Card swiped, signature
• etc…

Refer to API Data Mapping documentation for possible values.

Fee identifier used for cardholder reporting.

Refer to API Data Mapping documentation for possible values.

The percentage value used to generate the fee for product based on fee trigger setup. Maximum allowed length (including decimal point) is 11.

The standard amount generated for the product fee. Note that all fee amount currencies MUST match. Maximum allowed length (including decimal point) is 11.

Indicates the minimum value that can be charged for the product if the feeBase and feePercent values are LOWER than this value. Note that all fee amount currencies MUST match. Maximum allowed length (including decimal point) is 11.

Indicates the maximum value that can be charged for the product if the feeBase and feePercent values are GREATER than this value. Note that all fee amount currencies MUST match. Maximum allowed length (including decimal point) is 11.

Suppress or generate the fee.

Refer to API Data Mapping documentation for possible values.

Refer to API Data Mapping documentation for possible values.

Configures the fee to round the charge amount according to the currency exponent.

Refer to API Data Mapping documentation for possible values.

maximum: 999

Defines if the fee is generated as a separate transaction (Gross + Charges) or applied to the transaction (Net).

Refer to API Data Mapping documentation for possible values.

Service to which the transaction charge applies.

Refer to API Data Mapping documentation for possible values.

Describes the type of card service the fee definition applies to. It can be n/a.

Refer to API Data Mapping documentation for possible values.

The transaction type of the fee set up as an inward charge.

Refer to API Data Mapping documentation for possible values.

The transaction type of the fee set up as an outward charge.

Refer to API Data Mapping documentation for possible values.

Determines the value date of the transaction on which the charge is applied.

Refer to API Data Mapping documentation for possible values.

A user specified label for a card product or a group of card brands.

Refer to API Data Mapping documentation for possible values.

The card brand of the card product resource.

Refer to API Data Mapping documentation for possible values.

The card organisation of the card based product.

Refer to API Data Mapping documentation for possible values.

The date in ISO 8601 format when the record becomes effective and can be used.

Card service type (debit card, credit card, charge card).

Refer to API Data Mapping documentation for possible values.

Based on business - Acquirer, Issuer, Device, Clearing, Other.

Refer to API Data Mapping documentation for possible values.

Specifies the client level benefetting from the service. Such as one of:

• 001 Member Client
• 002 Billing level
• 003 not applicable
• 004 Grp Yes, Acct Yes
• 005 Grp Yes, Acct Option

Free text notes on the service definition.

maximum: 999

Charge type for the service fee.

Refer to API Data Mapping documentation for possible values.

The transaction type of the generated fee, eg Card Subscription Fee, Account Maintenance Fee.

Refer to API Data Mapping documentation for possible values.

Tariff package for the service fee.

Refer to API Data Mapping documentation for possible values.

Boolean value indicating if the fee is a contract fee, i.e institution default setup or not, i.e a client specific override.

Date in ISO 8601 format when the fee becomes live and can be used.

Date in ISO 8601 format when the fee expires and no longer applies.

The transaction type of the generated fee.

Refer to API Data Mapping documentation for possible values.

The standard amount generated for the service fee. Note that all fee amount currencies MUST match. Maximum allowed length (including decimal point) is 11.

Indicates the minimum value that can be charged for the service if the feeBase and feePercent values are LOWER than this value. Note that all fee amount currencies MUST match. Maximum allowed length (including decimal point) is 11.

Indicates the maximum value that can be charged for the service if the feeBase and feePercent values are GREATER than this value. Note that all fee amount currencies MUST match. Maximum allowed length (including decimal point) is 11.

The percentage value used to generate the fee for service based on fee trigger setup. Maximum allowed length (including decimal point) is 11.

Suppress or generate the fee.

Refer to API Data Mapping documentation for possible values.

Number of days due after the periodReference.

maximum: 999

Defines a set of rules related to the generic fee.

Refer to API Data Mapping documentation for possible values.

Defines the value or event that triggers the fee process, eg new service.

Refer to API Data Mapping documentation for possible values.

Used by trigger sources requiring values, for Overdue amount > 500. Note that all trigger amount currencies MUST match. Maximum allowed length (including decimal point) is 18.

Used by trigger sources requiring maximum values, for example tiered fees. Note that all trigger amount currencies MUST match. Maximum allowed length (including decimal point) is 18.

Sign operator related to trigger source and trigger value.

Refer to API Data Mapping documentation for possible values.

Defines when and how often the fee process is run, eg Daily, End of Cycle etc.

Refer to API Data Mapping documentation for possible values.

Defined for which level the service fee or account fee is being generated, eg Level, Group Level, First Service, Supplementary Service.

Refer to API Data Mapping documentation for possible values.

Determines the value date of the fee, eg. Posting Date.

Refer to API Data Mapping documentation for possible values.

Sign operator related to fixedPeriod following the periodReference.

Refer to API Data Mapping documentation for possible values.

Information used for statement generation purposes.

Refer to API Data Mapping documentation for possible values.

The service contract to which the service fee applies.

Refer to API Data Mapping documentation for possible values.

Applies fee to a tier level. Enables the setting up of the same fee but with a different trigger value high and low.

Refer to API Data Mapping documentation for possible values.

The record creation date in ISO8601 format.

Identifies the velocity profile level for the velocity rule.

Refer to API Data Mapping documentation for possible values.

Identifies the country group ID of countries where card activity is blocked by the velocity parameter.

Refer to API Data Mapping documentation for possible values.

Identifies the merchant category group blocked by the velocity parameter.

Refer to API Data Mapping documentation for possible values.

The date in ISO 8601 format on which the velocity parameter becomes effective. If left empty, the current system date is assumed.

The date in ISO 8601 format on which the velocity parameter is no longer effective. If left empty, the date 9999-12-31 is assumed.

The transaction type to which the velocity parameter applies, eg. Purchase transaction. Transaction type may be set to ‘All’ in order to apply the accumulator rule to all transaction types available.

Refer to API Data Mapping documentation for possible values.

Daily limit attributes.

Window limit attributes.

The maximum amount allowed for a single transaction. Note that all limit and usage amount currencies MUST match. Maximum allowed length for the value attribute (including decimal point) is 18.

The minimum amount allowed for a single transaction. Note that all limit and usage amount currencies MUST match. Maximum allowed length for the value attribute (including decimal point) is 18.

The maximum amount allowed for a single transaction. Note that all limit and usage amount currencies MUST match. Maximum allowed length for the value attribute (including decimal point) is 18.

Refer to API Data Mapping documentation for possible values.

Response code that will be retuned by the CommServer if the authorisation is declined.

Date when the accumulator check will be expired. Default to 31-12-9999 unless provided.

Card service definitions related to this velocity parameters. Effective date needs to be taken into consideration as the relationship gives access to past, current and future effective data.

The contract definition linked to this velocity parameter.