Skip to content

Available balance

GET
/api/managing-entity/{managingEntityIdentifier}/payment/ledger/balance
curl --request GET \
--url https://api.wink.travel/api/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/payment/ledger/balance \
--header 'Authorization: Bearer <token>' \
--header 'Wink-Version: 2.0'

Returns the withdrawable ledger balance per currency for the given managing entity. This is the authoritative source of truth for the withdrawal flow. Hotels are denominated in their local/source currency (e.g., THB); other beneficiaries in the internal currency (USD). Each balance entry shows the available amount ready for withdrawal.

managingEntityIdentifier
required
string
""

Managing entity identifier (UUID)

Example
d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69
Wink-Version
string
default: 2.0.0
Allowed values: 2.0

Available balance retrieved successfully

Media type application/json
Array<object>

Available withdrawable ledger balance for a single currency. Hotels are denominated in source currency (e.g., THB); affiliates and other beneficiaries in internal currency (USD).

object
amount
required

Available balance amount in the specified currency.

number
""
currencyCode
required

ISO 4217 currency code of the balance.

string
"" >= 1 characters
Example
[
null
]

Bad Request

object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com",
"properties": {
"additionalProperty": "example"
}
}

Unauthorized — missing or invalid JWT token

Media type */*
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties

Forbidden — missing ACCOUNTING:READ permission

Media type */*
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties

Managing entity not found

Media type application/json
Array<object>

Available withdrawable ledger balance for a single currency. Hotels are denominated in source currency (e.g., THB); affiliates and other beneficiaries in internal currency (USD).

object
amount
required

Available balance amount in the specified currency.

number
""
currencyCode
required

ISO 4217 currency code of the balance.

string
"" >= 1 characters
Example
[
null
]

Internal Server Error

object
Example generated
{}