Skip to main content
GET
/
fee-profiles
Get Fee Profile of Partner
curl --request GET \
  --url https://api.sandbox.iron.xyz/api/fee-profiles \
  --header 'X-API-Key: <api-key>'
{
  "items": [
    {
      "banking_fee_configs": [
        {
          "billing_type": "One Time",
          "fee_amount": {
            "amount": "100.5",
            "currency": {
              "code": "USD",
              "type": "Fiat"
            }
          },
          "fiat_transfer_type": "PayIn",
          "rail": "Sepa",
          "settlement": "deductedImmediately"
        }
      ],
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "iron_fee": {
        "type": "Bips",
        "bips": 123
      },
      "iron_fee_billing_type": "One Time",
      "iron_fee_settlement": "deductedImmediately",
      "is_default": true,
      "min_fee": {
        "amount": "100.5",
        "currency": {
          "code": "USD",
          "type": "Fiat"
        }
      },
      "name": "<string>",
      "network_fee_enabled": true,
      "network_fee_settlement": "deductedImmediately",
      "non_transactional_partner_fee_configs": [
        {
          "billing_type": "One Time",
          "fee_type": {
            "type": "Fixed",
            "fixed_fee": {
              "amount": "100.5",
              "currency": {
                "code": "USD",
                "type": "Fiat"
              }
            }
          },
          "label": "maintenance",
          "settlement": "deductedImmediately"
        }
      ],
      "partner_fee_configs": [
        {
          "billing_type": "One Time",
          "fee_type": {
            "type": "Fixed",
            "fixed_fee": {
              "amount": "100.5",
              "currency": {
                "code": "USD",
                "type": "Fiat"
              }
            }
          },
          "label": "maintenance",
          "settlement": "deductedImmediately"
        }
      ],
      "partner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "profile_type": "Invoicing"
    }
  ],
  "cursor": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "prev_cursor": null
}

Authorizations

​
X-API-Key
string
header
required

API Key

Headers

​
X-SUB-PARTNER-ID
string

Optional sub-partner UUID, if provided, the fee profiles will be filtered for the sub-partner

Query Parameters

​
fee_profile_ids
string<uuid>[]

Ids of the fee profiles to get. Will be ignored if is_default is set to true.

​
is_default
boolean

parameter to get the default fee profile. If set to true, only the default fee profile will be returned.

Response

GET Fee Profiles Succeeded

PagedList

A list of items with cursors used to fetch the next or previous page

​
items
FeeProfile · object[]
required

The list of items

​
cursor
string<uuid>

The cursor used to fetch the next page

​
prev_cursor
string<uuid>

The cursor used to fetch the previous page