Retrieve stored recipient history
Retrieve a stored recipient’s history to review recorded actions and changes. Each event shows when it occurred, who or which client made it, and any fields the API recorded as changed.
Endpoints
| Environment | Method and URL |
|---|---|
| Staging | https://api.staging.vitesse.io/v1/payment-initiation/storedRecipients/{id}/history |
| Production – UK Hub | https://api.vitesse.io/v1/payment-initiation/storedRecipients/{id}/history |
| Production – US Hub | https://api.us.vitesse.io/v1/payment-initiation/storedRecipients/{id}/history |
Replace {id} with the StoredRecipientId of the recipient whose history you want to retrieve.
For help choosing an environment, see Environment.
Access requirements
Configure at least one of the following access combinations:
| OAuth scope | Identity client role | Required for |
|---|---|---|
stored-recipients | stored-recipients.viewer | Listing and searching stored recipients and stored recipient search filters, and retrieving their details with read-only access. |
stored-recipients | stored-recipients.manager | Managing stored recipients, including listing, searching, retrieving details and history, retrieving search filters, creating and updating recipients, and activating, deactivating and archiving them. |
For more information about scopes, see Authentication. For information about the access granted by specific roles, see Identity client roles.
Before you begin
Get the recipient’s StoredRecipientId using List stored recipients or Search stored recipients.
Send the request
This example uses the Staging environment:
curl --request GET \
--url 'https://api.staging.vitesse.io/v1/payment-initiation/storedRecipients/7d978f47-1907-4d5d-8f85-8f40a96d21c8/history' \
--header 'Authorization: Bearer <access-token>' \
--header 'Accept: application/json'This request has no body.
Replace <access-token> with a valid access token that contains the required scope, and any example values with your own details.
Example response
A successful request returns 200 OK with an array of history events, ordered from newest to oldest. This example shows an email change and the recipient’s original creation:
[
{
"EventDate": "2026-09-18T08:15:46.222Z",
"ActionBy": "[email protected]",
"EventTitle": "StoredRecipientDetailsAmended",
"EventType": "Update",
"Changes": [
{
"FieldName": "Email",
"PreviousValue": "[email protected]",
"NewValue": "[email protected]",
"Parent": null
}
]
},
{
"EventDate": "2026-09-14T10:50:36.541Z",
"ActionBy": "payments-client",
"EventTitle": "StoredRecipientCreated",
"EventType": "Create",
"Changes": []
}
]EventTitle identifies the recorded action. EventType is Create or Update. Changes lists recorded field changes, including previous and new values when available. ActionBy identifies the user or client when the service has that information.
Changes can include previous and new payment details. Handle the history response as sensitive stored-recipient data.
Troubleshoot requests
If the request fails, use the returned HTTP status code to identify the likely cause and corrective action.
Check that the StoredRecipientId is correct and belongs to the merchant identified by the access token. Vitesse returns 404 Not Found when it cannot find history for that recipient.
For error response formats, additional HTTP status codes and error-handling guidance, see Error responses.
Next steps
To view the recipient’s current details, use Retrieve a stored recipient.
Updated 17 days ago