Saltar al contenido principal
Crear una cuenta alias
curl --request POST \
  --url http://127.0.0.1:4003/v1/holders/{holder_id}/aliases \
  --header 'Content-Type: application/json' \
  --header 'X-Lerian-Id: <x-lerian-id>' \
  --header 'X-Organization-Id: <x-organization-id>' \
  --data '{
  "ledgerId": "77b0fb8b-1bd9-4810-9c6d-7e80064fab0c",
  "accountId": "0194fa41-5333-77c7-91fe-309fb4618155",
  "bankingDetails": {
    "branch": "0001",
    "account": "123450",
    "type": "CACC",
    "openingDate": "2010-01-01",
    "iban": "US12345678901234567890",
    "countryCode": "US",
    "bankId": "12345"
  },
  "metadata": {
    "key": "value"
  }
}'
{
  "id": "01951ad1-9f62-793a-9095-fe7701f94434",
  "holderId": "0194f0ea-2cb2-78c9-b9be-704ba20a9cd8",
  "document": "08912345965",
  "ledgerId": "77b0fb8b-1bd9-4810-9c6d-7e80064fab0c",
  "accountId": "0194fa41-5333-77c7-91fe-309fb4618155",
  "metadata": {
    "key": "value"
  },
  "bankingDetails": {
    "branch": "0001",
    "account": "123450",
    "type": "CACC",
    "openingDate": "2010-01-01",
    "iban": "US12345678901234567890",
    "countryCode": "US",
    "bankId": "12345"
  },
  "createdAt": "2024-12-17T14:34:09.191705548Z",
  "updatedAt": "2024-12-17T14:34:09.191705648Z",
  "deletedAt": null
}

Headers

Authorization
string

Token de autorización. Este encabezado es obligatorio si tu entorno tiene habilitado el plugin Access Manager.

X-Organization-Id
string
required

Identificador único de la organización asociada a la solicitud.

X-Lerian-Id
string
required

Identificador único del cliente de Lerian, generado y asignado por Lerian.

Path Parameters

holder_id
string
required

Identificador único del titular que se asociará a la cuenta.

Body

application/json

Detalles de la cuenta alias.

accountId
string
required

Identificador único de la cuenta contable de Midaz.

ledgerId
string
required

Identificador único del libro contable de Midaz asociado a la cuenta.

bankingDetails
object

Detalles de la cuenta bancaria del titular.

metadata
object

Objeto que contiene pares clave-valor para agregar como metadata, donde el nombre del campo es la clave y el valor es el valor.

Response

Creado

Información sobre la cuenta alias.

id
string

Identificador único de la cuenta alias.

holderId
string

Identificador único del titular.

type
enum<string>

Tipo de titular.

Opciones disponibles:
LEGAL_PERSON,
NATURAL_PERSON
document
string

Documento de identificación del titular.

ledgerId
string

Identificador único del libro contable de Midaz de la cuenta relacionada.

accountId
string

Identificador único de la cuenta relacionada.

bankingDetails
object

Detalles de la cuenta bancaria del titular.

metadata
object

Objeto que contiene pares clave-valor para agregar como metadata, donde el nombre del campo es la clave y el valor es el valor.

createdAt
string

Fecha en que se creó la cuenta alias.

updatedAt
string

Fecha de la última actualización de la cuenta alias.

deletedAt
string

Fecha en que la cuenta alias fue eliminada.