Set Merchant Fees

PUT

/api/admin/merchants/{id}/fees

curl --request PUT \
  --url https://example.com/api/admin/merchants/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/fees \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "merchantId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "mode": "Inclusive", "card": { "percentageRate": 1, "fixedFee": 1, "minFee": 1, "maxFee": 1 }, "bank": { "percentageRate": 1, "fixedFee": 1, "minFee": 1, "maxFee": 1 } }'

Set a merchant’s fee mode and card/bank fee structures. A null rail clears that setting.

Authorizations

• Bearer

Parameters

Path Parameters

id

required

string format: uuid

Request Body

object

merchantId

string format: uuid

mode

string

Allowed values: Inclusive Exclusive

card

object

percentageRate

number format: double

<= 100

fixedFee

number format: double

<= 1000000

minFee

number format: double

nullable <= 1000000

maxFee

number format: double

nullable <= 1000000

bank

object

percentageRate

number format: double

<= 100

fixedFee

number format: double

<= 1000000

minFee

number format: double

nullable <= 1000000

maxFee

number format: double

nullable <= 1000000

object

merchantId

string format: uuid

mode

string

Allowed values: Inclusive Exclusive

card

object

percentageRate

number format: double

<= 100

fixedFee

number format: double

<= 1000000

minFee

number format: double

nullable <= 1000000

maxFee

number format: double

nullable <= 1000000

bank

object

percentageRate

number format: double

<= 100

fixedFee

number format: double

<= 1000000

minFee

number format: double

nullable <= 1000000

maxFee

number format: double

nullable <= 1000000

object

merchantId

string format: uuid

mode

string

Allowed values: Inclusive Exclusive

card

object

percentageRate

number format: double

<= 100

fixedFee

number format: double

<= 1000000

minFee

number format: double

nullable <= 1000000

maxFee

number format: double

nullable <= 1000000

bank

object

percentageRate

number format: double

<= 100

fixedFee

number format: double

<= 1000000

minFee

number format: double

nullable <= 1000000

maxFee

number format: double

nullable <= 1000000

Responses

200

OK

Media type application/json

object

mode

string

Allowed values: Inclusive Exclusive

card

object

percentageRate

number format: double

fixedFee

number format: double

minFee

number format: double

nullable

maxFee

number format: double

nullable

bank

object

percentageRate

number format: double

fixedFee

number format: double

minFee

number format: double

nullable

maxFee

number format: double

nullable

Example

{
  "mode": "Inclusive"
}

400

Bad Request

Media type application/json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Not Found

Media type application/json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}