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

Interface: ListDepositOptions

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

The options to use when listing customer deposits via the Affiliate API.

Since

v1.20240429.0

Hierarchy

• ListMethodOptions<AffiliateApiDepositModelDefinition>

  ↳ ListDepositOptions

Properties

fields

• Optional fields: keyof AffiliateApiDepositModelDefinition[]

The fields to return in the response. If not provided, all fields will be returned.

Inherited from

ListMethodOptions.fields

Defined in

src/clients/affiliateApi/utils.ts:563

---

filter

• Optional filter: Filters<AffiliateApiDepositModelDefinition>

The filters to apply to the results.

Inherited from

ListMethodOptions.filter

Defined in

src/clients/affiliateApi/utils.ts:567

---

limit

• Optional limit: number

The maximum number of results to return. Cannot exceed 200.

Inherited from

ListMethodOptions.limit

Defined in

src/clients/affiliateApi/utils.ts:559

---

page

• Optional page: number

The page number of the results to return.

Inherited from

ListMethodOptions.page

Defined in

src/clients/affiliateApi/utils.ts:555

---

sort

• Optional sort: Object

The field and order to sort the results by.

Type declaration

Name	Type
asc	undefined
desc	undefined

asc: undefined

-

---

desc: undefined

-

---

Inherited from

ListMethodOptions.sort

Defined in

src/clients/affiliateApi/utils.ts:571