Skip to main content
POST
/
fee
Set fee
curl --request POST \
  --url https://processor-prod.up.railway.app/fee \
  --header 'Content-Type: application/json' \
  --header 'x-service-key: <api-key>' \
  --data '
{
  "type": "percentage",
  "value": 0.5,
  "cap": 500,
  "min": 0.05
}
'
{
  "success": true,
  "status": 200,
  "message": "Fee set successfully",
  "timestamp": "2025-09-28T16:49:11.472Z",
  "data": {
    "type": "percentage",
    "value": 0.5,
    "max": 500,
    "min": 0.05
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.bread.africa/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-service-key
string
header
required

Body

application/json
​
type
enum<string>
required

Fee type - percentage or fixed amount

Available options:
percentage,
fixed
Example:

"percentage"

​
value
number
required

Fee value. For percentage: 0-50%, for fixed: 0-5000

Example:

0.5

​
cap
number

Maximum fee cap (optional)

Required range: 0 <= x <= 5000
Example:

500

​
min
number

Minimum fee amount (optional)

Required range: 0 <= x <= 5000
Example:

0.05

Response

200 - application/json

Fee set successfully

​
success
boolean
Example:

true

​
status
integer
Example:

200

​
message
string
Example:

"Fee set successfully"

​
timestamp
string<date-time>
Example:

"2025-09-28T16:49:11.472Z"

​
data
object