Iron API - Sandbox
curl --request GET \
--url https://api.sandbox.iron.xyz/api/fee-profiles \
--header 'X-API-Key: <api-key>' \
--header 'X-SUB-PARTNER-ID: <x-sub-partner-id>'{
"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",
"min_fee": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
},
"name": "<string>",
"network_fee_enabled": true,
"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"
}
],
"cursor": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prev_cursor": null
}Get Fee Profile of Partner
Gets fee profile of partner
curl --request GET \
--url https://api.sandbox.iron.xyz/api/fee-profiles \
--header 'X-API-Key: <api-key>' \
--header 'X-SUB-PARTNER-ID: <x-sub-partner-id>'{
"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",
"min_fee": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
},
"name": "<string>",
"network_fee_enabled": true,
"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"
}
],
"cursor": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prev_cursor": null
}Authorizations
API Key
Headers
Optional sub-partner UUID, if provided, the fee profiles will be filtered for the sub-partner
Response
GET ALL Fee Profiles Succeeded
PagedList
A list of items with cursors used to fetch the next or previous page
The list of items
Show child attributes
Show child attributes
The banking fee configs for the fee profile
Show child attributes
Show child attributes
Billing Type
The type of billing for the partner fee
One Time, Monthly, Quarterly, Annual, Semi Annual, Per Transaction An amount of money
Show child attributes
Show child attributes
The amount, a decimal number
Currency
Can be either crypto or fiat
- Crypto
- Fiat
Show child attributes
Show child attributes
Crypto "Crypto"
Blockchain
A type of blockchain
Solana, Ethereum, Polygon, Arbitrum, Base, Stellar The ticker of the token e.g. 'USDC'
{ "blockchain": "Solana", "token": "USDC" }{
"amount": "100.5",
"currency": { "code": "USD", "type": "Fiat" }
}Fiat Transfer
The type of fiat transfer
PayIn, PayOut PaymentNetwork
A payment network
Sepa, Swift, Fps, Chats, Ach, Wire, Rtp, Pix, Spei, AfricanBankTransfer, MobileMoney, Chaps Fee Settlement
The settlement type for the fee
deductedImmediately, settledLater The id of the fee profile
Billing Type
The type of billing for the partner fee
One Time, Monthly, Quarterly, Annual, Semi Annual, Per Transaction Fee Settlement
The settlement type for the fee
deductedImmediately, settledLater An amount of money
Show child attributes
Show child attributes
The amount, a decimal number
Currency
Can be either crypto or fiat
- Crypto
- Fiat
Show child attributes
Show child attributes
Crypto "Crypto"
Blockchain
A type of blockchain
Solana, Ethereum, Polygon, Arbitrum, Base, Stellar The ticker of the token e.g. 'USDC'
{ "blockchain": "Solana", "token": "USDC" }{
"amount": "100.5",
"currency": { "code": "USD", "type": "Fiat" }
}The name of the fee profile
The network fee enabled flag
The non-transactional partner fees for the fee profile
Show child attributes
Show child attributes
Billing Type
The type of billing for the partner fee
One Time, Monthly, Quarterly, Annual, Semi Annual, Per Transaction Partner Fixed Fee
A fixed fee for a partner
- PartnerFixedFee
- PartnerBipsFee
Show child attributes
Show child attributes
Fixed "Fixed"
An amount of money
Show child attributes
Show child attributes
The amount, a decimal number
Currency
Can be either crypto or fiat
- Crypto
- Fiat
Show child attributes
Show child attributes
Crypto "Crypto"
Blockchain
A type of blockchain
Solana, Ethereum, Polygon, Arbitrum, Base, Stellar The ticker of the token e.g. 'USDC'
{ "blockchain": "Solana", "token": "USDC" }{
"amount": "100.5",
"currency": { "code": "USD", "type": "Fiat" }
}maintenance, account_setup, onboarding, partner, customer, banking, surcharge Fee Settlement
The settlement type for the fee
deductedImmediately, settledLater The additional partner fees for the fee profile
Show child attributes
Show child attributes
Billing Type
The type of billing for the partner fee
One Time, Monthly, Quarterly, Annual, Semi Annual, Per Transaction Partner Fixed Fee
A fixed fee for a partner
- PartnerFixedFee
- PartnerBipsFee
Show child attributes
Show child attributes
Fixed "Fixed"
An amount of money
Show child attributes
Show child attributes
The amount, a decimal number
Currency
Can be either crypto or fiat
- Crypto
- Fiat
Show child attributes
Show child attributes
Crypto "Crypto"
Blockchain
A type of blockchain
Solana, Ethereum, Polygon, Arbitrum, Base, Stellar The ticker of the token e.g. 'USDC'
{ "blockchain": "Solana", "token": "USDC" }{
"amount": "100.5",
"currency": { "code": "USD", "type": "Fiat" }
}maintenance, account_setup, onboarding, partner, customer, banking, surcharge Fee Settlement
The settlement type for the fee
deductedImmediately, settledLater The Id of the partner
The cursor used to fetch the next page
The cursor used to fetch the previous page