Overview
The EPISHIP Billing Payouts API lets you manage the outgoing settlement of funds within your logistics network. You can develop applications that integrate with EPISHIP to automate the retrieval of payout records, audit settlement statuses, and download supporting PDF documentation for partner and reseller reimbursements.
View Doc →
The following figure shows the relationship between your EPISHIP app, the EPISHIP API, and Billing Payouts services.
Figure 1. EPISHIP API relationship diagram. Payout generation and settlement flow.
EPISHIP App
EPISHIP’s payout services provide a transparent ledger for outgoing funds, allowing administrators to track settlements to downstream companies, view credit/debit directions, and access detailed PDF statements for every transaction.
EPISHIP API
The REST API that allows users to list, retrieve, and generate payouts programmatically, serving as the financial bridge between your master account and your network of shippers or resellers.
File Management
A dedicated capability within the API that streams attached files (such as PDF summaries) directly in the response, enabling the automated archiving of financial documents.
Settlement Tracking
A system that categorizes payouts by direction (Credit vs. Debit) and status (Unpaid vs. Paid), linking them to specific Shipping Statements or Invoices for full auditability.
What can users do with the EPISHIP Payouts API?
Users can use the EPISHIP Payouts API to perform common workflows, such as:
- Retrieve a paginated list of payouts for a specific company
- Filter payouts by direction (credit or debit) and status
- Get the full details of a specific payout by ID
- Download attached payout files (PDFs) via secure stream
- Manually create a new payout record for a specific payer company
- Audit the balance amounts and associated invoices for settlements
Payout properties available to view and filter through the EPISHIP Payouts API:
- Payout ID
- Payer and Payee Company IDs
- Payout Date
- Total Amount and Balance
- Direction (Credit/Debit)
- Associated Invoice or Statement IDs