Skip to content

Overview

Welcome to the Wink API — a programmer-friendly way to manage, sell and book travel inventory on the Wink platform. See the Overview page (under API) for the full introduction, intended audience, testing, and versioning.

Account API

Account self-management for a managing entity: payment and payout accounts, the ledger and withdrawals, managers, applications, webhooks, features, and booking administration.

Documentation

Information

  • OpenAPI version: 3.1.0

Every endpoint is protected with OAuth2 client credentials. Create an Application in your account to obtain a clientId and clientSecret, then exchange them for a short-lived bearer token.

1. Request an access token

POST to the Token URL below with Content-Type: application/x-www-form-urlencoded and a body of grant_type=client_credentials (optionally scope=<space-separated scopes>). Send your credentials as HTTP Basic auth: Authorization: Basic base64(clientId + ":" + clientSecret).

2. Call the API

Pass the returned token on every request: Authorization: Bearer <access_token>.

Tokens carry only the scopes granted to your Application — request the least privilege you need. There is no interactive authorize step and no refresh token for this flow; request a new token when the current one expires.

Security scheme type: oauth2

Flow type: clientCredentials

Token URL: https://iam.wink.travel/oauth2/token

Scopes:

  • account.read - View your account settings.
  • account.write - Create and update your account settings.
  • account.remove - Delete your account settings.
  • booking.read - View your bookings.
  • booking.write - Create and update your bookings.
  • booking.remove - Delete your bookings.
  • payment.read - View your payments.
  • payment.write - Create and update your payments.
  • payment.remove - Delete your payments.
  • accounting.read - View your accounting & ledger.
  • accounting.write - Create and update your accounting & ledger.
  • accounting.remove - Delete your accounting & ledger.