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

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 BankWorks (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. Defaulted to 008 - Approved if not provided.

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

A free-text transaction description, up to 100 characters. If not provided, this will be defaulted to the transfer type narrative.

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

Relationship to the source transfer account.

Relationship to the destination transfer account.

The type of account.

Example:

• 001 : Payment Account Retail (where merchant presentments, payments, and other related transactions are posted to)

• 002 : Fee Account (account where fees are posted to)

• 003 : Chargeback account (where disputes are posted to)

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 account definitions available for the institution.

Account categorisation for information purposes.

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

The service contract ID under which the account definition is packaged. Refer to BankWorks (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 BankWorks (API) Data Mapping documentation for possible values.

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

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

The type of statement generated for the account definition.

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

Denotes to which billing cycle the account definition is assigned.

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

Denotes the default billing cycle applicable to accounts based on this account definition. Refer to BankWorks (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 BankWorks (API) Data Mapping documentation for possible values.

Account currency of the cycle in SWIFT format.

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

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

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

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

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

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

Refer to BankWorks (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 BankWorks (API) Data Mapping documentation for possible values.

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

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

Defines the interest generation method for the account.

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

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

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

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

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

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

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

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

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

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

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

The date in ISO 8601 format for when the account definition record was created.

Returns the BankWORKS billing cycle definition linked to this resource.

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

Refer to BankWorks (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 BankWorks (API) Data Mapping documentation for possible values.

The type of fee such as a commission.

Refer to BankWorks (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 BankWorks (API) Data Mapping documentation for possible values.

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

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

Tariff package for the account fee.

Refer to BankWorks (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.

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.

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

Suppress or generate the fee.

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

The transaction type of the generated fee.

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

Number of days due after the periodReference.

maximum: 999

Sign operator related to trigger source and trigger value.

Refer to BankWorks (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 BankWorks (API) Data Mapping documentation for possible values.

Defines a set of rules related to the generic fee.

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

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

Refer to BankWorks (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 BankWorks (API) Data Mapping documentation for possible values.

Sign operator related to fixedPeriod following the periodReference.

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

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

Refer to BankWorks (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 BankWorks (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 BankWorks (API) Data Mapping documentation for possible values.

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

Field representing the merchant account alias.

The swift code value of the account currency. In cases where value consists of 3 digits:

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

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

• 001 Active
• 002 Closed
• 003 Suspended.

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

External account number reference.

Description of the billing cycle applicable for this account.

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

Field indicating if the merchant account holds settlement responsibilities for the related sub-hierarchy.

• 001 Billing level
• 000 Not billing level

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

Indicates the statement generation rule applicable for this account.

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

Indicates the type of statement applicable for this account.

Refer to BankWorks (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.

Last account fee generation date in ISO 8601 format.

Last statement generation date in ISO 8601 format.

This field is populated during posting and indicates the date the first transaction was posted to the account. It is initialized to null by application processing.

Account definition or properties used as reference for what types of account/s are assigned to the client. Appropriate service contract should be taken into consideration for this related resource as a client can have accounts under multiple contracts.

Merchant client who owns the account. An account can only belong to one client.

Broker client who owns the account. An account can only belong to one client.

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

Client contract resources linked to this account. An account is linked to a single effective merchant contract, however each contract may have multiple ineffective resources, both past and future effective.

Payment transactions with settled amounts held in the account.

Presentment transactions held in the account.

Payment instructions defined for the account.

Account fees applicable for the merchant 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.

The billing account within the account hierarchy.

The account balances per cycle.

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

• 001 Standard
• 006 Statement
• 007 Location Address
• 010 Contact Address
• 022 Clearing Address
• 202 Branch Office Address

A client must have at least a standard (001) and a clearing (022) address.

Refer to BankWorks (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 BankWorks (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.

Client’s postcode.

P.O. Box details.

3-digit identifier for the client address language.

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

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 value indicating the preferred delivery option for correspondence. Defaulted to not applicable (000) if not provided.

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

Client’s e-mail address. This is required if deliveryMethod is set to 500 (E-mail).

The date in ISO 8601 format for when the address record was created.

Merchant who owns the address information. An address can only belong to one client.

Broker who owns the address information. An address can only belong to one client.

KYC/AML client who owns the address information. An address can only belong to one client.

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.

• 003 - Error
• 005 - Loaded
• 011 - Archived
• 024 - Duplicate
• 030 - Reversed
• 999 - Pending

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. If the authorization will include a surcharge amount (provided in feeAmount), the amount attribute needs to include the full authorization amount, requested amount + the surcharge amount.

The feeAmount can be used to add a surcharge fee to the transaction. The value accepts both a negative and positive value. A negative value indicates a credit to the cardholder. A positive value indicates a debit to the cardholder. To determine the authorisation amount the feeAmount can be added or subtracted to the amount value depending on the feeAmount sign.

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

• 00 - Purchase
• 20 - Refund
• 37 - Card Verification

Indicates

Pre-authorisations:

• A = Pre-authorisation Incremental (Used for subsequent incremental transactions after a pre-auth was made)

• P = Pre-authorisation (Used for the first pre-auth transaction)

• CP = Pre-authorisation with Credentials on File (Used for the first pre-auth transaction in which credentials will be stored). Respective RS2 Project Managers need to be contacted in order to make use of such value.

• T = Totality, (used for Pre-Authorization Completion; Final Authorization Indicator in a Pre-Authorization series)

Settlement Transaction

The following should only be used in the 0220 message to indicate that the transaction can be settled

• S = Capture Transaction

Credentials-on-File

The following value should be used for transactions which are sent using credentials stored on file, and which are not recurring or installments

• C = Credentials on file

For further information refer to Credentials-On-File used cases.

Other

• R = Recurring Transaction

Diners / Discover only values

• L = Delayed Card Sale

• E = Re-submission of Card Sale

• N = No-Show Charge

• H = Re-authorization (Diners only)

• U = Unscheduled Payment

This indicator can be used as an additional flag for specific authorization requests.

An example would be for merchants with terminals accepting partial authorizations, request would need to be provided with either 1 or 3 value.

Possible values:

• 0 = Not applicable: Indicators not set in current transaction or field is not applicable

• 1 = Terminal accepts partial authorization responses

• 2 = Estimated amount and terminal does not support partial authorization responses

• 3 = Estimated amount and terminal accepts partial authorization responses

This field contains the trace id / transaction identifier used by the card schemes to link subsequent transactions.

In the subsequent requests, RS2 should receive the original trace ID / transaction identifier returned in the response from the first authorization in a recurring series. This includes subsequent aggregate or incremental pre-authorizations, completions, recurring transactions and reversals.

In responses, RS2 will return the trace ID for each transaction as returned by the schemes, which may be different than the one sent in the request. API users are to store the networkTraceId value for subsequent transaction use.

Note: Currently, this field is returned for MasterCard, Visa, Discover, Diners and ELO transactions only

Applicable for MasterCard recurring transactions. A four character value indicating the cardholder/merchant initiated transaction category and and indicator subcategory.
For example, C102 to indicate Cardholder Initiated, Standing Order (variable amount and fixed frequency).

List of possible values:

C1 - Cardholder Initiated

• 01 - Credential-on-file (ad-hoc): Consumer agrees to store the credential on file with the merchant for future cardholder-initiated and/or merchant-initiated transactions that may occur from time to time, or consumer chooses to use a credential previously placed on file with the merchant when making a purchase.

• 02 - Standing Order (variable amount and fixed frequency): Consumer agrees to store the credential-on-file and initiates a first transaction in a series intended to be for a variable amount and a fixed frequency.

• 03 - Subscription (fixed amount and frequency): Consumer agrees to store the credential-on-file and initiates a first transaction in a series intended to be for a fixed amount and a fixed frequency.

M1 - Merchant Initiated Recurring Payment

• 01 - Unscheduled Credential on File: A transaction made pursuant to an agreement between a cardholder and a merchant, whereby the cardholder authorizes the merchant to store and use the cardholder’s account data to initiate one or more future transactions. The transaction can be for a fixed or variable amount but does not occur at regular intervals on a scheduled date.

• 02 - Standing Order (variable amount fixed frequency): A transaction made pursuant to an agreement between a cardholder and a merchant, whereby the cardholder authorizes the merchant to store and use the cardholder’s account data for a transaction that must occur at regularly scheduled intervals for a variable amount, as specified in the agreement.

• 03 - Subscription (fixed amount and frequency): A transaction made pursuant to an agreement between a cardholder and a merchant, whereby the cardholder authorizes the merchant to store and use the cardholder’s account data for a transaction that must occur at regularly scheduled intervals for a fixed amount, as specified in the agreement. The subscription agreement may include an allowance for introductory pricing or for price changes to occur from time to time.

M2 - Merchant initiated Industry practice

• 07 - No Show Charge: A penalty charged according to the merchant’s cancellation policy.

• 08 - Resubmission: Previous attempt to obtain authorization for a transaction has been declined but the issuer’s response does not prohibit the merchant from trying again later.

Represents the MasterCard merchant payment gateway identifier registered with the card scheme. Should contain numeric value only up to 11 digits.

2-digit ISO code value indicating the switch response.

A 2-digit code indicating the merchant advisory response code received from the card schemes (Visa or MasterCard. This functionality may not be available for your particular institution, in which case, no value is returned.

01 - Issuer will never approve. Do not try again. Payment Cancellation (MasterCard use only)

02 - Issuer cannot approve at this time (Visa: Re-attempt up to 15 times over 30 days)

03 - Issuer indicates data quality problem on payment information, acquire new account information or revalidate payment credentials (Visa: Re-validate payment information prior to re-attempt. Re-attempt up to 15 times over 30 days.

04 - Issuer generic decline category (Visa: Re-attempt up to 15 times over 30 days)

05 - Token requirements not fulfilled for this token type

06 - Undefined response code category, used for Visa or MasterCard in certain situations.

07 - MasterCard indicates that Merchant doesn’t qualify for product code. Modify transaction parameters or do not try again.

MasterCard use only:

08 - Not available. Retry after 1 hour

09 - Not available. Retry after 24 hours

10 - Not available. Retry after 2 days

11 - Not available. Retry after 4 days

12 - Not available. Retry after 6 days

13 - Not available. Retry after 8 days

14 - Not available. Retry after 10 days

15 - Informational - no action required.

Consumer non-reloadable prepaid card. Merchant should be aware using this card on file such as installments/subscription might be subject to future failure and should seek alternate method instead.

16 - Informational - no action required.

Consumer single-use virtual card number. Merchant should be aware using this card on file such as installments or subscription will likely be subject to future failure and should seek alternate method instead.

19 - Sanctions scoring service: Score exceeds applicable threshold value.

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 (left padded with zeros) automatically generated. Can be 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.

This flag should only be sent with a capture advice request (0220) whenever addendum data is sent via an 0340 message type. An example would be corporate cards L2/L3 data.

This field contains the equivalent of Visa DE62 Subfield 7.

Position 1 is the purchase identifier format. As listed below are the valid values:

• 1 - Order Number

• 3 - Rental Agreement Number

• 4 - Hotel Folio Number

• 5 - Invoice Number

Position 2-26 is the purchase identifier, this contains the order number.

The merchant ID or MID is a 15 character value that reflects the merchant account created by the processor.

Object containing eCommerce related attributes, for eCommerce transactions.

Object containing point of service specific attributes.

Object containing Address Verification System attributes

Object containing attributes that must be provided for recurring payments initiated on India issued cards (VISA only). This is only used for POST request and will not be returned to the response.

Object containing attributes to support payment facilitator or marketplace requests.

The service location object is used to pass service location data related to the transaction as required by MasterCard.

Service location data is applicable for:

• E-commerce: electric vehicle charging or fuel purchase
• E-commerce: In-store pickup
• Ride-hailing (eCommerce app payment)
• Onboard transit (eCommerce app payment)

This object can be used in the request message of a pre-Authorization Incremental transaction to fill the total accumulated amount of the pre-authorization. When having an Incremental transaction this field is mandatory (with amountType value ‘56’) for Discover and Diners, however, it is optional for other card schemes.

This object is also used in the request message of MIT such as Recurring, Installment, Delayed Card Sale, Re-submission of Card Sale, No-Show Charge, and Unscheduled Payment to fill the amount requested in the original transaction. When having any of the mentioned MIT, this field is mandatory (with amountType value ‘57’) for Discover and Diners. However, it is optional for other card schemes.

Linked merchant from where the authorization originated.

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.

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.

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.

2-digit ISO code value indicating the switch response.

Represents a descriptor identifying the type of addendum. Accepted values:

CORPT - (corporate card line item)

The addendum sequence number must be provided specifying the addendum number starting from ‘1’. If more than one addendum authorisation is sent, the correct sequence increment must be provided.

For example:

• 0340 request 1- addendumType: ‘CORPT’, addendumSequence: 1

• 0340 request 2 - addendumType: ‘CORPT’, addendumSequence: 2

Generic attribute which accepts a JSON object as a string, containing the necessary addendum record format. Following the intial response, this information is not sent back in GET calls. Data cannot exceed 2000 bytes in size. Please note that the specification is available as a separate document. Please contact your respective RS2 Project Manager for more information.

The addendum authorisation must be linked to the original pre-auth message.

The client’s BankWORKS sub-account number.

The balance brought forward from the previous cycle as of date cycle start.

The balance of the account based on all processed transactions, the current cycle balance.

The account’s billing cycle start date.

The account’s billing cycle end date.

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

The date this record was changed last.

Returns the BankWORKS client account related to the cycle balances.

This represents the 3-digit ID of the billing cycle. E.g. 020 (Business EOC)

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

The start date of the billing cycle in ISO 8601 format. E.g. 2022-04-01

The end date of the billing cycle in ISO 8601 format. E.g. 2022-04-30

The status ID of the billing cycle. E.g. 004 (Current)

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

The date in ISO 8601 format on which the billing cycle definition record was created.

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

Indicates the broker current status.

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

Indicates the broker’s client type.

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

Broker’s short name. If not provided during broker creation, the tradeName value will be used.

The broker company name.

The name under which the company is trading.

The broker registration number.

Broker’s language.

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

Related to the legal form of the broker, 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 ISO 4-digit business classification code.

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

A reference number used for clearing purposes.

External broker reference number.

^\d*$

Broker website address details.

The ISO 3-letter country code of the broker’s country for tax information. 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 account definitions available for the institution.

Broker’s addresses. A broker may have 1 effective address per category, the relationship provides access to current effective as well as past or future ineffective data.

Contracts linked to the broker. A broker may have one effective contract record per service contract assigned. Each

BankWORKS accounts assigned to the broker.

Broker’s bank account settlement details. Only brokers having accounts at billing level will require settlement information to be defined.

All virtual links related to the broker.

Indicates the card scheme for the addendum entry. Valid values:

• 002 Mastercard
• 003 Visa
• 004 Amex
• 006 Diners
• 023 Discover
• 032 Star
• 033 NYCE
• 034 Pulse
• 035 Shazam
• 036 ACCEL
• 037 AFFN
• 038 CULIANCE
• 039 INTERLINK
• 040 PAVD
• 041 EBT
  

The cardOrganisation value determines the applicable card scheme object such as ‘visa’, ‘mastercard’ etc.. The object ‘pinDebit’ refers to any card scheme not represented by an individual object such as Star or NYCE.

Indicates the cardSchemeAddendum resource when it will become effective.

If no value is provided prior to onboarding a new merchant the value defaults to the posting date available during merchant boarding.

Otherwise defaulted to the next processing date (posting date + 1).

Applicable for cardOrganisation value 003.

Applicable for cardOrganisation value 002.

Applicable for cardOrganisation value 004.

Applicable for cardOrganisation value 023.

Applicable for cardOrganisation value 006.

Applicable to any ONE of the following cardOrganisation values 032, 033, 034, 035, 036, 037, 038, 039, 040, 041.

The contract applicable to this cardSchemeAddendum.

Genrated by API. This id of the transaction tariff template is used when posting a new transaction tariff definition.

The type of fee such as a commission.

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

Defines where the transaction took place,

Refer to BankWorks (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 BankWorks (API) Data Mapping documentation for possible values.

Client tariff package assigned.

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

Date when the charge fee becomes effective.

User specified labels for transaction charge tiers.

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

The service contract to which charge rules applies.

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

Service to which the transaction charge applies.

Refer to BankWorks (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 BankWorks (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.

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

Refer to BankWorks (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.

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

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

Links to the parent tariff based rule. Applicable for POST in order to identify original parent recordIdNumber.

Indicates the currency applicable to the client mapping. The accepted currency value is in the 3-letter SWIFT format such as USD. Two 3 digit values are also accepted:

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

Refer to BankWorks (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.

The ISO 4-digit business classification code that the client mapping value is applies to.

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

Indicates the card scheme of client mapping.

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

Indicates the acquiring bank BIN number that the client mapping value applies to.

A value indicating the type of merchant ID which based on setup might be automatically generated or provided manually.

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

All merchant contract groups or not. Every mechant contract is bound to group which defines the hierarchy. Setting this value to true will apply the ID to all available merchant groups should the merchant have more than one service contract assigned. Otherwise, if false, the related contract needs to be linked to.

Client mapping reference value which can either be automatically generated or entered manually depending on the sequenceNumber value and associated setup. Generation method of 020 and 021 will trigger the automatic generation value for this field.

Merchant information to which the client mapping is related to.

List of contract details to which the client mapping are related to.

Identifies the type of institution-specific client reference type.

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

Value of client reference. E.g. 1234000-ABC

The merchant owner of the reference property.

The source client number of the virtual link.

The destination client number of the virtual link.

Indicates the link type of the virtual link record such as:

• 008 (Merchant → ISO)
• 021 (Merchant → Beneficiary Owner)
  

Refer to API Data Mapping documentation for other possible values.

The current status of the virtual link.

• 001 Active
• 002 Closed.

Refer to API Data Mapping documentation for other possible values.

The date in ISO 8601 format when the virtual link 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.

Client tariff identifier - unique per service contract and institution.

Description of client tariff identifier which taken from the account condition set choice table.

The service contract to which the account fee applies.

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

This is an array of client fee new rules that are to be define based on the client tariff template.

A new client tariff definition should be based on an existing client tariff template rule.

The service contract to which the account fee applies.

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

Broker client tariff template identifier that is unique per service contract and institution.

Description of broker client tariff id template which taken from the account condition set choice table.

Broker contract definitions.

Client tariff rules that are linked to this broker tariff template.

Generated by API. This id of the client tariff template is used when creating a new client tariff definition.

Three fee types represented under a client tariff such as account, service and device fees.

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

The transaction type of the generated fee.

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

Date when the client fee becomes effective.

The percentage value used to generate the fee for account fee trigger setup. 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.

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

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

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

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

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

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

The service contract to which fee rules applies.

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

Service to which the client fee applies.

Refer to BankWorks (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 BankWorks (API) Data Mapping documentation for possible values.

Defines a set of rules related to the generic fee.

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

Tariff enables to set up client fees within the service contract eg Blended Pricing, IC++ Pricing etc.

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

Based on the configuration, it tells whether or not the client tariff rule is amendable.

Service contract package identifier.

Refer to BankWorks (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 BankWorks (API) Data Mapping documentation for possible values.

Specifies how frequently the serviceContract should be revised.

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

Free text description of the service contract.

Services that are linked to the service contract.

Accounts types that are linked to the service contract.

Client contracts that are linked to the service contract.

Indicates the status of the client contract. If not provided, this will be defaulted to 001 (Active).

Refer to BankWorks (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 BankWorks (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 BankWorks (API) Data Mapping documentation for possible values.

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

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

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

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

Indicates the applicable transaction charges tariff. Transaction charges are represented as productChargeDefinitions. This is an optional field and if not provided will default to not applicable 000000. If a tariff value is provided, the merchant services clientTariff value will not apply.

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

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

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

Indicates the rebate tariff applicable for the contract.

Merchant contract document reference.

External additional reference number of the merchant with the bank.

Officer in charge of the client contract.

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

Contract application branch details. Related to the institutionAccountOfficer.

Refer to BankWorks (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 BankWorks (API) Data Mapping documentation for possible values.

Entity identifier used to split GL entries and transactions generated for financial activity in a single processing institution across multiple legal entities.

Identifier for the set of rules applies in the risk module.

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

The date in ISO 8601 format on which the merchant/contract record is created. Defaulted to the current posting date when a new record is created

Service contract definition the client contract is linked to.

Merchant linked to the contract. A contract can be linked to a single client.

Broker linked to the contract. A contract can be linked to a single client.

Accounts linked to the contract.

Client service/s created under the client contract. Services have an effectiveDate. The relationship links to past, current and future effective data.

Links to the parent contract, one level up the client hierarchy. The parent contract will have the current effective data as well as past or possible future effective iterations. The current effective can be determined by the effectiveDate value.

Direct child contracts beneath the Group or Sub-Group client in the hierarchy.

All the child contracts beneath the Group or Sub-Group client in the hierarchy.

Merchant velocity parameters that apply to the merchant contract.

One or more card scheme addendum resource this contract is linked to.

One or more risk rule parameters this client contract is linked to.

Terminal ID assigned to the device.

Terminal serial number.

Indicates the current terminal status.

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

The model terminal type if it is a virtual POS, specific POS model or kind of POS terminal.

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

A 3-character index-based value which determines the use of a POS device. E.g. Petrol-Unattended or Retail POS.

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

The currency of the device in ISO 3-letter SWIFT format. In cases where value consists of 3 digits:

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

Contact person responsible for the terminal.

The terminal capability for PAN PIN entry.

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

Defines the end-of-day method.

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

Date when the record was last changed in ISO 8601 format.

Services applicable to the owner of the pos device. A service may have multiple resources with effective dates various effectiveDate values which can be used to determine past versions, current data as well as upcoming future setup.

Device fee definition setup related to the particular device. The relationship links to both contract based as well as device specific fees. Refer to effectiveDate to determine the device fee setup applicable at a given point in time.

A sequential unique id number which serves a reference to a contract or individual fee.

Indicates if a device fee is a contract-based fee. Otherwise, value is false if it is an individual device fee specifically defined for the client.

Date when the device fee becomes effective.

Tariff enables to set up various fees within the service contract of the client.

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

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

Defines the date when the fee will expire and hence will no longer be generated.

The base amount of the fee in relation to the value on which it is calculated.

The minimum fee amount that will always be generated if calculated percentage is lower.

The maximum fee amount that will always be generated if calculated percentage is higher.

The flag which indicates whether the fee is to be generated or suppressed.

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

Number of days due after the period reference.

Defines the most recent date on which the fee was generated.

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

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

Sign operator related to fixedPeriod following the periodReference.

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

The frequency when the defined fee will be processed e.g. Daily, End of Cycle etc.

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

Sign operator related to trigger source and trigger value.

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

Defines the value or event that triggers the fee process.

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

Defines a set of rules related to the generic fee.

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

Device or terminal information related to the device fee setup.

Contract-based fees which served as a reference in creating individual device fees.

Service definition related to the device fee setup.

The BankWORKS DMS Case Number.

An external dispute management system reference value used for third party case reference if needed.

The disputed amount.

The settlement amount and currency in the acquirer original setup.

The date of the last action taken on the case.

Indicates the type of dispute transaction such as retrieval request, Pre-Arbitration, Arbitration, etc…

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

Indicates the current status of the case.

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

Reason depending on card organisation.

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

The date the dispute was loaded in BankWORKS.

Central processing date of transaction by card organization.

Indicates the remaining days of the dispute case deadline of the card scheme.

Represents the amount of days left before the merchant action deadline is reached.

Card network through which the dispute is being handled.

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

The last chargeback reason of the case. Applicable only where the case type is chargeback. For Discover, this also applies for pre-arbitration and arbitration.

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

Indicates the last retrieval reason of the given case, unless the case already has a chargeback. In Discover’s case, the same exception applies if the case has a pre-arbitrartion or arbitration.

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

Indicates the lastest dispute condition. Please note this only applies for Visa.

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

Indicates whether the case has been escalated.

BankWORKS merchant information

Relationship to the original purchase transaction on which the dispute orginated. This relationship allows retrieval of original presentment details.

Dispute case history.

Dispute case related actions.

Indicates the action type.

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

Indicates if documentation is required with this action. Possible values are:

• 000 means No
• 001 means Yes
• 003 means Conditional

Indicates if a fee will be incurred as part of the action (e.g. arbitration).

Indicates whether the planned refund date required for this action.

Indicates if notes are required with this action. Possible values are:

• 000 means No
• 001 means Yes
• 003 means Conditional

The date and time when the particular case action was recorded.

A unique action history identifier. Automatically increments with every action taken and unique for all cases.

Indicates the type of dispute transaction such as retrieval request, Pre-Arbitration, Arbitration, etc…

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

Indicates the status of every case history record.

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

Indicates the action taken for a particular case.

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

User entered note on action taken.

Indicates whether the merchant accepted the amount to be paid for this action.

File evidence document in any format provided that matched up to the fileExtension attribute. This should be in base 64 encoded representation.

For retrieval, this is an on-demand attribute i.e. not retrieved automatically but only retrieved if specified as an included field.

Document name provided by the merchant.

An autogenerated name which guarantee the uniqueness among in all files that are being uploaded.

This is the file extension of the document provided (e.g. jpg, pdf, etc…).

Indicates whether the merchant accepted the risk even the days to action equal to 0.

The date in ISO 8601 format when the actual refund date will be carried out.

POSTABLE only. To link to case when taking an action.

POSTABLE only. To link to case action when taking an action.

Generated by API. This id of the client tariff template is used when posting a new client tariff definition.

Three fee types represented under a client tariff such as account, service and device fees.

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

Date when the client fee becomes effective.

The transaction type of the generated fee.

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

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.

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

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

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

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

Refer to BankWorks (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 standard amount generated for the account fee. Note that all fee amount currencies MUST match. Maximum allowed length (including decimal point) is 11.

The service contract to which fee rules applies.

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

Service to which the client fee applies.

Refer to BankWorks (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 BankWorks (API) Data Mapping documentation for possible values.

Defines a set of rules related to the generic fee.

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

Tariff enables to set up client fees within the service contract eg Blended Pricing, IC++ Pricing etc.

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

Links to the parent client tariff based rule. Applicable for POST in order to identify original parent recordIdNumber.

8-digit BankWORKS client number unique that is unique per institution.

Indicates the current status of the client record.

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

Indicates the BankWORKS client type applicable for the funding client record.

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

The funding client’s company name.

The funding client registration number.

A reference number used for clearing purposes.

Client settlement information being funded by this client.

Indicates the status of KYC/AML client. If not provided will be defaulted to 001 (Active). Examples include:

• 001 (Active)
• 002 (Dormant)
• 003 (Suspended)
• 004 (Closed).
  

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

Defines the type of client record. For example, a business owner.

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

Indicates the KYC/AML client salutation. If not provided will be defaulted to 000 (n/a). Examples include:

• 000 (N/A)
• 001 (Mr)
• 002 (Mrs) -003 (Miss)

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

The first name of the private individual.

The last name of the private individual.

The date of birth in ISO 8601 format.

Indicates the unique social security number of the client. The value of this attribute in the response will always be returned in masked format.

Merchant resource to which the KYC/AML client is linked to.

The addresses linked to the KYC client.

A unique 35-character reference for the signed mandate

Type of the mandate whether it is a business-to-client or business-to-business scheme.

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

This will indicate whether the mandate is first occurrence or not. By default it will be set to No (000).

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

Date of which the mandate was signed or authorised.

Bank account settlement information which this mandate belongs to.

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

Indicates the current state of the merchant.

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

Indicates the merchant’s client type. If not provided during merchant creation, it will be defaulted to 002 (Merchant).

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

Merchant’s short name. If not provided during merchant creation, the tradeName value will be used.

First name of the merchant owner. For the USA market this would be the first name of the owner if the merchant is a sole proprietor. Required for USA merchants with legalForm of 029 - Sole Proprietor.

Middle name of the merchant owner. For USA merchants having a legalform of 029 - Sole Proprietor, the middleName would be used to store the middle initial followed by a full-stop (.) as per the Visa Acquirer Merchant Master File requirements.

Last name of the merchant owner. For the USA market this would be the last name of the owner if the merchant is a sole proprietor. Required for USA merchants with legalForm of 029 - Sole Proprietor.

The merchant company name.

The name under which the company is trading.

The merchant registration number.

Merchant’s VAT region.

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

Merchant’s language.

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

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 ISO 4-digit business classification code.

Merchant’s VAT number.

A reference number used for clearing purposes, typically the merchant ID.

The ISO 4-digit domestic merchant category code.

Object grouping main merchant contact information.

External merchant reference number.

Merchant website address details.

Indicates if the merchant business is eCommerce based or a traditional business.

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

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

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

Merchant’s tax region.

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

The ISO 3-letter country code of the merchant’s country for tax information. In cases where value consists of 3 digits:

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

The address linked to the merchant. A merchant may be linked to multiple addresses.

Service contract/s related to the merchant.

BankWORKS account/s assigned to the merchant.

Bank account settlement information related to the merchant.

Authorisation transactions of the merchant.

Additional attributes related to the merchant.

Additional attributes specifically for merchants based in USA.

Additional attributes specifically for merchants based in Colombia.

All client mappings available related to the merchant.

This is the originating (old) merchant for which this merchant has been moved from. This is only done via PATCH request. Please see Merchant Entity Move use case for proper usage.

All virtual links related to the merchant.

All tax status records related to the merchant.

All dispute cases related to the merchant.

All KYC/AML clients related to the merchant.

Flag to indicate if the merchant is a seasonal merchant or not. Such as:

• 000 No
• 001 Yes

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

The fee program indicator used for the VISA Base 2 clearing file.

Stores the value of the Visa interchange program value.

The ISO 3-digits used to determine the tier of the interchange.

Stores the value of the MasterCard AID.

The ISO 3-digits used to determine the tier of the interchange.

This attribute will contain the SSN, and it is required for Discover. It is also required when the taxIdNumberType in the merchantsAddendumUsa will be set to 002 SSN.

The value of this attribute in the response will always be returned in masked format.

Tax tariff that will be charged to merchant related to merchant VAT.

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

The municipality code of the place where the transaction occurred.

Mastercard requirement for government owned merchants. The country of origin for government-controlled merchants must always be populated. This includes when the government-controlled merchant’s home country is the country where the government-controlled merchant is physically located and when the government-controlled merchant’s home country is not the country where the government-controlled merchant is physically located.

The format is in ISO 3-letter country code. E.g. NZL (New Zealand)

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

The merchant’s main website address.

This value is also required for merchants acquiring MasterCard eCommerce and in case there is no main service telephone number (mainContactDetails.serviceTelephone).

Independent Sales Organisation ID value provided by Mastercard.

This value is equivalent to the merchantsAddendumUsa.independentSalesOrganisation attribute.

Merchant related to the addendum record.

Merchant URL information.

Independent Sales Organisation ID value provided by Mastercard.

This value is equivalent to the merchantsAddendum.independentSalesOrganisation attribute.

TAX ID/TIN number used by the IRS. Requirement of the 1099k form report. This is required when the taxIdNumberType either:

• 001 EIN
• 003 ITIN
• 004 ATIN

Indicates the type of TAX ID/TIN number used by the IRS. Requirement of the 1099k form report. When this is set to 002 SSN, the socialSecurityNumber in the merchantsAddendum is required.

Information about what product/services are sold by the merchant.

Flag indicating whether the Visa International Acquirer Fee is to be posted to client rather than institution account. Such as:

• 000 means institution account
• 001 means client account

Indicates the Federal tax fee tariff.

Addendum record for merchant based in USA.

Indicates the department code of the merchant that will be used for calculation of merchant tax ReteICA (Municipality Tax).

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

Indicates the municipal code of the merchant that will be used for calculation of merchant tax ReteICA (Municipality Tax).

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

This is used if the merchant will be charged with the municipality tax (ReteICA).

Tax tariff that will be charged to merchant related to merchant income (ReteFuente).

Tax tariff that will be charged to merchant related to merchant VAT (ReteIVA).

Merchant information related to addendum record.

The service contract to which the account fee applies.

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

Broker client tariff identifier that is unique per service contract and institution.

Descriptive name of the tariff. Up to 25 characters.

Indicates if this tariff has been processed or not. This cannot be changed if it has already been processed.

The source tariff to be cloned for modification. The tariff must be processed.

Client tariff rules that are linked to this broker tariff.

Indicates the type of merchant tax.

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

Indicates the current status of merchant tax type.

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

The date in ISO 8601 format on which the merchant tax status record becomes effective. The value can be future dated and cannot be less than the posting date. If not provided, posting date value is assumed.

The date in ISO 8601 format when the merchant tax status can no longer be used.

The date in ISO 8601 format on which the merchant tax status record is created. Defaulted to the current posting date when a new record is created

Merchant information related to merchant tax status record.

The service contract to which the account fee applies.

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

Broker client tariff identifier that is unique per service contract and institution.

Descriptive name of the tariff. Up to 25 characters.

Indicates if this tariff has been processed or not. This cannot be changed if it has already been processed.

The source tariff to be cloned for modification. The tariff must be processed.

Transaction tariff rules that are linked to this broker tariff.

Total amount of transactions allowed for this velocity parameter within a 24-hour period. Note that the limit amount currencies MUST match. Maximum allowed length for the value attribute (including decimal point) is 18.

Total number of transactions allowed for this velocity parameter within a 24-hour period.

maximum: 99999999

Maximum transaction amount allowed for a single transaction for this velocity parameter. Note that the limit amount currencies MUST match. Maximum allowed length for the value attribute (including decimal point) is 18.

The percentage of the limit after which, notifications should be considered.

maximum: 99

The percentage interval upon which the notification is triggered.

maximum: 99

Indicates the type of transaction that the velocity parameter is applicable to.

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

Indicates the transaction currency the velocity parameter applies to. The transaction currency is in 3-letter ISO SWIFT format. Value 999 is not allowed. In cases where value consists of 3 digits:

• 998 means not applicable

Indicates the card brand the velocity parameter applies to. This works in conjunction with the related merchant service. A value of 999, indicating that the velocity rule applies to all card brands is also acceptable.

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

Identifies the country grouping the velocity parameter applies to. The country grouping is a virtual group of countries that is defined to classify a number of countries under a common banner, for example high risk countries, blocked countries etc.

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

Indicates if the merchant velocity parameter is a contract level rule, part of the service contract setup, or a merchant specific rule.

Indicates if the rule applies to all merchant services or not.

Services that the merchant velocity parameter is applicable to. Services are returned regardless of their effectiveDate value.

Contracts that the merchant velocity parameters is applicable to. Contracts are returned regardless of their effectiveDate value.

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.

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

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

Auto-populated based on the related account provided.

This information is currently not supported.

This entry is currently not supported. Only a relationship to account is required during POST.

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 always be linked to an account.

The date in ISO 8601 format of when the transaction was (or will be) sent in the outward instruction file.

The date in ISO 8601 format of when the transaction was (or will be) actually executed by the external funding system.

The type of transaction.

• 002 Interchange Payment
• 005 Purchase
• 006 Refund (Credit)
• etc…

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

The transaction status.

• 001 Entered
• 002 Posted
• 003 Error
• etc…

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

The gross amount to be sent/received to/from the third party RBS account. Note that the gross and net amount currencies MUST match. Maximum allowed length for the value attribute (including decimal point) is 18.

The net amount to be sent/received to/from the third party RBS account. Note that the gross and net amount currencies MUST match. Maximum allowed length for the value attribute (including decimal point) is 18.