Sign in

v1

latestOpenAPI 3.0.12026-07-242871595.3 MB
INVENTORY

Get all configured service charges for a merchant

Retrieves all service charges created for a merchant.

get/v3/merchants/{mId}/order_fees

Path parameters

mIdstring required

Merchant identifier.

Query parameters

filterstring

Filter fields to display search results: [modifiedTime, amount, serviceChargeUuid, type, percentage, name, createdTime, id, deletedTime]

Headers

User-Agentstring required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <AppName>/<Version> <Comment>

Response

Successful response. Service charges are displayed for a merchant.

idstring

Service charge identifer.

namestring required

Name of the service charge.

amountinteger

Fixed order fee. Format: Cents

percentageinteger

For percentage based order fee, percent to charge times 10000, e.g. 12.5% will be 125000.

createdTimeinteger

Time when the order fee was created on the server.

modifiedTimeinteger

Time when the order fee was modified on the serve.

deletedTimeinteger

Time when the order fee was deleted on the server.

typestring

Applicable order fee type for an order.

serviceChargeUuidstring

Unique universal service charge (UUID) identifier.