logo

Patch a fee entry

Patches a fee entry.

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

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

ID of the resource.

Request Body schema: application/json
type
string

Type of fee.

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

Name of the fee.

filter
string [ 1 .. 255 ] characters

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

object (FeeFormula)

Formula that is used to calculate the fee.

type
required
string

Type of fee.

currency
required
string (CurrencyCode) = 3 characters

Currency code in ISO 4217 format.

amount
required
number <double>

Amount of the fee.

Responses
200

Fee entry patched.

Response Schema: application/json
type
required
string

Type of fee.

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

Name of the fee.

required
object (FeeFormula)

Formula that is used to calculate the fee.

type
required
string

Type of fee.

currency
required
string (CurrencyCode) = 3 characters

Currency code in ISO 4217 format.

amount
required
number <double>

Amount of the fee.

id
string <= 50 characters

ID of the fee.

filter
string [ 1 .. 255 ] characters

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

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

Array of objects (SelfLink)

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

422

Invalid data sent.

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

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

Stripe transaction fees. 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",
  • "_links": []
}
➔ Next to Files