# Get all payment providers

`GET /api/financial/payment-providers`

- **Success:** `200 OK`
- **Products:** Operator (`FOH`), Consumer (`CONSUMER`) (any one of these products, not all)
- **Features:** Online Bookings (`ONLINEBOOK`), Online Joining (`ONLINEJOIN`), Front of House Generic Access (`FOHGENERIC`) (any one of these features, not all)

HTML version: [Get all payment providers](https://support.gladstonesoftware.cloud/reference/payments/get-all-payment-providers)

## Overview

Lists the payment providers known to the operator. A payment provider is the gateway that
actually takes card payments — the thing named in `paymentMethods[].paymentProvider` when you
call [Pay for sales invoices](pays-for-sales-invoices-using-a-specified-payment-provider-and-can-handle-paymen.md).

Do not expect much from the response: it is three fields, an id, a name and a pointer to the
provider's settings group. There are no credentials, no capabilities and no enabled/disabled flag
here, and the payment endpoint accepts only `GladstonePay` regardless of what this list contains.
Treat it as a lookup list, not as a description of what you may charge against.

A recent change to the operator's providers may not appear straight away. An operator with no payment providers returns `200` with an empty
array — unlike most lists in this group, which return `404`.

## Endpoint

`GET {base_url}/api/financial/payment-providers`

`{base_url}` is the environment URL issued to your integration. See [Authenticating with Gladstone APIs](../../guides/authenticating-with-gladstone-apis.md).

## Sample request

```bash title="cURL"
curl -X GET '{base_url}/api/financial/payment-providers' \
  -H 'Authorization: Bearer {accessToken}' \
  -H 'X-Use-SSO: true'
```

## Response fields

| Field | Type | Description |
|-------|------|-------------|
| `[].id` | integer (int32) | The payment provider identifier, and the value you pass in the path to [Get payment provider by ID](get-payment-provider-by-id.md). |
| `[].configurationGroupId` | integer (int32) | The system configuration group holding this provider's settings. This API exposes no endpoint for reading the group, so there is nothing you can do with the value. |
| `[].name` | string | The provider's display name, always present and at most 60 characters. It is free-text configuration rather than a controlled vocabulary, so do not switch on it: the value that matters when taking a payment is the `paymentProvider` enum on [Pay for sales invoices](pays-for-sales-invoices-using-a-specified-payment-provider-and-can-handle-paymen.md), which currently accepts only `GladstonePay`. |

## Sample response

```json title="200 OK"
[
  {
    "id": 12345,
    "configurationGroupId": 12345,
    "name": "string"
  }
]
```

## Errors

| Status | Meaning | When |
|--------|---------|------|
| `500` | Internal server error | |