Class CoinWithdrawals

CoinWithdrawals - object-oriented interface

export

Hierarchy

BaseAPI
- CoinWithdrawals

Index

Constructors

constructor

Methods

Constructors

constructor

new CoinWithdrawals(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): CoinWithdrawals

Inherited from BaseAPI.constructor
- Defined in src/openapi/base.ts:52
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns CoinWithdrawals

Methods

commit

commit(coinWithdrawalId: string, options?: any): Promise<AxiosResponse<CoinWithdrawalResult>>

- Defined in src/openapi/api.ts:3597
summary
Commit a withdrawal

throws
{RequiredError}

memberof
CoinWithdrawals

Parameters
- coinWithdrawalId: string
  
  Coin withdrawal ID
- Optional options: any
Returns Promise<AxiosResponse<CoinWithdrawalResult>>

create

create(coinWithdrawalParams: CoinWithdrawalParams, options?: any): Promise<AxiosResponse<CoinWithdrawalResult>>

- Defined in src/openapi/api.ts:3609
To create a withdrawal you need to use either charged_amount, charged_amount_to_send or received_amount parameters in your request body.

summary
Create a withdrawal

throws
{RequiredError}

memberof
CoinWithdrawals

Parameters
- coinWithdrawalParams: CoinWithdrawalParams
- Optional options: any
Returns Promise<AxiosResponse<CoinWithdrawalResult>>

list

list(customerId?: string, startingAfter?: string, options?: any): Promise<AxiosResponse<CoinWithdrawalListResult>>

- Defined in src/openapi/api.ts:3622
summary
List withdrawals

throws
{RequiredError}

memberof
CoinWithdrawals

Parameters
- Optional customerId: string
- Optional startingAfter: string
- Optional options: any
Returns Promise<AxiosResponse<CoinWithdrawalListResult>>

listNetworkFees

listNetworkFees(allNetworks?: boolean, options?: any): Promise<AxiosResponse<NetworkFeeListResult>>

- Defined in src/openapi/api.ts:3634
summary
List network fees

throws
{RequiredError}

memberof
CoinWithdrawals

Parameters
- Optional allNetworks: boolean
- Optional options: any
Returns Promise<AxiosResponse<NetworkFeeListResult>>

retrieve

retrieve(coinWithdrawalId: string, options?: any): Promise<AxiosResponse<CoinWithdrawalResult>>

- Defined in src/openapi/api.ts:3646
summary
Retrieve a withdrawal

throws
{RequiredError}

memberof
CoinWithdrawals

Parameters
- coinWithdrawalId: string
  
  Coin withdrawal ID
- Optional options: any
Returns Promise<AxiosResponse<CoinWithdrawalResult>>

retrieveByCustomId

retrieveByCustomId(customId: string, options?: any): Promise<AxiosResponse<CoinWithdrawalResult>>

- Defined in src/openapi/api.ts:3658
summary
Retrieve a withdrawal by custom id

throws
{RequiredError}

memberof
CoinWithdrawals

Parameters
- customId: string
- Optional options: any
Returns Promise<AxiosResponse<CoinWithdrawalResult>>

Generated using TypeDoc