Payment flows

The Vitesse API supports three payment flows. Each flow corresponds to a Vitesse payment product. In each flow, the payment progresses through the payment lifecycle until it completes or fails.

Single payment

Use the Single payment flow when your system already holds the recipient’s payment details and can instruct the payment directly.

This flow is commonly used by:

Insurers or TPAs that already store beneficiary bank details in their internal systems
Claim management platforms that generate payments after claim approval is complete
Operational teams sending one-off payouts, reimbursements, or settlements

In this flow:

Your system supplies the recipient’s payment details in the request, or references a stored recipient
The API validates the request and immediately begins processing the payment

For implementation details, see Make an immediate payment.

Payee Choice

Use Payee Choice when the recipient provides their payment details directly in order to receive their payment.

This flow is commonly used by:

Insurers or TPAs paying claimants who may prefer different payout methods
Organisations that want to avoid storing sensitive payment details
Businesses that want to offer recipients a choice of payment methods (for example bank transfer, card, or wallet)

In this flow:

Your system creates a payment request
The recipient receives a link to a hosted payment journey
The recipient selects their preferred payment method and provides their payment details
After the required information is captured, the payment proceeds through the standard payment lifecycle

For implementation details, see Make a Payee Choice payment.

Vendor Pay

Use Vendor Pay when sending payments to vendors or suppliers as part of a structured operational workflow.

This flow is commonly used by:

Insurers paying repair networks, medical providers, or other service suppliers
TPAs managing payments to approved vendor panels
Organisations making repeat payments to the same group of suppliers

In this flow:

Vendors are onboarded and their payment details are captured and maintained
Your system initiates payments to those vendors using the Vendor Pay workflow
The platform manages payment execution and tracks the payment through the lifecycle

For implementation details, see Make a Vendor Pay payment.