Skip to main content
Equipment records define the hardware a merchant will use for card acceptance. Models specify the terminal type and configuration; orders track the physical fulfillment and deployment of that equipment, including line items, gateway settings, and file build types.

Equipment models

EndpointDescription
List equipment modelsRetrieve all equipment models for a lead
Create equipment modelAdd an equipment model to a lead
Get equipment modelRetrieve a single equipment model
Update equipment modelUpdate a lead equipment model
Delete equipment modelRemove an equipment model from a lead

Equipment orders

EndpointDescription
List equipment ordersRetrieve all equipment orders for a lead
Create equipment orderCreate a new equipment order for a lead
Get equipment orderRetrieve a single equipment order
Update equipment orderUpdate a lead equipment order
Delete equipment orderRemove an equipment order from a lead
List order itemsRetrieve all items in an equipment order
Create order itemAdd an item to an equipment order
Get order itemRetrieve a single order item
Update order itemUpdate an equipment order item
Delete order itemRemove an item from an equipment order
Create gatewayAdd gateway configuration to an equipment order
Get gatewayRetrieve the gateway configuration
Update gatewayUpdate the gateway configuration
Delete gatewayRemove the gateway configuration
Create file build typeSet the file build type for an equipment order
Get file build typeRetrieve the file build type
Update file build typeUpdate the file build type
Delete file build typeRemove the file build type from an equipment order