Skip to main content
POST
Create a provider config onboarding URL

Authorizations

Authorization
string
header
required

You can use an OAuth2 JWT bearer token in the Authorization header of your API requests for supported endpoints: Authorization: Bearer <YOUR_JWT_HERE>. These tokens are valid for 10 minutes and can be requested via the access token endpoint endpoint.

Headers

x-idempotency-key
string<uuid>
required

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

Path Parameters

providerId
string<uuid>
required

Identifier of the resource in Payrails.

providerConfigId
string<uuid>
required

Identifier of the resource in Payrails.

Body

application/json
returnUrl
string<uri>
required

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

Response

Success.

url
string<uri>
required

Generated onboarding URL for the provider.

authenticationMode
enum<string>

Authentication mode used for provider onboarding.

Available options:
none,
oauth,
trackingId
authentication
object

Provider onboarding credentials returned by the authentication flow.

Last modified on October 1, 2026