---
title: "Search & list providers"
method: GET
path: "/payment/providers"
tags: ["Providers"]
---

# Search & list providers

`GET /payment/providers`

Fetch a list of providers.

## Query parameters

- `filter[status]` 'active' | 'inactive' — Status of the provider.
- `filter[type]` 'Fraud' | 'Payment' | 'Payout' | 'Vault' | 'NetworkOffers' | 'ThreeDS' | 'NetworkGateway' | 'NetworkToken' | 'Bin' | 'Data' | 'Dispute' | 'DisputeAlert' | 'Tax' — Provider type.
- `filter[name]` string
- `filter[displayName]` string
- `filter[createdAt]` string
- `filter[updatedAt]` string — Filter by `updatedAt` field. The value should represent a range one of the following formats `(1973-02-03T04:32:11.596Z` - after the date excluding it `[1973-02-03T04:32:11.596Z` - after the date including it `1973-02-03T04:32:11.596Z)` - before the date excluding it `1973-02-03T04:32:11.596Z]` - before the date including it `(1973-02-03T04:32:11.596Z,1973-04-03T03:20:11.436Z)` - between two dates excluding both `(1973-02-03T04:32:11.596Z,1973-04-03T03:20:11.436Z]` - between two dates excluding on the left `[1973-02-03T04:32:11.596Z,1973-04-03T03:20:11.436Z)` - between two dates excluding on the right `[1973-02-03T04:32:11.596Z,1973-04-03T03:20:11.436Z]` - between two dates including both.
- `page[cursor]` string — Cursor for paging results.
- `page[after]` string — Cursor for paging results.
- `page[before]` string — Cursor for paging results.
- `page[size]` integer

## Response `200`

Success.

- object
  - `links` object
    - `self` string, required
    - `prev` string
    - `next` string
    - `first` string
    - `last` string
  - `results` object[], required
    - `id` string, uuid, required — Unique identifier of the provider.
    - `name` string, required — Name of the provider.
    - `displayName` string, required — Display name of the provider.
    - `type` 'Fraud' | 'Payment' | 'Payout' | 'Vault' | 'NetworkOffers' | 'ThreeDS' | 'NetworkGateway' | 'NetworkToken' | 'Bin' | 'Data' | 'Dispute' | 'DisputeAlert' | 'Tax', required — Provider type.
    - `status` 'active' | 'inactive' — Status of the provider.
    - `configSchema` string, required — JSON schema of the provider configuration.
    - `selfOnboarding` object — Self-onboarding capabilities available for this provider.
      - `enabled` boolean — Whether self-onboarding is enabled for this provider.
      - `supportedAuthModes` string[] — Authentication modes supported for self-onboarding.
    - `notificationURLTemplate` string — Template of the notification URL for provider configs of that provider. The template contains variables between curly braces that can be mapped to the fields of the provider configs (e.g. `{id}`, `{accountName}`) and substituted to generate the notification URL of that provider config.
    - `createdAt` string, date-time, required — Date of creation of the provider.
    - `updatedAt` string, date-time — Last update of the provider.

## Other responses

- `400` — Bad Request.
- `401` — Unauthorized.
- `403` — Insufficient Scope.
- `404` — Not Found.
- `429` — Too Many Requests.

---

[API](https://skmtc.net/payrails/apis/payrails-api-reference.md) · [All operations](https://skmtc.net/payrails/apis/payrails-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/payrails/payrails-api-reference/revisions/9dd2f0158582/schema)