EPISHIP API Billing Payout Payments overview

EPISHIP Billing Payout Payments API icon 32px svg

Overview

The EPISHIP Billing Payout Payments API lets you manage the settlement of payout records and facilitate fund transfers to partners or resellers. You can develop applications that integrate with EPISHIP to automate the reconciliation of payout balances, record manual settlement transactions, and trigger payments using stored financial instruments.

View Doc →

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

EPISHIP Billing Payout Payments API icon 32px diagram

Figure 1. EPISHIP API relationship diagram. Payout settlement and transaction flow.

EPISHIP App

EPISHIP’s payout services give financial administrators the ability to track outgoing settlements, ensuring that partners and resellers are paid accurately and that all manual transfers (such as wires or checks) are recorded against the correct payout ID.

EPISHIP API

The REST API that allows users to record manual payments, execute system-driven settlements, and retrieve payment history 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 initiate fund transfers or modify payment records.

Settlement Management

A system that links payment records to specific Payout IDs, enforcing validation rules to ensure that payment amounts do not exceed the outstanding payout balance.

What can users do with the EPISHIP Payout Payments API?

Users can use the EPISHIP Payout Payments API to perform common workflows, such as:

  • Retrieve a listing of payments associated with a specific Payout ID
  • Record a manual payment (e.g., external wire/check) with a transaction ID
  • Process a payout settlement using a stored Payment Method ID
  • Filter payment history by company, date, or amount
  • Retrieve the specific details of a single payout payment
  • Validate that settlement amounts align with payout balances

Payout Payment properties available to view and filter through the EPISHIP Payout Payments API:

  • Payout ID
  • Payment Method (Type and ID)
  • Transaction Amount
  • Transaction ID (External)
  • Payment Status
  • 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