Create a provider config

post

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

Trigger an action to create the provider config.

Path Params

providerId

uuid

required

Identifier of the resource in Payrails.

Body Params

uuid

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

accountName

string

required

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).

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

Response

Choose an example:

application/json

201Created.

400Bad Request.

401Unauthorized.

403Insufficient Scope.

429Too Many Requests.