Pular para o conteúdo

Create a sub-tenant

Creates a new sub-tenant under your tenant. Sub-tenants isolate credentials, allowed redirect domains, webhooks, and branding. The response carries the eppIamClientId and eppIamClientSecret you will use to authenticate every API call scoped to this sub-tenant.

POST/api/v1/sub-tenants

Create a sub-tenant

Creates a new sub-tenant under the caller tenant and returns its credentials and branding.

Auth: Bearer Token

Corpo da requisição

7 campos
name●
bodystring

Human-readable name of the sub-tenant.

subTenantId●
bodystring

Your own identifier for the sub-tenant. Must be unique within the tenant.

urlLogo
bodystring

URL of the sub-tenant logo (used in the White Label portal).

primaryColor
bodystring

Primary brand color (hex).

secondaryColor
bodystring

Secondary brand color (hex).

urlFont
bodystring

URL of the custom font file used by the sub-tenant.

nameFont
bodystring

Font family name to apply.

curl --request POST \
  --url 'https://embedded-payment-manager.hml.linaob.com.br/api/v1/sub-tenants' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <SEU_TOKEN>' \
  --data '{
  "name": "SubTenant A",
  "subTenantId": "subTenant123",
  "urlLogo": "http://example.com/logo.png",
  "primaryColor": "#000000",
  "secondaryColor": "#FFFFFF",
  "urlFont": "http://example.com/font.ttf",
  "nameFont": "Arial"
}'

Response

200Sub-tenant created successfully.
Response body
object
  • dataobjectrequired

    Details of the sub-tenant that was just created.

    • idstringrequired

      Internal ID of the created sub-tenant.

    • namestringrequired

      Name of the sub-tenant.

    • subTenantIdstringrequired

      Business identifier of the sub-tenant.

    • eppIamClientIdstringrequired

      IAM client ID used by this sub-tenant to obtain access tokens.

    • eppIamClientSecretstringrequired

      IAM client secret in plain text. Returned only at creation — store it immediately.

    • urlLogostringrequired

      URL of the sub-tenant logo.

    • primaryColorstringrequired

      Primary brand color (hex).

    • secondaryColorstringrequired

      Secondary brand color (hex).

    • urlFontstringrequired

      URL of the sub-tenant font file.

    • nameFontstringrequired

      Font family name.

    • tenantobjectrequired

      Parent tenant this sub-tenant belongs to.

  • messagestring

    Response message.

  • typestring

    Response type. One of `error`, `warning`, `info`, `success`.

  • statusCodeinteger· nullable

    HTTP status code carried inside the envelope.

200 · Sub-tenant created successfully.
{
  "data": {
    "id": "subTenant123",
    "name": "SubTenant A",
    "subTenantId": "subTenant123",
    "eppIamClientId": "eppClient123",
    "eppIamClientSecret": "eppClientSecret",
    "urlLogo": "http://example.com/logo.png",
    "primaryColor": "#000000",
    "secondaryColor": "#FFFFFF",
    "urlFont": "http://example.com/font.ttf",
    "nameFont": "Arial",
    "tenant": {
      "tenantId": "tenant123",
      "name": "Tenant A",
      "rpIamClientId": "rpClient123"
    }
  },
  "message": "Sub-tenant created successfully.",
  "type": "success",
  "statusCode": 200
}

Next steps