Sign in
ProviderConfigs

Provider config by ID

Retrieve the provider config by its ID.

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

Path parameters

providerIdstring uuid required

Identifier of the optional resource (Could be empty) in Payrails.

providerConfigIdstring uuid required

Identifier of the resource in Payrails.

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 endpoint across all 1 revision of this API.