# DepositOptions

Defined in: [packages/synapse-sdk/src/payments/service.ts:18](https://github.com/FilOzone/synapse-sdk/blob/1d6c4b9fe34534bf1087dfe41491b72be0b46858/packages/synapse-sdk/src/payments/service.ts#L18)

Options for deposit operation

## Properties

### onAllowanceCheck()?

```ts
optional onAllowanceCheck: (current, required) => void;
```

Defined in: [packages/synapse-sdk/src/payments/service.ts:22](https://github.com/FilOzone/synapse-sdk/blob/1d6c4b9fe34534bf1087dfe41491b72be0b46858/packages/synapse-sdk/src/payments/service.ts#L22)

Called when checking current allowance

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `current` | `bigint` |
| `required` | `bigint` |

#### Returns

`void`

***

### onApprovalConfirmed()?

```ts
optional onApprovalConfirmed: (receipt) => void;
```

Defined in: [packages/synapse-sdk/src/payments/service.ts:26](https://github.com/FilOzone/synapse-sdk/blob/1d6c4b9fe34534bf1087dfe41491b72be0b46858/packages/synapse-sdk/src/payments/service.ts#L26)

Called when approval is confirmed

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `receipt` | `TransactionReceipt` |

#### Returns

`void`

***

### onApprovalTransaction()?

```ts
optional onApprovalTransaction: (tx) => void;
```

Defined in: [packages/synapse-sdk/src/payments/service.ts:24](https://github.com/FilOzone/synapse-sdk/blob/1d6c4b9fe34534bf1087dfe41491b72be0b46858/packages/synapse-sdk/src/payments/service.ts#L24)

Called when approval transaction is sent

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tx` | `TransactionResponse` |

#### Returns

`void`

***

### onDepositStarting()?

```ts
optional onDepositStarting: () => void;
```

Defined in: [packages/synapse-sdk/src/payments/service.ts:28](https://github.com/FilOzone/synapse-sdk/blob/1d6c4b9fe34534bf1087dfe41491b72be0b46858/packages/synapse-sdk/src/payments/service.ts#L28)

Called before deposit transaction is sent

#### Returns

`void`

***

### to?

```ts
optional to: string;
```

Defined in: [packages/synapse-sdk/src/payments/service.ts:20](https://github.com/FilOzone/synapse-sdk/blob/1d6c4b9fe34534bf1087dfe41491b72be0b46858/packages/synapse-sdk/src/payments/service.ts#L20)

Optional recipient address (defaults to signer address if not provided)