Immediately process a Vendor Pay payment request
Use this endpoint to move an existing scheduled payment request into immediate processing. This operation does not create a new payment request.
Endpoints
| Environment | Method and URL |
|---|---|
| Staging | PUT https://api.staging.vitesse.io/v1/payment-initiation/paymentRequests/{id}/processNow |
| Production – UK Hub | PUT https://api.vitesse.io/v1/payment-initiation/paymentRequests/{id}/processNow |
| Production – US Hub | PUT https://api.us.vitesse.io/v1/payment-initiation/paymentRequests/{id}/processNow |
Replace {id} with the PaymentRequestId of the scheduled request you want to process now.
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.
Send the request
You must include a reason for processing the payment request now. Choose a ReasonId from the list:
ReasonId | When to select it |
|---|---|
hardship | Delaying payment would cause serious financial difficulty or prevent someone from meeting an essential need. |
medical-emergency | The payment will cover urgent medical treatment, care or related costs. |
catastrophic-damage | The payment will fund recovery from major damage or loss, such as damage caused by a disaster. |
legal-regulatory | A legal, regulatory or court deadline requires you to make the payment promptly. |
customer-service | The payment will help resolve an urgent customer complaint, service failure or compensation issue. |
supplier-relationship-urgency | Prompt payment will protect an important supplier relationship or keep essential goods or services flowing. |
business-interruption | Prompt payment will help your business resume or maintain operations after a disruption. |
reputational-damage | A payment delay could damage trust in your organisation; prompt payment could limit that damage. |
other | None of the listed reasons fits. Explain why you want to prioritise the payment in Description. |
When ReasonId is other, you must include a Description (15 to 256 characters). Description is optional for the other reasons.
This example uses the Staging environment:
curl --request PUT \
--url 'https://api.staging.vitesse.io/v1/payment-initiation/paymentRequests/550e8400-e29b-41d4-a716-446655440000/processNow' \
--header 'Authorization: Bearer <access-token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"ReasonId": "business-interruption",
"Description": "Urgent payment required to restore business operations after flooding."
}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 204 No Content. The response has no body.
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
To find payment requests using free text or structured criteria, see Search payment requests. To retrieve a specific request, see Retrieve a payment request.
Updated 16 days ago