EPISHIP API Billing Credit overview

EPISHIP Billing Credit API icon 32px svg

Overview

The EPISHIP Billing Credit API lets you manage financial transactions and credit balances within your shipping workspace. You can develop applications that integrate with EPISHIP to automate the retrieval of payment history, perform manual credit top-ups using stored payment methods, and reconcile transaction logs with external accounting systems.

View Doc →

The following figure shows the relationship between your EPISHIP app, the EPISHIP API, and Billing services.

EPISHIP Billing Credit API diagram svg

Figure 1. EPISHIP API relationship diagram. Billing credit architecture and funds flow.

EPISHIP App

EPISHIP’s billing services give administrators control over company funds, allowing for the review of credit entries, management of payment methods (such as ACH), and verification of transaction statuses to ensure uninterrupted shipping operations.

EPISHIP API

The REST API that allows users to access credit history, execute top-ups, and monitor transaction statuses 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 financial administrators can view transaction details or add funds.

Credit Management

A system that maintains a ledger of all credit entries, supporting detailed filtering by company ID, pagination of records, and sorting by transaction attributes like ID or date.

What can users do with the EPISHIP Billing Credit API?

Users can use the EPISHIP Billing Credit API to perform common workflows, such as:

  • Retrieve a paginated list of credit entries for a specific company
  • Perform manual credit top-ups using existing payment methods
  • Filter transaction logs by ID, type, status, or date
  • Retrieve the specific details of a single credit entry
  • Verify the status of a payment (e.g., pending vs. active)
  • Search for transactions using a query string

Billing properties available to view and filter through the EPISHIP Billing Credit API:

  • Credit Entry ID
  • Transaction ID
  • Payment Method (Type, ID)
  • Amount and Currency
  • Status (e.g., pending, success)
  • Description

Additional info

  • Learn more about developing with EPISHIP Billing API, including handling authentication, authorization, reference the Develop on EPISHIP API for your workspace. More →
  • Learn more about how to launch and run an EPISHIP Billing API app, read the Developer Page. More →

Related

Related Categories