PApayrails
ProviderConfigs

Update a provider config

Trigger an action to update the provider config.

put/payment/providers/{providerId}/configs/{providerConfigId}

Request

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

accountNamestring string

Account name of the provider.

configobject
accountDisplayNamestring string

Account display name of the provider.

additionalDataobject nullable

Custom key-value data included in authorization webhook notifications. Do not store secrets, credentials, or personally identifiable information (PII). Pass an empty object to clear previously stored data.

Response

Success.

idstring uuid required

Unique identifier of the provider config.

providerIdstring uuid required

Unique identifier of the provider.

accountNamestring string required

Account name of the provider.

configSchemastring required

JSON schema of the provider configuration.

createdAtstring date-time required

Date of creation of the provider config.

statusstring

The status of the provider config.

configobject
accountDisplayNamestring string required

Account display name of the provider.

workspacesstring[]

Workspaces that the Provider config belongs to.

providerNamestring

Name of the provider.

providerDisplayNamestring

Display name of the provider.

notificationUrlstring

Notification URL for this provider config.

additionalDataobject

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

Changes

No recorded changes to this operation across all 1 revision of this API.