Documentation
User guideDeveloper guideAPI ReferenceContact
  1. API Guide
  2. Welcome to the Vitesse API

Vendor Pay

Introduction

Vendor Pay simplifies and optimises payments to panel suppliers such as hospitals and repair shops. It allows claims administrators to schedule batch payments and verify fund availability in advance, reducing handling costs and operational complexity.

Vendor Pay require a standalone integration, separate from the core Vitesse API used for instructing payments. Even if your organisation already has an existing integration in place, a new integration is required to enable Vendor Pay.

This section outlines how to implement Payee Choice, including essential product context, integration requirements, and links to technical documentation.

Main functional areas

  • Payment Requests: Instruct payments to a supplier and let the system automatically group them into batches based on your criteria while verifying fund availability.
  • Stored recipients: Tokenised supplier records containing administrative data (e.g. address, tax IDs) and securely held payment details, which streamline payment processing and reporting.
  • Webhooks: Manage webhook subscriptions to monitor events related to payment requests. You can create, update, enable or disable subscriptions.

📘

Payment Request vs. Transaction

A Payment Request is a wrapper around a Transaction, i.e. the actual payment, including the full process:

  1. The scheduling and batching of payments
  2. The verification that sufficient fund is available before payment
  3. The creation of a Transaction using the Stored Recipient details

The whole process can be managed through the API. If needed, Transactions can be managed through the Foundations API, cf. Foundations.


Payment Request flow

  1. Your system creates Payment Requests that includes Stored Recipients (vendors).
  2. Vitesse schedules the payment and batches it with other payments to the same vendor.
  3. At the scheduled time for a specific vendor, Vitesse verifies that sufficient funds are available for the bulk payment.
  4. Vitesse generates a Transaction representing the consolidated payment.

API Reference Resources

Updated 2 months ago