Class default

Hierarchy

default

Index

Constructors

constructor

new default(client: default): default
Parameters
- client: default
Returns default
- Defined in services/FundAccount/index.ts:27

Properties

client

client: default

Methods

activate

activate(accountId: string): Promise<void>
Activates a fund account

Link
https://razorpay.com/docs/api/x/fund-accounts#activate-or-deactivate-a-fund-account
Parameters
- accountId: string
Returns Promise<void>
- Defined in services/FundAccount/index.ts:97

create

create(accountInfo: Object): Promise<FundAccountBank | FundAccountVPA>
Creates a fund account for a contact

Link
https://razorpay.com/docs/api/x/fund-accounts#create-a-fund-account
Parameters
- accountInfo: Object
Returns Promise<FundAccountBank | FundAccountVPA>
- Defined in services/FundAccount/index.ts:34

deactivate

deactivate(accountId: string): Promise<void>
Deactivates a fund account

Link
https://razorpay.com/docs/api/x/fund-accounts#activate-or-deactivate-a-fund-account
Parameters
- accountId: string
Returns Promise<void>
- Defined in services/FundAccount/index.ts:107

get

get(accountId: string): Promise<FundAccountBank | FundAccountVPA>
Fetches details of an fund account

Link
https://razorpay.com/docs/api/x/fund-accounts#fetch-fund-account-details-by-id
Parameters
- accountId: string
Returns Promise<FundAccountBank | FundAccountVPA>
- Defined in services/FundAccount/index.ts:64

getAll

getAll(filter?: Pageable & Partial<Pick<FundAccount, "contact_id" | "account_type">>): Promise<Response<FundAccountBank | FundAccountVPA>>
Fetches all fund accounts

Link
https://razorpay.com/docs/api/x/fund-accounts#fetch-all-fund-accounts
Parameters
- filter: Pageable & Partial<Pick<FundAccount, "contact_id" | "account_type">> = {}
Returns Promise<Response<FundAccountBank | FundAccountVPA>>
- Defined in services/FundAccount/index.ts:49

validate

validate(accountInfo: { account_number: string; amount: number; currency: "INR"; fund_account: { id: string }; notes?: Record<string, string> }): Promise<unknown>
validate the fund account

Link
https://razorpay.com/docs/api/x/account-validation#validate-a-bank-account

Link
https://razorpay.com/docs/api/x/account-validation#validate-a-vpa
Parameters
- accountInfo: { account_number: string; amount: number; currency: "INR"; fund_account: { id: string }; notes?: Record<string, string> }
  - account_number: string
  - amount: number
  - currency: "INR"
  - fund_account: { id: string }
    - id: string
  - Optional notes?: Record<string, string>
Returns Promise<unknown>
- Defined in services/FundAccount/index.ts:77

Class default

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

client: default

Returns default

Properties

client

Methods

activate

Link

Parameters

accountId: string

Returns Promise<void>

create

Link

Parameters

accountInfo: Object

Returns Promise<FundAccountBank | FundAccountVPA>

deactivate

Link

Parameters

accountId: string

Returns Promise<void>

get

Link

Parameters

accountId: string

Returns Promise<FundAccountBank | FundAccountVPA>

getAll

Link

Parameters

filter: Pageable & Partial<Pick<FundAccount, "contact_id" | "account_type">> = {}

Returns Promise<Response<FundAccountBank | FundAccountVPA>>

validate

Link

Link

Parameters

accountInfo: { account_number: string; amount: number; currency: "INR"; fund_account: { id: string }; notes?: Record<string, string> }

account_number: string

amount: number

currency: "INR"

fund_account: { id: string }

id: string

Optional notes?: Record<string, string>

Returns Promise<unknown>

Settings

Member Visibility

Theme

`Optional` notes?: Record<string, string>