List payment methods
List all the payment method types available in the Vitesse API. To find methods permitted for a specific programme, country, currency and field scope, use List payment methods permitted for a programme.
Endpoints
| Environment | Method and URL |
|---|---|
| Staging | GET https://api.staging.vitesse.io/v1/payment-initiation/paymentMethods |
| Production – UK Hub | GET https://api.vitesse.io/v1/payment-initiation/paymentMethods |
| Production – US Hub | GET https://api.us.vitesse.io/v1/payment-initiation/paymentMethods |
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.
Send the request
This example uses the Staging environment:
curl --request GET \
--url 'https://api.staging.vitesse.io/v1/payment-initiation/paymentMethods' \
--header 'Authorization: Bearer <access-token>' \
--header 'Accept: application/json'Replace <access-token> with an access token that contains the required scope.
Example response
A successful request returns 200 OK with a Data array containing the available payment method types:
{
"Data": [
"BankAccount",
"Echeck",
"PostalCheque"
]
}Troubleshoot the request
If the request fails, use the returned HTTP status code to identify the likely cause and corrective action.
If the request returns 403 Forbidden, check that the access token contains the required OAuth scope and that the identity client has an accepted role.
For error response formats, additional HTTP status codes and error-handling guidance, see Error responses.
Next steps
To check which methods are permitted for a programme and recipient combination, see List payment methods permitted for a programme. To choose eligible methods for a programme, see Create a programme or Update a programme.
Updated 15 days ago