Fees

Buy and sell fees.

This API is experimental and not guaranteed to be backward compatible.

Retrieve a list of Fees entries

Retrieve a list of Fees entries.

This operation is experimental and not guaranteed to be backward compatible.

Request
Security:
query Parameters
limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
200A fees list was retrieved successfully.
Response Headers
Pagination-Total
integer

Total items count.

Pagination-Limit
integer

Items per page limit.

Pagination-Offset
integer

Pagination offset.

Response Schema: application/json
Array
id
string <= 50 characters

The fee identifier.

type
required
string
Enum: "buy" "sell"
name
required
string [ 1 .. 255 ] characters

A fee name.

filter
string [ 1 .. 255 ] characters

A filter based on the transaction's properties which is used to determine when to apply the fee.

required
object (FeeFormula)
createdTime
string <date-time>

Fee created time.

updatedTime
string <date-time>

Fee updated time.

Array of SelfLink (object) non-empty

The links related to resource.

401Unauthorized access, invalid credentials was used.
403Access forbidden.
get/fees
Request samples
curl -i -X GET \
  'https://api-sandbox.rebilly.com/fees?limit=1000&offset=0' \
  -H 'Organization-Id: 4f6cf35x-2c4y-483z-a0a9-158621f77a21' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Create a fee entry

Create a fee entry.

This operation is experimental and not guaranteed to be backward compatible.

Request
Security:
header Parameters
Organization-Id
string (ResourceId) <= 50 characters

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Request Body schema: application/json
type
required
string
Enum: "buy" "sell"
name
required
string [ 1 .. 255 ] characters

A fee name.

filter
string [ 1 .. 255 ] characters

A filter based on the transaction's properties which is used to determine when to apply the fee.

required
object (FeeFormula)
Responses
201Fee entry was created successfully.
Response Schema: application/json
id
string <= 50 characters

The fee identifier.

type
required
string
Enum: "buy" "sell"
name
required
string [ 1 .. 255 ] characters

A fee name.

filter
string [ 1 .. 255 ] characters

A filter based on the transaction's properties which is used to determine when to apply the fee.

required
object (FeeFormula)
createdTime
string <date-time>

Fee created time.

updatedTime
string <date-time>

Fee updated time.

Array of SelfLink (object) non-empty

The links related to resource.

401Unauthorized access, invalid credentials was used.
403Access forbidden.
422Invalid data was sent.
post/fees
Request samples
application/json
{
  • "type": "buy",
  • "name": "A gateway fee",
  • "filter": "type:sale,capture;result:approved",
  • "formula": {
    }
}
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "type": "buy",
  • "name": "A gateway fee",
  • "filter": "type:sale,capture;result:approved",
  • "formula": {
    },
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}

Retrieve a fee entry

Retrieve a fee entry.

This operation is experimental and not guaranteed to be backward compatible.

Request
Security:
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
200A fee was retrieved successfully.
Response Schema: application/json
id
string <= 50 characters

The fee identifier.

type
required
string
Enum: "buy" "sell"
name
required
string [ 1 .. 255 ] characters

A fee name.

filter
string [ 1 .. 255 ] characters

A filter based on the transaction's properties which is used to determine when to apply the fee.

required
object (FeeFormula)
createdTime
string <date-time>

Fee created time.

updatedTime
string <date-time>

Fee updated time.

Array of SelfLink (object) non-empty

The links related to resource.

401Unauthorized access, invalid credentials was used.
403Access forbidden.
404Resource was not found.
get/fees/{id}
Request samples
curl -i -X GET \
  https://api-sandbox.rebilly.com/fees/:id \
  -H 'Organization-Id: 4f6cf35x-2c4y-483z-a0a9-158621f77a21' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "type": "buy",
  • "name": "A gateway fee",
  • "filter": "type:sale,capture;result:approved",
  • "formula": {
    },
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}

Upsert a fee entry

Upsert a fee entry.

This operation is experimental and not guaranteed to be backward compatible.

Request
Security:
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Request Body schema: application/json
type
required
string
Enum: "buy" "sell"
name
required
string [ 1 .. 255 ] characters

A fee name.

filter
string [ 1 .. 255 ] characters

A filter based on the transaction's properties which is used to determine when to apply the fee.

required
object (FeeFormula)
Responses
200Fee entry was updated successfully.
Response Schema: application/json
id
string <= 50 characters

The fee identifier.

type
required
string
Enum: "buy" "sell"
name
required
string [ 1 .. 255 ] characters

A fee name.

filter
string [ 1 .. 255 ] characters

A filter based on the transaction's properties which is used to determine when to apply the fee.

required
object (FeeFormula)
createdTime
string <date-time>

Fee created time.

updatedTime
string <date-time>

Fee updated time.

Array of SelfLink (object) non-empty

The links related to resource.

201Fee entry was created successfully.
Response Schema: application/json
id
string <= 50 characters

The fee identifier.

type
required
string
Enum: "buy" "sell"
name
required
string [ 1 .. 255 ] characters

A fee name.

filter
string [ 1 .. 255 ] characters

A filter based on the transaction's properties which is used to determine when to apply the fee.

required
object (FeeFormula)
createdTime
string <date-time>

Fee created time.

updatedTime
string <date-time>

Fee updated time.

Array of SelfLink (object) non-empty

The links related to resource.

401Unauthorized access, invalid credentials was used.
403Access forbidden.
422Invalid data was sent.
put/fees/{id}
Request samples
application/json
{
  • "type": "buy",
  • "name": "A gateway fee",
  • "filter": "type:sale,capture;result:approved",
  • "formula": {
    }
}
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "type": "buy",
  • "name": "A gateway fee",
  • "filter": "type:sale,capture;result:approved",
  • "formula": {
    },
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}

Patch a fee entry

Patch a fee entry.

This operation is experimental and not guaranteed to be backward compatible.

Request
Security:
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Request Body schema: application/json
type
string
Enum: "buy" "sell"
name
string [ 1 .. 255 ] characters

A fee name.

filter
string [ 1 .. 255 ] characters

A filter based on the transaction's properties which is used to determine when to apply the fee.

object (FeeFormula)
Responses
200Fee entry was patched successfully.
Response Schema: application/json
id
string <= 50 characters

The fee identifier.

type
required
string
Enum: "buy" "sell"
name
required
string [ 1 .. 255 ] characters

A fee name.

filter
string [ 1 .. 255 ] characters

A filter based on the transaction's properties which is used to determine when to apply the fee.

required
object (FeeFormula)
createdTime
string <date-time>

Fee created time.

updatedTime
string <date-time>

Fee updated time.

Array of SelfLink (object) non-empty

The links related to resource.

401Unauthorized access, invalid credentials was used.
403Access forbidden.
422Invalid data was sent.
patch/fees/{id}
Request samples
application/json
{
  • "type": "buy",
  • "name": "A gateway fee",
  • "filter": "type:sale,capture;result:approved",
  • "formula": {
    }
}
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "type": "buy",
  • "name": "A gateway fee",
  • "filter": "type:sale,capture;result:approved",
  • "formula": {
    },
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}