Create a provider config with authenticated onboarding

post

https://api.staging.payrails.io/payment/providers/{providerId}/configs/authenticated

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

Path Params

providerId

uuid

required

Identifier of the resource in Payrails.

Body Params

Parameters for authenticated provider onboarding. authentication carries the credentials returned by the onboarding flow, depending on the authentication mode.

uuid

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

accountName

string

required

^[a-zA-Z0-9_-]*$

Account name of the provider.

config

object

accountDisplayName

string

Account display name of the provider.

workspaces

array of uuids

List of workspaces that the provider configuration will be assigned.

workspaces

workspaceId

uuid | null

deprecated

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

additionalData

object

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

authenticationMode

string

enum

required

Authentication mode used for provider onboarding.

Allowed:

authentication

object

Provider onboarding credentials returned by the authentication flow.

Headers

x-idempotency-key

uuid

required

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

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Choose an example:

application/json

201Created.

400Bad Request.

401Unauthorized.

403Insufficient Scope.

429Too Many Requests.