Fees

Use fees to reconcile transactions with applicable fees and discount rates. Fees are not applied directly to transaction amounts, they do not modify the transaction amount. Fees help to describe each part of the transaction amount.

Important: These operations are experimental and may change.

Operations

Retrieve fee entries
Experimental

Request

Retrieves a list of fee entries.

Important: This operation is experimental and may not be backward compatible.

Security
SecretApiKey or JWT
Query
limitinteger, [ 0 .. 1000 ]

Limit the number of collection items to be returned. Use 0 to return an empty collection and still receive the count of matching items in Pagination-Total.

offsetinteger, [ 0 .. 1000 ]

Specifies the starting point within the collection of items to be returned.

filterstring

Criteria for filtering collection items. This field requires a special format. Use , to specify multiple allowed values. Use ; to specify multiple fields.

For more information, see Search filters.

sortArray of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -. Multiple fields can be sorted by separating each with ,.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/fees?limit=0&offset=0&filter=string&sort=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

List of fee entries retrieved.

Headers
Pagination-Totalinteger

Total number of items that match the request. The value is independent of limit, including when limit is 0.

Example:332
Pagination-Limitinteger

Maximum number of items per page.

Example:100
Pagination-Offsetinteger

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example:2
Bodyapplication/json
Array [
idstring, <= 50 charactersread-only

ID of the fee.

Example:"fee_01GQT145JX3XBRJ8K812Y3GRE9"
typestringrequired

Type of fee.

Enum:"buy""sell"
namestring, [ 1 .. 255 ] charactersrequired

Name of the fee.

Example:"A gateway fee"
filterstring or null, [ 1 .. 255 ] characters

Filter that is based on the properties of the transaction and used to determine when to apply the fee.

Example:"type:sale,capture;result:approved"
formulaobject(FeeFormula)required
settlementSettingsSettlementSettings (object) or null
One of:

Settlement settings. Use these settings to set up settlement accounts.

createdTimestring, (date-time)(CreatedTime)read-only

Date and time when the resource is created. This value is set automatically when the resource is created.

updatedTimestring, (date-time)(UpdatedTime)read-only

Date and time when the resource is updated. This value is set automatically when the resource is updated.

]
Response
[
  {
    "id": "fee_01GQT145JX3XBRJ8K812Y3GRE9",
    "type": "buy",
    "name": "A gateway fee",
    "filter": "type:sale,capture;result:approved",
    "formula": { … },
    "settlementSettings": { … },
    "createdTime": "2019-08-24T14:15:22Z",
    "updatedTime": "2019-08-24T14:15:22Z",
    "_links": [ … ]
  }
]