ZenPayments
  1. Terminals
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
            GET
          • View a specific Terminal
            GET
          • VAR Sheet
            GET
          • VAR View
            GET
        • List Merchants
          GET
      • 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. Terminals

List Terminals

GET
/api/terminals
List all terminals with their associated merchant.id and dba.id

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/api/terminals' \
--header 'Authorization: Bearer <token>'

Responses

🟢200List Terminals
application/json
Body

Example
{
    "items": [
        {
            "id": 1,
            "name": "ACME Corporation",
            "principals": [
                {
                    "id": 12,
                    "name": {
                        "first": "Elmer",
                        "last": "Fudd"
                    },
                    "isSigner": "Yes",
                    "isPersonalGuarantee": "Yes",
                    "ownershipPercentage": 100
                }
            ],
            "dbas": [
                {
                    "id": 14,
                    "name": "ACME",
                    "address": {
                        "street": null,
                        "city": null,
                        "zip": null,
                        "state": [
                            null
                        ],
                        "country": [
                            199
                        ]
                    },
                    "customerServiceContact": {
                        "phone": "+1 818-707-1234",
                        "email": "email@email.com"
                    },
                    "processing": {
                        "id": 4,
                        "mid": 1231231231231312,
                        "bank": {
                            "name": "Axiom Bank",
                            "accountNumber": "8888"
                        },
                        "mcc": "5899",
                        "riskLevel": "Low",
                        "status": "Live",
                        "boardedOn": "2020-11-27 11:59:26",
                        "volumes": {
                            "monthlyTransactionAmount": 1000,
                            "avgTransactionAmount": 10,
                            "maxTransactionAmount": 100
                        },
                        "sales": {
                            "swiped": 70,
                            "mail": 30,
                            "internet": 0
                        },
                        "feeSchedule": {
                            "fees": [
                                {
                                    "id": 49,
                                    "type": {
                                        "id": 1
                                    },
                                    "value": "0.00000"
                                },
                                {
                                    "id": 50,
                                    "type": {
                                        "id": 2
                                    },
                                    "value": "0.00000"
                                },
                                {
                                    "id": 51,
                                    "type": {
                                        "id": 3
                                    },
                                    "value": "0.00000"
                                },
                                {
                                    "id": 52,
                                    "type": {
                                        "id": 4
                                    },
                                    "value": "0.00000"
                                },
                                {
                                    "id": 53,
                                    "type": {
                                        "id": 5
                                    },
                                    "value": "0.00000"
                                },
                                {
                                    "id": 54,
                                    "type": {
                                        "id": 6
                                    },
                                    "value": "0.00000"
                                },
                                {
                                    "id": 55,
                                    "type": {
                                        "id": 7
                                    },
                                    "value": "0.75000"
                                },
                                {
                                    "id": 56,
                                    "type": {
                                        "id": 8
                                    },
                                    "value": "0.00000"
                                },
                                {
                                    "id": 57,
                                    "type": {
                                        "id": 9
                                    },
                                    "value": "0.00000"
                                },
                                {
                                    "id": 58,
                                    "type": {
                                        "id": 10
                                    },
                                    "value": "0.00000"
                                },
                                {
                                    "id": 59,
                                    "type": {
                                        "id": 11
                                    },
                                    "value": "5.00000"
                                },
                                {
                                    "id": 60,
                                    "type": {
                                        "id": 12
                                    },
                                    "value": "25.00000"
                                },
                                {
                                    "id": 61,
                                    "type": {
                                        "id": 13
                                    },
                                    "value": "0.00000"
                                },
                                {
                                    "id": 62,
                                    "type": {
                                        "id": 14
                                    },
                                    "value": "0.00000"
                                },
                                {
                                    "id": 63,
                                    "type": {
                                        "id": 15
                                    },
                                    "value": "0.05000"
                                },
                                {
                                    "id": 64,
                                    "type": {
                                        "id": 16
                                    },
                                    "value": "35.00000"
                                },
                                {
                                    "id": 65,
                                    "type": {
                                        "id": 17
                                    },
                                    "value": "5.00000"
                                },
                                {
                                    "id": 66,
                                    "type": {
                                        "id": 18
                                    },
                                    "value": "0.00000"
                                },
                                {
                                    "id": 67,
                                    "type": {
                                        "id": 18
                                    },
                                    "value": "0.00000"
                                },
                                {
                                    "id": 68,
                                    "type": {
                                        "id": 18
                                    },
                                    "value": "0.00000"
                                },
                                {
                                    "id": 69,
                                    "type": {
                                        "id": 19
                                    },
                                    "value": "0.00000"
                                },
                                {
                                    "id": 70,
                                    "type": {
                                        "id": 20
                                    },
                                    "value": "0.00000"
                                },
                                {
                                    "id": 71,
                                    "type": {
                                        "id": 21
                                    },
                                    "value": "0.00000"
                                },
                                {
                                    "id": 72,
                                    "type": {
                                        "id": 22
                                    },
                                    "value": "0.00000"
                                }
                            ],
                            "note": null
                        }
                    },
                    "ach": {
                        "id": 13,
                        "bank": {
                            "name": "Mufg Union Bank, NA",
                            "accountNumber": "123456"
                        },
                        "riskLevel": "Low",
                        "status": "Inactive",
                        "boardedOn": "2020-11-27 11:59:26",
                        "volumes": {
                            "monthlyTransactions": 100,
                            "avgMonthlyTransactionAmount": 10,
                            "avgTransactionAmount": 100,
                            "maxTransactionAmount": 1000
                        },
                        "feeSchedule": {
                            "fees": [
                                {
                                    "id": 145,
                                    "type": {
                                        "id": 25
                                    },
                                    "value": "0.00000"
                                },
                                {
                                    "id": 146,
                                    "type": {
                                        "id": 26
                                    },
                                    "value": "0.00000"
                                },
                                {
                                    "id": 147,
                                    "type": {
                                        "id": 27
                                    },
                                    "value": "0.00000"
                                },
                                {
                                    "id": 148,
                                    "type": {
                                        "id": 28
                                    },
                                    "value": "0.00000"
                                },
                                {
                                    "id": 149,
                                    "type": {
                                        "id": 29
                                    },
                                    "value": "0.00000"
                                },
                                {
                                    "id": 150,
                                    "type": {
                                        "id": 30
                                    },
                                    "value": "0.00000"
                                },
                                {
                                    "id": 151,
                                    "type": {
                                        "id": 31
                                    },
                                    "value": "0.00000"
                                },
                                {
                                    "id": 152,
                                    "type": {
                                        "id": 32
                                    },
                                    "value": "0.00000"
                                },
                                {
                                    "id": 153,
                                    "type": {
                                        "id": 33
                                    },
                                    "value": "0.00000"
                                },
                                {
                                    "id": 154,
                                    "type": {
                                        "id": 35
                                    },
                                    "value": "0.00000"
                                },
                                {
                                    "id": 155,
                                    "type": {
                                        "id": 35
                                    },
                                    "value": "0.00000"
                                },
                                {
                                    "id": 156,
                                    "type": {
                                        "id": 35
                                    },
                                    "value": "0.00000"
                                }
                            ],
                            "note": null
                        }
                    }
                }
            ]
        }
    ],
    "_links": {
        "self": {
            "href": "https://zendashboard.com/api/merchant?page=1"
        },
        "first": {
            "href": "https://zendashboard.com/api/merchant?page=1"
        },
        "last": {
            "href": "https://zendashboard.com/api/merchant?page=1"
        }
    },
    "_meta": {
        "totalCount": 1,
        "pageCount": 1,
        "currentPage": 1,
        "perPage": 30
    }
}
Modified at 2025-08-09 05:39:41
Previous
Terminals
Next
View a specific Terminal
Built with