Generate UMA Invoices for Deposits

Release Date: May 23, 2024

Summary

As part of Zero Hash's support of the Lightning Network and UMA, there is new functionality to generate invoices to receive deposits.

More information can be found in our Lightning Network Integration Guide and FAQ or by contacting the Zero Hash team.

API Documentation References

Create UMA Address: https://docs.zerohash.com/reference/post_deposits-uma
Get UMA Addresses: https://docs.zerohash.com/reference/get_deposits-uma

Generate UMA Invoice in CERT

An invoice must be generated in order to receive a deposit over the Lightning Network. This step currently assumes you would like to use your own domain and manage your own UMA server, which will require working with the Zero Hash team to setup (support for ZH-managed available soon).

Once your UMA server is setup, a user must first be registered by your server and then sent to Zero Hash via POST /deposits/uma

Once successfully registered, that participant can then generate an invoice in CERT by calling: uma.cert.zerohash.com/.well-known/lnurlp

Note: if you will see the error message "UMA recipient not found" if attempting to generate an invoice without registering the participant first.

Generate UMA Invoice in PROD

Note that it is recommended to test these flows in CERT first. All platforms must be allow-listed to use Lightning and UMA in Production.

Once your UMA server is setup, a user must first be registered by your server and then sent to Zero Hash via POST /deposits/uma

Once successfully registered, that participant can then generate an invoice in PROD by calling: uma.zerohash.com/.well-known/lnurlp

Note: The above URL is unique to each environment. If you will see the error message "UMA recipient not found" if attempting to generate an invoice without registering the participant first.