---
title: "Get provider by ID"
method: GET
path: "/payment/providers/{providerId}"
tags: ["Providers"]
---

# Get provider by ID

`GET /payment/providers/{providerId}`

Retrieve the provider by provider ID.

## Path parameters

- `providerId` string, uuid, required

## Response `200`

Created.

- object
  - `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)