/api/v1/transactionCharges/{mid}

get https://cat-webfarm.1dc.com/boarding-ui-dev/external-api/maintenance/api/v1/transactionCharges/{mid}

Retrieves a paginated list of transaction charges assigned to the merchant id.

Responses

Response body

object

meta

object

paging

object

sorting

object

Has additional fields

messages

array of objects

messages

object

string

code

string

title

string

detail

string

source

object

data

array of objects

data

object

chargeModel

string

enum

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

INDIVIDUAL DEFAULT

chargeStatus

string

enum

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).

ACTIVE FUTURE INACTIVE

recordIdNumber

string

Record id of the transaction fee to be overwritten. For a list of valid record ids check the institution index file.

cardType

object

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

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 triggered 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 maximum amounts. Values are restricted by institution configuration. For a list of valid codes check the institution index file.

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

object

The transaction fees applicable to the currency of the transaction.

lastUpdatedBy

string

Contact name of the person or system description that last updated the record.

lastUpdated

date

Date when the record was last updated.

errors

array of objects

errors

object

links

object

self

string

first

string

last

string

204

No register was found

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url https://cat-webfarm.1dc.com/boarding-ui-dev/external-api/maintenance/api/v1/transactionCharges/mid \
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

401Unauthorized request

403Forbidden request

404Record does not exist

500Internal Error