Patch a fee entry

Patch a fee entry.

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

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

The resource identifier string.

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)
type
required
string
currency
required
string (CurrencyCode) = 3 characters

ISO 4217 alphabetic currency code.

amount
required
number <double>
Responses
200

Fee entry was patched successfully.

Response Schema: application/json
type
required
string
Enum: "buy" "sell"
name
required
string [ 1 .. 255 ] characters

A fee name.

required
object (FeeFormula)
type
required
string
currency
required
string (CurrencyCode) = 3 characters

ISO 4217 alphabetic currency code.

amount
required
number <double>
id
string <= 50 characters

The fee identifier.

filter
string [ 1 .. 255 ] characters

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

createdTime
string <date-time>

Fee created time.

updatedTime
string <date-time> (UpdatedTime)

Read-only timestamp updates when the resource is updated.

Array of Self (object) non-empty

The links related to resource.

Array (non-empty)
Any of:
href
required
string

The link URL.

rel
required
string

The link type.

Value: "self"
401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

422

Invalid data was sent.

patch/fees/{id}
Request samples
application/json

The transaction fees for Stripe. Discount rate fees are a separate record.

{
  • "type": "buy",
  • "name": "Stripe transaction fees",
  • "filter": "type:sale,capture;result:approved;gatewayAccountId:stripe",
  • "formula": {
    }
}
Response samples
application/json

The transaction fees for Stripe. Discount rate fees are a separate record.

{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "type": "buy",
  • "name": "Stripe transaction fees",
  • "filter": "type:sale,capture;result:approved;gatewayAccountId:stripe",
  • "formula": {
    },
  • "createdTime": "2021-12-15T14:15:22Z",
  • "updatedTime": "2021-12-15T14:15:22Z",
}