Account balance API

Below is a set of APIs that allow one to check account balances.

Retrieve balance for a all accounts

Get merchant accounts balances and details.

get

Retrieves balances and public details for all accounts associated with a merchant.

This endpoint returns a list of accounts with their associated balances, currencies, payment methods, and other public-facing metadata.

Account fields

• accountId (string): Unique account identifier.

• accountLabel (string | null): Optional human-readable account label.

• accountNumber (string): Account number.

• accountCurrency (string): Currency in which the account balance is held.

• referenceCurrency (string): Reference currency used for reporting purposes (e.g. USD).

• currency (string): Operational currency. Deposits are typically made in this currency.

• balance (string): Current account balance.

• balanceReferenceCurrency (string): Current balance expressed in the reference currency.

• withdrawalBalance (string): Balance available for withdrawal.

• withdrawalBalanceReferenceCurrency (string): Withdrawable balance expressed in the reference currency.

• paymentMethod (string | null): Attached payment method name, if applicable.

• isActive (boolean): Indicates whether the account is active.

• isWithdrawalAllowed (boolean): Indicates whether withdrawals are allowed for this account.

• type (string): Account type. Possible values: fiat, crypto.

• network (string | null): Blockchain network for crypto accounts, if applicable.

• minConfirmationBlock (number | null): Minimum number of blocks required for a transaction to be considered confirmed.

• fullConfirmationBlock (number | null): Number of blocks required for a transaction to be considered fully confirmed.

• depositFullConfirmationThresholdReferenceCurrency (string | null): Threshold for full deposit confirmation in the reference currency. If a transaction exceeds this threshold, it must receive the full number of confirmation blocks.

• depositManualReviewThresholdReferenceCurrency (string | null): Threshold for manual deposit review in the reference currency. If a transaction exceeds this threshold, it must be manually reviewed by an XGateway admin.

Authorizations

api_key

x-api-keystringRequired

Responses

200

Ok

application/json

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

get

/balance/accounts

HTTPcURLJavaScriptPython

GET /api/v2/balance/accounts HTTP/1.1
Host: api.xgateway.tech
x-api-key: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "type": "fiat",
      "accountId": "ff36a7a5-08fd-418a-a150-f6f2d36676a8",
      "accountLabel": "TRY Papara",
      "accountNumber": "TRY-ff36a7a5-TRY",
      "accountCurrency": "TRY",
      "referenceCurrency": "USD",
      "currency": "TRY",
      "balance": "1000.00",
      "balanceReferenceCurrency": "115.00",
      "withdrawableBalance": "950.00",
      "withdrawableBalanceReferenceCurrency": "109.25",
      "paymentMethod": "PAPARA",
      "isActive": true,
      "isWithdrawalAllowed": true
    }
  ],
  "success": true
}

Retrieve balance for a specific account

Get merchant account balances and details.

get

Retrieves balances and public details for a specific merchant account.

This endpoint returns an account with its associated balances, currencies, payment method, and other public-facing metadata.

Account fields

• accountId (string): Unique account identifier.

• accountLabel (string | null): Optional human-readable account label.

• accountNumber (string): Account number.

• accountCurrency (string): Currency in which the account balance is held.

• referenceCurrency (string): Reference currency used for reporting purposes (e.g. USD).

• currency (string): Operational currency. Deposits are typically made in this currency.

• balance (string): Current account balance.

• balanceReferenceCurrency (string): Current balance expressed in the reference currency.

• withdrawalBalance (string): Balance available for withdrawal.

• withdrawalBalanceReferenceCurrency (string): Withdrawable balance expressed in the reference currency.

• paymentMethod (string | null): Attached payment method name, if applicable.

• isActive (boolean): Indicates whether the account is active.

• isWithdrawalAllowed (boolean): Indicates whether withdrawals are allowed for this account.

• type (string): Account type. Possible values: fiat, crypto.

• network (string | null): Blockchain network for crypto accounts, if applicable.

• minConfirmationBlock (number | null): Minimum number of blocks required for a transaction to be considered confirmed.

• fullConfirmationBlock (number | null): Number of blocks required for a transaction to be considered fully confirmed.

• depositFullConfirmationThresholdReferenceCurrency (string | null): Threshold for full deposit confirmation in the reference currency. If a transaction exceeds this threshold, it must receive the full number of confirmation blocks.

• depositManualReviewThresholdReferenceCurrency (string | null): Threshold for manual deposit review in the reference currency. If a transaction exceeds this threshold, it must be manually reviewed by an XGateway admin.

Authorizations

api_key

x-api-keystringRequired

Path parameters

accountIdstringRequired

• Unique identifier of the account.

Responses

200

Ok

application/json

400

Bad request

application/json

401

Unauthorized

application/json

404

Account not found

application/json

500

Internal server error

application/json

get

/balance/accounts/{accountId}

HTTPcURLJavaScriptPython

GET /api/v2/balance/accounts/{accountId} HTTP/1.1
Host: api.xgateway.tech
x-api-key: YOUR_API_KEY
Accept: */*

{
  "data": {
    "type": "fiat",
    "accountId": "ff36a7a5-08fd-418a-a150-f6f2d36676a8",
    "accountLabel": "TRY Papara",
    "accountNumber": "TRY-ff36a7a5-TRY",
    "accountCurrency": "TRY",
    "referenceCurrency": "USD",
    "currency": "TRY",
    "balance": "1000.00",
    "balanceReferenceCurrency": "115.00",
    "withdrawableBalance": "950.00",
    "withdrawableBalanceReferenceCurrency": "109.25",
    "paymentMethod": "PAPARA",
    "isActive": true,
    "isWithdrawalAllowed": true
  },
  "success": true
}