Skip to content

platform-fees.mdx

Latest commit

 

History

History
121 lines (91 loc) · 3.38 KB

platform-fees.mdx

File metadata and controls

121 lines (91 loc) · 3.38 KB
title Platform Fees
description Configure platform fees with feePercentage and feeAddress

Overview

Platform fees let your product collect an additional fee during payment execution.

To configure a platform fee, pass:

  • feePercentage
  • feeAddress

Use this page for setup and integration patterns. For protocol-level fees charged by Request Network, see Protocol Fees.

Required Parameters

Fee percentage to apply at payment time (for example `"2.5"` for 2.5%). Wallet address that receives the platform fee. `feePercentage` and `feeAddress` must be provided together. If one is missing, validation fails.

Validation Rules

  • feePercentage must be a number between 0 and 100
  • feeAddress must be a valid blockchain address
  • For v2 request payment calls, these are query parameters

Endpoint Usage

Use platform fee parameters on these endpoints:

How to Add Platform Fees

Set the percentage and receiver address used by your platform. Add `feePercentage` and `feeAddress` to the payment endpoint call. The API returns payment payloads that include fee handling. Your app executes the returned transactions as usual.

Integration Examples

Request-based payment

curl -X GET 'https://api.request.network/v2/request/{requestId}/pay?feePercentage=2.5&feeAddress=0x742d35CC6634c0532925a3B844BC9e7595f8fA40' \
  -H 'x-api-key: YOUR_API_KEY'

Direct payout

curl -X POST 'https://api.request.network/v2/payouts' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "payee": "0x6923831ACf5c327260D7ac7C9DfF5b1c3cB3C7D7",
    "amount": "100",
    "invoiceCurrency": "USD",
    "paymentCurrency": "USDC-base",
    "feePercentage": "2.5",
    "feeAddress": "0x742d35CC6634c0532925a3B844BC9e7595f8fA40"
  }'

Batch payout

curl -X POST 'https://api.request.network/v2/payouts/batch' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "payer": "0x2e2E5C79F571ef1658d4C2d3684a1FE97DD30570",
    "feePercentage": "2.5",
    "feeAddress": "0x742d35CC6634c0532925a3B844BC9e7595f8fA40",
    "requests": [
      {
        "payee": "0x6923831ACf5c327260D7ac7C9DfF5b1c3cB3C7D7",
        "amount": "10",
        "invoiceCurrency": "USD",
        "paymentCurrency": "USDC-base"
      }
    ]
  }'

Related Pages

Understand Request Network protocol-level fees. Inspect fee line items returned by API responses.

API Reference

For full schemas and examples, see Request Network API Reference.