Java Wrapper for the popular payant payment gateway.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib
nbproject
src
.gitignore
README.md
build.xml

README.md

jPayant

Java wrapper for Payant payment

Background

Payant makes receiving money on your website or from your app very easy.
You can accept payments, set invoices make transfer from one bank account to another and many more.

Visit Payant developer's page for a comprehensive documentation.

Installation

To use this wrapper in your app, copy the jar files in the lib folder into your app directory.

Luckily, this wrapper is well documented.

Usage.

To start with, visit Payant startup page to register and obtain your Authorization Keys. You'd get both a PUBLIC KEY and a PRIVATE KEY. The PRIVATE KEY is expected for all authentication.

Visit jPayantDoc for the Java documentation

There are five major features in the api, including: Client, Invoice, Miscellaneous, Transfer, Product, Payment

Client

      //Initialize client. Use Implementation.LIVE when going Live
      Client client = new Client("YOUR_PRIVATE_KEY", Implementation.DEMO);

      //Add a new Client using very few information
      ClientObject newClient = client.addClient("First Name", "Last Name", "Email", "Phone");

      //OR add all the details using an empty string for information that's not available
      newClient = client.addClient("First Name", "Last Name", "Email", "Phone", "Bank Id", "Account Number", "Website", "Address", ClientType.CUSTOMER, "Company Name");

      //Use the ClientObject object to get details of the newly registered client.
      String clientId = newClient.getClientId();
      String accountNumber = newClient.getAccountNumber();

      // Retrieve a client
      ClientObject oldClient = client.getClient(clientId);

      //Edit a client. The two variants of addClient also exist for editClient
      ClientObject editedClient = client.editClient(clientId, "First Name", "Last Name", "Email", "Phone");

      //Delete Client
      ResponseParser parser = client.deleteClient(clientId);

      //You can view the details of the request by checking the parser object. e.g:
      String message = parser.getMessage();
      String status = parser.getStatus();
      String data = parser.getData(); //This would throw a NoDataException if there's no data in the response.

      //A client object also has a parser in it to view the response details.
      //You can obtain it by doing:
      ResponseParser parser1 = newClient.getParser();

Invoice

    //Initialize the invoice class
    Invoice invoice = new Invoice("YOUR_PRIVATE_KEY", Implementation.DEMO);

    //Add a new invoice
    /*
    For an invoice, you'd need a client to add the invoice for.
    Either create a new client or add a new client to get a clientObject to use.
    e.g ClientObject client Object = client.getClient("client id");
    You'd also need to create a list of items to add to the invoice.
    The list may however contain just one item.
     */
    ClientObject client = new Client("YOUR_PRIVATE_KEY", Implementation.DEMO).getClient("47");
    List<Item> items = new ArrayList<>();
    items.add(new Item("Another", "Another Item", "20000", 1));
    items.add(new Item("Second", "Another Second Item", "25000", 5));
    items.add(new Item("Third", "Another Third Item", "10000", 3));
    InvoiceObject newInvoice = invoice.addInvoice(client, "12/30/2016", FeeBearer.ACCOUNT, items);

    //Retrieve an invoice
    // Reference code may be obtained from an invoice object.
    InvoiceObject oldInvoice = invoice.getInvoice("Reference Code");

    //Delete an invoice
    ResponseParser parser = invoice.deleteInvoice("Reference Code");

    //Send an invoice
    InvoiceObject sentInvoice = invoice.sendInvoice("Reference Code");

    //Invoice History
    /*
    //Retrieving between a preset history period.
    Make use of the several period options in HistoryPeriod class.
    e.g: HistoryPeriod.TODAY, HistoryPeriod.ONE_WEEK etc.
     */
    List<InvoiceObject> invoices = invoice.getInvoiceHistory(HistoryPeriod.LAST_NINETY_DAYS);

    //Or use a custom date range
    invoices = invoice.getInvoiceHistory("05/12/2016", "05/12/2017");

    //Get details of an invoice from an invoice object. e.g:
    ClientObject receivingClient = sentInvoice.getClient();
    List<Item> attachedItems = sentInvoice.getItems();
    String dueDate = sentInvoice.getDueDate();
    String feeBearer = sentInvoice.getFeeBearer();

Miscellaneous

  Miscellaneous miscellaneous = new Miscellaneous("YOUR_PRIVATE_KEY", Implementation.DEMO);

  //Retrieve a payment
  PaymentObject payment = miscellaneous.getPayment("Reference Code");
  //The payment object has all the details of the payment in it

  //Retrieve all banks
  //This would return a map of bank codes to bank names
  Map<String, String> banks = miscellaneous.getBanks();

  //Resolve an account
  AccountDetails accountDetails = miscellaneous.resolveAccount("Bank Id", "Account Number");
  String accountName = accountDetails.getAccountName();
  String accountNumber = accountDetails.getAccountNumber();

Payment

  //Initialize payment
  Payment payment = new Payment("YOUR_PRIVATE_KEY", Implementation.DEMO);

  //Add a new payment
  //Get payment channels from PaymentChannel class.
  PaymentObject addedPayment = payment.addPayment("Reference Code", "05/12/2018", "20000", PaymentChannel.CASH);

  //Get a previous payment with it's Reference Code
  PaymentObject payment1 = payment.getPayment("Reference Code");

  //Get payments within a period
  List<PaymentObject> paymentHistory = payment.getPaymentHistory(HistoryPeriod.TODAY);

  //Or within a specified custom date
  List<PaymentObject> paymentHistory1 = payment.getPaymentHistory("05/12/2016", "05/12/2018");

  //Get payment details from PaymentObject. e.g:
  String amount = addedPayment.getAmount();
  ClientObject client = addedPayment.getClient();

Product

    //Initialize product
    Product product = new Product("YOUR_PRIVATE_KEY", Implementation.DEMO);

    //Add a new product
    //Get ProductType from ProductType class
    ProductObject addedProduct = product.addProduct("Name", "Description", "20000", ProductType.PRODUCT);

    //Get a previously added product
    ProductObject product1 = product.getProduct("Product Id");

    //Get all products
    List<ProductObject> products = product.getProducts();

    //Delete a product
    ResponseParser deleteProduct = product.deleteProduct("Product Id");

    //Get product information from ProductObject. e.g:
    String description = addedProduct.getDescription();

Transfer

    //Initialize transfer
    Transfer transfer = new Transfer("YOUR_PRIVATE_KEY", Implementation.DEMO);

    //Make a transfer from your account to another account.
    TransferObject addedTransfer = transfer.addTransfer("First Name", "Last Name", "Email", "Phone", "Bank code", "Account Number", "Amount");

    //Delete a transfer
    ResponseParser deletedTransfer = transfer.deleteTransfer("Reference code");

    //Get a transfer
    TransferObject transfer1 = transfer.getTransfer("Reference Code");

    //Get transfers made within a period range making use of HistoryPeriod to obtain available periods.
    List<TransferObject> transferHistory = transfer.getTransferHistory(HistoryPeriod.ONE_WEEK);

    //Or get transfer history within a date range
    List<TransferObject> transferHistory1 = transfer.getTransferHistory("05/12/2016", "05/12/2018");

    //Get details of transfer using the TransferObject e.g:
    String accountNumber = addedTransfer.getAccountNumber();
    ClientObject client = addedTransfer.getClient();
    String clientId = addedTransfer.getClientId();
    String accountName = addedTransfer.getAccountName();

Contributing

To contribute, Fork this repo, make your changes and create a pull request.

License

This library is licensed under the MIT License

Making payment could not be more easier.