Apply Fee

post

https://devapi.qolopay.com/api/{version}/fees/apply

Apply a fee to the source with the proceeds going into the revenue account

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

version

string

required

Body Params

request_code

string

required

length ≥ 1

The Fee request code.

amount

double

required

Fee amount to be charged for the source account

currency

string

required

length between 3 and 3

Three letter currency code of the fee

description

string | null

Optional - API Partner can send the transfer's description for reference

client_reference_id

string

required

length ≥ 1

API Partner can send the transfer's unique id on their system and it can be used to fetch transfer details later

source

object

required

revenue_account_guid

uuid | null

Optional - API Partner provided revenue account, must belong to same program

allow_partial

boolean | null

Defaults to True – When set to True, a partial fee amount can be debited from the account. When set to False, the entire fee amount will be debited, potentially resulting in a negative account balance

txn_guid

uuid

If applying a fee to a financial transaction this input is required.

memo_code

string | null

Client driven code used to add more details to the transfer type.

Responses

500

Server Error

201Returns newly created fee details

400Bad request

401Unauthorized

404Card not found