GET
/
api
/
v2
/
ledger
/
institutions
/
{institutionId}
/
orders
/
{orderId}
/
balance
import os
from samplehc import SampleHealthcare

client = SampleHealthcare(
    api_key=os.environ.get("SAMPLEHC_API_KEY"),  # This is the default and can be omitted
)
response = client.v2.ledger.institutions.orders.retrieve_balance(
    order_id="orderId",
    institution_id="institutionId",
)
print(response.balance_usd_cents)
{
  "balanceUsdCents": 123
}

Path Parameters

institutionId
string
required

Institution ID

orderId
string
required

Order ID

Response

200 - application/json

Default Response

The response is of type object.

GET
/
api
/
v2
/
ledger
/
institutions
/
{institutionId}
/
orders
/
{orderId}
/
balance
import os
from samplehc import SampleHealthcare

client = SampleHealthcare(
    api_key=os.environ.get("SAMPLEHC_API_KEY"),  # This is the default and can be omitted
)
response = client.v2.ledger.institutions.orders.retrieve_balance(
    order_id="orderId",
    institution_id="institutionId",
)
print(response.balance_usd_cents)
{
  "balanceUsdCents": 123
}

Path Parameters

institutionId
string
required

Institution ID

orderId
string
required

Order ID

Response

200 - application/json

Default Response

The response is of type object.