Get started

Getting started with the Transaction API involves obtaining authentication credentials, selecting the correct environment, and understanding the available API resources.

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

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

Authenticate your application

Authenticate all API requests using an API token created in the Merchant Administration System (MAS).

For more information, see Authentication: Transaction API.

Choose the correct environment

Vitesse provides separate environments for development and production use.

For the available endpoints, see Environment: Transaction API.

Understand the available resources

The Transaction API provides endpoints for managing transactions, recipients, accounts, foreign exchange (FX), and validation rules.

The main resources are:

• Transactions – Send payments to recipients and retrieve transaction information.
  See Create transaction request.

• Accounts – Retrieve merchant account balances and account activity.
  See List account balances.

• Account Movements – Create and manage movements between accounts.
  See Create account movements.

• Stored Recipients – Create, retrieve, update, and delete stored recipients.
  See List stored recipients.

• Foregn exchange – Retrieve FX rates and manage FX rate groups for cross-currency payments.
  See Retrieve foreign exchange rates for a send account.

• Rules – Retrieve country- and currency-specific validation requirements for payments.
  See List rules.

• Cheque Void – Manage cheque void requests.
  See Void a cheque.

• Search – Search for transactions using query parameters.
  See Search transactions.

Send your first transaction

Verify your integration by creating a transaction request using the Transactions endpoints.

For more information, see Create transaction request.

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.