finch

finch copied to clipboard

What is Finch

Finch is an open-source cryptocurrency payment processor with a focus on ease of integration and flexibility.

Note: Finch is currently in beta form and may yet be subject to significant modification prior to the release of version 1.0.

Demo

Try a public demo of Finch and its Management Console.

Installation

We support two methods of installing and running your own Finch server. Our recommended approach is to use Docker, but if this environment is not supported, you may also set up a Rust environment.

• Via Docker
• Via Rust

Integration with Your Services

Since Finch communicates directly with the client-side of integrated services, our front-end SDK can handle almost everything needed for the integration. We currently provide JavaScript SDK, which allows you to start accepting cryptocurrencies with a block of code;

<script>
  window.onload = function() {
    const finchCheckout = new FinchCheckout({
      apiUrl: "https://api.finchtech.io",
      apiKey: "5tsdghD/RusjgbskoisRrgw==",
      currencies: ["btc", "eth"],
      fiat: "usd",
      price: "1.2",
      identifier: "[email protected]",
      button: document.getElementById("pay-with-crypto"),
      onSuccess: function(voucher) {
        // Here you can get signed payment vouchers in the form of JSON Web Tokens.
        // On your service’s backend you simply need to verify
        // this voucher using the JWT decode library of your choice.
        console.log("Successfully completed the payment.", voucher);
      }
    });
    finchCheckout.init();
  };
</script>

After a user has successfully completed the payment, onSuccess callback will be called and you’ll receive a payment voucher (JSON Web Token) as a parameter. Send the voucher to your service’s backend so that you can decode and verify it. Please refer to the official documentation for a more detailed explanation of our payment voucher.

Store Management Console

We also provide an open-source web-based store management console.

Resources

• Documentation
• Installation Guide
• Getting Started Guide (Store Setup and Integration)
• Payment API Documentation
• Store Management API Documentation