Pular para o conteúdo

List sub-tenants by user CPF

Returns sub-tenant identifiers associated with a user CPF that have active automatic payment requests. Use it to discover which subTenantId values apply before calling List automatic payment requests by user CPF.

GET/api/v1/automatic-payments/subtenants/{cpf}

Get sub-tenants by user CPF

Lists sub-tenants linked to automatic payment activity for the given CPF.

Auth: Bearer Token

Parâmetros de path

1 campo
cpf●
pathstring

User CPF (digits only).

curl --request GET \
  --url 'https://embedded-payment-manager.hml.linaob.com.br/api/v1/automatic-payments/subtenants/12345678901' \
  --header 'Authorization: Bearer <SEU_TOKEN>'

Response

200Sub-tenants returned.
Response body
object
  • dataarray of objectsrequired

    Entries may include subTenantId and display name — see OpenAPI example.

    • itemobject
  • messagestring
  • typestring
200 · Sub-tenants returned.
{
  "data": [
    {
      "subTenantId": "subtenant-123",
      "name": "Company ABC"
    }
  ],
  "message": "",
  "type": "success"
}

Next steps