AccountDetail

Complete account details model for the MMS dashboard

description
Type: string · Description
required

Description of the account
devices
Type: array object[] · Devices
required

Devices assigned to stores or the account
Model representing a device
- assignedTo
  Type: string · Assignedto
  required
- firmwareVersion
  Type: string · Firmwareversion
  required
- id
  Type: string · Id
  required
- lastSeen
  Type: string · Lastseen
  required
- model
  Type: string · Model
  required
- name
  Type: string · Name
  required
- serialNumber
  Type: string · Serialnumber
  required
- status
  Type: string · Status
  required
- type
  Type: string · Type
  required
id
Type: string · Id
required

Unique identifier for the account
merchants
Type: array object[] · Merchants
required

Child merchant accounts
Model representing a child account
- id
  Type: string · Id
  required
- name
  Type: string · Name
  required
- type
  Type: string · Type
  required
name
Type: string · Name
required

Name of the account holder or organization
partners
Type: array object[] · Partners
required

Child partner accounts
Model representing a child account
- id
  Type: string · Id
  required
- name
  Type: string · Name
  required
- type
  Type: string · Type
  required
processors
Type: array object[] · Processors
required

List of payment processors associated with this account
Model representing a payment processor configuration
- description
  Type: string · Description
  required
- gateway
  Type: string · Gateway
  required
- id
  Type: string · Id
  required
- name
  Type: string · Name
  required
- processor
  Type: string · Processor
  required
- psp
  Type: string · Psp
  required
- type
  Type: string · Type
  required
status
Type: string · Status
required

Current status of the account
stores
Type: array object[] · Stores
required

Physical retail locations
Model representing a store/location
- address
  Type: string · Address
  required
- description
  Type: string · Description
  required
- id
  Type: string · Id
  required
- name
  Type: string · Name
  required
- processor
  Type: object · StoreProcessorDetail
  required
  
  Model representing processor details for a store
taxId
Type: string · Taxid
required

Tax identification number
terminals
Type: array object[] · Terminals
required

List of payment terminals owned by the account
Model representing a payment terminal
- bin
  Type: string · Bin
  required
- countryCode
  Type: string · Countrycode
  required
- currencyCode
  Type: string · Currencycode
  required
- gateway
  Type: string · Gateway
  required
- id
  Type: string · Id
  required
- locationNumber
  Type: string · Locationnumber
  required
- mid
  Type: string · Mid
  required
- model
  Type: string · Model
  required
- name
  Type: string · Name
  required
- processor
  Type: string · Processor
  required
- serialNumber
  Type: string · Serialnumber
  required
- softwareVersion
  Type: string · Softwareversion
  required
- status
  Type: string · Status
  required
- tid
  Type: string · Tid
  required
- vnumber
  Type: string · Vnumber
  required
transactions
Type: array object[] · Transactions
required

Recent transactions for the account
Model representing a transaction summary
- amount
  Type: number · Amount
  required
- date
  Type: string · Date
  required
- id
  Type: string · Id
  required
- paymentMethod
  Type: string · Paymentmethod
  required
- status
  Type: string · Status
  required
type
Type: string · Type
required

Account type (admin, psp, partner, merchant)

Examples

{
  "description": "Global technology and innovation company specializing in software solutions",
  "devices": [
    {
      "assignedTo": "Downtown Flagship",
      "firmwareVersion": "15.4.1",
      "id": "dev_1",
      "lastSeen": "2023-05-15 15:30:00+00:00",
      "model": "iPad Pro 12.9\"",
      "name": "Checkout iPad 1",
      "serialNumber": "IPAD123456789",
      "status": "active",
      "type": "Tablet"
    }
  ],
  "id": "acc_123456",
  "merchants": [
    {
      "id": "mchnt_1",
      "name": "Acme Retail",
      "type": "Merchant"
    }
  ],
  "name": "Acme Corporation",
  "partners": [
    {
      "id": "prtnr_1",
      "name": "Acme Partners",
      "type": "Partner"
    }
  ],
  "processors": [
    {
      "apiVersion": "2023-10",
      "fee": 2.9,
      "id": "proc_1",
      "isActive": true,
      "name": "Stripe",
      "settlementTime": "2-3 business days",
      "type": "Credit Card"
    }
  ],
  "status": "active",
  "stores": [
    {
      "address": "123 Main Street, New York, NY 10001",
      "description": "Main retail location in the city center",
      "id": "store_1",
      "name": "Downtown Flagship",
      "processor": {
        "config": "Standard Retail",
        "mid": "MID12345678",
        "name": "Stripe",
        "tid": "TID98765"
      }
    }
  ],
  "taxId": "12-3456789",
  "terminals": [
    {
      "bin": "123456",
      "countryCode": "US",
      "currencyCode": "USD",
      "gateway": "Stripe Terminal",
      "id": "term_1",
      "locationNumber": "001",
      "mid": "MID12345678",
      "model": "Clover Flex",
      "name": "Main Store Terminal",
      "processor": "Stripe",
      "serialNumber": "ST001",
      "softwareVersion": "4.2.1",
      "status": "active",
      "tid": "T123456",
      "vnumber": "V12345"
    }
  ],
  "transactions": [
    {
      "amount": 219.41,
      "date": "2025-04-30 16:44:43.396000+00:00",
      "id": "txn_4mockw5w",
      "paymentMethod": "Mastercard",
      "status": "failed"
    }
  ],
  "type": "merchant"
}