Saltar al contenido principal

Cliente

El objeto Cliente es el perfil de tu propia compañía tal como lo ve la API — la cuenta detrás de las credenciales con las que te autenticaste. getMyClient es el único método aquí: una lectura de tu propio registro, sin nada que configurar ni listar.

getMyClient()​

Lee la compañía asociada a las credenciales autenticadas.

Firma​

getMyClient(): Promise<MyClient>

Parámetros​

Ninguno. La compañía se resuelve a partir del token autenticado — no hay un ownerId que pasar.

Retorno​

MyClient:

CampoTipoSignificado
client.idstringId del registro de cliente.
client.clientstringString identificador del cliente.
client.namestringNombre de la compañía.
client.isActivebooleanSi el cliente está activo.
client.permissionsstring[]Permisos otorgados a este cliente.
fundingRecord<string, unknown> | nullObjeto de configuración de fondeo, opaco; null cuando no está configurado. Su forma no se documenta en esta página.

Ejemplo​

import {
RetornaClientBuilder,
RetornaEnvironment,
} from "@retorna-tech/retorna-gateway-sdk";

const client = new RetornaClientBuilder()
.environment(RetornaEnvironment.SANDBOX)
.clientId(process.env.RETORNA_CLIENT_ID!)
.clientSecret(process.env.RETORNA_CLIENT_SECRET!)
.privateKey(process.env.RETORNA_PRIVATE_KEY!)
.buildClient();

const me = await client.getMyClient();
console.log(me.client.name, me.client.isActive);

Errores​

Desde la API (RetornaB2BError, consulta el catálogo de errores):

  • B2B_UNAUTHORIZED — credenciales, token o firma rechazados.
  • B2B_COMPANY_NOT_FOUND — no hay ninguna compañía asociada a las credenciales usadas.

Notas​

  • getMyClient() lee la compañía asociada a tus credenciales — un conjunto de credenciales mapea a exactamente una compañía.
  • Su respuesta es camelCase, a diferencia del resto del contrato snake_case de esta API — pasa el registro subyacente prácticamente tal cual.

Referencia de API​

No existe una página pública de referencia de API para /me/client — sus datos vienen de tu registro de alta, no de un endpoint documentado.