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

DBA

This endpoint is used to view all Merchant DBA related information.
DBA Object
FieldsDescriptionTypeFilterableRequiredReadonly
idUnique ID of the DBA recordIntegerNoNoYes
nameName of the DBAStringNoNoYes
addressObjectObjectNoNoYes
address.streetStreetStringNoNoYes
address.cityCityStringNoNoYes
address.zipZip codeStringNoNoYes
address.stateObjectObjectNoNoYes
address.state.idState IDStringNoNoYes
address.countryObjectObjectNoNoYes
address.country.idCountry IDStringNoNoYes
customerServiceContactObjectObjectNoNoYes
customerServiceContact.phoneCustomer service phone numberStringNoNoYes
customerServiceContact.emailCustomer service emailStringNoNoYes
processingObjectObjectNoNoYes
processing.idUnique ID of the Merchant Account recordIntegerNoNoYes
processing.midMerchant Identification NumberIntegerYesNoYes
processing.bankBank DetailsObjectNoNoYes
processing.bank.accountNumberThe Bank Account NumberStringNoNoYes
processing.bank.routingNumberThe Bank Routing NumberStringNoNoYes
processing.banksBank DetailsObjectNoNoYes
processing.banks.idUnique ID of the Bank AccountIntegerNoNoYes
processing.banks.typeThe Bank Account type All, Debits, DepositsENUMNoNoYes
processing.banks.bankAccountNumberThe Bank Account NumberStringNoNoYes
processing.banks.bankRoutingNumberThe Bank Routing NumberStringNoNoYes
processing.mccMerchant Category CodeStringNoNoYes
processing.statusStatus Approved, Live, Inactive, ClosedENUMYesNoYes
processing.boardedOnDate and Time when the DBA was createdDatetimeNoNoYes
processing.closedOnDate and Time when the DBA was closedDatetimeNoNoYes
processing.volumesObjectObjectNoNoYes
processing.volumes.monthlyTransactionAmountMonthly VolumeIntegerNoNoYes
processing.volumes.avgTransactionAmountAverage Transaction AmountIntegerNoNoYes
processing.volumes.maxTransactionAmountMax Transaction AmountIntegerNoNoYes
processing.salesObjectObjectNoNoYes
processing.sales.swipedPercentage of card-present transactionsIntegerNoNoYes
processing.sales.mailPercentage of mail/phone card not present transactionsIntegerNoNoYes
processing.sales.internetPercentage of internet/eCommerce card not present transactionsIntegerNoNoYes
processing.feeScheduleObjectObjectNoNoYes
processing.feeSchedule.feesFee ObjectObjectNoNoYes
processing.feeSchedule.fees.idIdentifier of FeeStringNoNoYes
processing.feeSchedule.fees.typeFee Type ObjectObjectNoNoYes
processing.feeSchedule.fees.type.idIdentifier of fee typesStringNoNoYes
processing.feeSchedule.fees.valueFee AmountStringNoNoYes
processing.feeSchedule.noteFee NoteStringNoNoYes
achObjectObjectNoNoYes
ach.idIdentification NumberStringNoNoYes
ach.bankBank DetailsObjectNoNoYes
ach.bank.accountNumberThe Bank Account NumberStringNoNoYes
ach.bank.routingNumberThe Bank Routing NumberStringNoNoYes
ach.banksBank DetailsObjectNoNoYes
ach.banks.idUnique ID of the Bank AccountIntegerNoNoYes
ach.banks.typeThe Bank Account type All, Debits, Credits, BillingENUMNoNoYes
ach.banks.bankAccountNumberThe Bank Account NumberStringNoNoYes
ach.banks.bankRoutingNumberThe Bank Routing NumberStringNoNoYes
ach.mccMerchant Category CodeStringNoNoYes
ach.statusStatus Approved, Live, Inactive, ClosedENUMYesNoYes
ach.boardedOnDate and Time when the DBA was createdDatetimeNoNoYes
ach.closedOnDate and Time when the DBA was closedDatetimeNoNoYes
ach.volumesObjectObjectNoNoYes
ach.volumes.monthlyTransactionsNumber Of Monthly TransactionsIntegerNoNoYes
ach.volumes.avgMonthlyTransactionAmountMonthly VolumeIntegerNoNoYes
ach.volumes.avgTransactionAmountAverage Transaction AmountIntegerNoNoYes
ach.volumes.maxTransactionAmountMax Transaction AmountIntegerNoNoYes
ach.volumes.monthlyReturnMonthly ReturnIntegerNoNoYes
ach.feeScheduleObjectObjectNoNoYes
ach.feeSchedule.feesFee ObjectObjectNoNoYes
ach.feeSchedule.fees.idIdentifier of FeeStringNoNoYes
ach.feeSchedule.fees.typeFee Type ObjectObjectNoNoYes
ach.feeSchedule.fees.type.idIdentifier of fee typesStringNoNoYes
ach.feeSchedule.fees.valueFee AmountStringNoNoYes
ach.feeSchedule.noteFee NoteStringNoNoYes
Modified at 2025-08-09 05:39:42
Previous
List Merchants
Next
List
Built with