Fees

Get Fee Balances

get

Retrieve the claimable fee balances for the authenticated organization

Authorizations

Authorization

Header parameters

Authorization-SignaturestringRequired

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

Responses

200

Fee balances retrieved successfully

application/json

fiatstringRequiredExample: USD

amount_centsinteger · int64RequiredExample: 150

401

Unauthorized - Authentication required

application/json

500

Internal Server Error

application/json

get

/fees/balance

HTTPcURLJavaScriptPython

GET /v2/fees/balance HTTP/1.1
Authorization-Signature: text
Accept: */*

{
  "amount_cents": 150,
  "fiat": "USD"
}

Claim Fees

post

Claim accrued fees for the authenticated organization

Authorizations

Authorization

Header parameters

Authorization-SignaturestringRequired

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

Body

application/json

recipientstringRequiredExample: 0x1234...abcd

metadataany ofOptional

or

nullOptional

Responses

200

Fees claimed successfully

application/json

claim_order_idstringRequiredExample: cuidjkhg3e289y74u5t6v

source_transaction_hashstringRequiredExample: 0x1234...abcd

transaction_hashstringRequiredDeprecated

Use 'source_transaction_hash' instead

Example: 0x1234...abcd

source_chain_idinteger · int64RequiredExample: 1

400

Bad Request - Invalid request body

application/json

401

Unauthorized - Authentication required

application/json

422

Unprocessable Entity - Invalid request body format

application/json

500

Internal Server Error

application/json

501

Not Implemented - Fee claiming not yet available

application/json

post

/fees/claim

HTTPcURLJavaScriptPython

POST /v2/fees/claim HTTP/1.1
Authorization-Signature: text
Content-Type: application/json
Accept: */*
Content-Length: 296

{
  "currency": {
    "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
    "chain_id": 30000000000001
  },
  "metadata": {
    "refund": {
      "additional_info": "Item was never shipped",
      "currency": "USD",
      "name": "Order Cancellation",
      "reason": "Customer requested refund",
      "refund_amount": 99.98
    }
  },
  "recipient": "0x1234...abcd"
}

{
  "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"
}