Set default scheduler
Set a payment scheduler as the default for a merchant. When you create a payment request with "Scheduler": { "Default": true }, Vitesse uses the merchant’s default scheduler to calculate when to process the request.
Endpoints
| Environment | Method and URL |
|---|---|
| Staging | PUT https://api.staging.vitesse.io/v1/payment-initiation/paymentSchedulers/{id}/setDefault |
| Production – UK Hub | PUT https://api.vitesse.io/v1/payment-initiation/paymentSchedulers/{id}/setDefault |
| Production – US Hub | PUT https://api.us.vitesse.io/v1/payment-initiation/paymentSchedulers/{id}/setDefault |
Replace {id} with the scheduler's PaymentSchedulerId.
For help choosing an environment, see Environment.
Access requirements
Configure the following access:
| OAuth scope | Identity client role |
|---|---|
payment-requests | payment-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
Get the PaymentSchedulerId for the scheduler you want to set as the default. Use List schedulers to find the relevant scheduler.
Send the request
This example uses the Staging environment:
curl --request PUT \
--url 'https://api.staging.vitesse.io/v1/payment-initiation/paymentSchedulers/7d978f47-1907-4d5d-8f85-8f40a96d21c8-0/setDefault' \
--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.
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 access token identifies a merchant
- The identity client has one of the required roles
- You are using the correct
PaymentSchedulerId.
For error response formats, additional HTTP status codes and error-handling guidance, see Error responses.
Next steps
When you create a payment request that should use the default scheduler, set "Scheduler": { "Default": true }. For an example workflow, see Make a payment using Vendor Pay.
Updated 15 days ago