ZenPayments
  1. Boarding Applications
ZenPayments
  • General Information
    • Authentication
    • Errors
    • Responses
    • Filters
      • Example - gte
      • Example - between
      • Example - like
      • Example - in
      • Example - non-empty
    • Pagination
      • 10 results per page
    • Data Types
  • Merchants
    • Sandbox
      • Sandbox Payment Gateway
    • Card Payments
      • Authorization
      • Sale
      • Capture
      • Partial Capture
      • Refund
      • Partial Refund
      • Soft/Dynamic Descriptor
      • Card Authentication
      • Card Tokenization
      • Card Tokenization with Global Token
      • Sale with a Fee Terminal
    • Hosted Form
      • Generate
      • Generate with Billing and Contact Information
    • Hosted Fields
      • How it Works
      • Hosted Fields Token
        • Hosted Fields Token
      • Integration Guide
        • Step 1: Include the JavaScript Library
        • Step 2: Add HTML Elements for all payment fields
        • Step 3: Set the AccessToken and Configure the rest of the form
        • Step 4: Add styling
        • Step 5: Listen for Events
        • Step 6: Get the tokenized card
          • Get the tokenized card
        • Add Payment Method Page
        • Testing your integration
    • CustomerVault
      • Sandbox
        • Sandbox Dashboard
      • Hosted Card Form
        • Generate
      • Customers
        • List
        • View
        • Create
        • Update
        • Archive
        • Delete
      • Cards
        • List Cards
        • View
        • Add Card
        • Update Exp Date
        • Archive
        • Unarchive
        • Delete
      • Billing Information
        • List
        • View
        • Update
        • Create
      • Shipping Information
        • List
        • View
        • Update
        • Create
      • Recurring Payment
        • List
        • View
        • Update
        • Create
    • Transaction Reporting
      • List
      • View
    • Response Codes
      • Verification Response Codes
    • 3DSecure
      • Version
      • Create
        • Create
      • Check
        • Check
      • Test Cards
    • Account Updater
      • Card Compatibility
      • How It Works
        • Sale with Account Updater
    • ACH Payments
      • General Information
      • Transactions
        • SEC Codes
        • Statuses
        • Actions
          • Action
        • History Log
          • Log
        • List
        • View
        • Create ACH
        • Create ACH & Save Customer
        • Create ACH for an existing Customer
        • Create ACH for an existing Customer and specific Account
        • Remove
      • Hosted Form
        • Example Request
      • Customers
        • List Customers
        • View specific Customer
        • Create Customer
        • Update Customer
        • Delete a Customer
      • Customer Accounts
        • List Customer Accounts
        • Create Customer Account
        • Update Customer Account
        • Delete a Customer Account
      • Bank Information
        • View
      • ACH Settlements
        • List
        • View
      • ACH Webhooks
        • New ACH Record
        • ACH Status Update
        • New ACH Customer
    • Reporting
      • Sandbox
        • Sandbox Dashboard
      • Authorizations
        • List
        • List with Filters
      • Batches
        • List
        • List with Filters
        • Summary
      • Payouts
        • List
        • View
        • Export
      • Chargebacks
        • Disputes
          • Upload a temporary file
          • Create a Dispute
          • Preview
          • Submit
        • Webhooks
          • Signatures
          • Events
            • Chargeback
              • New Chargeback Record
              • Chargeback Update
        • View
          • List
          • View
      • Statements
        • List
        • Download
      • Reserve
        • List
      • Fraud Report
        • Generate
      • Visa Verifi
        • Submiting External Transactions
          • Submit
        • List
      • Other Reports
        • Request a Report
        • Check Status
        • Download
    • Gateway Test Cards
  • Platforms
    • Sandbox
      • Sandbox Dashboard
    • Onboarding
      • Boarding Applications
        • Campaigns
          • List
        • Equipment
          • Terminals
            • List
            • View
          • View
          • Update
        • List
          • List Boarding Applications
        • Create
          • Create Boarding Application
        • Delete
          • Delete Boarding Application
        • View
          • View Boarding Application
        • Update
          • Update Boarding Application
        • Principals
          • List Principals
          • Create Principal
          • Update a Single Principal
          • Mass update Principals
          • Delete Principal
        • Processing
          • View Processing section
          • Update Processing section
        • Merchant Category Codes (MCCs)
          • List MCCs
        • ACH
          • View ACH section
          • Update ACH section
        • Documents
          • Attachment About
            • List All Document Categories
          • View all documents
          • MPA
          • Assign a single document
          • Assign multiple documents
          • Update a single document
          • Delete a single document
        • Fees
          • Types
            • List
          • Other Fees
            • Add
            • Update
            • Delete
          • List all fees
          • View a specific fee
          • Update a single fee
          • Update multiple fees
        • Bank Accounts
          • Add
          • Update
          • Change
        • Validate
          • Validate a Boarding Application
        • URL
          • GET URL of Boarding Application
        • Signature
          • Request E-sign
            • Request Signature
          • Embed E-sign
            • Embeded E-sign Example Flow 1
            • Embeded E-sign Example Flow 2
            • Request Embed
          • Manually Signing
            • Manual Sign
          • External eSign Signing
            • External eSign
        • Automation
          • AutoSign
            • Set AutoSign
          • AutoUnderwriting
            • Set AutoUnderwriting
        • Status
          • Set status to Underwriting
        • Notes
          • List
          • Create
      • Merchants
        • Terminals
          • List Terminals
          • View a specific Terminal
          • VAR Sheet
          • VAR View
        • List Merchants
      • DBA
        • List
        • View
      • Attachments
        • Temporary Upload
          • Temporary Upload
        • Chunk Upload
          • Initialize
          • Upload Request 1/2
          • Upload Request 2/2
        • Standard Upload
        • List attachments
        • View
        • View in browser
        • Download
        • Delete
      • Webhooks
        • Signatures
        • Events
          • Boarding Application
          • Merchant
            • Account
              • New Acquiring Account
              • New ACH Account
              • Closed Acquiring Account
              • Closed ACH Account
            • Terminal
              • New Terminal Record
              • Update Terminal Record
              • Delete Terminal Record
    • Reporting
      • Authorizations
        • List
        • List with Filters
      • Batches
        • List
        • List with Filters
        • Summary
      • Payouts
        • List
        • View
        • Export
      • Chargebacks
        • View
          • List
          • View
        • Disputes
          • Upload a temporary file
          • Create a Dispute
          • Preview
          • Submit
        • Webhooks
          • Signatures
          • Events
            • Chargeback
              • New Chargeback Record
              • Chargeback Update
      • Statements
        • List
        • Download
      • Reserve
        • List
      • Fraud Report
        • Generate
      • Other Reports
        • Request a Report
        • Check Status
        • Download
    • Residuals
      • List
      • View
    • Tickets
      • Update Ticket Status
        • Close
        • Re-Open
      • Responses
        • List
        • Create
        • Add an Attachment
      • Attachments
        • List
        • View
        • Create
        • Delete
      • Categories
        • List
      • Notes
        • List
        • View
        • Create
        • Update
        • Delete
        • Attachments
      • List
      • Create
      • View a specific ticket
    • Connect
      • Webhooks
        • Access Granted
        • Access Updated
        • Access Revoked
    • Misc
      • Address Checker
        • List Countries
        • List States
        • List Cities and Zip Codes
        • Filter by City and State
      • BIN Check
        • Get BIN Information
  1. Boarding Applications

