Sign in

v1

latestOpenAPI 3.1.0Payrails GmbH2026-07-2614905.7 MB
Providers

Get provider by ID

Retrieve the provider by provider ID.

get/payment/providers/{providerId}

Path parameters

providerIdstring uuid required

Identifier of the resource in Payrails.

Response

Created.

idstring uuid required

Unique identifier of the provider.

namestring required

Name of the provider.

displayNamestring 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.

configSchemastring required

JSON schema of the provider configuration.

notificationURLTemplatestring

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.

createdAtstring date-time required

Date of creation of the provider.

updatedAtstring date-time

Last update of the provider.