EPISHIP API Billing Credit Ship Cards overview

EPISHIP Billing Credit Ship Cards API icon 32px svg

Overview

The EPISHIP Billing Credit Ship Cards API lets you manage prepaid credit instruments within your logistics ecosystem. You can develop applications that integrate with EPISHIP to automate the generation of digital or physical gift cards, facilitate bulk redemptions via CSV, and programmatically distribute value to reseller accounts or customers.

View Doc →

The following figure shows the relationship between your EPISHIP app, the EPISHIP API, and Ship Card services

EPISHIP Billing Credit Ship Cards API diagram svg

Figure 1. EPISHIP API relationship diagram. Ship Card generation and redemption flow.

EPISHIP App

EPISHIP’s ship card services give administrators the ability to issue prepaid funds to account holders, enabling seamless balance top-ups through QR codes, verification strings, or physical cards mailed directly to the user.

EPISHIP API

The REST API that allows users to create, redeem, and manage the lifecycle of Ship Cards programmatically from within your app.

Card Generation

A flexible system that supports both real-time creation for immediate digital use and queued generation for large batches, with options to trigger physical mailing to specified addresses.

Redemption & Management

A mechanism that validates verification codes to apply funds to company balances, while offering tools to export data, restore deleted cards, or disable compromised cards instantly.

What can users do with the EPISHIP Ship Cards API?

Users can use the EPISHIP Ship Cards API to perform common workflows, such as:

  • Generate new Ship Cards in real-time or via background queues
  • Redeem cards using a Slug and Verification Code to add funds
  • Export and Import Ship Card data via CSV for batch processing
  • Distribute cards via email or download PDF versions
  • Manage card states (Enable, Disable, Soft-delete, Restore)
  • Request physical mailing of cards to specific addresses

Ship Card properties available to view and filter through the EPISHIP Ship Cards API:

  • Slug and Verification Code
  • Monetary Value
  • Redemption Status
  • QR Code and Short URLs
  • Mailing Address
  • Card State (Enabled/Disabled)

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