Payee Choice
Payee Choice enables organisations to collect a recipient's preferred payment method and payment details during a payment.
Rather than collecting payment details during the claims process, your organisation creates a Payment Request when payment is approved. The recipient is then invited to securely provide their preferred payment method and the required payment details and provides the required payment details. Payee Choice uses these details to execute the payment.
You can use Payee Choice through Vitesse Online or the Payee Choice API.
Key concepts
| Concept | Description |
|---|---|
| Payment Request | Represents the process of collecting a payee's preferred payment method and payment details. Each Payment Request is associated with a Programme. After the payee submits their payment details, Payee Choice creates a Transaction to execute the payment. |
| Programme | Defines how a Payment Request is presented and processed. A Programme specifies the branding, supported payout methods, funding source, trust settings, support contact details, and whether Vitesse or your organisation sends email notifications. |
| Transaction | Represents the payment created after the payee submits their payment details through a Payment Request. A Transaction uses the submitted payment details to execute the payment. |
Payment Requests and TransactionsA Payment Request and a Transaction are separate concepts.
- A Payment Request collects the payee's preferred payment method and payment details.
- A Transaction uses those payment details to execute the payment.
A single Payment Request results in a single Transaction.
Payment Request lifecycle
A typical Payment Request follows these steps:
- Your organisation creates a Payment Request for a payee.
- The payee receives a secure link to the Payment Request.
- The payee selects a payment method and provides the required payment details.
- A Transaction is created using the submitted payment details.
- The Transaction is processed and the payment is completed.
Best practices
- Notify the payee that a Payment Request is expected before sending the secure link.
- Monitor Payment Requests and Transactions so that you can respond to incomplete requests or failed payments.
- Provide clear guidance to payees on what information they will need before beginning the process.
Next steps
- If you use Vitesse Online, see the Payee Choice guides for creating and managing Payment Requests.
- If you integrate with the Payee Choice API, see the API Guide for integration requirements and API reference documentation.
Updated 6 days ago
Did this page help you?