Sign in

v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB
Provider Configurations API

Create a Provider Configuration

Use this endpoint to create a new provider configuration. The configuration is validated against the provider's JSON Schema.

post/v1/provider-configurations

Request body

configobject required

Provider-specific configuration that is validated against the provider's JSON Schema.

descriptionstring

Human-readable description of this provider configuration.

metadataobject

Custom key-value pairs for tagging.

namestring required

Unique name for this provider configuration.

providerIdstring required

ID of the catalog provider to configure. Must match a registered provider.

Example request

{
  "config": {
    "baseUrl": "https://api.clearsale.com.br",
    "apiKey": "cs-key-abc123",
    "environment": "production"
  },
  "description": "ClearSale anti-fraud for Pix transactions",
  "metadata": {
    "environment": "production",
    "team": "risk"
  },
  "name": "ClearSale Production",
  "providerId": "clearsale"
}

Response

Indicates that the resource was successfully created and the operation was completed as expected.

createdAtstring date-time

Timestamp when the configuration was created.

idstring uuid

Unique identifier of the created configuration.

namestring

Name of the configuration.

statusstring

Initial status (always active on creation).

Example response

{
  "createdAt": "2026-03-17T14:00:00Z",
  "id": "c3d4e5f6-a7b8-9012-cdef-345678901234",
  "name": "ClearSale Production",
  "status": "active"
}