Update or create fee settings

curl --request PUT \
  --url https://olive-gateway-a6ba.onrender.com/api/v1/fee-settings \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "party_type": "<string>",
  "transaction_type": "<string>"
}
'

const options = {
  method: 'PUT',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({party_type: '<string>', transaction_type: '<string>'})
};

fetch('https://olive-gateway-a6ba.onrender.com/api/v1/fee-settings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://olive-gateway-a6ba.onrender.com/api/v1/fee-settings"

payload = {
    "party_type": "<string>",
    "transaction_type": "<string>"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

{}

{}

{}

{}

PUT

fee-settings

Update or create fee settings

curl --request PUT \
  --url https://olive-gateway-a6ba.onrender.com/api/v1/fee-settings \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "party_type": "<string>",
  "transaction_type": "<string>"
}
'

const options = {
  method: 'PUT',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({party_type: '<string>', transaction_type: '<string>'})
};

fetch('https://olive-gateway-a6ba.onrender.com/api/v1/fee-settings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://olive-gateway-a6ba.onrender.com/api/v1/fee-settings"

payload = {
    "party_type": "<string>",
    "transaction_type": "<string>"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

{}

{}

{}

{}

Update Fee Setting

Create or update a fee setting. Uses upsert - creates if not exists, updates if exists.

Endpoint

PUT /api/v1/fee-settings

Authentication

string

required

Bearer token (Admin JWT)

Request Body

string

required

Transaction type

string

required

Party type: sender, recipient, agent, processor

string

required

Fee calculation: percentage or flat

number

required

Fee value (percentage 0-100 or flat amount in SLE)

boolean

Apply fee on debit transactions

boolean

Apply fee on credit transactions

Example

curl -X PUT "https://demo.api.vultlocal.com/api/v1/fee-settings" \
  -H "Authorization: Bearer ADMIN_JWT" \
  -H "Content-Type: application/json" \
  -d '{
    "transaction_type": "transfer_p2p",
    "party_type": "sender",
    "fee_type": "percentage",
    "fee_value": 1.5,
    "debit_enabled": true
  }'

{
  "success": true,
  "message": "Fee settings updated successfully",
  "id": 1,
  "transaction_type": "transfer_p2p",
  "party_type": "sender",
  "updated_by": "admin"
}

Validation

Percentage fee cannot exceed 100%
Fee value must be >= 0

Errors

Code	Description
400	Invalid request or percentage exceeds 100%
401	Unauthorized
500	Internal server error

Authorizations

Authorization

string

header

required

API Key for third-party integrations (WhatsApp, Smart PAY, VULT). Format: 'Bearer olive_live_xxxxxxxxxxxxx'

Body

application/json

Fee settings configuration

fee_type

enum<string>

required

Available options:

percentage,

flat

party_type

string

required

transaction_type

string

required

credit_enabled

boolean

debit_enabled

boolean

fee_value

number

Required range: x >= 0

Response

The response is of type object.

Get Fee Setting

Delete Fee Setting

​Update Fee Setting

​Endpoint

​Authentication

​Request Body

​Example

​Validation

​Errors

Authorizations

Body

Response

Update Fee Setting

Endpoint

Authentication

Request Body

Example

Validation

Errors