Payee Choice

Introduction

Payee Choice allows clients to digitize and automate the capture of claimant's preferred payment method and corresponding payment details, reducing manual process and speeding up payouts. You can watch a 2-minute product explainer.

Payee Choice 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 Payee Choice.

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

Main functional areas

• Payment Requests: Send money to a payee including the capture of their preferred payment method and the corresponding payment details. You can create, retrieve and cancel payment requests.
• Programmes: Retrieve the parameters defining your defined payment experiences, such as branding, account fund sources, payout methods, trust method, support contact details, and whether your application or the Vitesse system will send emails to the payee.
• 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 capture of the payee payment details
2. The creation of a Transaction using the captured payment details

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

Payment Request flow

1. Your system creates a Payment Request linked to a specific Programme.
2. Vitesse or your system (depending on the Programme configuration) sends the payee an email with a notification of a pending payment and a secure link.
3. Using this link, the payee provides their payment details via a secure online process.
4. Using the submitted payment details, Vitesse generates a Transaction.
5. Based on the Transaction status, your system notifies the payee of the process outcome and any required next steps.

📘

Best practices

• Share information with the payee in advance to build trust and ensure they are fully prepared to complete the process.
• Design flows for all potential failure scenarios (for example, the payee not clicking the link or the transaction failing) to avoid inquiries to customer support and maintain a smooth customer experience.

API Reference Resources

• Payment requests
• Programmes
• Webhooks