Delete a scheduler

Delete a scheduler using its PaymentSchedulerId.

Endpoints

EnvironmentMethod and URL
StagingDELETE https://api.staging.vitesse.io/v1/payment-initiation/paymentSchedulers/{id}
Production – UK HubDELETE https://api.vitesse.io/v1/payment-initiation/paymentSchedulers/{id}
Production – US HubDELETE https://api.us.vitesse.io/v1/payment-initiation/paymentSchedulers/{id}

Replace {id} with the scheduler's PaymentSchedulerId.

For help choosing an environment, see Environment.

Access requirements

Configure the following access:

OAuth scopeIdentity client role
payment-requestspayment-requests.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 scheduler’s PaymentSchedulerId. Use List schedulers to find it.

Send the request

This example uses the Staging environment:

curl --request DELETE \
  --url 'https://api.staging.vitesse.io/v1/payment-initiation/paymentSchedulers/<payment-scheduler-id>' \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Accept: application/json'

Replace <access-token> and <payment-scheduler-id> with your access token and the scheduler's PaymentSchedulerId.

Example response

A successful request returns either 200 OK or 204 No Content. Both return an empty body.

Troubleshoot requests

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

Check that:

  • The PaymentSchedulerId is correct.
  • The access token and identity client have the required access.

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

Next steps

To view the remaining schedulers, see List schedulers. To create another scheduler, see Create a scheduler.