Overview
The EPISHIP Billing Invoice Payments API lets you manage the settlement of invoices and reconcile financial transactions within your shipping platform. You can develop applications that integrate with EPISHIP to automate the payment of outstanding balances, record manual payments (such as checks or wire transfers), and process refunds for cancelled services.
View Doc →
The following figure shows the relationship between your EPISHIP app, the EPISHIP API, and Invoice Payment services.
Figure 1. EPISHIP API relationship diagram. Payment processing and refund architecture.
EPISHIP App
EPISHIP’s payment services give financial administrators the ability to view payment history, settle invoices using stored payment methods, and manually record external transactions to ensure accurate account balances.
EPISHIP API
The REST API that allows users to execute payments, issue refunds, and retrieve transaction logs programmatically from within your app.
Authentication
A secure method utilizing Bearer tokens in the Authorization header (`Bearer {API_TOKEN}`) to validate requests, ensuring that only authorized personnel can execute financial transactions.
Payment Management
A system that organizes payment records by Company or Invoice ID, allowing for detailed auditing of transaction amounts, methods, and statuses.
What can users do with the EPISHIP Invoice Payments API?
Users can use the EPISHIP Invoice Payments API to perform common workflows, such as:
- Retrieve a listing of payments associated with a specific invoice
- Process a payment using a stored Payment Method ID
- Record a manual payment (e.g., check/wire) with a specific transaction ID
- Refund a previous payment with a reason and description
- Filter payment history by date, amount, or company
- Validate that payment amounts do not exceed invoice balances
Payment properties available to view and filter through the EPISHIP Invoice Payments API:
- Invoice ID
- Payment Method (Type and ID)
- Transaction Amount
- Transaction ID (External or Internal)
- Payment Status
- Refund Reason