A Java library for integrating Payload.

<dependency>
  <groupId>co.payload</groupId>
  <artifactId>payload</artifactId>
  <version>0.1.12</version>
</dependency>

Download the latest version from GitHub.

Include the Payload folder in your Android Studio or Eclipse project.

Once you've included the Payload Java library in your project, include the co.payload.pl namespace to get started.

All Payload objects and methods are accessible using the pl static class.

To authenticate with the Payload API, you'll need a live or test API key. API keys are accessible from within the Payload dashboard.

import co.payload.pl;

pl.api_key = "secret_key_3bW9JMZtPVDOfFNzwRdfE";

Interfacing with the Payload API is done primarily through Payload Objects. Below is an example of creating a customer using the pl.Customer object.

// Create a Customer
pl.Customer customer = new pl.Customer(){{
    set("email", "matt.perez@example.com");
    set("full_name", "Matt Perez");
    create();
}};

// Create a Payment
pl.Payment payment = new pl.Payment(){{
    set("amount", 100.0);
    set("payment_method, new pl.Card(){{
        set("card_number", "4242 4242 4242 4242");
    }});
    create();
}};

Object attributes are accessible through getStr, getInt, and getFloat.

System.out.print(customer.getStr("email"));

Updating an object is a simple call to the update object method.

// Updating a customer's email
customer.update(pl.attr("email", "matt.perez@newwork.com"));

Objects can be selected using any of their attributes.

// Select a customer by email
pl.Customer customers = pl.Customer.filter_by(
    "email", "matt.perez@example.com"
);

Use the pl.attr attribute helper interface to write powerful queries with a little extra syntax sugar.

pl.Payment payments = pl.Payments.filter_by(
    pl.attr("amount").gt(100),
    pl.attr("amount").lt(200),
    pl.attr("description").contains("Test"),
    pl.attr("created_at").gt(LocalDate.of(2019, 02, 20))
).all();

To get further information on Payload's Java library and API capabilities, visit the unabridged Payload Documentation.