Retrieve a stored recipient
Retrieve a stored recipient by its StoredRecipientId to view its saved contact, address and payment details. The recipient must belong to the merchant associated with the access token.
Endpoints
| Environment | Method and URL |
|---|---|
| Staging | GET https://api.staging.vitesse.io/v1/payment-initiation/storedRecipients/{id} |
| Production – UK Hub | GET https://api.vitesse.io/v1/payment-initiation/storedRecipients/{id} |
| Production – US Hub | GET https://api.us.vitesse.io/v1/payment-initiation/storedRecipients/{id} |
Replace {id} with the StoredRecipientId of the stored recipient you want to retrieve.
For help choosing an environment, see Environment.
Access requirements
Configure at least one of the following access combinations:
| OAuth scope | Identity client role | Required for |
|---|---|---|
stored-recipients | stored-recipients.viewer | Listing and searching stored recipients and stored recipient search filters, and retrieving their details with read-only access. |
stored-recipients | stored-recipients.manager | Managing stored recipients, including listing, searching, retrieving details and history, retrieving search filters, creating and updating recipients, and activating, deactivating and archiving them. |
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 recipient's StoredRecipientId from the response when you create a stored recipient, or from List stored recipients or Search stored recipients.
Send the request
This example uses the Staging environment:
curl --request GET \
--url 'https://api.staging.vitesse.io/v1/payment-initiation/storedRecipients/7d978f47-1907-4d5d-8f85-8f40a96d21c8' \
--header 'Authorization: Bearer <access-token>' \
--header 'Accept: application/json'To retrieve another page, include the returned ContinuationToken in the next request.
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 a Data array and pagination details. For example:
{
"StoredRecipientId": "7d978f47-1907-4d5d-8f85-8f40a96d21c8",
"Version": "N2Q5NzhmNDctMTkwNy00ZDVkLThmODUtOGY0MGE5NmQyMWM4QDA",
"Status": "Active",
"ConfirmationOfPayee": null,
"Country": "GB",
"Currency": "GBP",
"Type": "Person",
"Name": "Emma Thornton",
"Email": "[email protected]",
"PhoneNumber": "+442079460123",
"ExternalStoredRecipientId": null,
"SecondaryReferenceData": null,
"CoPDetails": null,
"PaymentMethod": "BankAccount",
"Address": {
"StreetName": "High Street",
"BuildingNumber": "10",
"PostCode": "SW1A 1AA",
"TownName": "London",
"CountrySubDivision": "Greater London",
"Country": "GB",
"AddressLine1": "Flat 2",
"AddressLine2": null
},
"BankAccountDetails": {
"AccountNumber": "88877665",
"SortCode": "112233"
},
"Person": null,
"Business": null
}The Version value identifies the returned version of the stored recipient.
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 returned StoredRecipientId for another operation that requires a stored recipient identifier.
Updated 17 days ago