This version (v0.7) has not been published to npm yet.
Skip to content

Reference / @getenginex/sdk / PixKey

PixKey ​

Saved PIX key of the player. The full value never comes back from the gateway: only the masked version, for display.

Properties ​

createdAt ​

createdAt: string

Registration date, ISO 8601 (UTC).


id ​

id: string

Key id, for withdrawals (pixKeyId), PixKeysApi.remove and PixKeysApi.setDefault.


isDefault ​

isDefault: boolean

Default key for withdrawals.


keyType ​

keyType: string & object | PixKeyType

Key type, e.g. email.


maskedKeyValue ​

maskedKeyValue: string

Masked value for display, e.g. a***@exemplo.com.


verified ​

verified: boolean

Ownership already verified by the payment service.