Get started

Getting started with the Vitesse API involves obtaining authentication credentials, selecting the correct environment, and understanding the available payment flows.

The steps below outline the basic process for integrating with the Vitesse API.

If you are integrating with the Transaction API, see Welcome to the Transaction API.

Authenticate your application

Authenticate all API requests using an access token obtained from the Vitesse Identity service.

For more information, see Authentication.

Choose the correct environment

Vitesse provides separate environments for development and production use.

For the available endpoints, see Environment.

Understand the available payment flows

The Vitesse API supports three payment flows: Payee Choice, Vendor Pay and Immediate Payment.

For more information, see Payment flows.

Send your first payment

Verify your integration by fetching your account information.

For more information, see Quickstart: Retrieve accounts.

Review the API reference

Consult the API reference for full technical details, including endpoints, request schemas, response fields, and error formats.

For more information, see API reference.