Saltar al contenido principal
GET
/
v1
/
organizations
/
{organization_id}
/
ledgers
/
{ledger_id}
/
accounts
/
alias
/
{alias}
/
balances
Obtener un Saldo por Alias ​​de Cuenta
curl --request GET \
  --url https://transaction.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts/alias/{alias}/balances \
  --header 'Content-Type: <content-type>'
{
  "id": "string",
  "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  "ledgerId": "a2873d47-59a8-4daf-a325-cb2c04557dd7",
  "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
  "alias": "string",
  "key": "string",
  "assetCode": "string",
  "available": "1000.00",
  "onHold": "50.00",
  "version": 0,
  "accountType": "string",
  "allowSending": true,
  "allowReceiving": true,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "deletedAt": null
}

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 application/json.

​
X-Request-Id
string

Identificador único usado para rastrear cada solicitud.

Path Parameters

​
organization_id
string
required

Identificador único de la organización asociada al ledger.

​
ledger_id
string
required

Identificador único del ledger asociado.

​
alias
string
required

Alias de la cuenta usado en la operación.

Response

Indica que la solicitud se realizó correctamente y 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 ledger.

​
accountId
string<uuid>

Identificador único de la cuenta.

​
alias
string

Alias de la cuenta usado en la operación.

​
key
string

Identificador único del saldo en el contexto de la cuenta.

​
assetCode
string

Nombre del activo utilizado en la operación.

​
available
string

Saldo disponible previo.

​
onHold
string

Monto retenido/reservado.

​
version
integer

Versión del saldo, actualizada con cada transacción.

​
accountType
string

Tipo de cuenta.

​
allowSending
boolean

Si es true, indica que el saldo puede usarse para enviar transacciones.

​
allowReceiving
boolean

Si es true, indica que el saldo puede usarse para recibir transacciones.

​
createdAt
string<date-time>

Marca de tiempo de creación (UTC).

​
updatedAt
string<date-time>

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

​
deletedAt
string<date-time> | null

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

​
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 agregar un centro de costos, usa 'costCenter': 'BR_11101997'.