#Referencia de API

Esta página lista los métodos públicos actuales disponibles en el SDK.

#Clase SDK (@bloque/sdk)

import { SDK } from '@bloque/sdk';

const bloque = new SDK(config);

Métodos:

• assert(origin, alias)
• authenticate()
• me()
• register(alias, params)
• connect(alias)
• connect(origin, alias, code)

#API Modular (@bloque/sdk)

import { init, Accounts, Compliance, Identity, Orgs, Swap } from '@bloque/sdk/init';

init(config);

Exports:

• init(config)
• Accounts (AccountsClient)
• Compliance (ComplianceClient)
• Identity (IdentityClient)
• Orgs (OrgsClient)
• Swap (SwapClient)

#Accounts

Nivel superior (AccountsClient):

• balance(urn)
• balances()
• get(urn)
• list(params?)
• transfer(params)
• batchTransfer(params)
• movements(params)
• transactions(params?) (transacciones globales, sin URN de cuenta)

Card (accounts.card):

• create(params?, options?)
• list(params?)
• movements(params)
• balance(params)
• updateMetadata(params)
• updateName(urn, name)
• activate(urn)
• freeze(urn)
• disable(urn)

Virtual (accounts.virtual):

• create(params, options?)
• list(params?)
• updateMetadata(params)
• activate(urn)
• freeze(urn)
• disable(urn)

Bancolombia (accounts.bancolombia):

• create(params?, options?)
• list(params?)
• updateMetadata(params)
• updateName(urn, name)
• activate(urn)
• freeze(urn)
• disable(urn)

US (accounts.us):

• getTosLink(params)
• create(params, options?)
• list(params?)
• updateMetadata(params)
• activate(urn)
• freeze(urn)
• disable(urn)

Polygon (accounts.polygon):

• create(params, options?)
• list(params?)
• updateMetadata(params)
• activate(urn)
• freeze(urn)
• disable(urn)

#Compliance

KYC (compliance.kyc):

• startVerification(params)
• getVerification(params)

#Identity

Nivel superior (identity):

• me()

Aliases (identity.aliases):

• get(alias)

Origins (identity.origins):

• list()
• register(alias, origin, params)
• custom(origin).assert(alias)
• whatsapp.assert(alias)
• email.assert(alias)

#Organizations

Nivel superior (orgs):

• create(params)

#Swap

Nivel superior (swap):

• findRates(params)

PSE (swap.pse):

• banks()
• create(params)

Bank Transfer (swap.bankTransfer):

• create(params)