Java Lite SDK (Retired)


Using the BitPay Java light client

This SDK 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 SDK optionally provides the flexibility for developers to have control over important details, including the handling of private tokens needed for client-server communication.


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

If you need a test account, please visit 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 and
create a new wallet.
If you need testnet bitcoin please visit a testnet faucet, e.g. or

For more information about testing, please see Testing


This library was built and tested using the Intellij IDE; the source code tree is directly compatible with Other Java IDEs.
You can also look ar the full JavaDoc for reference here

Getting your client token

First of all, you need to generate a new POS token on your BitPay's account which will be required to securely connect to the BitPay's API.
For testing purposes use:

For production use:

Click on 'Add New Token', give a name on the Token Label input, leave the 'Require Authentication' checkbox unchecked and click on 'Add Token'.
The new token will appear and ready to use.

Initializing your BitPay client

Once you have the token, you can initialize the client for the desired environment:

// Testing
import com.bitpay.sdk_light.Client;
import com.bitpay.sdk_light.Env;

Client bitpay = new Client("H78Yiu78uh78Gjht6g67gjh6767ghj", Env.Test);
// Production [The environment is selected by default]
import com.bitpay.sdk_light.Client;

Client bitpay = new Client("uh78Gjht6g67gjH78Yiu78h6767ghj");