Documentation for a newer release is available. View Latest

Implementation

This section will guide you through how to embed the Payment Warehouse into your Java application.

Step 1: Import Dependencies

Add the payment-warehouse-mongo artefact to your pom.xml dependencies.

<dependency>
    <groupId>com.iconsolutions.ipf.core.warehouse</groupId>
    <artifactId>payment-warehouse-mongo</artifactId>
</dependency>

Step 2: Get a Database Running

Payment Warehouse supports MongoDB and Azure CosmosDB for MongoDB. You will need to have one of these databases running to use your application.

Step 3: Configure

The default Payment Warehouse configuration is detailed on Configuration. You can override the values to suit your requirements.

  • Set the ipf.mongodb.url property to your MongoDB connection string.

  • Set the ipf.core.payment-warehouse.database-mode to the appropriate value (as detailed in Configuration).

  • The remaining default configuration will suffice for getting started.

Step 4: Save your first Payment Entry

You can now save your first Payment Entry! Follow the guide on the Save Your First Payment Entry page.