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

Reference / @getenginex/sdk / PixDeposit

PixDeposit ​

PIX charge created by DepositsApi.createPix: show the QR code and the copy-and-paste code until expiresAt (when the payment provider gives one). The balance only changes when the payment is confirmed (track it with DepositsApi.get or through the balance).

Properties ​

amount ​

amount: number

Amount in minor units of the operator's currency (the same one sent).


expiresAt? ​

optional expiresAt?: string

Validity of the charge, ISO 8601 (UTC). After that, create another one. Absent when the operator's payment provider does not report an expiry: do not show a countdown then.


id ​

id: string

Deposit id, for DepositsApi.get.


qrCode ​

qrCode: string

QR code of the charge, as the operator's payment provider delivers it (check with the provider whether it is a base64 image or the payload itself to generate the image).


qrCodeText ​

qrCodeText: string

PIX copy-and-paste code (the EMV payload), for the "copy" button.


redirectUrl? ​

optional redirectUrl?: string

Payment page of the provider, when it offers one (e.g. to pay in the bank's app or site).