Update a provider config with authenticated onboarding

put

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

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

Path Params

providerId

uuid

required

Identifier of the resource in Payrails.

providerConfigId

uuid

required

Identifier of the resource in Payrails.

Body Params

accountName

string

Account name of the provider.

config

object

accountDisplayName

string

Account display name of the provider.

additionalData

object | null

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.

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

200Success.

400Bad Request.

401Unauthorized.

403Insufficient Scope.

404Not Found.

429Too Many Requests.