v1

latestOpenAPI 3.1.0Payrails GmbH2026-07-2614905.7 MB
ProviderConfigs

Create a provider config onboarding URL

Build a redirect onboarding URL for a provider config. If the provider config does not exist yet, use the same provider config ID later when creating the authenticated provider config.

post/payment/providers/{providerId}/configs/{providerConfigId}/onboarding-url

Path parameters

providerIdstring uuid required

Identifier of the resource in Payrails.

providerConfigIdstring 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

returnUrlstring uri required

URL the provider should redirect the user back to after the onboarding flow completes.

Response

Success.

urlstring uri required

Generated onboarding URL for the provider.