v1

latestOpenAPI 3.1.02026-07-1325128129.5 KB
fees

Claim Fees

Claim accrued fees for the authenticated organization

post/fees/claim

Headers

Authorization-Signaturestring required

Authorization header format: 'APIKey=<api_key>,signature=<signature>,timestamp=<unix_timestamp>'

Request body

recipientstring required

Example request

{
  "currency": {
    "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
    "chain_id": 30000000000001
  },
  "metadata": {
    "items": [
      {
        "currency": "USD",
        "description": "High-quality widget with extra features",
        "image": "https://example.com/images/widget.png",
        "name": "Premium Widget",
        "quantity": 2,
        "unit_price": 49.99
      }
    ],
    "refund": {
      "additional_info": "Item was never shipped",
      "currency": "USD",
      "name": "Order Cancellation",
      "reason": "Customer requested refund",
      "refund_amount": 99.98
    }
  },
  "recipient": "0x1234...abcd"
}

Response

Fees claimed successfully

OR

Example response

{
  "claim_order_id": "cuidjkhg3e289y74u5t6v",
  "currency": {
    "raw_amount": "2400000",
    "ui_amount": 2.4,
    "ui_amount_display": "2.4",
    "value_usd": 123.45
  },
  "source_chain_id": 1,
  "source_transaction_hash": "0x1234...abcd",
  "transaction_hash": "0x1234...abcd"
}