Obtain Account Data¶
Profile overview¶
API: PRIVATE
Endpoint: /account/profile
Method: GET
Authentication: BasicAuth
Response Sample
```json
{
"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"
}
}
}
```
Balance¶
API: PRIVATE
Endpoint: /account/balances
Method: GET
Authentication: BasicAuth
The account request contains the balance object linked to the account's currencies (currency_accounts):
- Active balance (
active_balance) that are available funds to withdrawal - Pending balance (
pending_balance) that are funds included processing payouts - Reserved or frozen balance (
reserved_balance) that's a part of the amount of accepted payments reserved for a certain period - Overdraft (
overdraft_limit) is an overdraft limit (available credit funds) - Minimum required balance (
balance_lower_limit) is a checksum held in the account
Response Sample
```json
{
"data": {
"type": "account",
"id": "coma_LbkX9aJymRKeqFHW",
"attributes": {
"currency_accounts": {
"USD": {
"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
},
"RUB": {
"account_id": "comca_eRb9pWCMbrCadlw0",
"active_balance": "96.00",
"pending_balance": "0.00",
"reserved_balance": "0.00",
"overdraft_limit": "0.00",
"balance_lower_limit": null
}
}
},
"links": {
"self": "/api/account/balances"
}
}
}
```
Basic account settings¶
Payment options¶
API: PRIVATE
Endpoint: /account/payment-options
Method: GET
Authentication: BasicAuth
Related section at the Dashboard: Payment options
Response Sample
```json
{
"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"
}
}
}
```
Payout options¶
API: PRIVATE
Endpoint: /account/payout-options
Method: GET
Authentication: BasicAuth
Related section at the Dashboard: Payout options
Response Sample
```json
{
"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"
}
}
}
```