Get a Merchant Fee By Its ID

Path

GET /v1/clients/{clientId}/merchantfees/{merchantFeeId}

Request Parameters

clientId
required

integer

Your assigned `ClientId`.

merchantFeeId
required

string

The Merchant Fee Id.

Responses

200 OK.

RESPONSE SCHEMA:

id

string

currencyValue

string <double>

taxAmount

string <double>

taxRate

string <double>

taxLabel

array

Array () [
languageCode
required

string

ISO language code

value
required

string

text in language code

]
description

array

Array () [
languageCode
required

string

ISO language code

value
required

string

text in language code

]
validFrom

string

Accepted formats example: 1985-04-12T23:02:50 or 1985-04-12T23:02:50Z or 1985-04-12T23:02:50-04:00

validTo

string

Accepted formats example: 1985-04-12T23:02:50 or 1985-04-12T23:02:50Z or 1985-04-12T23:02:50-04:00

feeType

string

One value must to be assigned [SEGMENT, PENALTY, INVOICE, REMINDER, LOOKUP]

400 Bad request.

RESPONSE SCHEMA:

type
required

string

The type of error that is carried within this response. The value of this type is an URI that can be dereferenced for a human-readable explanation of the error type.

category
required

string

Enum:BUSINESS_ERRORTECHNICAL_ERROR

Category of the error, used primarily to determine whether the same request should be retried or not. Possible values: * `BUSINESS_ERROR` - A business error occured. This request should *not* be retried without modification * `TECHNICAL_ERROR` - A temporary, technical error occurred. the request *should* be retried after a back-off period.

title

string

A short, human-readable summary of the problem.

message

string

A short, human-readable summary of the problem. Identical to `title`.

401 Missing or invalid "Authorization" header.

RESPONSE SCHEMA:

type
required

string

The type of error that is carried within this response. The value of this type is an URI that can be dereferenced for a human-readable explanation of the error type.

category
required

string

Enum:BUSINESS_ERRORTECHNICAL_ERROR

Category of the error, used primarily to determine whether the same request should be retried or not. Possible values: * `BUSINESS_ERROR` - A business error occured. This request should *not* be retried without modification * `TECHNICAL_ERROR` - A temporary, technical error occurred. the request *should* be retried after a back-off period.

title

string

A short, human-readable summary of the problem.

message

string

A short, human-readable summary of the problem. Identical to `title`.

403 Lacking permissions.

RESPONSE SCHEMA:

type
required

string

The type of error that is carried within this response. The value of this type is an URI that can be dereferenced for a human-readable explanation of the error type.

category
required

string

Enum:BUSINESS_ERRORTECHNICAL_ERROR

Category of the error, used primarily to determine whether the same request should be retried or not. Possible values: * `BUSINESS_ERROR` - A business error occured. This request should *not* be retried without modification * `TECHNICAL_ERROR` - A temporary, technical error occurred. the request *should* be retried after a back-off period.

title

string

A short, human-readable summary of the problem.

message

string

A short, human-readable summary of the problem. Identical to `title`.

404 Resource not found.

RESPONSE SCHEMA:

type
required

string

The type of error that is carried within this response. The value of this type is an URI that can be dereferenced for a human-readable explanation of the error type.

category
required

string

Enum:BUSINESS_ERRORTECHNICAL_ERROR

Category of the error, used primarily to determine whether the same request should be retried or not. Possible values: * `BUSINESS_ERROR` - A business error occured. This request should *not* be retried without modification * `TECHNICAL_ERROR` - A temporary, technical error occurred. the request *should* be retried after a back-off period.

title

string

A short, human-readable summary of the problem.

message

string

A short, human-readable summary of the problem. Identical to `title`.

500 Unexpected internal server error.

RESPONSE SCHEMA:

type
required

string

The type of error that is carried within this response. The value of this type is an URI that can be dereferenced for a human-readable explanation of the error type.

category
required

string

Enum:BUSINESS_ERRORTECHNICAL_ERROR

Category of the error, used primarily to determine whether the same request should be retried or not. Possible values: * `BUSINESS_ERROR` - A business error occured. This request should *not* be retried without modification * `TECHNICAL_ERROR` - A temporary, technical error occurred. the request *should* be retried after a back-off period.

title

string

A short, human-readable summary of the problem.

message

string

A short, human-readable summary of the problem. Identical to `title`.

Response Example