Skip to main content
POST
/
fee-profiles
Create Fee Profile
curl --request POST \
  --url https://api.sandbox.iron.xyz/api/fee-profiles \
  --header 'Content-Type: application/json; charset=utf-8' \
  --header 'IDEMPOTENCY-KEY: <idempotency-key>' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "banking_fee_configs": [
    {
      "fee_amount": "<string>"
    }
  ],
  "name": "<string>",
  "transaction_fee_bips": 123
}
'
{
  "banking_fee_configs": [
    {
      "fee_amount": {
        "amount": "100.5",
        "currency": {
          "code": "USD",
          "type": "Fiat"
        }
      }
    }
  ],
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "iron_fee": {
    "type": "Bips",
    "bips": 123
  },
  "is_default": true,
  "min_fee": {
    "amount": "100.5",
    "currency": {
      "code": "USD",
      "type": "Fiat"
    }
  },
  "name": "<string>",
  "network_fee_enabled": true,
  "non_transactional_partner_fee_configs": [
    {
      "fee_type": {
        "type": "Fixed",
        "fixed_fee": {
          "amount": "100.5",
          "currency": {
            "code": "USD",
            "type": "Fiat"
          }
        }
      }
    }
  ],
  "partner_fee_configs": [
    {
      "fee_type": {
        "type": "Fixed",
        "fixed_fee": {
          "amount": "100.5",
          "currency": {
            "code": "USD",
            "type": "Fiat"
          }
        }
      }
    }
  ],
  "partner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "rule": {
    "currency_pairs": [
      {
        "from_currency": {
          "blockchain": "Solana",
          "token": "USDC"
        },
        "to_currency": {
          "blockchain": "Solana",
          "token": "USDC"
        }
      }
    ],
    "customer_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "ramp_kinds": []
  }
}

Authorizations

​
X-API-Key
string
header
required

API Key

Headers

​
IDEMPOTENCY-KEY
string
required

Unique key to ensure idempotent creation

Body

application/json; charset=utf-8

Create Partner Fee Profile Request

Parameters for creating a new transactional fee profile as a partner. Iron fee settings (including whether the on-chain network fee is enabled) are inherited from the partner's invoicing fee profile.

​
banking_fee_configs
BankingFeeConfiguration · object[]
required

Banking fee configurations. Each entry's fee currency is constrained by its rail to avoid FX exposure: SEPA→EUR, FPS/CHAPS→GBP, PIX→BRL, SPEI→MXN, all other rails (ACH, WIRE, RTP, SWIFT, CHATS, AFRICAN_BANK_TRANSFER, MOBILE_MONEY)→USD.

​
name
string
required

The name of the fee profile

​
network_fee_settlement
enum<string>
required

Fee Settlement

The settlement type for the fee

Available options:
deductedImmediately,
settledLater
​
transaction_fee_bips
integer<uint32>
required

Transaction fee in basis points (bps). 100 bps = 1%.

Response

Create fee profile successful

Fee Profile

A fee profile

A Fee Profile

​
banking_fee_configs
BankingFeeConfig · object[]
required

The banking fee configs for the fee profile

​
id
string<uuid>
required

The id of the fee profile

​
iron_fee
BipsFeeRequest · object
required

Fee Schedule

The Schedule of Fees associated with a Partner

​
iron_fee_billing_type
enum<string>
required

Billing Type

The type of billing for the partner fee

Available options:
One Time,
Monthly,
Quarterly,
Annual,
Semi Annual,
Per Transaction
​
iron_fee_settlement
enum<string>
required

Fee Settlement

The settlement type for the fee

Available options:
deductedImmediately,
settledLater
​
is_default
boolean
required

Is default

​
min_fee
Amount · object
required

An amount of money

Example:
{
  "amount": "100.5",
  "currency": { "code": "USD", "type": "Fiat" }
}
​
name
string
required

The name of the fee profile

​
network_fee_enabled
boolean
required

The network fee enabled flag

​
network_fee_settlement
enum<string>
required

Fee Settlement

The settlement type for the fee

Available options:
deductedImmediately,
settledLater
​
non_transactional_partner_fee_configs
NonTransactionalPartnerFeeConfig · object[]
required

The non-transactional partner fees for the fee profile

​
partner_fee_configs
PartnerFeeConfig · object[]
required

The additional partner fees for the fee profile

​
partner_id
string<uuid>
required

The Id of the partner

​
profile_type
enum<string>
required

Fee Profile Type

The type of fee profile

Available options:
Invoicing,
Transactional
​
rule
FeeProfileRule · object

Fee Profile Rule

A rule for a fee profile which limits the fee profile to be used for certain customers, ramp kinds, and currency pairs.