Ctrl+K

Account Balance Check

get/api/trade/v1/enterprise/{enterpriseId}/account/{accountId}/tradingpartners/{partnerAccountId}/balance

The Account Balance Check API verifies whether an account has enough funds to support a settlement of some amount.

Path Parameters

  • enterpriseIdstringRequired
    Enterprise ID
  • accountIdstringRequired
    Your trading account ID
  • partnerAccountIdstringRequired
    Trading partner's trading account ID to balance check

Query Parameters

  • amountstringRequired
    Amount of offchain currency to balance check. Integer as a string
  • currencystringRequired
    Offchain currency to balance check

200 Response

check boolean

400 Response

error string required
Human-readable error message
errorName string required
Immutable error code for API integration
reqId string required
Client request id