Отримання даних акаунту¶

Деталі профілю¶

API: PRIVATE

Endpoint: /account/profile

Метод: GET

Авторизація: BasicAuth

Приклад відповіді

{
    "data": {
        "type": "account",
        "id": "coma_LbkX9aJymRKeqFHW",
        "attributes": {
            "status": "active",
            "name": "Test Docs",
            "icon": null,
            "description": "",
            "commerce_reference_id": "docs1",
            "website": "https://test.doc.home",
            "payment_fee_shift_out": false,
            "hp_domain": null,
            "callback_url": "https://test.doc.home",
            "ledger_scheme": "none",
            "api_ip_white_list": [],
            "created": 1568200307,
            "updated": 1632495587,
            "report": false,
            "time_zone": "Europe/Kiev"
        },
        "links": {
            "self": "/api/account/profile"
        }
    }
}

Баланси¶

API: PRIVATE

Endpoint: /account/balances

Метод: GET

Авторизація: BasicAuth

У відповіді приходить об'єкт currency_accounts з балансами за валютами:

Active (active_balance) — активний баланс (доступні засоби для виведення);
Pending (pending_balance) — баланс із сумами в обробці (містить незавершені виплати));
Reserved (reserved_balance) — "заморожений" баланс (може бути встановлене резервування частини суми прийнятих платежів на певний період);
Overdraft (overdraft_limit) — овердрафт ліміт (доступні кредитні кошти);
Minimum required balance (balance_lower_limit) — необхідний мінімальний баланс, контрольна сума у прив'язаній валюті, яка має зберігатися на рахунку.

Приклад відповіді

{
    "data": {
        "type": "account",
        "id": "coma_LbkX9aJymRKeqFHW",
        "attributes": {
            "currency_accounts": {
                "UAH": {
                    "account_id": "comca_JvRIVXVF5TmNDYk1",
                    "active_balance": "110.00",
                    "pending_balance": "0.00",
                    "reserved_balance": "0.00",
                    "overdraft_limit": "0.00",
                    "balance_lower_limit": null
                },
                "EUR": {
                    "account_id": "comca_MKViNXS0TmOdTJSc",
                    "active_balance": "0.00",
                    "pending_balance": "0.00",
                    "reserved_balance": "0.00",
                    "overdraft_limit": "0.00",
                    "balance_lower_limit": null
                },
            }
        },
        "links": {
            "self": "/api/account/balances"
        }
    }
}

Налаштування акаунту¶

Опції платежів¶

API: PRIVATE

Endpoint: /account/payment-options

Метод: GET

Авторизація: BasicAuth

Відповідний розділ у панелі управління: Опції платежів

Приклад відповіді

{
    "data": {
        "type": "account",
        "id": "coma_LbkX9aJymRKeqFHW",
        "attributes": {
            "payment_options": {
                "descriptor_template": "",
                "description_template": "",
                "attempts_limit": 5,
                "disabled_services": [],
                "methods": [],
                "disable_new_services": false,
                "reverse_fee": false,
                "fee_strategy": "external",
                "invoice_lifetime": 31,
                "forbid_public_creation": false,
                "public_zero_fee": false,
                "public_fee": true,
                "expose_internal_data": true,
                "bypass_hpp": true,
                "force_commerce_return_url": false,
                "send_operation_context_on_return": true,
                "refund_fee": false,
                "allow_overwrite_descriptor": false,
                "return_url": null,
                "return_urls": [],
                "return_fee_on_refund": false,
                "return_fee_on_chargeback": false
            }
        },
        "links": {
            "self": "/api/account/payment-options"
        }
    }
}

Опції виплат¶

API: PRIVATE

Endpoint: /account/payout-options

Метод: GET

Авторизація: BasicAuth

Відповідний розділ у панелі управління: Опції виплат

Приклад відповіді

{
    "data": {
        "type": "account",
        "id": "coma_LbkX9aJymRKeqFHW",
        "attributes": {
            "payout_options": {
                "descriptor_template": null,
                "disabled_services": [
                    "comcpos_mJ2jcDjcg5SXYsuD"
                ],
                "batch_options": {
                    "processing_mode": "parallel"
                },
                "methods": [
                    {
                        "code": "test",
                        "hide": false,
                        "disabled": false,
                        "position": 0
                    },
                    {
                        "code": "payment_card",
                        "hide": false,
                        "disabled": false,
                        "position": 1
                    },
                    {
                        "code": "swift",
                        "hide": false,
                        "disabled": false,
                        "position": 2
                    }
                ],
                "disable_new_services": false,
                "reverse_fee": true,
                "p2p_firstly": false,
                "fee_strategy": "internal",
                "moderation_required": false,
                "invoice_lifetime": 30,
                "split_mode": false,
                "attempts_limit": 0,
                "parallel_mode": false,
                "allow_partially": true,
                "public_zero_fee": false,
                "public_fee": false,
                "expose_internal_data": true,
                "auto_process": false,
                "skip_route_history_filter": false,
                "skip_verify": false
            }
        },
        "links": {
            "self": "/api/account/payout-options"
        }
    }
}