1. Balances & History
Partner API
  • Getting Started
    • Introduction
    • Authentication
    • Business Use Cases
  • API References
    • Balances & History
      • Get Balances
        GET
      • Get Balance History
        GET
    • Crypto Deposits
      • Get Crypto Deposit Details
      • Update Travel Rule
    • Crypto Withdrawals
      • Add Whitelisted Wallet
      • Get Whitelisted Wallets
      • Delete Whitelisted Wallet
      • Create Crypto Withdrawal
      • Get Crypto Withdrawal Details
    • SEPA Deposits
      • Get SEPA Payment Details
      • Get SEPA Deposit Details
    • SEPA Withdrawals
      • Create SEPA Withdrawal
      • Get SEPA Withdrawal Details
    • Currency Exchange
      • Get Rates
      • Create Lock
      • Create Exchange
      • Get Exchange Details
  • Integration
    • Integration Guides
    • Transaction Processing
    • Error Handling
    • Rate Limiting
    • Webhooks
      • Crypto Deposit Webhook
      • Crypto Withdrawal Webhook
      • SEPA Deposit Webhook
      • SEPA Withdrawal Webhook
      • Exchange Webhook
  • Reference
    • Supported Currencies
    • Fees
    • FAQ
    • Changelog
    • Support
  1. Balances & History

Get Balances

Testing Env
http://k8s-partnera-partnera-7873f15634-69ebb7c047cac3d1.elb.eu-central-1.amazonaws.com
Testing Env
http://k8s-partnera-partnera-7873f15634-69ebb7c047cac3d1.elb.eu-central-1.amazonaws.com
GET
/v1/partner/balances
Returns all balances of the Partner account - fiat and crypto - together with deposit, withdrawal and exchange parameters for each balance.
Each balance has its own id (balanceId), used in other endpoints (e.g. Get Balance History). Each crypto balance is held on a single network. For the list of available currencies and networks, see Supported Currencies.

Amounts#

All amounts and rates are returned as strings, without trailing zeros. Amounts sent in requests (e.g. withdrawals, exchanges) must not exceed the precision of the currency.

Rates#

rate is indicative and intended for displaying portfolio value. Exchanges are executed at the rate returned by Create Lock - see also Get Rates.

Deposits#

Crypto: if depositEnabled is true, send funds to depositAddress on the given network.
Fiat: if depositEnabled is true, deposit details are returned by Get SEPA Payment Details.

Fees#

Withdrawal: the fixed withdrawal.feeAmount is deducted from the withdrawal amount - the recipient receives amount - feeAmount. withdrawal.minAmount includes the fee.
Exchange: the exchange.feePercent of the source balance applies. The fee is calculated from the converted amount and charged in the destination currency.

Request

Authorization
API Key
Add parameter in header
x-api-key
Example:
x-api-key: ********************
or

Responses

🟢200Success
application/json
List of all Partner account balances.
Bodyapplication/json

