Skip to main content
GET
Get provider by ID

Authorizations

x-api-key
string
header
required

You can use your secret API key in the x-api-key header of your API requests for supported endpoints: x-api-key: <YOUR_API_KEY_HERE>. API keys are environment specific and should be securely guarded.

You don't have your API key yet? Contact your Payrails account manager.

Path Parameters

providerId
string<uuid>
required

Identifier of the resource in Payrails.

Response

Created.

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
enum<string>
required

Provider type.

Available options:
Fraud,
Payment,
Payout,
Vault,
NetworkOffers,
ThreeDS,
NetworkGateway,
NetworkToken,
Bin,
Data,
Dispute,
DisputeAlert,
Tax,
Billing
configSchema
string
required

JSON schema of the provider configuration.

createdAt
string<date-time>
required

Date of creation of the provider.

status
enum<string>

Status of the provider.

Available options:
active,
inactive
selfOnboarding
object

Self-onboarding capabilities available for this provider.

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.

updatedAt
string<date-time>

Last update of the provider.

Last modified on October 7, 2026