When a user creates and sends a request, he expects to receive the correct amount of money. But how does he keep track of the payments due and received? Request is a ledger that documents requests for payment and how to agree on their completion.
There are different methods available for the payee and payer to agree on the payment status, and that is when payment networks come into play. A payment network is a predefined set of rules on how to agree on the payment status of a specific request.
A payment network is defined by:
- The information, defined at the request creation, necessary to be able to detect payments
- A payment method, the method used to perform a detectable payment
- A payment detection method, the process to determine the amount paid by the payer through the payment method
Types of payment detection
There are three ways to get consensus on a payment status.
For these payment networks, a request contains a payment address that is unique to the request. The balance of the request is computed by reading all the inbound transfers to the payment address. To pay the request, the payer performs a normal transfer to the payment address. Outbound transfers are not taken into consideration to compute the request's balance. The address must be created exclusively for the request since every inbound transfer to the addresses is considered a payment. For example, if a Bitcoin request is created with a payment address that has already received 1 BTC, the request balance will be 1 BTC even though the payee hasn't received any funds from the payer.
For address based payment requests, the refund address also has to be exclusive to this payment refund.
For these payment networks, a request contains one payment address. This address doesn't have to be exclusive to the request. The balance is computed by reading transfers to the payment address containing a specific payment reference, defined by the request ID and payment address.
For ETH, we can tag and detect the payment reference directly in the transaction, using the
input data field of the transaction.
When we cannot use
input data or equivalent, typically for ERC20, we use a proxy smart contract to document the payment reference.
The smart contract forwards a currency transfer and stores a reference.
If you need the proxy smart contract addresses, we list the most relevant ones below.
For reference based payment requests, the references for the main payment and the refund are different.
For these payment networks, the request doesn't require any additional data. The request's stakeholders declare sending and receiving payments or refunds manually. Optionally, the creator of the request can specify the information to describe how the payment should occur, but this data will not be used to detect the payment. The payee declares the received payments and the payer declares the received refunds. The balance of the request is the sum of declared payments minus the sum of declared refunds. The payee can also declare the sent refunds and the payer the sent payments. These declarations are used only for documentation purposes and aren't taken into consideration to compute the request balance.
This type of payment network can be used with every currency.
The currencies that are supported for automated payment detection are
A Bitcoin request requires an address based payment network. This payment network is sufficient for Bitcoin requests because generating a new address for every inbound BTC transfers is already part of Bitcoin's good practices.
Because one Ethereum address is generally used many times to receive and send transactions, we need a way to identify payments for a specific request without having to create a new address. Therefore, we use a reference-based payment network for ether requests. Input data and proxy contract methods can be used to reference the ether transfer.
Request is compatible with every ERC20 currency, but some of them have to be detailed manually. We use Metamask's package
eth-contract-metadata to automatically fetch smart contracts and currency codes of main currencies.
For listed ERC20 currencies, you can use the code directly.
For additional ERC20 tokens, or specific neworks, you have to mention the contract address and network identifier.
The most convenient way to implement ERC20 requests is with a proxy contract payment network. Note that the smart contract deployed for ERC20 tokens is different than the one deployed for ether.
ERC20 requests payment detection can also be address based, but using the proxy contract payment network is the most convenient.
If you would like to create a request with a currency we don't support, you have two options:
- Create a declarative request
- Contact us for your currency requirements: Join the Request Hub here
- Contribute to the protocol creating a dedicated payment network for this currency, by:
- Writing the specification (following the advanced logic specification and get inspired by the others payment networks)
- Developing the new payment network in the advanced-logic package.
- Developing the payment detection in the payment payment-detection package.
- (OPTIONAL) Developing the payment processing in the payment-processor package