Activate or deactivate a stored recipient
Newly created stored recipients are active and available for use. Use the activate endpoint to restore an inactive recipient, or the deactivate endpoint to prevent using a recipient. Both actions change the recipient's status without deleting their record.
Endpoints
| Environment | Activate method and URL | Deactivate method and URL |
|---|---|---|
| Staging | PUT https://api.staging.vitesse.io/v1/payment-initiation/storedRecipients/{id}/activate | PUT https://api.staging.vitesse.io/v1/payment-initiation/storedRecipients/{id}/deactivate |
| Production – UK Hub | PUT https://api.vitesse.io/v1/payment-initiation/storedRecipients/{id}/activate | PUT https://api.vitesse.io/v1/payment-initiation/storedRecipients/{id}/deactivate |
| Production – US Hub | PUT https://api.us.vitesse.io/v1/payment-initiation/storedRecipients/{id}/activate | PUT https://api.us.vitesse.io/v1/payment-initiation/storedRecipients/{id}/deactivate |
Replace {id} with the stored recipient's ID.
For help choosing an environment, see Environment.
Access requirements
Configure the following access:
| OAuth scope | Identity client role | Required for |
|---|---|---|
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 from the response when you create a stored recipient, or from List stored recipients or Search stored recipients.
You cannot activate or deactivate an archived recipient.
Send the request
These examples uses the Staging environment.
Activate a stored recipient
curl --request PUT \
--url 'https://api.staging.vitesse.io/v1/payment-initiation/storedRecipients/7d978f47-1907-4d5d-8f85-8f40a96d21c8/activate' \
--header 'Authorization: Bearer <access-token>' \
--header 'Accept: application/json'Deactivate a stored recipient
curl --request PUT \
--url 'https://api.staging.vitesse.io/v1/payment-initiation/storedRecipients/7d978f47-1907-4d5d-8f85-8f40a96d21c8/deactivate' \
--header 'Authorization: Bearer <access-token>' \
--header 'Accept: application/json'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.
Activation sets the recipient's status to Active. Deactivation sets it to Inactive.
Troubleshoot requests
If the request fails, use the returned HTTP status code to identify the likely cause and corrective action.
A 404 Not Found error can mean the ID is incorrect or the recipient belongs to a different merchant. Check that the recipient is not archived and that the identity client has the role required for the action.
For error response formats, additional HTTP status codes and error-handling guidance, see Error responses.
Next steps
Use Retrieve a stored recipient to confirm the recipient's status.
Updated 17 days ago