/api/v1/application/transaction-charges

get https://cat-webfarm.1dc.com/boarding-ui-cat/external-api/api/v1/application/transaction-charges

This endpoint allows you to retrieve information about a list of all Transaction Charges of the institution pageable

Responses

Response body

object

meta

object

paging

object

Map containing pagination related information about data.

sorting

object

Map containing sorting related information about data.

messages

array of objects

Messages related to request processing or response data - any additional information or warnings to be returned in the case of a successful API call.

messages

object

string

Generated message identifier for particular request, helping to locate server logs.

code

string

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

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

object

Object containing references to the source of the message.

data

array of objects

data

object

chargeModel

string

Default - Is part of a set of transaction charges that are not linked to any particular merchant, but linked to a client tariff. Only Deafault model is supported.

recordIdNumber

string

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.

merchantTariff

object

Merchant tariff determines a set of transaction fees to be generated for the merchant per service, the object provides numerical code and description for each tariff.

chargeType

object

The type of charge being generated e.g. Per Tran fee, Assessment fee, Commission etc.

serviceId

object

The acquiring service against which the charge will apply.

transactionType

object

The transaction type which would triggred transaction charge to be applied.

captureMethod

object

The means by which the transaction was accepted.

areaOfEvent

object

Area Of Event against the charge applied.

feeCategory

object

The pricing mechanism to be used e.g. Interchange Plus, Pricing Plus Fees.

effectiveDate

date

Detail today's date or a future date as appropriate. Format YYYYMMDD

expiryDate

date

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

Charge base to be applied.

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 field values in service-contracts/{serviceContractIndex}/account-settlement 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

object

The posted transaction charges fee type, e.g. Assessment Fee

transactionCurrency

string

serviceType

object

The card service type against which the charge will apply. Generally set to Credit, Debit or All.

204

No register was found

401

Unauthorized request

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://cat-webfarm.1dc.com/boarding-ui-cat/external-api/api/v1/application/transaction-charges?offset=0&pageSize=100' \
3
     --header 'accept: */*'

Click Try It! to start a request and see the response here! Or choose an example:

*/*

application/json

200Successful operation

400Bad request

403Forbidden request

500Internal Error

502API Error