--- title: "Retrieves merchant transaction charges" method: GET path: "/transaction-charges" tags: ["Transaction Charges"] --- # Retrieves merchant transaction charges `GET /transaction-charges` Retrieves a paginated list of transaction charges assigned to the merchant id. Can be filtered by charge status (default: ACTIVE) and the merchant's enabled acquiring service ( default: all). Filtering can be used together or independently. ## Query parameters - `chargeStatus` 'ACTIVE' | 'FUTURE' | 'ALL' | 'INACTIVE' - `serviceIndex` string - `recordIdNumber` string - `chargeTierLevel` string - `chargeCurrencyCode` string - `chargeModel` 'INDIVIDUAL' | 'DEFAULT' - `limit` integer - `offset` integer ## Headers - `Content-Type` 'application/json' | 'application/json;charset=UTF-8', required - `FSV-Interaction-Id` string, required - `Environment` string, required - `Institution-Number` string, required - `Internal-Merchant-Id` string, required ## Response `200` OK - InlineResponse2006 — An API response. The API response will be either a `SUCCESS` or an `ERROR`. A partial success or warning scenario will be treated as a Success with embedded messages in the meta data. A full success may not have messages. The API response will contain at least one of the following top level members." - `meta` MetaType — Supplementary information about the data. - `paging` PagingMetaType — Map containing pagination related information about data. - `count` integer — Total number of records present in system which can be retrieved. - `totalPages` integer — Total number of pages with maximum limit taken into account. - `currentOffset` integer — Current offset used in request. - `currentNumberOfRetrievedRecords` integer — Current number of retrieved records. - `maxLimit` integer — Maximum limit of records that can be retrieved. - `hasMoreRecords` boolean — Indicates if there are more records available. - `pageNumber` integer — Current page number. - `sorting` SortingMetaType — Map containing sorting related information about data. - `sort` string — Indicates the elements the current data is sorted with and the direction of sorting. - `messages` ErrorType[] — Messages related to request processing or response data - any additional information or warnings to be returned in the case of a successful API call. - `id` string — Generated message identifier for particular request, helping to locate server logs. - `code` string, required — Machine readable, unique code of the message related to particular case within operation execution. For complete list of codes please refer to API portal, messages page. - `title` string, required — Short description of the error. Not for displaying purposes. - `detail` string — Provides additional low-level details about the error to assist with troubleshooting. Not for displaying purposes. - `source` SourceType — Object containing references to the source of the message. - `pointer` string — Indicates the element in the request document which caused the error. - `parameter` string — Indicates which query parameter caused the error. - `header` string — Indicates which header caused the error. - `data` object[], required — "Contains the primary data to be returned as the API response. Use this object only when respnse type is an array. It will not be returned in case of error." - `chargeModel` 'INDIVIDUAL' | 'DEFAULT' — Default - Is part of a set of transaction charges that are not linked to any particular merchant, but linked to a client tariff. Individual - Is part of a set of transaction charges that are assigned directly to a merchant. Individual tariffs superceeds defaults. A merchant can either be on a set of default or individual transaction charges - `chargeStatus` 'ACTIVE' | 'FUTURE' | 'INACTIVE' — Active - Indicates currently processable transaction charges ( effective date smaller than current posting date, expiry date bigger than current posting date, fee mode true ) Future - Indicates charges becoming active in the future ( effective date bigger than current posting date, expiry date bigger than current posting date, fee mode true ). - `recordIdNumber` string, required — Record id of the transaction fee to be overwritten. For a list of valid record ids use transaction-charges GET endpoint in Merchant Maintenance API. - `cardType` OPYTransactionChargesCardServiceTypeObj — The card service type against which the charge will apply. Generally set to Credit, Debit or All. - `cardServiceTypeIndex` string — Numeric Code. - `cardServiceTypeDescription` string — Contains description associated to a code in English. - `chargeType` OPYTransactionChargesChargeTypeObj — The type of charge being generated e.g. Per Tran fee, Assessment fee, Commission etc. - `chargeTypeIndex` string — Numeric Code. - `chargeTypeIndexDescription` string — Contains description associated to a code in English. - `serviceId` OPYTransactionChargesServiceIDObjV11 — The acquiring service against which the charge will apply. - `serviceIndex` string — Numeric Code. - `serviceDescription` string — Contains description associated to a code in English. - `transactionType` OPYTransactionChargesTransactionTypeObj — The transaction type which would triggred transaction charge to be applied. - `transactionType` string — Numeric Code. - `transactionTypeDescription` string — Contains description associated to a code in English. - `captureMethod` OPYTransactionChargesCaptureMethodObj — The means by which the transaction was accepted. - `captureMethodIndex` string — Numeric Code. - `captureMethodDescription` string — Contains description associated to a code in English. - `areaOfEvent` OPYTransactionChargesAreaOfEventObj — Area Of Event against the charge applied. - `areaOfEventIndex` string — Numeric Code. - `areaOfEventDescription` string — Contains description associated to a code in English. - `feeCategory` OPYTransactionChargesFeeCategoryObj — The pricing mechanism to be used e.g. Interchange Plus, Pricing Plus Fees. - `feeCategoryIndex` string — Numeric Code. - `feeCategoryIndexDescription` string — Contains description associated to a code in English. - `effectiveDate` string — Effective date assigned to transaction charge. Format YYYYMMDD - `expiryDate` string — Expiry date for fee if defined or set to or future date 99991231. Format YYYYMMDD. The date should be in future - `feeMode` boolean — Indicates if the fee is being generated (true) or suppressed (false). Suppressing a fee in effect is the same as setting the fee's pricing to zero, i.e. no fee will be charged. - `feePercentage` string — Fee percentage to be applied. Valid value as per the Format NNNNNN.NNNN - `feeBase` string — Charge base amount to be applied. - `feeMinimum` string — Minimum charge amount. - `feeMaximum` string — Maximum charge amount. - `chargeCurrencyCode` string — The ISO 4217 currency code for the charge base, minimum and maximun amounts. Values are restricted by institution configuration. For a list of valid codes refer accountCurrency classification in reference-data endpoint in Acquirer Profile API. - `chargeTierLevel` string — The tier assigned which will drive the merchant tiered pricing. The tier level that is assigned to the merchant. This will be N/A (Default) if the transaction charge record is not tiered. - `feeType` OPYTransactionChargesFeeTypeObj — The posted transaction charges fee type, e.g. Assessment Fee - `feeTypeIndex` string — Numeric Code. - `feeTypeDescription` string — Contains description associated to a code in English. - `transactionCurrency` OPYTransactionChargesTransactionCurrencyObj — The transaction fees applicable to the currency of the transaction. - `transactionCurrencyIndex` string — Numeric Code. - `transactionCurrencyDescription` string — Contains description associated to a code in English. - `lastUpdatedBy` string — Contact name of the person or system description that last updated the record. - `lastUpdated` string — Date when the record was last updated. Format YYYYMMDD. - `errors` ErrorType[] — "Contains one or more error messages and is mutually exclusive with the data item. This will not be returned in success scenarios." - `id` string — Generated message identifier for particular request, helping to locate server logs. - `code` string, required — Machine readable, unique code of the message related to particular case within operation execution. For complete list of codes please refer to API portal, messages page. - `title` string, required — Short description of the error. Not for displaying purposes. - `detail` string — Provides additional low-level details about the error to assist with troubleshooting. Not for displaying purposes. - `source` SourceType — Object containing references to the source of the message. - `pointer` string — Indicates the element in the request document which caused the error. - `parameter` string — Indicates which query parameter caused the error. - `header` string — Indicates which header caused the error. - `links` LinksType — Contains the links to retrieve the resources exposed as part of this API. - `self` string — The link to the primary resource being retrieved in the request. - `first` string — This is to provide the link to retrieve the first record/page. This SHOULD be used in case server provides pagination of the resource. - `last` string — This is to provide the link to retrieve the last record/page. This SHOULD be used in case server provides pagination of the resource. - `prev` string — This is to provide the link to retrieve the previous record/page. This SHOULD be used in case server provides pagination of the resource. - `next` string — This is to provide the link to retrieve the last record. This SHOULD be used in case server provides pagination of the resource ## Other responses - `400` — Invalid request - `401` — Authorization error - `403` — Forbidden error i.e. Consumer token credentials are valid but lack of permissions to do this action. - `404` — Record does not exist - `500` — Internal Server Error --- [API](https://skmtc.net/fiserv/apis/acquirer-profile-in-design.md) · [All operations](https://skmtc.net/fiserv/apis/acquirer-profile-in-design/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/fiserv/acquirer-profile-in-design/versions/dd7ef6ce81a1/schema)