MerchantWithRelations

  • Core merchant object

    • activatedDate
      Type: stringFormat: date-time

      Date merchant was activated

    • addresses
      Type: array object[] · MerchantAddress[]

      Business address information

    • agentAccountId
      Type: string

      Agent account ID reference

    • agentName
      Type: string

      Agent name

    • banking
      Type: object

      Banking information

    • compliance
      Type: object

      Compliance information

    • createdAt
      Type: stringFormat: date-time

      When the merchant was created

    • createdBy
      Type: string

      Email of user who created the merchant

    • 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: integer

      Unique identifier for the merchant

    • isoAccountId
      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

    • merchantAccountId
      Type: string

      Merchant account ID reference

    • merchantName
      Type: string

      Business trading name

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

      Notes about the merchant

    • principals
      Type: array object[] · MerchantPrincipal[]

      Business principal/owner information

    • processing
      Type: object

      Processing configuration

    • processingStatus
      Type: stringenum

      Processing status

      values
      • enabled
      • disabled
      • limited
      • hold
    • rates
      Type: array object[] · MerchantRates[]

      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
    • updatedAt
      Type: stringFormat: date-time

      When the merchant was last updated

    • updatedBy
      Type: string

      Email of user who last updated the merchant