Manage stored recipients
Stored recipients let you securely manage and reuse payee information (such as bank account and address details) for repeat payments. Instead of including full recipient details in every payment request, you can reference a recipient you have previously stored using either:
StoredRecipientId– a unique ID generated by VitesseExternalStoredRecipientId– your own custom identifier
This simplifies recurring payments, improves performance, and reduces the risk of data entry errors.
Use a stored recipient in a payment request
When sending payments to a stored recipient, include the StoredRecipient object with either ID.
Provide only one of StoredRecipientId or ExternalStoredRecipientId in each payment request.
Example
The below example references a StoredRecipient, with a payment made via EFT. You can also pay using cheques or eChecks. To understand the structure of a stored recipient in the API, see Create a stored recipient.
{
"SendAccountId": 1234,
"SendCurrency": "GBP",
"ReceiveValue": 100,
"ReceiveCurrency": "GBP",
"PaymentMethod": "BankAccount",
"StoredRecipient": {
"StoredRecipientId": "00000000-0000-0000-0000-000000000001"
},
"RecipientReference": "Invoice #12345",
"PaymentDescription": "Consulting fees"
}Best practices
- Use
ExternalStoredRecipientIdto align with your organisation's internal system identifier for stored recipients. - Validate stored recipient data using the Rules configuration to ensure required fields for each route (for example, IBAN or ABA code) are correct.
- Consider storing recipient metadata for reporting or reconciliation.
Updated 23 days ago