Retrieve a programme
Retrieve a programme by its ID.
Endpoints
| Environment | Method and URL |
|---|---|
| Staging | GET https://api.staging.vitesse.io/v1/payment-initiation/programmes/{id} |
| Production – UK Hub | GET https://api.vitesse.io/v1/payment-initiation/programmes/{id} |
| Production – US Hub | GET https://api.us.vitesse.io/v1/payment-initiation/programmes/{id} |
Replace {id} with the programme's ID.
For help choosing an environment, see Environment.
Access requirements
Configure at least one of the following access combinations:
| OAuth scope | Identity client role |
|---|---|
programmes | programmes.viewer |
programmes | programmes.manager |
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 filter programmes and page through the results.
| Parameter | When to use it |
|---|---|
WithAccountData | Set to true to include account details, such as account name, subtype and upper payment limit, in EligibleAccounts. |
WithTrustMethodName | Set to true to include the configured names of eligible trust methods. |
WithVerificationMethodDetails | Set to true to include passphrase details for eligible passphrase verification methods. |
Before you begin
Obtain the ProgrammeId. Use List programmes if you need to find it.
Send the request
This example uses the Staging environment:
curl --request GET \
--url 'https://api.staging.vitesse.io/v1/payment-initiation/programmes/42ea67d3-30d9-4143-848a-15cd59878ccd' \
--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. This example returns the requested programme and lists its available source accounts in the EligibleAccounts array:
{
"ProgrammeId": "42ea67d3-30d9-4143-848a-15cd59878ccd",
"Name": "UK Claims",
"Description": "UK claims payments",
"EligibleAccounts": [
{
"AccountId": 3761,
"Name": "Motor Claims Disbursements",
"CurrencyCode": "GBP"
},
{
"AccountId": 6341,
"Name": "Property Claims Disbursements",
"CurrencyCode": "GBP"
},
{
"AccountId": 6562,
"Name": "Liability Claims Disbursements",
"CurrencyCode": "GBP"
}
]
}Use the ProgrammeId when retrieving or updating a programme, or when creating a Payee Choice payment request. For details, see Make a payment using Payee Choice.
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 view all programmes, see List programmes. To search for a programme, see Search programmes. To make a Payee Choice payment, see Make a payment using Payee Choice.
Updated 17 days ago