Skip to content

Obtain Account Data

Overview

Endpoint: /account

Method: GET

Authentication: Private API BasicAuth

Response Sample

{
    "data": {
        "type": "account",
        "id": "coma_CebLG6xR7jOhQmkD",
        "attributes": {
            "status": "active",
            "name": "MyAccount",
            "icon": "https://example.com/images/coma_CebLG6xR7jOhQmkD/logo.png?1583399986",
            "description": "",
            "website": "https://example.com",
            "payment_fee_shift_out": false,
            "hp_domain": "https://example.eu/",
            "payment_options": {
                "descriptor_template": null,
                "attempts_limit": 5,
                "disabled_services": [
                    "comcps_HSORYCGLJ237V07d",
                    "comcps_a8WLGWFgNDm1jA48"
                ],
                "disable_new_services": true,
                "reverse_fee": false,
                "fee_strategy": "internal",
                "invoice_lifetime": 2880,
                "forbid_public_creation": false,
                "public_zero_fee": false,
                "public_fee": false,
                "expose_internal_data": true,
                "bypass_hpp": true,
                "force_commerce_return_url": true,
                "send_operation_context_on_return": true,
                "refund_fee": false,
                "recurrent": false,
                "allow_overwrite_descriptor": false
            },
            "payout_options": {
                "descriptor_template": null,
                "disabled_services": [],
                "batch_options": {
                    "attempts_limit": 5,
                    "processing_mode": "parallel"
                },
                "methods": [],
                "disable_new_services": false,
                "reverse_fee": true,
                "fee_strategy": "internal",
                "moderation_required": false,
                "invoice_lifetime": 30,
                "split_mode": false,
                "attempts_limit": 5,
                "parallel_mode": false,
                "allow_partially": false,
                "public_zero_fee": false,
                "public_fee": false,
                "expose_internal_data": false
            },
            "api_key": "jA55tDxgWwROc******5L0XtZZW2hKbsNLxBXs",
            "api_key_updated": 1581174500,
            "live_public_key": "pk_live_gHJXSMdFxG********ncFZDOhMBaf0MYkk",
            "live_private_key": "sk_live_r52mIq_qbL497********g-Vr8pfoN6Ojrw98E",
            "test_public_key": "pk_test_eCEOeg*****7M46Rv3bIn2Ag",
            "test_private_key": "sk_test_0Jb_N2x*************LbHXW0VC6wRcGf_Qxs1DAs",
            "callback_url": "https://example.site/026c96db-be91-481e-b7c6-4a82bac744a7",
            "ledger_scheme": "simple",
            "api_ip_white_list": [],
            "created": 1556285176,
            "updated": 1583327142,
            "currency_accounts": {

                "EUR": {
                    "active_balance": "11.00",
                    "pending_balance": "1.00",
                    "reserved_balance": "0.00",
                    "overdraft_limit": "10.00"
                },
                "BTC": {
                    "active_balance": "0.00000000",
                    "pending_balance": "0.00000000",
                    "reserved_balance": "0.00000000",
                    "overdraft_limit": "0.00000000"
                },
                "USD": {
                    "active_balance": "0.22",
                    "pending_balance": "2.00",
                    "reserved_balance": "0.00",
                    "overdraft_limit": "10.00"
                }
            },
            "report": true,
            "time_zone": "Europe/Kiev"
        },
        "links": {
            "self": "/api/account"
        }
    }
}

Balances

The account request contains balance objects linked to the account's currencies — currency_accounts:

  • Active (active_balance) — active balance (available funds to withdrawal)
  • Pending (pending_balance) — pending balance (funds that include processing payouts)
  • Reserved (reserved_balance) — frozen balance (a part of the amount of accepted payments that can be reserved for a certain period)
  • Overdraft (overdraft_limit) — overdraft limit (available credit funds)

Response Sample

{
"currency_accounts":{
    "EUR":{
        "active_balance":"11.00",
        "pending_balance":"1.00",
        "reserved_balance":"0.00",
        "overdraft_limit":"10.00"
    },
    "BTC":{
        "active_balance":"0.00000000",
        "pending_balance":"0.00000000",
        "reserved_balance":"0.00000000",
        "overdraft_limit":"0.00000000"
    },
    "USD":{
        "active_balance":"0.22",
        "pending_balance":"2.00",
        "reserved_balance":"0.00",
        "overdraft_limit":"10.00"
    }
  }
}