🟠401Access Denied
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'http://k8s-partnera-partnera-7873f15634-69ebb7c047cac3d1.elb.eu-central-1.amazonaws.com/v1/partner/balances' \
--header 'x-api-key: <api-key>'
Response Response Example
200 - Success
{
    "rateCurrency": "EUR",
    "fiatBalances": [
        {
            "id": "ea93abc7-389d-4bd6-aeff-2257bfa72683",
            "currency": "EUR",
            "precision": 2,
            "amount": "176.34",
            "rate": "1",
            "depositEnabled": true,
            "withdrawal": {
                "feeAmount": "1",
                "minAmount": "2"
            },
            "exchange": {
                "feePercent": "0.1",
                "minAmount": "1"
            }
        }
    ],
    "cryptoBalances": [
        {
            "id": "49c0d66f-7827-42de-a465-1cc99b03a7aa",
            "currency": "BNB",
            "networks": [
                {
                    "name": "BSC",
                    "depositEnabled": false,
                    "depositAddress": null,
                    "withdrawal": {
                        "feeAmount": "0.0075",
                        "minAmount": "0.015"
                    },
                    "exchange": {
                        "feePercent": "0",
                        "minAmount": "0.01"
                    }
                }
            ],
            "walletType": "CUSTODY",
            "precision": 18,
            "amount": "0",
            "rate": "693.173033745742"
        },
        {
            "id": "1255050a-ab45-40dd-8541-8ef964fb7d67",
            "currency": "BONK",
            "networks": [
                {
                    "name": "SOL",
                    "depositEnabled": false,
                    "depositAddress": null,
                    "withdrawal": {
                        "feeAmount": "50000",
                        "minAmount": "100000"
                    },
                    "exchange": {
                        "feePercent": "0",
                        "minAmount": "10000"
                    }
                }
            ],
            "walletType": "CUSTODY",
            "precision": 5,
            "amount": "0",
            "rate": "0.0000034815187120373336"
        },
        {
            "id": "6d1c19f5-993f-4495-95f2-90b88413eb47",
            "currency": "BTC",
            "networks": [
                {
                    "name": "BTC",
                    "depositEnabled": true,
                    "depositAddress": "3KRYKbqH24iNbmp8Vjd2i6WLRmGWLbHTms",
                    "withdrawal": {
                        "feeAmount": "0.00011",
                        "minAmount": "0.00022"
                    },
                    "exchange": {
                        "feePercent": "0",
                        "minAmount": "0.0001"
                    }
                }
            ],
            "walletType": "CUSTODY",
            "precision": 8,
            "amount": "0",
            "rate": "77124.37211940593"
        },
        {
            "id": "6f22378e-71e6-4389-b1d8-3e3d40828e28",
            "currency": "DOGE",
            "networks": [
                {
                    "name": "DOGE",
                    "depositEnabled": true,
                    "depositAddress": "DBHrjdKiLm6GFZpqSSW7Gomj2EnaBtAZnw",
                    "withdrawal": {
                        "feeAmount": "10",
                        "minAmount": "20"
                    },
                    "exchange": {
                        "feePercent": "0.1",
                        "minAmount": "10"
                    }
                }
            ],
            "walletType": "CUSTODY",
            "precision": 8,
            "amount": "432.4416286",
            "rate": "0.08634815216699511"
        },
        {
            "id": "8df4a7f9-8d6a-4a55-9aef-8b20c225d570",
            "currency": "ETH",
            "networks": [
                {
                    "name": "ETH",
                    "depositEnabled": true,
                    "depositAddress": "0x3019ee6b1a44a0b58bdc91c6be767a48d5348d15",
                    "withdrawal": {
                        "feeAmount": "0.0025",
                        "minAmount": "0.005"
                    },
                    "exchange": {
                        "feePercent": "0",
                        "minAmount": "0.001"
                    }
                }
            ],
            "walletType": "CUSTODY",
            "precision": 18,
            "amount": "0",
            "rate": "2445.9926275491794"
        },
        {
            "id": "5101221b-151c-47f2-a97a-b796ba14b4a1",
            "currency": "FLOKI",
            "networks": [
                {
                    "name": "ETH",
                    "depositEnabled": false,
                    "depositAddress": null,
                    "withdrawal": {
                        "feeAmount": "32039",
                        "minAmount": "60000"
                    },
                    "exchange": {
                        "feePercent": "0",
                        "minAmount": "10000"
                    }
                }
            ],
            "walletType": "CUSTODY",
            "precision": 9,
            "amount": "0",
            "rate": "0.00002531684350075172"
        },
        {
            "id": "847eccfa-f6c5-4044-914c-8e352ff22144",
            "currency": "LDO",
            "networks": [
                {
                    "name": "ETH",
                    "depositEnabled": false,
                    "depositAddress": null,
                    "withdrawal": {
                        "feeAmount": "3",
                        "minAmount": "5"
                    },
                    "exchange": {
                        "feePercent": "0",
                        "minAmount": "1"
                    }
                }
            ],
            "walletType": "CUSTODY",
            "precision": 18,
            "amount": "0",
            "rate": "0.41496382945818205"
        },
        {
            "id": "a18772a5-e506-45bd-b40c-c8b7bd1bd698",
            "currency": "LTC",
            "networks": [
                {
                    "name": "LTC",
                    "depositEnabled": true,
                    "depositAddress": "M9cE5jUC8m74dKGRWKBTfGWAtC54uUEpCp",
                    "withdrawal": {
                        "feeAmount": "0.02",
                        "minAmount": "0.05"
                    },
                    "exchange": {
                        "feePercent": "0",
                        "minAmount": "0.01"
                    }
                }
            ],
            "walletType": "CUSTODY",
            "precision": 8,
            "amount": "0",
            "rate": "62.147056713651274"
        },
        {
            "id": "8dca6e34-504e-4a59-a9e7-6d29b2badffb",
            "currency": "PEPE",
            "networks": [
                {
                    "name": "ETH",
                    "depositEnabled": false,
                    "depositAddress": null,
                    "withdrawal": {
                        "feeAmount": "200000",
                        "minAmount": "400000"
                    },
                    "exchange": {
                        "feePercent": "0",
                        "minAmount": "100000"
                    }
                }
            ],
            "walletType": "CUSTODY",
            "precision": 18,
            "amount": "0",
            "rate": "0.000003979297355883014"
        },
        {
            "id": "8605c733-9e93-476e-8885-2b8b4c8670d9",
            "currency": "POL",
            "networks": [
                {
                    "name": "POLYGON",
                    "depositEnabled": false,
                    "depositAddress": null,
                    "withdrawal": {
                        "feeAmount": "5",
                        "minAmount": "20"
                    },
                    "exchange": {
                        "feePercent": "0",
                        "minAmount": "10"
                    }
                }
            ],
            "walletType": "CUSTODY",
            "precision": 18,
            "amount": "0",
            "rate": "0.10018852140817955"
        },
        {
            "id": "185fdc87-5957-44de-a09f-01664f58ec2c",
            "currency": "SHIB",
            "networks": [
                {
                    "name": "ETH",
                    "depositEnabled": false,
                    "depositAddress": null,
                    "withdrawal": {
                        "feeAmount": "200000",
                        "minAmount": "400000"
                    },
                    "exchange": {
                        "feePercent": "0",
                        "minAmount": "100000"
                    }
                }
            ],
            "walletType": "CUSTODY",
            "precision": 18,
            "amount": "0",
            "rate": "0.00000526866556944899"
        },
        {
            "id": "9fa07bb0-4b22-4a16-a713-13246fc622b0",
            "currency": "SOL",
            "networks": [
                {
                    "name": "SOL",
                    "depositEnabled": false,
                    "depositAddress": null,
                    "withdrawal": {
                        "feeAmount": "0.02",
                        "minAmount": "0.04"
                    },
                    "exchange": {
                        "feePercent": "0",
                        "minAmount": "0.01"
                    }
                }
            ],
            "walletType": "CUSTODY",
            "precision": 9,
            "amount": "0",
            "rate": "108.71626564742596"
        },
        {
            "id": "badf9775-243f-41ac-ac40-4f835d999b7c",
            "currency": "TON",
            "networks": [
                {
                    "name": "TON",
                    "depositEnabled": false,
                    "depositAddress": null,
                    "withdrawal": {
                        "feeAmount": "0.5",
                        "minAmount": "0.1"
                    },
                    "exchange": {
                        "feePercent": "0",
                        "minAmount": "0.01"
                    }
                }
            ],
            "walletType": "CUSTODY",
            "precision": 9,
            "amount": "0",
            "rate": "1.383"
        },
        {
            "id": "c2c78955-38c4-4de2-b00b-147174049f3e",
            "currency": "TRUMP",
            "networks": [
                {
                    "name": "SOL",
                    "depositEnabled": false,
                    "depositAddress": null,
                    "withdrawal": {
                        "feeAmount": "0.1",
                        "minAmount": "0.3"
                    },
                    "exchange": {
                        "feePercent": "0",
                        "minAmount": "0.3"
                    }
                }
            ],
            "walletType": "CUSTODY",
            "precision": 6,
            "amount": "0",
            "rate": "1.939817023602403"
        },
        {
            "id": "1be9eb01-7273-46d3-bee7-f25127384fed",
            "currency": "WIF",
            "networks": [
                {
                    "name": "SOL",
                    "depositEnabled": false,
                    "depositAddress": null,
                    "withdrawal": {
                        "feeAmount": "1",
                        "minAmount": "2"
                    },
                    "exchange": {
                        "feePercent": "0",
                        "minAmount": "0.01"
                    }
                }
            ],
            "walletType": "CUSTODY",
            "precision": 6,
            "amount": "0",
            "rate": "0.21246235875824682"
        },
        {
            "id": "6664f771-8677-4ddc-84f1-0597bc366fac",
            "currency": "WOO",
            "networks": [
                {
                    "name": "ETH",
                    "depositEnabled": false,
                    "depositAddress": null,
                    "withdrawal": {
                        "feeAmount": "25",
                        "minAmount": "50"
                    },
                    "exchange": {
                        "feePercent": "0",
                        "minAmount": "1"
                    }
                }
            ],
            "walletType": "CUSTODY",
            "precision": 18,
            "amount": "0",
            "rate": "0.012359912124393047"
        },
        {
            "id": "a9dc9001-0edc-413a-9cae-a5f96819ee39",
            "currency": "XRP",
            "networks": [
                {
                    "name": "XRP",
                    "depositEnabled": false,
                    "depositAddress": null,
                    "withdrawal": {
                        "feeAmount": "2",
                        "minAmount": "6"
                    },
                    "exchange": {
                        "feePercent": "0",
                        "minAmount": "1"
                    }
                }
            ],
            "walletType": "CUSTODY",
            "precision": 6,
            "amount": "0",
            "rate": "1.3713876305126298"
        }
    ]
}
Previous
Balances & History
Next
Get Balance History
Built with