Archive a stored recipient

Archive a stored recipient when you no longer need to make payments to them. You cannot reactivate an archived recipient. If you may need to use the recipient again, deactivate them instead.

Endpoints

EnvironmentMethod and URL
StagingPUT https://api.staging.vitesse.io/v1/payment-initiation/storedRecipients/{id}/archive
Production – UK HubPUT https://api.vitesse.io/v1/payment-initiation/storedRecipients/{id}/archive
Production – US HubPUT https://api.us.vitesse.io/v1/payment-initiation/storedRecipients/{id}/archive

Replace {id} with the StoredRecipientId of the stored recipient you want to archive.

For help choosing an environment, see Environment.

Access requirements

Configure the following access:

OAuth scopeIdentity client roleRequired for
stored-recipientsstored-recipients.managerManaging 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 PUT \
  --url 'https://api.staging.vitesse.io/v1/payment-initiation/storedRecipients/7d978f47-1907-4d5d-8f85-8f40a96d21c8/archive' \
  --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 or 204 No Content. The response has no body.

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 that the identity client has the required scope and role. You cannot archive a recipient that is already archived.

For error response formats, additional HTTP status codes and error-handling guidance, see Error responses.

Next steps

To confirm the recipient’s status, use Retrieve a stored recipient. To temporarily deactivate a recipient and make them unavailable for use, see Activate or deactivate a stored recipient