Skip to main content
Deployment endpoints cover everything that happens to physical equipment after an application is approved: the order, the devices on it, the file build each device is programmed with, the VAR sheet that identifies it to the processor, and the shipment that gets it to the merchant. An order carries line items — one per device. Each line item is configured by a file build, provisioned against a device workflow, and identified by a VAR sheet. Once provisioned, line items are grouped into shipments that quote carrier rates, buy labels, and track delivery. Every step is recorded on the order’s event timeline.

Orders

Create and manage deployment orders for a lead, client, or merchant.

Line Items

Add devices to an order, then provision them and mint their VAR sheets.

File Builds

Configure how a device is programmed, including PIN Debit.

Shipments

Quote carrier rates, purchase and void labels, and cancel shipments.

Shipment Line Items

Choose which devices travel in which shipment.

Events

Read the timeline of everything that happened to an order.

VAR Sheets

List, create, and retrieve the VAR sheets that identify deployed terminals.

Devices

Manage the merchant-facing device records created by provisioning.

Inventory Units

Track serialized stock available to assign to a line item.

Models

Browse the equipment catalog and which models each order type may offer.