List schedulers

List all available schedulers.

Endpoints

EnvironmentMethod and URL
StagingGET https://api.staging.vitesse.io/v1/payment-initiation/paymentSchedulers
Production – UK HubGET https://api.vitesse.io/v1/payment-initiation/paymentSchedulers
Production – US HubGET https://api.us.vitesse.io/v1/payment-initiation/paymentSchedulers

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.

Send the request

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

Replace <access-token> with an access token that contains the required scope.

Example response

A successful request returns 200 OK with a PaymentSchedulers array and pagination details. This example returns two schedulers:

{
  "PaymentSchedulers": [
    {
      "PaymentSchedulerId": "f42e2a27-7646-4ea8-bd32-eb5f6a7cca98",
      "Name": "Weekday claims run",
      "CronExpression": "0 15 10 * * ?",
      "IsDefault": true
    },
    {
      "PaymentSchedulerId": "a1b2c3d4-e5f6-4789-a012-3456789abcde",
      "Name": "Afternoon claims run",
      "CronExpression": "0 30 16 * * ?",
      "IsDefault": false
    }
  ],
  "HasMore": false,
  "ContinuationToken": null,
  "TotalCount": 2
}

Troubleshoot requests

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

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

Next steps

Use the PaymentSchedulerId when creating a Vendor Pay payment request. For more information, see Make a payment using Vendor Pay​.