Skip to content
Wink

Available funds

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

Returns the currently available (withdrawable) funds aggregated per beneficiary for the managing entity’s bookings.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
managingEntityIdentifier
required
string
""

Managing entity identifier

Example 
d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69

Header Parameters

Section titled “Header Parameters ”
Wink-Version
string
default: 2.0.0
Allowed values: 2.0

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Available withdrawable funds per beneficiary for the managing entity

Media type application/json
Array<object>

Available funds for a managing entity in source and internal currencies.

object
managingEntityIdentifier
required

Unique identifier of the managing entity.

string format: uuid
""
sourceCurrency
required

Source currency code of the funds (e.g. hotel’s local currency).

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

Internal (capture) currency code used for settlement.

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

Available funds in source currency.

number format: double
""
internalAmount
required

Available funds in internal currency.

number format: double
""
Example 
[
  {
    "managingEntityIdentifier": "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69",
    "sourceCurrency": "THB",
    "internalCurrency": "USD",
    "sourceAmount": 45000,
    "internalAmount": 1250
  }
]

400

Section titled “400 ”

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

401

Section titled “401 ”

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

403

Section titled “403 ”

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

404

Section titled “404 ”

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

405

Section titled “405 ”

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

415

Section titled “415 ”

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

500

Section titled “500 ”

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

503

Section titled “503 ”

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