@nht-pandats/sdk / @nht-pandats/sdk/clients / @nht-pandats/sdk/clients/affiliateApi / AffiliateApiDepositModelDefinition

Interface: AffiliateApiDepositModelDefinition

@nht-pandats/sdk/clients.@nht-pandats/sdk/clients/affiliateApi.AffiliateApiDepositModelDefinition

The model definition for a deposit in the Affiliate API.

Since

v1.20240429.0

Hierarchy

• ModuleModelDefinition

  ↳ AffiliateApiDepositModelDefinition

Properties

amount

• amount: Object

The deposit's amount

Type declaration

Name	Type
filters	{ contain: true ; match: true }
filters.contain	true
filters.match	true
inCreatePayload	false
inResponsePayload	true
inUpdatePayload	false
requiredInCreatePayload	false
requiredInUpdatePayload	false
type	number

filters: { contain: true ; match: true }

-

---

filters.contain: true

-

---

filters.match: true

-

---

inCreatePayload: false

-

---

inResponsePayload: true

-

---

inUpdatePayload: false

-

---

requiredInCreatePayload: false

-

---

requiredInUpdatePayload: false

-

---

type: number

-

---

Defined in

src/clients/affiliateApi/deposits.ts:91

---

amountUsd

• amountUsd: Object

The deposit's amount in US Dollars

Type declaration

Name	Type
filters	{ contain: true ; match: true ; range: true }
filters.contain	true
filters.match	true
filters.range	true
inCreatePayload	false
inResponsePayload	true
inUpdatePayload	false
requiredInCreatePayload	false
requiredInUpdatePayload	false
type	number

filters: { contain: true ; match: true ; range: true }

-

---

filters.contain: true

-

---

filters.match: true

-

---

filters.range: true

-

---

inCreatePayload: false

-

---

inResponsePayload: true

-

---

inUpdatePayload: false

-

---

requiredInCreatePayload: false

-

---

requiredInUpdatePayload: false

-

---

type: number

-

---

Defined in

src/clients/affiliateApi/deposits.ts:106

---

confirmationTime

• confirmationTime: Object

The date and time when the deposit was confirmed

Type declaration

Name	Type
filters	{ match: true ; range: true }
filters.match	true
filters.range	true
inCreatePayload	false
inResponsePayload	true
inUpdatePayload	false
requiredInCreatePayload	false
requiredInUpdatePayload	false
type	string

filters: { match: true ; range: true }

-

---

filters.match: true

-

---

filters.range: true

-

---

inCreatePayload: false

-

---

inResponsePayload: true

-

---

inUpdatePayload: false

-

---

requiredInCreatePayload: false

-

---

requiredInUpdatePayload: false

-

---

type: string

-

---

Defined in

src/clients/affiliateApi/deposits.ts:192

---

createdTime

• createdTime: Object

The date and time when the deposit was created

Type declaration

Name	Type
filters	{ match: true ; range: true }
filters.match	true
filters.range	true
inCreatePayload	false
inResponsePayload	true
inUpdatePayload	false
requiredInCreatePayload	false
requiredInUpdatePayload	false
type	string

filters: { match: true ; range: true }

-

---

filters.match: true

-

---

filters.range: true

-

---

inCreatePayload: false

-

---

inResponsePayload: true

-

---

inUpdatePayload: false

-

---

requiredInCreatePayload: false

-

---

requiredInUpdatePayload: false

-

---

type: string

-

---

Defined in

src/clients/affiliateApi/deposits.ts:207

---

currency

• currency: Object

The deposit's currency

Type declaration

Name	Type
filters	{ contain: true ; match: true }
filters.contain	true
filters.match	true
inCreatePayload	false
inResponsePayload	true
inUpdatePayload	false
requiredInCreatePayload	false
requiredInUpdatePayload	false
type	string

filters: { contain: true ; match: true }

-

---

filters.contain: true

-

---

filters.match: true

-

---

inCreatePayload: false

-

---

inResponsePayload: true

-

---

inUpdatePayload: false

-

---

requiredInCreatePayload: false

-

---

requiredInUpdatePayload: false

-

---

type: string

-

---

Defined in

src/clients/affiliateApi/deposits.ts:76

---

customerId

• customerId: Object

The unique identifier of the deposit's customer in the database

Type declaration

Name	Type
filters	{ contain: true ; match: true }
filters.contain	true
filters.match	true
inCreatePayload	false
inResponsePayload	true
inUpdatePayload	false
requiredInCreatePayload	false
requiredInUpdatePayload	false
type	string

filters: { contain: true ; match: true }

-

---

filters.contain: true

-

---

filters.match: true

-

---

inCreatePayload: false

-

---

inResponsePayload: true

-

---

inUpdatePayload: false

-

---

requiredInCreatePayload: false

-

---

requiredInUpdatePayload: false

-

---

type: string

-

---

Defined in

src/clients/affiliateApi/deposits.ts:31

---

declineReason

• declineReason: Object

The deposit's type of payment

Type declaration

Name	Type
inCreatePayload	false
inResponsePayload	true
inUpdatePayload	false
requiredInCreatePayload	false
requiredInUpdatePayload	false
type	null | string

inCreatePayload: false

-

---

inResponsePayload: true

-

