Class TransferService

Service class for managing transfers related operations.

Hierarchy

ApiService
- TransferService

Index

Methods

confirm create get getAll preview getInstance

Methods

confirm

confirm(transferConfirm: TransferConfirm): Promise<CustomerTransfer>
Confirms a transfer for execution (processing state).
Parameters
- transferConfirm: TransferConfirm
  The transfer confirm request.
Returns Promise<CustomerTransfer>
A promise that resolve to the updated transfer.
Throws
If the HTTP request fails.
Example
```
// Example usage:
transferService.confirm(transferConfirm)
  .then((response) => {
    console.log(response);
  })
  .catch((error) => {
    console.error(`Error processing transfer`);
  });
```
- Defined in transfers/services/transfer.service.ts:120

create

create(transferCreate: TransferCreate): Promise<CustomerTransfer>
Requests a transfer creation (pending state).
Parameters
- transferCreate: TransferCreate
  The transfer create request.
Returns Promise<CustomerTransfer>
A promise that resolve to the updated transfer.
Throws
If the HTTP request fails.
Example
```
// Example usage:
transferService.create(transferCreate)
  .then((response) => {
    console.log(response);
  })
  .catch((error) => {
    console.error(`Error creating transfer`);
  });
```
- Defined in transfers/services/transfer.service.ts:97

get

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

getAll

getAll(
getTransferParameters?: GetTransferParameters,
): Promise<CustomerTransferList>
Retrieves user transfers with pagination metadata.
Parameters
- OptionalgetTransferParameters: GetTransferParameters
  Filter parameters.
Returns Promise<CustomerTransferList>
A promise that resolves to a transfer list.
Throws
If the HTTP request fails.
Example
```
// Example usage:
transferService.getAll({ limit: 5 })
  .then((response) => {
    console.log(response);
  })
  .catch((error) => {
    console.error(`Error fetching transfers.`);
  });
```
- Defined in transfers/services/transfer.service.ts:153

preview

preview(transferRequest: CustomerTransferRequest): Promise<CustomerTransfer>
Creates a transfer preview.
Parameters
- transferRequest: CustomerTransferRequest
  The request payload for creating a transfer preview.
Returns Promise<CustomerTransfer>
A promise that resolves to the newly created transfer preview.
Throws
If the HTTP request fails.
Example
```
// Example usage:
transferService.preview(transferPreviewRequest)
  .then((response) => {
    console.log(response);
  })
  .catch((error) => {
    console.error(`Error creating transfer.`);
  });
```
- Defined in transfers/services/transfer.service.ts:71

`Static`getInstance

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

Returns TransferService
The singleton instance of the TransferService class.
Static
Example
```
// Usage:
const transferService = TransferService.getInstance();
```
- Defined in transfers/services/transfer.service.ts:44