Account balance API

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

Retrieve balance for a all accounts

get

Returns all accounts belonging to the authenticated merchant This endpoint provides a list of accounts with their respective balances, currencies, payment method, and other public-facing information Each account includes fields such as:

• accountId: Unique account identifier

• accountLabel: Optional human-readable label

• accountNumber: Account number string

• accountCurrency / referenceCurrency: Currency codes

• balance / balanceReferenceCurrency: Current balance in both account and reference currencies

• withdrawalBalance / withdrawalBalanceReferenceCurrency: Balance available for withdrawal

• paymentMethod: Name of the attached payment method, if any

• isActive: Indicates whether the account is active.

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": [
    {
      "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
    }
  ],
  "success": true
}

Retrieve balance for a specific account

get

Returns account belonging to the authenticated merchant by id This endpoint provides account with respective balances, currencies, payment method, and other public-facing information Account includes fields such as:

• accountId: Unique account identifier

• accountLabel: Optional human-readable label

• accountNumber: Account number string

• accountCurrency / referenceCurrency: Currency codes

• balance / balanceReferenceCurrency: Current balance in both account and reference currencies

• withdrawalBalance / withdrawalBalanceReferenceCurrency: Balance available for withdrawal

• paymentMethod: Name of the attached payment method, if any

• isActive: Indicates whether the account is active.

Authorizations

api_key

x-api-keystringRequired

Path parameters

accountIdstringRequired

• Id of account.

Responses

200

Ok

application/json

400

Bad request

application/json

401

Unauthorized

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": {
    "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
  },
  "success": true
}