Equipment

You can utilize this endpoint to perform several operations in the Equipment section of the Boarding Application
Equipment Object
FieldsDescriptionTypeFilterableRequiredReadonly
equipmentEquipment InfoObjectNoNoNo
equipment.usedEquipment Used ObjectObjectNoNoNo
equipment.used.valueEquipment Used ValueStringNoNoNo
equipment.used.lockedEquipment Used Locked Flag Yes or NoEnumNoNoNo
equipment.noteEquipment Note ObjectObjectNoNoNo
equipment.note.valueEquipment Note ValueStringNoNoNo
equipment.note.lockedEquipment Note Locked Flag Yes or NoEnumNoNoNo
equipment.providedByEquipment Provided By ObjectObjectNoNoNo
equipment.providedBy.valueISO,Deployment Center or ReprogramStringNoNoNo
equipment.providedBy.lockedEquipment Provided By Locked Flag Yes or NoEnumNoNoNo
varRequiredVar Required ObjectObjectNoNoNo
varRequired.valueVar Required Value Yes or NoEnumNoNoNo
varRequired.lockedVar Required Locked Flag Yes or NoEnumNoNoNo
discountPeriodDiscount Period ObjectObjectNoNoNo
discountPeriod.valueDiscount Period Value Daily or MonthlyEnumNoNoNo
discountPeriod.lockedDiscount Period Locked Flag Yes or NoEnumNoNoNo
fundingPeriodFunding Period ObjectObjectNoNoNo
fundingPeriod.valueFunding Period Value TwoBusinessDays, NextDay, SameDayEnumNoNoNo
fundingPeriod.lockedFunding Period Locked Flag Yes or NoEnumNoNoNo
typeType ObjectObjectNoNoNo
type.valueType Value NoHardware or PhysicalHardwareEnumNoNoNo
type.lockedType Locked Flag Yes or NoEnumNoNoNo
emvEmv ObjectObjectNoNoNo
emv.valueEmv Value Yes or NoEnumNoNoNo
emv.lockedEmv Locked Flag Yes or NoEnumNoNoNo
mobileTerminalMobile Terminal ObjectObjectNoNoNo
mobileTerminal.valueMobile Terminal Value Yes or NoEnumNoNoNo
mobileTerminal.lockedMobile Terminal Locked Flag Yes or NoEnumNoNoNo
externalPinPadExternal Pin Pad ObjectObjectNoNoNo
externalPinPad.valueExternal Pin Pad Value Yes or NoEnumNoNoNo
externalPinPad.lockedExternal Pin Pad Locked Flag Yes or NoEnumNoNoNo
contactlessContactless ObjectObjectNoNoNo
contactless.valueContactless Value Yes or NoEnumNoNoNo
contactless.lockedContactless Locked Flag Yes or NoEnumNoNoNo
existingTIDExisting TID ObjectObjectNoNoNo
existingTID.valueExisting TID Value Yes or NoEnumNoNoNo
existingTID.lockedExisting TID Locked Flag Yes or NoEnumNoNoNo
existingTID.terminalsExisting TID Boarding Application Terminals ObjectObjectNoNoNo
serialNumberSettingsSerial Number Settings ObjectObjectNoNoNo
serialNumberSettings.valueSerial Number Settings ValueStringNoNoNo
serialNumberSettings.lockedSerial Number Settings Locked Flag Yes or NoEnumNoNoNo
pinDebitPadPin Debit Pad ObjectObjectNoNoNo
pinDebitPad.valuePin Debit Pad Value Internal or ExternalEnumNoNoNo
pinDebitPad.lockedPin Debit Pad Locked Flag Yes or NoEnumNoNoNo
ebtFnsNumberEBT FNS NumberObjectNoNoNo
ebtFnsNumber.valueEBT FNS Number ValueStringNoNoNo
ebtFnsNumber.lockedEBT By Locked Flag Yes or NoEnumNoNoNo
terminalTerminal ObjectObjectNoNoNo
terminal.paidByTerminal Paid By ObjectObjectNoNoNo
terminal.paidBy.valueTerminal Paid By Value ISO, Deployment Center, Merchant, NAEnumNoNoNo
terminal.paidBy.lockedTerminal Paid By Locked Flag Yes or NoEnumNoNoNo
terminal.paidAmountTerminal Paid Amount ObjectObjectNoNoNo
terminal.paidAmount.valueTerminal Paid Amount ValueNumberNoNoNo
terminal.paidAmount.lockedTerminal Paid Amount Locked Flag Yes or NoEnumNoNoNo
terminal.shipToTerminal Ship To ObjectObjectNoNoNo
terminal.shipTo.valueTerminal Ship To Value ISO, Sub-Agent, MerchantEnumNoNoNo
terminal.shipTo.lockedTerminal Ship To Locked Flag Yes or NoEnumNoNoNo
terminal.shippingTerminal Shipping ObjectObjectNoNoNo
terminal.shipping.addressTerminal Shipping Address ObjectObjectNoNoNo
terminal.shipping.address.valueTerminal Shipping Address ValueStringNoNoNo
terminal.shipping.address.lockedTerminal Shipping Address Locked Flag Yes or NoEnumNoNoNo
terminal.shipping.methodTerminal Shipping Method ObjectObjectNoNoNo
terminal.shipping.method.valueTerminal Shipping Method Value Overnight, OvernightAm, SecondDay, FedexExpressSaverEnumNoNoNo
terminal.shipping.method.lockedTerminal Shipping Method Locked Flag Yes or NoEnumNoNoNo
terminal.communicationTerminal Communication ObjectObjectNoNoNo
terminal.communication.valueTerminal Communication Value Dial, Ethernet, WirelessEnumNoNoNo
terminal.communication.lockedTerminal Communication Locked Flag Yes or NoEnumNoNoNo
terminal.batchTerminal Batch ObjectObjectNoNoNo
terminal.batch.typeTerminal Batch Type ObjectObjectNoNoNo
terminal.batch.type.valueTerminal Batch Type Value Auto or ManualEnumNoNoNo
terminal.batch.type.lockedTerminal Batch Type Locked Flag Yes or NoEnumNoNoNo
terminal.batch.periodTerminal Batch Period ObjectObjectNoNoNo
terminal.batch.period.valueTerminal Batch Period ValueTimeNoNoNo
terminal.batch.period.lockedTerminal Batch Period Locked Flag Yes or NoEnumNoNoNo
terminal.headerTerminal Header ObjectObjectNoNoNo
terminal.header.valueTerminal Header ValueStringNoNoNo
terminal.header.lockedTerminal Header Locked Flag Yes or NoEnumNoNoNo
terminal.footerLineTerminal Footer Line ObjectObjectNoNoNo
terminal.footerLine.valueTerminal Footer Line Value One, Two, Three, FourEnumNoNoNo
terminal.footerLine.lockedTerminal Footer Line Locked Flag Yes or NoEnumNoNoNo
terminal.surchargeTerminal Surcharge ObjectObjectNoNoNo
terminal.surcharge.feeDescriptionTerminal Surcharge Fee Description ObjectObjectNoNoNo
terminal.surcharge.feeDescription.valueTerminal Surcharge Fee Description ValueStringNoNoNo
terminal.surcharge.feeDescription.lockedTerminal Surcharge Fee Description Locked Flag Yes or NoEnumNoNoNo
terminal.surcharge.percentageTerminal Surcharge Percentage ObjectObjectNoNoNo
terminal.surcharge.percentage.valueTerminal Surcharge Percentage ValueNumberNoNoNo
terminal.surcharge.percentage.lockedTerminal Surcharge Percentage Locked Flag Yes or NoEnumNoNoNo
terminal.surcharge.bypassOptionTerminal Surcharge Bypass Option ObjectObjectNoNoNo
terminal.surcharge.bypassOption.valueTerminal Surcharge Bypass Option Value Yes or NoEnumNoNoNo
terminal.surcharge.bypassOption.lockedTerminal Surcharge Bypass Option Locked Flag Yes or NoEnumNoNoNo
terminal.surcharge.notesTerminal Surcharge Notes ObjectObjectNoNoNo
terminal.surcharge.notes.valueTerminal Surcharge Notes ValueStringNoNoNo
terminal.surcharge.notes.lockedTerminal Surcharge Notes Locked Flag Yes or NoEnumNoNoNo
terminal.tipTerminal Tip ObjectObjectNoNoNo
terminal.tip.lineTerminal Tip Line ObjectObjectNoNoNo
terminal.tip.line.valueTerminal Tip Line Value Yes or NoEnumNoNoNo
terminal.tip.line.lockedTerminal Tip Line Locked Flag Yes or NoEnumNoNoNo
terminal.tip.promptTerminal Tip Prompt ObjectObjectNoNoNo
terminal.tip.prompt.valueTerminal Tip Prompt Value Yes or NoEnumNoNoNo
terminal.tip.prompt.lockedTerminal Tip Prompt Locked Flag Yes or NoEnumNoNoNo
terminal.tip.suggestionTerminal Tip Suggestion ObjectObjectNoNoNo
terminal.tip.suggestion.valueTerminal Tip Suggestion Value Yes or NoEnumNoNoNo
terminal.tip.suggestion.lockedTerminal Tip Suggestion Locked Flag Yes or NoEnumNoNoNo
terminal.tip.suggestion.percentagesTerminal Tip Suggestion Percentages ObjectObjectNoNoNo
terminal.tip.suggestion.percentages.valueTerminal Tip Suggestion Percentages ValueStringNoNoNo
terminal.tip.suggestion.percentages.lockedTerminal Tip Suggestion Percentages Locked Flag Yes or NoEnumNoNoNo
lastEquipmentUpdatedLast Date Equipment UpdatedDatetimeNoNoNo
lastAgentReviewLast Date Reviewed By AgentDatetimeNoNoNo
Modified at 2025-08-09 05:39:42
Previous
List
Next
Terminals
Built with