# pay

Payments Contract Operations

## Example

```ts
import * as Pay from '@filoz/synapse-core/pay'
```

## Namespaces

| Namespace | Description |
| ------ | ------ |
| [accounts](/reference/filoz/synapse-core/pay/namespaces/accounts/toc/) | - |
| [accountsCall](/reference/filoz/synapse-core/pay/namespaces/accountscall/toc/) | - |
| [deposit](/reference/filoz/synapse-core/pay/namespaces/deposit/toc/) | - |
| [depositCall](/reference/filoz/synapse-core/pay/namespaces/depositcall/toc/) | - |
| [depositSync](/reference/filoz/synapse-core/pay/namespaces/depositsync/toc/) | - |
| [getRail](/reference/filoz/synapse-core/pay/namespaces/getrail/toc/) | - |
| [getRailCall](/reference/filoz/synapse-core/pay/namespaces/getrailcall/toc/) | - |
| [getRailsForPayeeAndToken](/reference/filoz/synapse-core/pay/namespaces/getrailsforpayeeandtoken/toc/) | - |
| [getRailsForPayeeAndTokenCall](/reference/filoz/synapse-core/pay/namespaces/getrailsforpayeeandtokencall/toc/) | - |
| [getRailsForPayerAndToken](/reference/filoz/synapse-core/pay/namespaces/getrailsforpayerandtoken/toc/) | - |
| [getRailsForPayerAndTokenCall](/reference/filoz/synapse-core/pay/namespaces/getrailsforpayerandtokencall/toc/) | - |
| [operatorApprovals](/reference/filoz/synapse-core/pay/namespaces/operatorapprovals/toc/) | - |
| [operatorApprovalsCall](/reference/filoz/synapse-core/pay/namespaces/operatorapprovalscall/toc/) | - |
| [setOperatorApproval](/reference/filoz/synapse-core/pay/namespaces/setoperatorapproval/toc/) | - |
| [setOperatorApprovalCall](/reference/filoz/synapse-core/pay/namespaces/setoperatorapprovalcall/toc/) | - |
| [setOperatorApprovalSync](/reference/filoz/synapse-core/pay/namespaces/setoperatorapprovalsync/toc/) | - |
| [settleRail](/reference/filoz/synapse-core/pay/namespaces/settlerail/toc/) | - |
| [settleRailCall](/reference/filoz/synapse-core/pay/namespaces/settlerailcall/toc/) | - |
| [settleRailSync](/reference/filoz/synapse-core/pay/namespaces/settlerailsync/toc/) | - |
| [settleTerminatedRailWithoutValidation](/reference/filoz/synapse-core/pay/namespaces/settleterminatedrailwithoutvalidation/toc/) | - |
| [settleTerminatedRailWithoutValidationCall](/reference/filoz/synapse-core/pay/namespaces/settleterminatedrailwithoutvalidationcall/toc/) | - |
| [settleTerminatedRailWithoutValidationSync](/reference/filoz/synapse-core/pay/namespaces/settleterminatedrailwithoutvalidationsync/toc/) | - |
| [withdraw](/reference/filoz/synapse-core/pay/namespaces/withdraw/toc/) | - |
| [withdrawCall](/reference/filoz/synapse-core/pay/namespaces/withdrawcall/toc/) | - |
| [withdrawSync](/reference/filoz/synapse-core/pay/namespaces/withdrawsync/toc/) | - |

## Type Aliases

| Type Alias | Description |
| ------ | ------ |
| [DepositAndApproveOptions](/reference/filoz/synapse-core/pay/type-aliases/depositandapproveoptions/) | - |
| [RailInfo](/reference/filoz/synapse-core/pay/type-aliases/railinfo/) | Rail information |

## Functions

