Pular para o conteúdo

Add a redirect domain

Registers a domain in the sub-tenant's allow-list of redirect targets. This is the only way to authorize a new host name to appear as redirectUri in a payment consent.

POST/api/v1/sub-tenants/domains

Add a redirect domain

Adds a domain to the sub-tenant allow-list used to validate redirect URIs in payment consents.

Auth: Bearer Token

Corpo da requisição

2 campos
domain●
bodystring

Domain name to allow as the host of a `redirectUri` (without protocol). Example: `app.example.com.br`.

subTenantId●
bodystring

Business identifier of the sub-tenant that should accept this domain.

curl --request POST \
  --url 'https://embedded-payment-manager.hml.linaob.com.br/api/v1/sub-tenants/domains' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <SEU_TOKEN>' \
  --data '{
  "domain": "app.example.com.br",
  "subTenantId": "subTenant123"
}'

Response

200Domain registered successfully.
Response body
object
  • dataobjectrequired

    Full sub-tenant record, with the `domains[]` list updated.

    • idstringrequired

      Internal ID of the sub-tenant.

    • namestringrequired

      Name of the sub-tenant.

    • subTenantIdstringrequired

      Business identifier of the sub-tenant.

    • eppIamClientIdstringrequired

      IAM client ID used by this sub-tenant.

    • 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.

    • domainsarray of stringrequired

      Updated list of redirect domains allowed for this sub-tenant.

  • messagestring

    Response message.

  • typestring

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

  • statusCodeinteger· nullable

    HTTP status code carried inside the envelope.

200 · Domain registered successfully.
{
  "data": {
    "id": "subTenant123",
    "name": "SubTenant A",
    "subTenantId": "subTenant123",
    "eppIamClientId": "eppClient123",
    "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"
    },
    "domains": [
      "app.example.com.br"
    ]
  },
  "message": "Domain added successfully.",
  "type": "success",
  "statusCode": 200
}

Next steps