Class WithdrawalService

Service class for managing withdrawals related operations.

Hierarchy

ApiService
- WithdrawalService

Index

Methods

confirm create get getAll getOptions preview getInstance

Methods

confirm

confirm(withdrawalConfirm: WithdrawalConfirm): Promise<Withdrawal>
Requests a withdrawal status update.
Parameters
- withdrawalConfirm: WithdrawalConfirm
  The withdrawal confirm request.
Returns Promise<Withdrawal>
A promise that resolves to the updated withdrawal.
Throws
If the HTTP request fails.
Example
```
// Example usage:
withdrawalService.confirm(withdrawalId)
  .then((response) => {
    console.log(response);
  })
  .catch((error) => {
    console.error(`Error processing withdrawal.`);
  });
```
- Defined in withdrawals/services/withdrawal.service.ts:185

create

create(withdrawalCreate: WithdrawalCreate): Promise<Withdrawal>
Requests a withdrawal creation.
Parameters
- withdrawalCreate: WithdrawalCreate
  The withdrawal create request.
Returns Promise<Withdrawal>
A promise that resolves to the updated withdrawal.
Throws
If the HTTP request fails.
Example
```
// Example usage:
withdrawalService.create(withdrawalCreate)
  .then((response) => {
    console.log(response);
  })
  .catch((error) => {
    console.error(`Error creating withdrawal.`);
  });
```
- Defined in withdrawals/services/withdrawal.service.ts:157

get

get(id: string): Promise<Withdrawal>
Retrieves a withdrawal by id.
Parameters
- id: string
  The id of the withdrawal.
Returns Promise<Withdrawal>
A promise that resolves to a withdrawal.
Throws
If the HTTP request fails.
Example
```
// Example usage:
withdrawalService.get(withdrawalId)
  .then((response) => {
    console.log(response);
  })
  .catch((error) => {
    console.error(`Error fetching withdrawal.`);
  });
```
- Defined in withdrawals/services/withdrawal.service.ts:213

getAll

getAll(
getWithdrawalsParameters?: GetWithdrawalParameters,
): Promise<WithdrawalList>
Retrieves user withdrawals with pagination metadata.
Parameters
- OptionalgetWithdrawalsParameters: GetWithdrawalParameters
  Filter parameters.
Returns Promise<WithdrawalList>
A promise that resolves to a withdrawal list.
Throws
If the HTTP request fails.
Example
```
// Example usage:
withdrawalService.getAll({ limit: 5 })
  .then((response) => {
    console.log(response);
  })
  .catch((error) => {
    console.error(`Error fetching withdrawals.`);
  });
```
- Defined in withdrawals/services/withdrawal.service.ts:132

getOptions

getOptions(): Promise<WithdrawalOption[]>
Retrieves all withdrawal options.

Returns Promise<WithdrawalOption[]>
A promise that resolve to a list of withdrawal options.
Throws
If the HTTP request fails.
Example
```
// Example usage:
withdrawalService.getOptions()
  .then((response) => {
    console.log(response);
  })
  .catch((error) => {
    console.error(`Error fetching withdrawal options.`);
  });
```
- Defined in withdrawals/services/withdrawal.service.ts:76

preview

preview(
withdrawalRequest: WithdrawalRequest,
instrumentType?: InstrumentType,
): Promise<Withdrawal>
Creates a withdrawal preview.
Parameters
- withdrawalRequest: WithdrawalRequest
  The request payload for creating a withdrawal preview.
- OptionalinstrumentType: InstrumentType
  The instrument type for localization when no instrument reference is provided.
Returns Promise<Withdrawal>
A promise that resolves to the newly created withdrawal preview.
Throws
If the HTTP request fails.
Example
```
// Example usage:
withdrawalService.preview(withdrawalRequest)
  .then((response) => {
    console.log(response);
  })
  .catch((error) => {
    console.error(`Error creating withdrawal.`);
  });
```
- Defined in withdrawals/services/withdrawal.service.ts:100

`Static`getInstance

getInstance(): WithdrawalService
Function
Retrieves the singleton instance of the WithdrawalService class.

Returns WithdrawalService
The singleton instance of the WithdrawalService class.
Static
Example
```
// Usage:
const withdrawalService = WithdrawalService.getInstance();
```
- Defined in withdrawals/services/withdrawal.service.ts:50