Skip to main content
POST
/
fees
/
claim
Claim Fees
curl --request POST \
  --url https://api.coinvoyage.io/v2/fees/claim \
  --header 'Authorization-Signature: <authorization-signature>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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"
}
'
{
  "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"
}

Headers

​
Authorization-Signature
string
required

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

Body

application/json
​
currency
object
required
Example:
{
  "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
  "chain_id": 30000000000001
}
​
recipient
string
required
Example:

"0x1234...abcd"

​
metadata
object
Example:
{
  "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
  }
}

Response

Fees claimed successfully

​
claim_order_id
string
required
Example:

"cuidjkhg3e289y74u5t6v"

​
source_transaction_hash
string
required
Example:

"0x1234...abcd"

​
transaction_hash
string
required
deprecated

Use 'source_transaction_hash' instead

Example:

"0x1234...abcd"

​
source_chain_id
enum<integer>
required
Available options:
1,
10,
56,
137,
8453,
42161,
20000000000001,
30000000000001,
30000000000002
Example:

1

​
currency
object
required
Example:
{
  "raw_amount": "2400000",
  "ui_amount": 2.4,
  "ui_amount_display": "2.4",
  "value_usd": 123.45
}