Skip to content
Wink

Retrieve beneficiary payment amounts

GET
/api/managing-entity/{managingEntityIdentifier}/booking/aggregate/beneficiary
 
curl --request GET \
  --url https://api.wink.travel/api/managing-entity//booking/aggregate/beneficiary \
  --header 'Wink-Version: 2.0'

Returns aggregate beneficiary payment data for a managing entity.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
managingEntityIdentifier
required
string
""

Managing entity identifier

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 ”

OK

Media type application/json
Array<object>
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
internalCurrency
required

The internal currency

string
"" >= 1 characters
sourceAmount
required

Amount in source currency

number
""
internalAmount
required

Amount in internal currency

number
""
Example 
[
  {
    "managingEntityIdentifier": "",
    "accountName": "",
    "type": "TRIP_PAY",
    "totalItemsSold": "",
    "sourceCurrency": "",
    "internalCurrency": "",
    "sourceAmount": "",
    "internalAmount": ""
  }
]

400

Section titled “400 ”

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"
  }
}

401

Section titled “401 ”

Unauthorized

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

403

Section titled “403 ”

Forbidden

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

500

Section titled “500 ”

Internal Server Error

object
Example generated
{}