Saltar al contenido principal
Obtener un Saldo por Alias de Cuenta
curl --request GET \
  --url http://127.0.0.1:3001/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts/alias/{alias}/balances \
  --header 'Content-Type: <content-type>'
{
  "id": "<string>",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "alias": "<string>",
  "assetCode": "<string>",
  "available": 123,
  "onHold": 123,
  "scale": 123,
  "version": 123,
  "accountType": "<string>",
  "allowSending": true,
  "allowReceiving": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z"
}

Headers

​
Authorization
string

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

​
Content-Type
string
required

Tipo de medio del recurso. Debe ser <code>application/json</code>.

​
X-Request-Id
string

Identificador único utilizado para rastrear cada solicitud.

Path Parameters

​
organization_id
string
required

Identificador único de la organización asociada con el libro contable.

​
ledger_id
string
required

Identificador único del libro contable asociado.

​
alias
string
required

Alias de la cuenta utilizado en la operación.

Response

Indica que la solicitud se realizó correctamente y que la respuesta contiene los datos esperados.

​
id
string

Identificador único del saldo.

​
organizationId
string<uuid>

Identificador único de la organización.

​
ledgerId
string<uuid>

Identificador único del libro contable.

​
accountId
string<uuid>

Identificador único de la cuenta.

​
alias
string

Alias de la cuenta utilizada en la operación.

​
assetCode
string

Nombre del activo utilizado en la operación.

​
available
integer

Saldo disponible previo.

​
onHold
integer

Monto retenido o reservado.

​
scale
integer

Número de decimales utilizados para mostrar el saldo.

​
version
integer

Versión del saldo, que se actualiza con cada transacción.

​
accountType
string

Tipo de cuenta.

​
allowSending
boolean

Si es true, indica que se permite enviar transacciones.

​
allowReceiving
boolean

Si es true, indica que se permite recibir transacciones.

​
createdAt
string<date-time>

Marca temporal de creación (UTC).

​
updatedAt
string<date-time>

Marca temporal de la última actualización (UTC).

​
deletedAt
string<date-time> | null

Marca temporal de eliminación lógica, si aplica (UTC).