MerchantEquipment

Equipment assigned to merchant

  • acceptAmex
    Type: boolean nullable
  • acceptDiscover
    Type: boolean nullable
  • acceptEbt
    Type: boolean nullable
  • acceptGiftCard
    Type: boolean nullable
  • acceptMastercard
    Type: boolean nullable
  • acceptPinDebit
    Type: boolean nullable
  • acceptVisa
    Type: boolean nullable
  • agentBank
    Type: string nullable
  • approvedMonthlyVolume
    Type: string nullable
  • backendProcessorId
    Type: string nullable

    Encrypted at rest. Endpoints other than …/sensitive return "REDACTED" here.

  • bin
    Type: string nullable

    Bank Identification Number.

  • chain
    Type: string nullable
  • createdAt
    Type: stringFormat: date-time

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • customerServicePhone
    Type: string nullable
  • deployedDate
    Type: stringFormat: date nullable

    Date equipment was deployed

  • equipmentNote
    Type: string nullable
  • equipmentUsed
    Type: string nullable
  • externalEquipmentId
    Type: string nullable
  • externalSource
    Type: string nullable

    e.g. maverick.

  • externalUrl
    Type: string nullable
  • gatewayProvider
    Type: string nullable
  • id
    Type: string
  • locationNumber
    Type: string nullable
  • mcc
    Type: string nullable

    Merchant Category Code.

  • merchantId
    Type: integer

    Integer numbers.

  • merchantNumber
    Type: string nullable

    MID number printed on the VAR sheet.

  • metaData
    Type: object nullable
    • propertyName
      Type: anything
  • midId
    Type: integer

    Integer numbers.

  • model
    Type: string

    Equipment model

  • notes
    Type: string nullable
  • providedBy
    Type: stringenum nullable
    values
    • ISO
    • Merchant
  • returnedDate
    Type: stringFormat: date nullable

    Date equipment was returned

  • serialNumber
    Type: string nullable

    Serial number

  • shippingAddress
    Type: object nullable
    • propertyName
      Type: anything
  • status
    Type: stringenum

    Equipment status

    values
    • active
    • inactive
    • returned
  • storeNumber
    Type: string nullable
  • terminalId
    Type: string nullable
  • threeDsStatus
    Type: string nullable
  • type
    Type: string

    Equipment type (terminal, gateway, etc.)

  • updatedAt
    Type: stringFormat: date-time

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z