Esta versión (v0.7) todavía no se publicó en npm.
Ir al contenido

Claves PIX ​

El namespace pixKeys guarda las claves PIX del jugador, usadas como destino de los retiros (withdrawals.request({ amount, pixKeyId })). Todos los métodos requieren inicio de sesión.

Listar ​

ts
const keys = await enginex.pixKeys.list()
const preferred = keys.find((k) => k.isDefault) ?? keys[0]
// { id, keyType: 'cpf', maskedKeyValue: '***.456.789-**', isDefault: true, verified: true, createdAt }

El valor completo de la clave nunca vuelve del gateway: solo maskedKeyValue, para mostrar. verified indica si el servicio de pagos ya confirmó la titularidad.

Registrar ​

ts
const key = await enginex.pixKeys.add({ keyType: 'email', keyValue: 'ana@exemplo.com' })
key.maskedKeyValue // masked version, e.g. 'a***.com'

keyType es 'cpf', 'email', 'phone' o 'random' (clave aleatoria). Un tipo o valor vacío se rechaza con INVALID_ARGUMENT (400); una clave inválida o repetida vuelve como error del servicio de pagos: trátalo por el code (consulta Errores).

Clave predeterminada y eliminación ​

ts
await enginex.pixKeys.setDefault({ keyId: key.id }) // becomes the one suggested for withdrawals
await enginex.pixKeys.remove({ keyId: oldKey.id })

Ambos se resuelven sin valor; vuelve a listar para actualizar la pantalla. Un id inexistente (o de otro jugador) llega como error del gateway, por lo general NOT_FOUND.

Retiro sin clave guardada ​

No es obligatorio registrar la clave antes: withdrawals.request también acepta pixKeyType + pixKeyValue en el momento, y con pixKeyType: 'cpf' usa el CPF del registro sin necesitar el valor.