Pular para o conteúdo principal
POST
/
v1
/
organizations
/
{organization_id}
/
ledgers
/
{ledger_id}
/
segments
Criar um Segmento
curl --request POST \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/segments \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "name": "Premium Retail Segment",
  "status": {
    "code": "ACTIVE",
    "description": "Customer segment for high-value retail clients with enhanced services and limits"
  },
  "metadata": {
    "minMonthlyIncome": 10000,
    "creditScoreThreshold": 750,
    "tier": "Gold",
    "fxEnabled": true,
    "overdraftEligibility": true,
    "dailyTransferLimit": 50000,
    "segmentationSource": "internal_scoring_engine",
    "notes": "Applied automatically based on KYC score and account history"
  }
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "status": "<unknown>",
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z"
}

Cabeçalhos

​
Authorization
string

O token de autorização. Este cabeçalho é obrigatório se o seu ambiente tiver o Access Manager habilitado.

​
Content-Type
string
obrigatório

O tipo de mídia do recurso. Deve ser application/json.

​
X-Request-Id
string<uuid>

Um identificador único utilizado para rastrear e acompanhar cada requisição.

Parâmetros de caminho

​
organization_id
string
obrigatório

O identificador único da Organização associada ao Ledger.

​
ledger_id
string
obrigatório

O identificador único do Ledger associado.

Corpo

application/json
​
name
string
obrigatório

O nome do Segmento.

Maximum string length: 256
​
status
object

Um objeto contendo informações sobre o status. Importante: Se não fornecido, o status padrão será 'ACTIVE'.

​
metadata
object

Um objeto contendo pares de chave-valor para adicionar como metadata, onde o campo name é a chave e o campo value é o valor. Por exemplo, para adicionar um Centro de Custo, use 'costCenter': 'BR_11101997'.

Resposta

Indica que a requisição foi bem-sucedida e a resposta contém os dados esperados.

​
id
string<uuid>

O identificador único do Segmento.

​
organizationId
string<uuid>

O identificador único da Organização.

​
ledgerId
string<uuid>

O identificador único do Ledger.

​
name
string

O nome do Segmento.

Maximum string length: 256
​
status
any
​
metadata
object

Um objeto contendo pares de chave-valor para adicionar como metadata, onde o campo name é a chave e o campo value é o valor. Por exemplo, para adicionar um Centro de Custo, use 'costCenter': 'BR_11101997'.

​
createdAt
string<date-time>

Data e hora de criação (UTC).

​
updatedAt
string<date-time>

Data e hora da última atualização (UTC).

​
deletedAt
string<date-time> | null

Data e hora da exclusão lógica, se aplicável (UTC).