Skip to main content

Create a Fee

You should call the Create fees endpoint to create a fee:

Sample Request
curl https://api.allawee.com/fees
-H "Authorization: Bearer YOUR_SECRET_KEY"
-H "Content-Type: application/json"
-d '{
"name": "string",
"description": "string",
"structure": "flat",
"currency": "NGN",
"value": 500,
"cap": 10000,
"account": "ac.2cbc123456",
"metadata": {
"key": "value"
}
}'
-X POST
Request Body ParametersRequired?Description
nameYesA name for the fee to identify it.
descriptionNoA description of the fee.
structureYes`flat` or `percentage`, which determines whether it is a flat fee or a percentage fee.
currencyNoThe currency for the fee.
valueYesThe percentage if the selected structure is a percentage fee and the fee in the smallest unit of the currency if it is a flat fee.
capNoAn optional limit on the fee if it is a percentage fee.
accountYesThe account the fee should be paid into.
metadataNoAny other information you wish to associate with the fee.