ZenPayments
  1. Merchants
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
          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. Merchants

List Merchants

GET
/api/merchant

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/merchant' \
--header 'Authorization: Bearer <token>'

Responses

🟢200List Merchants
application/json
Body

Example
{
  "items": [
      {
                  "id": "1",
                  "name": "Demo Merchant Inc",
                  "principals": [
                      {
                          "name": {
                              "first": "Dewayne",
                              "last": "Stehr"
                          },
                          "isSigner": "Yes",
                          "isPersonalGuarantee": "Yes",
                          "ownershipPercentage": 51
                      },
                      {
                          "name": {
                              "first": "Kelli",
                              "last": "Morar"
                          },
                          "isSigner": "Yes",
                          "isPersonalGuarantee": "No",
                          "ownershipPercentage": 12
                      }
                  ],
                  "dbas": [
                      {
                          "id": "1",
                          "name": "Demo Merchant DBA",
                          "address": {
                              "street": "Lorem 15",
                              "city": "New Damonmouth",
                              "zip": "2222",
                              "state": [
                                  15
                              ],
                              "country": [
                                  199
                              ]
                          },
                          "customerServiceContact": {
                              "phone": "+1 717-888-8888",
                              "email": "demo-merchant@manky.org"
                          },
                          "processing": {
                              "mid": "201143806445",
                              "bank": {
                                  "accountNumber": "123123",
                                  "routingNumber": "123123333"
                              },
                              "banks": [
                                {
                                  "id": 65622,
                                  "type": "All",
                                  "bankAccountNumber": "123123",
                                  "bankRoutingNumber": "123123333"
                                }
                              ],
                              "mcc": "5734",
                              "status": "Closed",
                              "boardedOn": "2019-02-06 12:00:00",
                              "closedOn": "2022-02-16 15:38:33",
                              "volumes": {
                                  "monthlyTransactionAmount": 7000000,
                                  "avgTransactionAmount": 700,
                                  "maxTransactionAmount": 7000
                              },
                              "sales": {
                                  "swiped": 30,
                                  "mail": 10,
                                  "internet": 60
                              },
                              "feeSchedule": {
                                  "fees": [
                                      {
                                          "id": "1",
                                          "type": {
                                              "id": "1"
                                          },
                                          "value": "0.00000"
                                      },
                                      {
                                          "id": "2",
                                          "type": {
                                              "id": "2"
                                          },
                                          "value": "0.00000"
                                      },
                                      {
                                          "id": "3",
                                          "type": {
                                              "id": "3"
                                          },
                                          "value": "0.00000"
                                      },
                                      {
                                          "id": "4",
                                          "type": {
                                              "id": "4"
                                          },
                                          "value": "0.00000"
                                      },
                                      {
                                          "id": "5",
                                          "type": {
                                              "id": "5"
                                          },
                                          "value": "0.00000"
                                      },
                                      {
                                          "id": "6",
                                          "type": {
                                              "id": "6"
                                          },
                                          "value": "0.00000"
                                      },
                                      {
                                          "id": "7",
                                          "type": {
                                              "id": "7"
                                          },
                                          "value": "0.75000"
                                      },
                                      {
                                          "id": "8",
                                          "type": {
                                              "id": "8"
                                          },
                                          "value": "0.00000"
                                      },
                                      {
                                          "id": "9",
                                          "type": {
                                              "id": "9"
                                          },
                                          "value": "0.00000"
                                      },
                                      {
                                          "id": "10",
                                          "type": {
                                              "id": "10"
                                          },
                                          "value": "0.00000"
                                      },
                                      {
                                          "id": "11",
                                          "type": {
                                              "id": "11"
                                          },
                                          "value": "5.00000"
                                      },
                                      {
                                          "id": "12",
                                          "type": {
                                              "id": "12"
                                          },
                                          "value": "25.00000"
                                      },
                                      {
                                          "id": "13",
                                          "type": {
                                              "id": "13"
                                          },
                                          "value": "0.00000"
                                      },
                                      {
                                          "id": "14",
                                          "type": {
                                              "id": "14"
                                          },
                                          "value": "0.00000"
                                      },
                                      {
                                          "id": "15",
                                          "type": {
                                              "id": "15"
                                          },
                                          "value": "0.05000"
                                      },
                                      {
                                          "id": "16",
                                          "type": {
                                              "id": "16"
                                          },
                                          "value": "35.00000"
                                      },
                                      {
                                          "id": "17",
                                          "type": {
                                              "id": "17"
                                          },
                                          "value": "5.00000"
                                      },
                                      {
                                          "id": "18",
                                          "type": {
                                              "id": "18"
                                          },
                                          "value": "0.00000"
                                      },
                                      {
                                          "id": "19",
                                          "type": {
                                              "id": "20"
                                          },
                                          "value": "0.00000"
                                      },
                                      {
                                          "id": "20",
                                          "type": {
                                              "id": "18"
                                          },
                                          "value": "0.00000"
                                      },
                                      {
                                          "id": "21",
                                          "type": {
                                              "id": "18"
                                          },
                                          "value": "0.00000"
                                      }
                                  ],
                                  "note": null
                              }
                          },
                          "ach": {
                              "id": "14",
                              "bank": {
                                  "accountNumber": "123123",
                                  "routingNumber": "123123333"
                              },
                              "banks": [
                                {
                                  "id": 65622,
                                  "type": "All",
                                  "bankAccountNumber": "123123",
                                  "bankRoutingNumber": "123123333"
                                }
                              ],
                              "status": "Inactive",
                              "boardedOn": "2020-04-14 17:04:37",
                              "volumes": {
                                  "monthlyTransactions": 4,
                                  "avgMonthlyTransactionAmount": 5,
                                  "avgTransactionAmount": 6,
                                  "maxTransactionAmount": 7,
                                  "monthlyReturn": 1
                              },
                              "feeSchedule": {
                                  "fees": [
                                      {
                                          "id": "145",
                                          "type": {
                                              "id": "25"
                                          },
                                          "value": "2.00000"
                                      },
                                      {
                                          "id": "146",
                                          "type": {
                                              "id": "26"
                                          },
                                          "value": "2.00000"
                                      },
                                      {
                                          "id": "147",
                                          "type": {
                                              "id": "27"
                                          },
                                          "value": "2.00000"
                                      },
                                      {
                                          "id": "148",
                                          "type": {
                                              "id": "28"
                                          },
                                          "value": "2.00000"
                                      },
                                      {
                                          "id": "149",
                                          "type": {
                                              "id": "29"
                                          },
                                          "value": "2.00000"
                                      },
                                      {
                                          "id": "150",
                                          "type": {
                                              "id": "30"
                                          },
                                          "value": "2.00000"
                                      },
                                      {
                                          "id": "151",
                                          "type": {
                                              "id": "31"
                                          },
                                          "value": "2.00000"
                                      },
                                      {
                                          "id": "152",
                                          "type": {
                                              "id": "32"
                                          },
                                          "value": "2.00000"
                                      },
                                      {
                                          "id": "153",
                                          "type": {
                                              "id": "33"
                                          },
                                          "value": "2.00000"
                                      },
                                      {
                                          "id": "154",
                                          "type": {
                                              "id": "35"
                                          },
                                          "value": "2.00000"
                                      },
                                      {
                                          "id": "155",
                                          "type": {
                                              "id": "35"
                                          },
                                          "value": "2.00000"
                                      },
                                      {
                                          "id": "156",
                                          "type": {
                                              "id": "35"
                                          },
                                          "value": "2.00000"
                                      }
                                  ],
                                  "note": "2"
                              }
                          }
                      }
  ],
  "_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
VAR View
Next
DBA
Built with