Activate or deactivate a programme

Use these operations to control whether a completed programme is available to supported payment flows. Activate an inactive programme or deactivate an active one. You cannot activate incomplete draft programmes.

Endpoints

EnvironmentActivate endpointDeactivate endpoint
StagingPUT https://api.staging.vitesse.io/v1/payment-initiation/programmes/{id}/activatePUT https://api.staging.vitesse.io/v1/payment-initiation/programmes/{id}/deactivate
Production – UK HubPUT https://api.vitesse.io/v1/payment-initiation/programmes/{id}/activatePUT https://api.vitesse.io/v1/payment-initiation/programmes/{id}/deactivate
Production – US HubPUT https://api.us.vitesse.io/v1/payment-initiation/programmes/{id}/activatePUT https://api.us.vitesse.io/v1/payment-initiation/programmes/{id}/deactivate

Replace {id} with the programme's ID.

For help choosing an environment, see Environment.

Access requirements

Configure the following access:

OAuth scopeIdentity client role
programmesprogrammes.manager

For more information about scopes, see Authentication. For information about the access granted by specific roles, see Identity client roles.

Before you begin

Obtain the relevant ProgrammeId. Use List programmes if you need to find it.

Send the request

This example activates a programme in the Staging environment:

curl --request PUT \
  --url 'https://api.staging.vitesse.io/v1/payment-initiation/programmes/4f8a2c31-6d7e-4b90-a123-9c5d7e8f2a61/activate' \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{}'

Replace <access-token> with a valid access token that contains the required scope, and any example values with your own details.

To deactivate the programme, change the final path segment from activate to deactivate.

Example response

A successful request returns an empty JSON object:

{}

Troubleshoot requests

If the request fails, use the returned HTTP status code to identify the likely cause and corrective action.

Check that the ProgrammeId is correct and the programme has the status required for the operation: Inactive to activate or Active to deactivate. Also check that the access token and identity client have the required scope and role.

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

Next steps

To check the programme’s status, see Retrieve a programme. To change its configuration, see Update a programme.

Use the active programme with a supported payment flow, for example Make a payment using Payee Choice​.