---

inUpdatePayload: false

-

---

requiredInCreatePayload: false

-

---

requiredInUpdatePayload: false

-

---

type: null | string

-

---

Defined in

src/clients/affiliateApi/deposits.ts:151

---

email

• email: Object

The email of the deposit's customer in the database

Type declaration

Name	Type
filters	{ contain: true ; match: true }
filters.contain	true
filters.match	true
inCreatePayload	false
inResponsePayload	true
inUpdatePayload	false
requiredInCreatePayload	false
requiredInUpdatePayload	false
type	string

filters: { contain: true ; match: true }

-

---

filters.contain: true

-

---

filters.match: true

-

---

inCreatePayload: false

-

---

inResponsePayload: true

-

---

inUpdatePayload: false

-

---

requiredInCreatePayload: false

-

---

requiredInUpdatePayload: false

-

---

type: string

-

---

Defined in

src/clients/affiliateApi/deposits.ts:61

---

ftd

• ftd: Object

Whether the deposit is a first time deposit

Type declaration

Name	Type
filters	{ match: true }
filters.match	true
inCreatePayload	false
inResponsePayload	true
inUpdatePayload	false
requiredInCreatePayload	false
requiredInUpdatePayload	false
type	boolean

filters: { match: true }

-

---

filters.match: true

-

---

inCreatePayload: false

-

---

inResponsePayload: true

-

---

inUpdatePayload: false

-

---

requiredInCreatePayload: false

-

---

requiredInUpdatePayload: false

-

---

type: boolean

-

---

Defined in

src/clients/affiliateApi/deposits.ts:122

---

id

• id: Object

The unique identifier of the deposit in the database

Type declaration

Name	Type
filters	{ contain: true ; match: true }
filters.contain	true
filters.match	true
inCreatePayload	false
inResponsePayload	true
inUpdatePayload	false
requiredInCreatePayload	false
requiredInUpdatePayload	false
type	string

filters: { contain: true ; match: true }

-

---

filters.contain: true

-

---

filters.match: true

-

---

inCreatePayload: false

-

---

inResponsePayload: true

-

---

inUpdatePayload: false

-

---

requiredInCreatePayload: false

-

---

requiredInUpdatePayload: false

-

---

type: string

-

---

Defined in

src/clients/affiliateApi/deposits.ts:16

---

login

• login: Object

The deposit's login

Type declaration

Name	Type
filters	{ contain: true ; match: true }
filters.contain	true
filters.match	true
inCreatePayload	false
inResponsePayload	true
inUpdatePayload	false
requiredInCreatePayload	false
requiredInUpdatePayload	false
type	string

filters: { contain: true ; match: true }

-

---

filters.contain: true

-

---

filters.match: true

-

---

inCreatePayload: false

-

---

inResponsePayload: true

-

---

inUpdatePayload: false

-

---

requiredInCreatePayload: false

-

---

requiredInUpdatePayload: false

-

---

type: string

-

---

Defined in

src/clients/affiliateApi/deposits.ts:46

---

paymentType

• paymentType: Object

The deposit's type of payment

Type declaration

Name	Type
filters	{ contain: true ; match: true }
filters.contain	true
filters.match	true
inCreatePayload	false
inResponsePayload	true
inUpdatePayload	false
requiredInCreatePayload	false
requiredInUpdatePayload	false
type	string

filters: { contain: true ; match: true }

-

---

filters.contain: true

-

---

filters.match: true

-

---

inCreatePayload: false

-

---

inResponsePayload: true

-

---

inUpdatePayload: false

-

---

requiredInCreatePayload: false

-

---

requiredInUpdatePayload: false

-

---

type: string

-

---

Defined in

src/clients/affiliateApi/deposits.ts:136

---

status

• status: Object

The deposit's status

Type declaration

Name	Type
filters	{ contain: true ; match: true }
filters.contain	true
filters.match	true
inCreatePayload	false
inResponsePayload	true
inUpdatePayload	false
requiredInCreatePayload	false
requiredInUpdatePayload	false
type	"pending" | "Approved" | "Rejected" | "Cancelled"

filters: { contain: true ; match: true }

-

---

filters.contain: true

-

---

filters.match: true

-

---

inCreatePayload: false

-

---

inResponsePayload: true

-

---

inUpdatePayload: false

-

---

requiredInCreatePayload: false

-

---

requiredInUpdatePayload: false

-

---

type: "pending" | "Approved" | "Rejected" | "Cancelled"

-

---

Defined in

src/clients/affiliateApi/deposits.ts:177

---

transactionId

• transactionId: Object

The deposit's transaction ID

Type declaration

Name	Type
filters	{ contain: true ; match: true }
filters.contain	true
filters.match	true
inCreatePayload	false
inResponsePayload	true
inUpdatePayload	false
requiredInCreatePayload	false
requiredInUpdatePayload	false
type	string

filters: { contain: true ; match: true }

-

---

filters.contain: true

-

---

filters.match: true

-

---

inCreatePayload: false

-

---

inResponsePayload: true

-

---

inUpdatePayload: false

-

---

requiredInCreatePayload: false

-

---

requiredInUpdatePayload: false

-

---

type: string

-

---

Defined in

src/clients/affiliateApi/deposits.ts:162