HEhellozai
Fees

Create fee

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.

post/fees

Request

  • Base URL
    https://test.api.promisepay.com
  • URL
    https://test.api.promisepay.com/fees
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://au-0000.sandbox.auth.assemblypay.com/tokens

Request body

namestring required

Name

fee_type_id'1' | '2' | '3' | '4' required

Fee type:

  1. Fixed
  2. Percentage
  3. Percentage with Cap
  4. Percentage with Min
amountinteger required

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.)

capstring

Cap the Fee

mininteger

Minimum Fee

maxinteger

Maximum Fee

to'buyer' | 'seller' | 'cc' | 'int_wire'

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)

Example request

{
  "name": "Seller Success Fee",
  "fee_type_id": "2",
  "amount": 200,
  "to": "seller"
}

Response

OK

Example response

{
  "fees": {
    "id": "36020976-f345-4d0f-b860-9c025ccce668",
    "name": "Seller Success Fee",
    "to": "seller",
    "calculated_fee": 400
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.