API ReferenceEndpointsPublic API (v1)Replace the region enabled payment providers

Replace the region enabled payment providers

Replaces the enabled payment providers of the region with exactly the listed installations. An empty list disables all.

PUT
/v1/regions/{regionId}/payment-providers
AuthorizationBearer <token>

Admin API key (server-to-server). Issue via the dashboard at Settings → API keys. Plain-text key is shown once — store in a secret manager. Format: Authorization: Bearer brainerce_xxxxxxxxx.

In: header

Path Parameters

regionIdstring

Region ID

providerIdsarray<string>

Installed payment provider IDs (app installation IDs) enabled for the region. Replaces the whole set: providers not listed are removed from the region, and an empty array removes all. Each must be an installed payment app of the store that is available in the region countries.

curl -X PUT "https://api.brainerce.com/api/v1/regions/string/payment-providers" \  -H "Content-Type: application/json" \  -d '{    "providerIds": [      "clx1a2b3c4d5e6f7g8h9"    ]  }'
{
  "id": "clx1a2b3c4d5e6f7g8h9",
  "accountId": "clx1a2b3c4d5e6f7g8h9",
  "storeId": "clx1a2b3c4d5e6f7g8h9",
  "name": "Israel",
  "slug": "israel",
  "currency": "USD",
  "fxBufferPercent": "2.00",
  "countries": [
    "string"
  ],
  "provinces": {},
  "taxInclusive": true,
  "effectiveTaxInclusive": true,
  "automaticTaxes": true,
  "isDefault": true,
  "isActive": true,
  "metadata": {},
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "paymentProviders": [
    {
      "id": "clx1a2b3c4d5e6f7g8h9",
      "regionId": "clx1a2b3c4d5e6f7g8h9",
      "appInstallationId": "clx1a2b3c4d5e6f7g8h9",
      "isEnabled": true,
      "createdAt": "2019-08-24T14:15:22Z"
    }
  ]
}

{
  "statusCode": 400,
  "code": "VALIDATION_FAILED",
  "message": "name should not be empty, price must be a positive number",
  "timestamp": "2026-08-23T10:15:00.000Z",
  "path": "/api/v1/regions/{regionId}/payment-providers"
}

{
  "statusCode": 401,
  "code": "UNAUTHORIZED",
  "message": "Invalid or expired credential",
  "timestamp": "2026-08-23T10:15:00.000Z",
  "path": "/api/v1/products/bulk/{jobId}"
}

{
  "statusCode": 403,
  "code": "INSUFFICIENT_SCOPE",
  "message": "API key does not have the required scope: products:write",
  "timestamp": "2026-08-23T10:15:00.000Z",
  "path": "/api/v1/regions/{regionId}/payment-providers"
}

{
  "statusCode": 404,
  "code": "RESOURCE_NOT_FOUND",
  "message": "Resource not found",
  "timestamp": "2026-08-23T10:15:00.000Z",
  "path": "/api/v1/regions/{regionId}/payment-providers"
}

{
  "statusCode": 429,
  "code": "RATE_LIMITED",
  "message": "Too many requests",
  "details": {
    "retryAfterSeconds": 12
  },
  "timestamp": "2026-08-23T10:15:00.000Z",
  "path": "/api/v1/store"
}