Skip to content

Aggregate funds

GET
/api/managing-entity/{managingEntityIdentifier}/booking/funds
curl --request GET \
--url 'https://api.wink.travel/api/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/booking/funds?state=UPCOMING&accountFundsOnly=false' \
--header 'Authorization: Bearer <token>' \
--header 'Wink-Version: 2.0'

Returns total aggregate funds for the managing entity, optionally filtered by financial state; when accountFundsOnly is true only funds earned by this account as a beneficiary are summed, otherwise the full booking amounts it participated in.

managingEntityIdentifier
required
string
""

Managing entity identifier

Example
d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69
state
string
""

Financial state filter

Example
UPCOMING
accountFundsOnly
string
""

Return only funds earned by this account as a beneficiary (true), or total booking amounts this account was part of (false). Defaults to false.

Example
false
Wink-Version
string
default: 2.0.0
Allowed values: 2.0

Aggregate funds for the managing entity

Media type application/json

Aggregated booking funds expressed in three currency contexts: the property’s source currency, the platform’s internal capture currency, and the user’s display currency.

object
sourceCurrency

The property’s source currency code.

string
"" /^[A-Z]{3}$/
internalCurrency

The platform’s internal capture currency code.

string
"" /^[A-Z]{3}$/
displayCurrency

The user’s preferred display currency code.

string
"" /^[A-Z]{3}$/
sourceAmount

Total amount in the source currency.

number format: double
""
internalAmount

Total amount in the internal capture currency.

number format: double
""
displayAmount

Total amount in the user’s display currency.

number format: double
""
key
additional properties
""
Example
{
"sourceCurrency": "THB",
"internalCurrency": "USD",
"displayCurrency": "USD",
"sourceAmount": 45000,
"internalAmount": 1285.75,
"displayAmount": 1285.75
}

Bad Request — missing or invalid request parameter or body

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

Unauthorized — authentication is required or the session has expired

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

Forbidden — authenticated but lacking the required permission or scope

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

Not Found — the requested resource does not exist

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

Method Not Allowed — the HTTP verb is not supported on this endpoint

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

Unsupported Media Type — use application/json

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

Internal Server Error — an unexpected failure occurred on the server

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

Service Unavailable — a downstream dependency is unreachable

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example