v2

OpenAPI 3.1.02026-07-3139137119.0 KB
fees

Claim Fees

post/fees/claim

Headers

Authorization-Signaturestring required

HMAC-SHA256 signature header: 'APIKey=<api_key>,signature=<hex>,timestamp=<unix_timestamp>'. The signature is computed over METHOD + path (with the /v3 prefix stripped) + 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 (or a no-claimable-fees message)

claim_order_idstring required
source_transaction_hashstring required
source_chain_id1 | 10 | 56 | 137 | 4663 | 8453 | 42161 | 20000000000001 | 30000000000001 | 30000000000002 required

Example response

{
  "claim_order_id": "cuidjkhg3e289y74u5t6v",
  "currency": {
    "raw": "100000000",
    "ui": "100.0",
    "value_usd": 100
  },
  "source_chain_id": 1,
  "source_transaction_hash": "0x1234...abcd"
}