Saltar al contenido principal
POST
/
v1
/
holders
/
{holder_id}
/
aliases
Crear una cuenta alias
curl --request POST \
  --url https://crm.sandbox.lerian.net/v1/holders/{holder_id}/aliases \
  --header 'Content-Type: application/json' \
  --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

El token de autorización en formato 'Bearer <token>'.
Importante: Este encabezado es obligatorio si su entorno tiene habilitado Access Manager. Para obtener más información, consulte la documentación de Access Manager.

X-Organization-id
string
required

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

Example:

"01946120-0f45-7c5f-86a0-0ea7c59fdbd4"

Path Parameters

holder_id
string
required

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

Body

application/json

Detalles sobre la cuenta alias.

accountId
string
required

Identificador único de la cuenta de Midaz Ledger.

ledgerId
string
required

Identificador único del Ledger 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 metadatos, donde el campo name es la clave y el campo value es el valor. Por ejemplo, para añadir un centro de costos, usa costCenter: BR_11101997.

Response

Indica que el recurso se creó correctamente y que la operación se completó según lo esperado.

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 Ledger de Midaz asociado a la cuenta.

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 metadatos, donde el campo name es la clave y el campo value es el valor. Por ejemplo, para añadir un centro de costos, usa costCenter: BR_11101997.

createdAt
string

Fecha en la que se creó la cuenta alias.

updatedAt
string

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

deletedAt
string

Fecha en la que se eliminó la cuenta alias.