| Function | Description |
| ------ | ------ |
| [accounts](/reference/filoz/synapse-core/pay/functions/accounts/) | Get account information from the Filecoin Pay contract |
| [accountsCall](/reference/filoz/synapse-core/pay/functions/accountscall/) | Create a call to the accounts function |
| [deposit](/reference/filoz/synapse-core/pay/functions/deposit/) | Deposit funds into the Filecoin Pay contract |
| [depositAndApprove](/reference/filoz/synapse-core/pay/functions/depositandapprove/) | Deposit funds to the payments contract and approve an operator. |
| [depositCall](/reference/filoz/synapse-core/pay/functions/depositcall/) | Create a call to the deposit function |
| [depositSync](/reference/filoz/synapse-core/pay/functions/depositsync/) | Deposit funds into the Filecoin Pay contract and wait for confirmation |
| [extractDepositEvent](/reference/filoz/synapse-core/pay/functions/extractdepositevent/) | Extracts the DepositRecorded event from transaction logs |
| [extractSetOperatorApprovalEvent](/reference/filoz/synapse-core/pay/functions/extractsetoperatorapprovalevent/) | Extracts the OperatorApprovalUpdated event from transaction logs |
| [extractSettleRailEvent](/reference/filoz/synapse-core/pay/functions/extractsettlerailevent/) | Extracts the RailSettled event from transaction logs |
| [extractSettleTerminatedRailWithoutValidationEvent](/reference/filoz/synapse-core/pay/functions/extractsettleterminatedrailwithoutvalidationevent/) | Extracts the RailSettled event from transaction logs |
| [extractWithdrawEvent](/reference/filoz/synapse-core/pay/functions/extractwithdrawevent/) | Extracts the WithdrawRecorded event from transaction logs |
| [getRail](/reference/filoz/synapse-core/pay/functions/getrail/) | Get rail information from the Filecoin Pay contract |
| [getRailCall](/reference/filoz/synapse-core/pay/functions/getrailcall/) | Create a call to the getRail function |
| [getRailsForPayeeAndToken](/reference/filoz/synapse-core/pay/functions/getrailsforpayeeandtoken/) | Get rails for a payee and token with pagination |
| [getRailsForPayeeAndTokenCall](/reference/filoz/synapse-core/pay/functions/getrailsforpayeeandtokencall/) | Create a call to the getRailsForPayeeAndToken function |
| [getRailsForPayerAndToken](/reference/filoz/synapse-core/pay/functions/getrailsforpayerandtoken/) | Get rails for a payer and token with pagination |
| [getRailsForPayerAndTokenCall](/reference/filoz/synapse-core/pay/functions/getrailsforpayerandtokencall/) | Create a call to the getRailsForPayerAndToken function |
| [operatorApprovals](/reference/filoz/synapse-core/pay/functions/operatorapprovals/) | Get operator approval information from the Filecoin Pay contract |
| [operatorApprovalsCall](/reference/filoz/synapse-core/pay/functions/operatorapprovalscall/) | Create a call to the operatorApprovals function |
| [parseAccounts](/reference/filoz/synapse-core/pay/functions/parseaccounts/) | Parse the contract output into the accounts output type |
| [parseGetRailsForPayeeAndToken](/reference/filoz/synapse-core/pay/functions/parsegetrailsforpayeeandtoken/) | Parse the contract output into the getRailsForPayeeAndToken output type |
| [parseGetRailsForPayerAndToken](/reference/filoz/synapse-core/pay/functions/parsegetrailsforpayerandtoken/) | Parse the contract output into the getRailsForPayerAndToken output type |
| [parseOperatorApprovals](/reference/filoz/synapse-core/pay/functions/parseoperatorapprovals/) | Parse the contract output into the operatorApprovals output type |
| [setOperatorApproval](/reference/filoz/synapse-core/pay/functions/setoperatorapproval/) | Set operator approval on the Filecoin Pay contract |
| [setOperatorApprovalCall](/reference/filoz/synapse-core/pay/functions/setoperatorapprovalcall/) | Create a call to the setOperatorApproval function |
| [setOperatorApprovalSync](/reference/filoz/synapse-core/pay/functions/setoperatorapprovalsync/) | Set operator approval on the Filecoin Pay contract and wait for confirmation |
| [settleRail](/reference/filoz/synapse-core/pay/functions/settlerail/) | Settle a payment rail up to a specific epoch |
| [settleRailCall](/reference/filoz/synapse-core/pay/functions/settlerailcall/) | Create a call to the settleRail function |
| [settleRailSync](/reference/filoz/synapse-core/pay/functions/settlerailsync/) | Settle a payment rail up to a specific epoch and wait for confirmation |
| [settleTerminatedRailWithoutValidation](/reference/filoz/synapse-core/pay/functions/settleterminatedrailwithoutvalidation/) | Settle a terminated payment rail without validation |
| [settleTerminatedRailWithoutValidationCall](/reference/filoz/synapse-core/pay/functions/settleterminatedrailwithoutvalidationcall/) | Create a call to the settleTerminatedRailWithoutValidation function |
| [settleTerminatedRailWithoutValidationSync](/reference/filoz/synapse-core/pay/functions/settleterminatedrailwithoutvalidationsync/) | Settle a terminated payment rail without validation and wait for confirmation |
| [withdraw](/reference/filoz/synapse-core/pay/functions/withdraw/) | Withdraw funds from the Filecoin Pay contract |
| [withdrawCall](/reference/filoz/synapse-core/pay/functions/withdrawcall/) | Create a call to the withdraw function |
| [withdrawSync](/reference/filoz/synapse-core/pay/functions/withdrawsync/) | Withdraw funds from the Filecoin Pay contract and wait for confirmation |