# Paych The Paych methods are for interacting with and managing payment channels ## PaychAllocateLane Perms: sign Inputs: ```json ["f01234"] ``` Response: `42` ## PaychAvailableFunds Perms: sign Inputs: ```json ["f01234"] ``` Response: ```json { "Channel": "f01234", "From": "f01234", "To": "f01234", "ConfirmedAmt": "0", "PendingAmt": "0", "NonReservedAmt": "0", "PendingAvailableAmt": "0", "PendingWaitSentinel": { "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" }, "QueuedAmt": "0", "VoucherRedeemedAmt": "0" } ``` ## PaychAvailableFundsByFromTo Perms: sign Inputs: ```json ["f01234", "f01234"] ``` Response: ```json { "Channel": "f01234", "From": "f01234", "To": "f01234", "ConfirmedAmt": "0", "PendingAmt": "0", "NonReservedAmt": "0", "PendingAvailableAmt": "0", "PendingWaitSentinel": { "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" }, "QueuedAmt": "0", "VoucherRedeemedAmt": "0" } ``` ## PaychCollect Perms: sign Inputs: ```json ["f01234"] ``` Response: ```json { "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" } ``` ## PaychFund PaychFund gets or creates a payment channel between address pair. The specified amount will be added to the channel through on-chain send for future use Perms: sign Inputs: ```json ["f01234", "f01234", "0"] ``` Response: ```json { "Channel": "f01234", "WaitSentinel": { "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" } } ``` ## PaychGet PaychGet gets or creates a payment channel between address pair The specified amount will be reserved for use. If there aren't enough non-reserved funds available, funds will be added through an on-chain message. * When opts.OffChain is true, this call will not cause any messages to be sent to the chain (no automatic channel creation/funds adding). If the operation can't be performed without sending a message an error will be returned. Note that even when this option is specified, this call can be blocked by previous operations on the channel waiting for on-chain operations. Perms: sign Inputs: ```json [ "f01234", "f01234", "0", { "OffChain": true } ] ``` Response: ```json { "Channel": "f01234", "WaitSentinel": { "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" } } ``` ## PaychGetWaitReady Perms: sign Inputs: ```json [ { "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" } ] ``` Response: `"f01234"` ## PaychList Perms: read Inputs: `null` Response: ```json ["f01234"] ``` ## PaychNewPayment Perms: sign Inputs: ```json [ "f01234", "f01234", [ { "Amount": "0", "TimeLockMin": 10101, "TimeLockMax": 10101, "MinSettle": 10101, "Extra": { "Actor": "f01234", "Method": 1, "Data": "Ynl0ZSBhcnJheQ==" } } ] ] ``` Response: ```json { "Channel": "f01234", "WaitSentinel": { "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" }, "Vouchers": [ { "ChannelAddr": "f01234", "TimeLockMin": 10101, "TimeLockMax": 10101, "SecretHash": "Ynl0ZSBhcnJheQ==", "Extra": { "Actor": "f01234", "Method": 1, "Data": "Ynl0ZSBhcnJheQ==" }, "Lane": 42, "Nonce": 42, "Amount": "0", "MinSettleHeight": 10101, "Merges": [ { "Lane": 42, "Nonce": 42 } ], "Signature": { "Type": 2, "Data": "Ynl0ZSBhcnJheQ==" } } ] } ``` ## PaychSettle Perms: sign Inputs: ```json ["f01234"] ``` Response: ```json { "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" } ``` ## PaychStatus Perms: read Inputs: ```json ["f01234"] ``` Response: ```json { "ControlAddr": "f01234", "Direction": 1 } ``` ## PaychVoucherAdd Perms: write Inputs: ```json [ "f01234", { "ChannelAddr": "f01234", "TimeLockMin": 10101, "TimeLockMax": 10101, "SecretHash": "Ynl0ZSBhcnJheQ==", "Extra": { "Actor": "f01234", "Method": 1, "Data": "Ynl0ZSBhcnJheQ==" }, "Lane": 42, "Nonce": 42, "Amount": "0", "MinSettleHeight": 10101, "Merges": [ { "Lane": 42, "Nonce": 42 } ], "Signature": { "Type": 2, "Data": "Ynl0ZSBhcnJheQ==" } }, "Ynl0ZSBhcnJheQ==", "0" ] ``` Response: `"0"` ## PaychVoucherCheckSpendable Perms: read Inputs: ```json [ "f01234", { "ChannelAddr": "f01234", "TimeLockMin": 10101, "TimeLockMax": 10101, "SecretHash": "Ynl0ZSBhcnJheQ==", "Extra": { "Actor": "f01234", "Method": 1, "Data": "Ynl0ZSBhcnJheQ==" }, "Lane": 42, "Nonce": 42, "Amount": "0", "MinSettleHeight": 10101, "Merges": [ { "Lane": 42, "Nonce": 42 } ], "Signature": { "Type": 2, "Data": "Ynl0ZSBhcnJheQ==" } }, "Ynl0ZSBhcnJheQ==", "Ynl0ZSBhcnJheQ==" ] ``` Response: `true` ## PaychVoucherCheckValid Perms: read Inputs: ```json [ "f01234", { "ChannelAddr": "f01234", "TimeLockMin": 10101, "TimeLockMax": 10101, "SecretHash": "Ynl0ZSBhcnJheQ==", "Extra": { "Actor": "f01234", "Method": 1, "Data": "Ynl0ZSBhcnJheQ==" }, "Lane": 42, "Nonce": 42, "Amount": "0", "MinSettleHeight": 10101, "Merges": [ { "Lane": 42, "Nonce": 42 } ], "Signature": { "Type": 2, "Data": "Ynl0ZSBhcnJheQ==" } } ] ``` Response: `{}` ## PaychVoucherCreate Perms: sign Inputs: ```json ["f01234", "0", 42] ``` Response: ```json { "Voucher": { "ChannelAddr": "f01234", "TimeLockMin": 10101, "TimeLockMax": 10101, "SecretHash": "Ynl0ZSBhcnJheQ==", "Extra": { "Actor": "f01234", "Method": 1, "Data": "Ynl0ZSBhcnJheQ==" }, "Lane": 42, "Nonce": 42, "Amount": "0", "MinSettleHeight": 10101, "Merges": [ { "Lane": 42, "Nonce": 42 } ], "Signature": { "Type": 2, "Data": "Ynl0ZSBhcnJheQ==" } }, "Shortfall": "0" } ``` ## PaychVoucherList Perms: write Inputs: ```json ["f01234"] ``` Response: ```json [ { "ChannelAddr": "f01234", "TimeLockMin": 10101, "TimeLockMax": 10101, "SecretHash": "Ynl0ZSBhcnJheQ==", "Extra": { "Actor": "f01234", "Method": 1, "Data": "Ynl0ZSBhcnJheQ==" }, "Lane": 42, "Nonce": 42, "Amount": "0", "MinSettleHeight": 10101, "Merges": [ { "Lane": 42, "Nonce": 42 } ], "Signature": { "Type": 2, "Data": "Ynl0ZSBhcnJheQ==" } } ] ``` ## PaychVoucherSubmit Perms: sign Inputs: ```json [ "f01234", { "ChannelAddr": "f01234", "TimeLockMin": 10101, "TimeLockMax": 10101, "SecretHash": "Ynl0ZSBhcnJheQ==", "Extra": { "Actor": "f01234", "Method": 1, "Data": "Ynl0ZSBhcnJheQ==" }, "Lane": 42, "Nonce": 42, "Amount": "0", "MinSettleHeight": 10101, "Merges": [ { "Lane": 42, "Nonce": 42 } ], "Signature": { "Type": 2, "Data": "Ynl0ZSBhcnJheQ==" } }, "Ynl0ZSBhcnJheQ==", "Ynl0ZSBhcnJheQ==" ] ``` Response: ```json { "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" } ``` [Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill_Page+URL=https://docs.filecoin.io/reference/json-rpc/paych) --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.filecoin.io/reference/json-rpc/paych.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.