Methods
cancel
- cancel(payoutId: string): Promise<void>
-
Returns Promise<void>
create
- create(payoutInfo: Pick<Payout, "reference_id" | "notes" | "account_number" | "fund_account_id" | "amount" | "currency" | "mode" | "purpose" | "narration"> & { queue_if_low_balance?: boolean }): Promise<Payout>
-
Parameters
-
payoutInfo: Pick<Payout, "reference_id" | "notes" | "account_number" | "fund_account_id" | "amount" | "currency" | "mode" | "purpose" | "narration"> & { queue_if_low_balance?: boolean }
Returns Promise<Payout>
get
- get(payoutId: string): Promise<Payout>
-
Returns Promise<Payout>
getAll
- getAll(accountNumber: undefined | string, filter?: Pageable & Partial<Pick<Payout, "reference_id" | "fund_account_id" | "mode" | "status">> & { contact_id?: string }): Promise<Response<Payout>>
-
Parameters
-
accountNumber: undefined | string
-
filter: Pageable & Partial<Pick<Payout, "reference_id" | "fund_account_id" | "mode" | "status">> & { contact_id?: string } = {}
Cancels the payout for given payoutId
Link
https://razorpay.com/docs/api/x/payouts/#cancel-a-queued-payout