Skip to main content
GET
/
businesses
/
{id}
/
balances
Get business payment processor balance
curl --request GET \
  --url https://api.guile.app/businesses/{id}/balances \
  --header 'Authorization: Bearer <token>'
{
  "available": "456.78",
  "availableForInstant": "456.78",
  "pending": "456.78",
  "allocated": "456.78",
  "retrievedAt": "2023-11-07T05:31:56Z"
}

Path Parameters

​
id
string<uuid>
required

The unique, opaque system identifier for a resource. This case-sensitive ID is also used as path parameters in URLs or in other properties or parameters that reference a resource by ID rather than URL.

Response

Ok. The operation succeeded.

Representation of a business's payment processor balance.

​
available
string<decimal>
required

Funds available for payout.

Pattern: ^(0|[1-9][0-9]*)\.[0-9][0-9]$
Example:

"456.78"

​
availableForInstant
string<decimal>
required

Funds available for instant payout within daily limits.

Pattern: ^(0|[1-9][0-9]*)\.[0-9][0-9]$
Example:

"456.78"

​
pending
string<decimal>
required

Funds that are pending and not yet available for payout.

Pattern: ^(0|[1-9][0-9]*)\.[0-9][0-9]$
Example:

"456.78"

​
allocated
string<decimal>
required

Funds that are allocated to existing processing payouts.

Pattern: ^(0|[1-9][0-9]*)\.[0-9][0-9]$
Example:

"456.78"

​
retrievedAt
string<date-time>
required

The date-time when this balance information was retrieved, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC.