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

Reference / @getenginex/sdk / Deposit

Deposit ​

Deposit (GET /deposits/{id}).

Properties ​

amount ​

amount: number

Amount in minor units of currency.


createdAt ​

createdAt: string

Creation date, ISO 8601 (UTC).


currency ​

currency: string

Currency code, e.g. BRL.


expiresAt? ​

optional expiresAt?: string

Validity of the charge, ISO 8601 (UTC); absent when the payment provider did not report one.


id ​

id: string

Deposit id.


method ​

method: string

Payment method, without the PAYMENT_METHOD_ prefix and in lowercase, e.g. pix.


redirectUrl? ​

optional redirectUrl?: string

Payment page of the provider, when it offers one.


status ​

status: DepositStatus

Status; completed when the payment was confirmed and credited.