The BancolombiaClient provides methods to manage Bancolombia accounts.
create() Create a new Bancolombia account.
await bloque . accounts . bancolombia . create ( params ?: CreateBancolombiaAccountParams , options ?: CreateAccountOptions ): Promise < BancolombiaAccount >
Parameters params
CreateBancolombiaAccountParams
Bancolombia account creation parameters Display name for the account
Ledger account ID to associate with the Bancolombia account
Webhook URL to receive account events
Custom metadata to attach to the Bancolombia account
Creation options Wait for account to become active before returning
Timeout in milliseconds (default: 60000)
Returns Unique resource name for the Bancolombia account
Reference code for the Bancolombia account
status
'creation_in_progress' | 'active' | 'disabled' | 'frozen' | 'deleted' | 'creation_failed'
Account status
Ledger account ID associated with the account
Webhook URL (if configured)
Token balances (optional, included in list responses and after creation)
Example // Create without waiting const account = await bloque . accounts . bancolombia . create ({ name: 'Main Account' }); // Create and wait for active status const account = await bloque . accounts . bancolombia . create ({ name: 'Main Account' }, { waitLedger: true });
list() List Bancolombia accounts.
await bloque . accounts . bancolombia . list ( params ?: ListBancolombiaAccountsParams ): Promise < ListBancolombiaAccountsResult >
Parameters params
ListBancolombiaAccountsParams
List parameters URN of a specific Bancolombia account to retrieve
Returns ListBancolombiaAccountsResult
Array of Bancolombia accounts with balance information
Example // List all Bancolombia accounts const result = await bloque . accounts . bancolombia . list (); // Get a specific Bancolombia account const result = await bloque . accounts . bancolombia . list ({ urn: 'did:bloque:account:bancolombia:abc-123' });
Update Bancolombia account metadata.
await bloque . accounts . bancolombia . updateMetadata ( params : UpdateBancolombiaMetadataParams ): Promise < BancolombiaAccount >
Parameters params
UpdateBancolombiaMetadataParams
Metadata update parameters URN of the Bancolombia account to update
metadata
Record<string, unknown>
required
Metadata to update (name and source are reserved fields and cannot be modified)
Returns Updated Bancolombia account
Example const account = await bloque . accounts . bancolombia . updateMetadata ({ urn: 'did:bloque:mediums:bancolombia:account:123' , metadata: { updated_by: 'admin' , update_reason: 'customer_request' } });
updateName() Update Bancolombia account name.
await bloque . accounts . bancolombia . updateName ( urn : string , name : string ): Promise < BancolombiaAccount >
Parameters Returns Updated Bancolombia account
Example const account = await bloque . accounts . bancolombia . updateName ( 'did:bloque:mediums:bancolombia:account:123' , 'Main Business Account' );
activate() Activate a Bancolombia account.
await bloque . accounts . bancolombia . activate ( urn : string ): Promise < BancolombiaAccount >
Parameters Returns Updated Bancolombia account
Example const account = await bloque . accounts . bancolombia . activate ( 'did:bloque:mediums:bancolombia:account:123' );
freeze() Freeze a Bancolombia account.
await bloque . accounts . bancolombia . freeze ( urn : string ): Promise < BancolombiaAccount >
Parameters Returns Updated Bancolombia account
Example const account = await bloque . accounts . bancolombia . freeze ( 'did:bloque:mediums:bancolombia:account:123' );
disable() Disable a Bancolombia account.
await bloque . accounts . bancolombia . disable ( urn : string ): Promise < BancolombiaAccount >
Parameters Returns Updated Bancolombia account
Example const account = await bloque . accounts . bancolombia . disable ( 'did:bloque:mediums:bancolombia:account:123' );