Retrieve a payment request
Retrieve a payment request by its ID to view its current status, payment details and recipient information.
Endpoints
| Environment | Method and URL |
|---|---|
| Staging | GET https://api.staging.vitesse.io/v1/payment-initiation/paymentRequests/{id} |
| Production – UK Hub | GET https://api.vitesse.io/v1/payment-initiation/paymentRequests/{id} |
| Production – US Hub | GET https://api.us.vitesse.io/v1/payment-initiation/paymentRequests/{id} |
Replace {id} with the payment request's PaymentRequestID.
For help choosing an environment, see Environment.
Access requirements
Configure at least one of the following access combinations:
| OAuth scope | Identity client role |
|---|---|
payment-requests | payment-requests.viewer |
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 payment request’s PaymentRequestId from the response when you create it, or use List payment requests or Search payment requests to find it.
Send the request
This example uses the Staging environment:
curl --request GET \
--url 'https://api.staging.vitesse.io/v1/payment-initiation/paymentRequests/95a54a33-32cb-4415-94f7-607dc0fd1a6c' \
--header 'Authorization: Bearer <access-token>' \
--header 'Accept: application/json'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 200 OK with the payment request object. This abridged example shows a request in Processing status:
{
"PaymentRequestId": "95a54a33-32cb-4415-94f7-607dc0fd1a6c",
"SendAccountId": 3761,
"PaymentMethod": "BankAccount",
"SendValue": 183.47,
"SendCurrency": "GBP",
"ReceiveValue": 183.47,
"ReceiveCurrency": "GBP",
"UseFxRateGroup": false,
"Recipient": {
"Type": "Person",
"Name": "Emma Thornton",
"Country": "GB",
"Address": {
"StreetName": "High Street",
"BuildingNumber": "10",
"PostalCode": "SW1A 1AA",
"City": "London",
"CountrySubDivision": "Greater London",
"Country": "GB",
"AddressLines": [
"Flat 2"
]
},
"BankAccount": {
"AccountNumber": "88877665",
"SortCode": "112233"
}
},
"TransactionId": "990e8400-e29b-41d4-a716-446655440004",
"Status": "Processing",
"CreatedAt": "2026-10-28T08:15:00Z"
}Status shows the request’s current state. For status meanings, see Payment lifecycle.
Troubleshoot requests
If the request fails, use the returned HTTP status code to identify the likely cause and corrective action.
Check that {id} is a valid PaymentRequestId and that the request exists in the environment you called. An ID that is not a valid GUID returns 400 Bad Request; if Vitesse cannot find a matching request, it returns 404 Not Found.
For error response formats, additional HTTP status codes and error-handling guidance, see Error responses.
Next steps
Check the returned Status to see what happens next. For status meanings, see Payment lifecycle. If the payment request is eligible for cancellation, see Cancel a payment. To find other payment requests, see List payment requests or Search payment requests.
Updated 17 days ago