> For the complete documentation index, see [llms.txt](https://docs.loomgate.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.loomgate.io/en/api-reference/balance.md).

# Balance

Available and pending balance per currency.

See how the balance changes and how unlock times work in [Balance and unlock times](/en/concepts/balance.md).

## Retrieve your balance

> Per currency: \`available\` (whose unlock time has passed) and \`pending\` (the locked unlock steps of your payments, per unlock time in \`pending\_unlocks\`). Balances may be negative.

```json
{"openapi":"3.0.0","info":{"title":"Loomgate API","version":"v1"},"tags":[{"name":"Balance","description":"Your available and pending balance per currency."}],"servers":[{"url":"https://api.loomgate.io"}],"security":[{"secret_key":[]}],"components":{"securitySchemes":{"secret_key":{"scheme":"bearer","type":"http","description":"Secret key `sk_live_…` (server-side only)."}},"schemas":{"Balance":{"type":"object","properties":{"object":{"type":"string","enum":["balance"]},"available":{"description":"Funds whose available_at has passed.","type":"array","items":{"$ref":"#/components/schemas/BalanceAmount"}},"pending":{"description":"Funds whose unlock time has not come yet: the payments' locked unlock steps (see pending_unlocks).","type":"array","items":{"$ref":"#/components/schemas/BalanceAmount"}},"pending_unlocks":{"description":"The pending funds per currency and time they become available, earliest first. A time just passed stays listed for the few seconds until it is applied.","type":"array","items":{"$ref":"#/components/schemas/PendingUnlock"}}},"required":["object","available","pending","pending_unlocks"]},"BalanceAmount":{"type":"object","properties":{"currency":{"type":"string","enum":["usd","eur"]},"amount":{"type":"integer","description":"Signed, minor units. May be negative."}},"required":["currency","amount"]},"PendingUnlock":{"type":"object","properties":{"currency":{"type":"string","enum":["usd","eur"]},"amount":{"type":"integer","description":"Signed, minor units: what becomes available then."},"available_at":{"type":"integer","description":"Unix seconds, on a :00 or :30 mark."}},"required":["currency","amount","available_at"]},"ErrorResponse":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/Error"}},"required":["error"]},"Error":{"type":"object","properties":{"type":{"type":"string","enum":["invalid_request_error","authentication_error","card_error","rate_limit_error","api_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string","description":"The request field at fault."},"decline_code":{"type":"string","description":"Card declines only, when the reason is known."}},"required":["type","code","message"]}}},"paths":{"/partner/v1/balance":{"get":{"description":"Per currency: `available` (whose unlock time has passed) and `pending` (the locked unlock steps of your payments, per unlock time in `pending_unlocks`). Balances may be negative.","operationId":"retrieveBalance","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Balance"}}}},"401":{"description":"authentication_error: missing, invalid or revoked key / client secret.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"rate_limit_error: `rate_limited`, too many requests; retry after the `Retry-After` seconds.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"summary":"Retrieve your balance","tags":["Balance"]}}}}
```

Example response:

```json
{
  "object": "balance",
  "available": [{ "currency": "usd", "amount": 125000 }],
  "pending": [{ "currency": "usd", "amount": 9680 }],
  "pending_unlocks": [{ "currency": "usd", "amount": 9680, "available_at": 1790607600 }]
}
```

## The balance object

## The Balance object

```json
{"openapi":"3.0.0","info":{"title":"Loomgate API","version":"v1"},"components":{"schemas":{"Balance":{"type":"object","properties":{"object":{"type":"string","enum":["balance"]},"available":{"description":"Funds whose available_at has passed.","type":"array","items":{"$ref":"#/components/schemas/BalanceAmount"}},"pending":{"description":"Funds whose unlock time has not come yet: the payments' locked unlock steps (see pending_unlocks).","type":"array","items":{"$ref":"#/components/schemas/BalanceAmount"}},"pending_unlocks":{"description":"The pending funds per currency and time they become available, earliest first. A time just passed stays listed for the few seconds until it is applied.","type":"array","items":{"$ref":"#/components/schemas/PendingUnlock"}}},"required":["object","available","pending","pending_unlocks"]},"BalanceAmount":{"type":"object","properties":{"currency":{"type":"string","enum":["usd","eur"]},"amount":{"type":"integer","description":"Signed, minor units. May be negative."}},"required":["currency","amount"]},"PendingUnlock":{"type":"object","properties":{"currency":{"type":"string","enum":["usd","eur"]},"amount":{"type":"integer","description":"Signed, minor units: what becomes available then."},"available_at":{"type":"integer","description":"Unix seconds, on a :00 or :30 mark."}},"required":["currency","amount","available_at"]}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.loomgate.io/en/api-reference/balance.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.