Sign in

v1

latestOpenAPI 3.1.0Payrails GmbH2026-07-2614905.7 MB
ProviderConfigs

Create a provider config with authenticated onboarding

Trigger an action to create the provider config after completing an authenticated onboarding flow.

post/payment/providers/{providerId}/configs/authenticated

Path parameters

providerIdstring uuid required

Identifier of the resource in Payrails.

Headers

x-idempotency-keystring uuid required

Idempotency key to be used. Sending again the same key would return the same result without re-executing the update.

Request body

idstring uuid

Optional ID for the provider configuration. If not specified, a new ID is automatically generated.

accountNamestring string required

Account name of the provider.

configobject
accountDisplayNamestring string

Account display name of the provider.

workspacesstring[]

List of workspaces that the provider configuration will be assigned.

workspaceIdstring uuid nullable

Deprecated (use workspaces), Workspace ID that the provider configuration will be assigned.

additionalDataobject

Custom key-value data included in authorization webhook notifications. Do not store secrets, credentials, or personally identifiable information (PII).

authenticationMode'none' | 'oauth' required

Authentication mode used for provider onboarding.

Response

Created.

idstring uuid required

Unique identifier of the provider config.

providerIdstring uuid required

Unique identifier of the provider.

accountNamestring string required

Account name of the provider.

configSchemastring required

JSON schema of the provider configuration.

createdAtstring date-time required

Date of creation of the provider config.

statusstring

The status of the provider config.

configobject
accountDisplayNamestring string required

Account display name of the provider.

workspacesstring[]

Workspaces that the Provider config belongs to.

providerNamestring

Name of the provider.

providerDisplayNamestring

Display name of the provider.

notificationUrlstring

Notification URL for this provider config.

additionalDataobject

Custom key-value data included in authorization webhook notifications. Do not store secrets, credentials, or personally identifiable information (PII).