List stored recipients
List stored recipients in pages. Use the continuation token to retrieve the next page.
Endpoints
| Environment | Method and URL |
|---|---|
| Staging | GET https://api.staging.vitesse.io/v1/payment-initiation/storedRecipients |
| Production – UK Hub | GET https://api.vitesse.io/v1/payment-initiation/storedRecipients |
| Production – US Hub | GET https://api.us.vitesse.io/v1/payment-initiation/storedRecipients |
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.
Query parameters
Use these parameters to retrieve stored recipients in pages.
| Parameter | When to use it |
|---|---|
ContinuationToken | Retrieve the next page. Use the token returned in the previous response. |
PageSize | Required. Set the maximum number of recipients to return. |
Send the request
This example uses the Staging environment:
curl --request GET \
--url 'https://api.staging.vitesse.io/v1/payment-initiation/storedRecipients?PageSize=2' \
--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:
{
"Data": [
{
"StoredRecipientId": "7d978f47-1907-4d5d-8f85-8f40a96d21c8",
"Status": "Active",
"Country": "GB",
"Currency": "GBP",
"Type": "Person",
"Name": "Emma Thornton",
"Email": "[email protected]",
"PhoneNumber": "+442079460123",
"ExternalStoredRecipientId": null,
"PaymentMethod": "BankAccount",
"Address": {
"StreetName": "High Street",
"BuildingNumber": "10",
"PostCode": "SW1A 1AA",
"TownName": "London",
"CountrySubDivision": "Greater London",
"Country": "GB",
"AddressLine1": "Flat 2",
},
"BankAccountDetails": {
"AccountNumber": "88877665",
"SortCode": "112233"
},
"Person": null,
"Business": null
},
{
"StoredRecipientId": "9a82f47b-ef01-4e52-9a33-238c671acf27",
"Status": "Active",
"Country": "US",
"Currency": "USD",
"Type": "Person",
"Name": "George Thornton",
"Email": "[email protected]",
"PhoneNumber": "+12125550123",
"ExternalStoredRecipientId": null,
"PaymentMethod": "ECheck",
"Address": {
"StreetName": "Main Street",
"BuildingNumber": "25",
"PostCode": "10001",
"TownName": "New York",
"CountrySubDivision": "New York",
"Country": "US"
},
"BankAccountDetails": {
"AccountNumber": "98765432",
"AbaCode": "011000390"
},
"Person": null,
"Business": null
}
],
"ContinuationToken": "cGFnZS0y",
"TotalCount": null,
"HasMore": true
}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 a returned StoredRecipientId to retrieve that recipient’s details. To find recipients by criteria, see Search stored recipients.
Updated 17 days ago