Skip to content

Beneficiary payments

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

Returns payment amounts aggregated per beneficiary across the managing entity’s bookings.

managingEntityIdentifier
required
string
""

Managing entity identifier

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

Beneficiary payment amounts for the managing entity

Media type application/json
Array<object>

Aggregated beneficiary payment data across bookings in source, internal, and display currencies.

object
managingEntityIdentifier
required

Beneficiary managing entity identifier

string format: uuid
"" >= 1 characters
accountName
required

Beneficiary account name

string
"" >= 1 characters
type
required

Type of payment to beneficiary

string
""
Allowed values: TRIP_PAY PLATFORM_FEE COMMISSION AFFILIATE_AGENCY_FEE SUPPLIER_AGENCY_FEE SALE
totalItemsSold
required

Total items sold

integer format: int64
""
sourceCurrency
required

The source currency

string
"" >= 1 characters /^[A-Z]{3}$/
internalCurrency
required

The internal currency

string
"" >= 1 characters /^[A-Z]{3}$/
sourceAmount
required

Amount in source currency

number
""
internalAmount
required

Amount in internal currency

number
""
Example
[
{
"managingEntityIdentifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51",
"accountName": "The Siam Residences",
"type": "SALE",
"totalItemsSold": 2,
"sourceCurrency": "THB",
"internalCurrency": "USD",
"sourceAmount": 75000,
"internalAmount": 2150
}
]

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