MerchantList

  • currentPage
    Type: integer

    Integer numbers.

  • data
    Type: array object[] · MerchantResponse[]

    Enhanced merchant response with all related data

    • accountNumber
      Type: string

      Merchant account number

    • activatedDate
      Type: stringFormat: date-time

      Date merchant was activated

    • address
      Type: object

      Business address

    • agentId
      Type: string

      Agent account ID reference

    • agentName
      Type: string

      Agent name

    • banking
      Type: object

      Banking information

    • compliance
      Type: object

      Compliance information

    • createdDate
      Type: stringFormat: date-time

      When the merchant was created

    • dba
      Type: string

      Doing Business As name

    • documents
      Type: array object[] · MerchantDocument[]

      Documents related to merchant

    • equipment
      Type: array object[] · MerchantEquipment[]

      Equipment assigned to merchant

    • id
      Type: string

      Merchant account ID

    • isoId
      Type: string

      ISO account ID reference

    • isoName
      Type: string

      ISO name

    • lastProcessingDate
      Type: stringFormat: date-time

      Last processing activity date

    • legalName
      Type: string

      Legal business name

    • mcc
      Type: string

      Merchant category code

    • mccDescription
      Type: string

      Description of the MCC

    • merchantName
      Type: string

      Business trading name

    • notes
      Type: array object[] · MerchantNote[]

      Notes about the merchant

    • owner
      Type: object

      Primary owner information

    • processing
      Type: object

      Processing configuration

    • processingStatus
      Type: stringenum

      Processing status

      values
      • enabled
      • disabled
      • limited
      • hold
    • rates
      Type: object

      Rate structure

    • riskLevel
      Type: stringenum

      Risk assessment level

      values
      • low
      • medium
      • high
      • critical
    • riskMetrics
      Type: object

      Risk assessment metrics

    • status
      Type: stringenum

      Current merchant status

      values
      • active
      • inactive
      • suspended
      • pending
      • closed
    • supportTickets
      Type: array object[]
  • totalCount
    Type: integer

    Integer numbers.

  • totalPages
    Type: integer

    Integer numbers.