/api/v1/omnipay/accountFees/{mid}

get https://uat-merchant-services.fiservapp.com/boarding-ui/external-api/maintenance/api/v1/omnipay/accountFees/{mid}

Retrieves a paginated list of merchant account fees. By default only active fees are returned, the results can be filtered by fee status and fee model.

Path Params

mid

string

required

Query Params

accountFeeModel

string

Default - returns the fees configured to the Client Tariff that are applicable to the merchant. Individual - Retrieves merchant customized fees. All - returns both default and individual fees. By default All are returned.

accountFeeStatus

string

Active - returns all active account fees. Can be a mix of default and individual fees. Future - returns fees that are set to become effective in the future, having effectiveDate later than current posting date. Inactive - Fees that has been overriden by a more recent effective fee. All - returns all active, future and expired fees. By default active charges are returned.

offset

int32

≥ 0

Defaults to 0

offset

pageSize

int32

≥ 1

Defaults to 100

Number of items per page

Responses

Response body

array of objects

object

feeModel

string

Indicates if it is a merchant individual fee or default fee. Default fees are a set of fees that apply to a group of merchants falling under the same service contract. Individual fees are fees forming part of the default set that are customised for a particular merchant.

DEFAULT INDIVIDUAL

recordIdNumber

string

required

Record id of the client account fee to be overwritten. The corresponding id should belong to the client tariff id selected on the merchant contract details and the merchant accounts with account currency assigned to the merchant. For a list of valid codes use account-fees GET endpoint in merchant maintenance API.

status

string

Active - returns currently active merchant fees ( having effective date smaller than current posting date and fee mode true ). Future - returns merchant fees not yet effective ( having effective date later than current posting date ). Inactive - returns merchant fees that are not active anymore ( having expiry date smaller than current effective date ).

ACTIVE FUTURE INACTIVE

accountType

object

Index of the account type to be assigned to the merchant. For a list of valid codes check the institution index file.

accountCurrencyCode

string

ISO 4217 currency of the account selected, possible values are restricted based on the institution configuration. For a list of valid codes check the institution index file.

effectiveDate

date

Effective date of the fee. For auditing reasons merchant fees can not be deleted after it has become effective hence the use of effective dates for fees.

expiryDate

date

Expiry date for fee if defined or set to or future date 99991231. The date should be in future

triggerSource

object

The condition that triggers the fee.

rule

object

Rule to apply for this fee.

feeBaseCurrencyCode

string

The ISO 4217 currency code for the fee base, minimum and maximun amounts. Values are restricted by institution configuration.

feePercentage

string

Fee percentage to be applied. Valid value as per the Format NNNNNN.NNNN

feeBase

string

Fee base to be applied. Valid value as per the Format NNNNNN.NNNN

feeMinimum

string

Fee minimum to be applied. Valid value as per the Format NNNNNN.NNNN

feeMaximum

string

Fee maximum to be applied. Valid value as per the Format NNNNNN.NNNN

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.

triggerHighValue

string

The trigger high value for fees, for example this need to be set for the minimum processing fee and minimum processing closed-fee.

triggerLowValue

string

The minimum value/volume of the tier level. May be used in conjunction with the trigger source to define the condition that triggers the fee. This is only relevant in certain cases.

triggerVolumeHigh

string

Indicates the upper threshold limit set in terms of volume of transactions that is used as a trigger for fee calculation.

triggerVolumeLow

string

Indicates the lower threshold limit set in terms of volume of transactions that is used as a trigger for fee calculation.

feeType

object

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

rateCategory

object

Indicates the rate category assigned to the merchant account fee that will be used to convert the fee value into merchant funding amount.

feeId

object

The description of the fee that will be posted to the merchant account.

feeLevel

object

The level at which the fee applies to the merchant.

triggerFrequency

object

The frequency at which the fee is applied.

triggerCurrency

object

For which transaction currency the fee is charged.

postToAccount

object

Indicates whether the generated fee should be applied to the merchant account specified in this configuration or not.

lastUpdated

date

Date when the record was last updated. Format YYYYMMDD.

lastUpdatedBy

string

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

204

No register was found

401

Unauthorized request

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://uat-merchant-services.fiservapp.com/boarding-ui/external-api/maintenance/api/v1/omnipay/accountFees/mid?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

404Record does not exist

500Internal Error

502API Error