Partner fees
Add your own fee to a quote and receive it in your wallet when the order settles.
You can add your own fee to a quote. Pulse builds it into the rate and pays it to your wallet when the order settles.
Set your fee wallets
You must set your wallets before you add a fee. A team admin sets one payout wallet
for each network under Fees in the dashboard. Without wallets, a quote with a fee
returns partner_fee_wallet_missing.
Wallet changes after your first save go live after 24 hours.
Add a fee to a quote
Set partner_fee.bps on the quote in basis points. 100 bps is 1%.
curl https://engine-api.pilot.pulseshiga.io/v1/quotes \
-H "X-API-Key: <your key>" \
-H "Content-Type: application/json" \
-d '{
"source_currency": "NGN",
"destination_currency": "USDT",
"network": "POLYGON",
"source_amount": "150000",
"partner_fee": { "bps": 20 }
}'- Cap: 300 bps (3%) by default. A higher value returns
partner_fee_exceeds_cap. - Amount: an estimate. The fee paid comes from the executed order. It can be lower if the market moves before an offramp settles.
- Refresh: a refreshed quote keeps the fee.
Payout
Pulse pays the fee on every order, in the transfer that settles it. An offramp fee is paid in the stablecoin that the order settles in. That stablecoin can differ from the quote.
See the fee paid
An order from a quote with a fee returns partner_fee on
GET /v1/orders/{id}. It has only bps until Pulse pays the
fee. After the payout, it shows the fee paid:
"partner_fee": {
"bps": 20,
"amount": "0.19461",
"currency": "USDT",
"network": "POLYGON",
"transaction_hash": "0x5c50…"
}The order list does not return partner_fee.