---
title: "Create a provider config onboarding URL"
method: POST
path: "/payment/providers/{providerId}/configs/{providerConfigId}/onboarding-url"
tags: ["ProviderConfigs"]
---

# Create a provider config onboarding URL

`POST /payment/providers/{providerId}/configs/{providerConfigId}/onboarding-url`

## Request

- Base URL: `https://api.staging.payrails.io`
- URL: `https://api.staging.payrails.io/payment/providers/{providerId}/configs/{providerConfigId}/onboarding-url`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/payrails/apis/payrails-api-reference/docs/payment/providers/:providerId/configs/:providerConfigId/onboarding-url/post.ts> (a function with typed inputs; its response is checked against the schema)

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.

## Path parameters

- `providerId` string, uuid, required
- `providerConfigId` string, uuid, required

## Headers

- `x-idempotency-key` string, uuid, required

## Request body

- object
  - `returnUrl` string, uri, required: URL the provider should redirect the user back to after the onboarding flow completes.

## Response `200`

Success.

- object
  - `url` string, uri, required: Generated onboarding URL for the provider.

## Other responses

- `400`: Bad Request.
- `401`: Unauthorized.
- `403`: Insufficient Scope.
- `404`: Not Found.
- `429`: Too Many Requests.

---

[API](https://skmtc.dev/payrails/apis/payrails-api-reference.md) - [All operations](https://skmtc.dev/payrails/apis/payrails-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/payrails/apis/payrails-api-reference/revisions/9dd2f0158582?raw)