BitPay Java Library

Implement blockchain payments on your e-commerce website using BitPay's Java Library.

Using the BitPay Java Library

This library provides a convenient abstraction of BitPay's cryptographically-secure API and allows payment gateway developers to focus on payment flow/e-commerce integration rather than on the specific details of client-server interaction using the API. This library optionally provides the flexibility for developers to have control over important details, including the handling of private keys needed for client-server communication.

It also implements BitPay's remote client authentication and authorization strategy. No private or shared-secret information is ever transmitted over the wire.

Dependencies

You must have a BitPay merchant account to use this library. It's free to sign-up for a BitPay merchant account.

If you need a test account, please visit https://test.bitpay.com/dashboard/signup and register for a BitPay merchant test account. Please fill in all questions, so you get a fully working test account. If you are looking for a testnet bitcoin wallet to test with, please visit https://bitpay.com/wallet and create a new wallet. If you need testnet bitcoin please visit a testnet faucet, e.g. https://testnet.coinfaucet.eu/en/ or http://tpfaucet.appspot.com/

For more information about testing, please see https://bitpay.com/docs/testing

Handling your client private key

Each client paired with the BitPay server requires a ECDSA key. This key provides the security mechanism for all client interaction with the BitPay server. The public key is used to derive the specific client identity that is displayed on your BitPay dashboard. The public key is also used for securely signing all API requests from the client. See the BitPay API for more information.

The private key should be stored in the client environment such that it cannot be compromised. If your private key is compromised you should revoke the compromised client identity from the BitPay server and re-pair your client, see the API tokens for more information.

There are two ways to generate the configuration file required to load the library:

  • Using the BitPaySetup Script helps to generate the private key, as well as a environment file formatted in JSON which contains all configuration requirements, that should be stored in the client local file system. It is not recommended to transmit the private key over any public or unsecure networks.

    Once the BitPaySetup Script has run and generated the Json correctly, read the console output and follow the instructions in order to pair your new tokens. This method would also allow you to generate the Private Key as plain text which you can securely store in case you are using cloud services.

  • Or using the BitPay.Net Setup utility on a Windows machine, helps to generate the private key, as well as a environment file formatted in JSON which contains all configuration requirements, that should be stored in the client local file system. It is not recommended to transmit the private key over any public or unsecure networks.

    Follow the guide BitPay.Net Setup utility guide that assist you to create the environment file which you will be able to modify it, either manually or by using the BitPay.Net Setup utility, later on by asking you to provide the path to your existing JSON file.

The environment file can be either generated by the BitPay.Net Setup utility or created manually by copying the following Json structure:

{
  "BitPayConfiguration": {
    "Environment": "",
    "EnvConfig": {
      "Test": {
        "PrivateKeyPath": "",
        "PrivateKey": "",
        "ApiTokens": {
          "pos": "",
          "merchant": "",
          "payroll": ""
        }
      },
      "Prod": {
        "PrivateKeyPath": "",
        "PrivateKey": "",
        "ApiTokens": {
          "pos": "",
          "merchant": "",
          "payroll": ""
        }
      }
    }
  }
}


Usage

This library was built and tested using the Intellij IDE; the source code tree is directly compatible with Other Java IDEs. Library dependencies can be downloaded by executing the following command at the root of the library:

You can also look ar the full JavaDoc for reference here

Initializing your BitPay client

Once you have the environment file (JSON previously generated) you can initialize the client on two different ways:

// Provide the full path to the env file which you have previously stored securely.

Client bitpay = new Client("[FULL_PATH_TO_THE_CONFIG_FILE]", null); //as second argument, Pass a HttpHost object for proxy usage or NULL to ignore


// Initialize with separate variables.

Client bitpay = new Client(
    Env.Test,
    "[FULL_PATH_TO_THE_PRIVATE_KEY_|OR|_PRIVATE_KEY_AS-PLAIN_TEXT]",
    new Env.Tokens(){{
        pos = "AvJdGrEqTW9HVsJit9zabAnrJabqaQDhWHRacHYgfgxK";
        merchant = "2smKkjA1ACPKWUGN7wUEEqdWi3rhXYhDX6AKgG4njKvj";
        payroll = "9pJ7fzW1GGeuDQfj32aNATCDnyY6YAacVMcDrs7HHUNo";
    }},
    null //Pass a HttpHost object for proxy usage or NULL to ignore
);


Pair your client with BitPay

Your client must be paired with the BitPay server. The pairing initializes authentication and authorization for your client to communicate with BitPay for your specific merchant account.

Pairing is accomplished by having the BitPay.Net Setup utility request a pairing code from the BitPay server. Meanwhile a new pairing code is generated, the BitPay.Net Setup utility will ask you to activate it in your BitPay account. It will also store the paired token in the environment file.

The pairing code is then entered into the BitPay merchant dashboard for the desired merchant. Your interactive authentication at https://bitpay.com/login provides the authentication needed to create finalize the client-server pairing request.

Create an invoice

Invoice invoice = bitpay.createInvoice(new Invoice(50.0, "USD"));

String invoiceUrl = invoice.getURL();

String status = invoice.getStatus();


Retrieve an invoice

Invoice invoice = bitpay.getInvoice(invoice.getId());


Get exchange Rates

You can retrieve BitPay's BBB exchange rates.

Rates rates = bitpay.getRates();

double rate = rates.getRate("USD");

rates.update();


See also the test package for more examples of API calls.

Integration Options
BitPay Java Library
Category

Libraries

View on GitHubview on maven

Get Started with the BitPay Java Library integration