Create fee

post

https://test.api.promisepay.com/fees

Create a Fee to be associated with an Item. Fees will add or subtract from the Item amount based on the User, payment type or Disbursement account type. Fees can be Fixed or Percentage based. Fees can be capped, have a maximum amount and/or a minimum amount.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

name

string

required

Defaults to Seller Success Fee

Name

fee_type_id

string

enum

required

Defaults to 2

Fee type:

Fixed
Percentage
Percentage with Cap
Percentage with Min

Allowed:

amount

integer

required

Defaults to 200

Amount in cents; if the fee type is percentage, then this shows the percentage in hundredths (For example, an amount of 5 refers to 0.05% in fees.)

cap

string

Cap the Fee

min

integer

Minimum Fee

max

integer

Maximum Fee

string

enum

Who pays the Fee. Allowed values are (buyer or seller). If this field has a value of buyer, then the buyer will have to pay the fee on top of the actual payment (example for an item of 100 and a fee of 2, then the buyer would have to pay 102) If this field has a value of seller, then the seller will end up receiving the amount - the fee (example for an item of 100 and a fee of 2, then the seller would end up receiving 98)

Allowed:

Response

Language

Credentials

OAuth2

URL

Loading…

Response

Choose an example:

application/json

201OK