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
- city
  Type: string
- country
  Type: string
- postalCode
  Type: string
- state
  Type: string
- street1
  Type: string
- street2
  Type: string
agentId
Type: string

Agent account ID reference
agentName
Type: string

Agent name
banking
Type: object

Banking information
- accountNumberLast4
  Type: string
  
  Last 4 digits of account number
- accountType
  Type: stringenum
  values
  checking
  savings
- bankName
  Type: string
- routingNumber
  Type: string
compliance
Type: object

Compliance information
- documentsRequired
  Type: array object[]
- lastPciDate
  Type: stringFormat: date-time
  
  the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- nextPciDue
  Type: stringFormat: date-time
  
  the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- pciCompliant
  Type: boolean
- pciLevel
  Type: string
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
- id
  Type: string
- name
  Type: string
  
  Document name
- status
  Type: stringenum
  
  Document status
  
  values
  pending
  approved
  rejected
- type
  Type: string
  
  Document type
- uploadedBy
  Type: string
  
  Who uploaded the document
- uploadedDate
  Type: stringFormat: date-time
  
  Upload date
- url
  Type: string
  
  Document URL
equipment
Type: array object[] · 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
- 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
- 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
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
- author
  Type: string
  
  Note author
- content
  Type: string
  
  Note content
- date
  Type: stringFormat: date-time
  
  Note creation date
- id
  Type: string
- type
  Type: stringenum
  
  Note type
  
  values
  general
  risk
  support
  compliance
  billing
  agent
- visibility
  Type: stringenum
  
  Note visibility
  
  values
  internal
  merchant
  all
owner
Type: object

Primary owner information
- email
  Type: string
- firstName
  Type: string
- lastName
  Type: string
- phone
  Type: string
- ssn
  Type: string
  
  SSN (decrypted for display)
processing
Type: object

Processing configuration
- averageTicket
  Type: numberFormat: decimal
- currentReserve
  Type: numberFormat: decimal
- dailyLimit
  Type: numberFormat: decimal
- highTicket
  Type: numberFormat: decimal
- monthlyLimit
  Type: numberFormat: decimal
- monthlyVolume
  Type: numberFormat: decimal
- processingLimit
  Type: numberFormat: decimal
- reservePercentage
  Type: numberFormat: decimal
processingStatus
Type: stringenum

Processing status
values
- enabled
- disabled
- limited
- hold
rates
Type: object

Rate structure
- agentSplit
  Type: numberFormat: decimal
- annualFee
  Type: numberFormat: decimal
- batchFee
  Type: numberFormat: decimal
- chargebackFee
  Type: numberFormat: decimal
- discountRate
  Type: numberFormat: decimal
- isoSplit
  Type: numberFormat: decimal
- monthlyFee
  Type: numberFormat: decimal
- pciComplianceFee
  Type: numberFormat: decimal
- statementFee
  Type: numberFormat: decimal
- transactionFee
  Type: numberFormat: decimal
riskLevel
Type: stringenum

Risk assessment level
values
- low
- medium
- high
- critical
riskMetrics
Type: object

Risk assessment metrics
- chargebackCount
  Type: number
- chargebackRatio
  Type: numberFormat: decimal
- lastRiskReview
  Type: stringFormat: date-time
  
  the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- nextRiskReview
  Type: stringFormat: date-time
  
  the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- refundRatio
  Type: numberFormat: decimal
- riskScore
  Type: number
- suspiciousActivity
  Type: boolean
status
Type: stringenum

Current merchant status
values
- active
- inactive
- suspended
- pending
- closed
supportTickets
Type: array object[]
- createdDate
  Type: stringFormat: date-time
  
  the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- id
  Type: string
- lastUpdated
  Type: stringFormat: date-time
  
  the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- priority
  Type: stringenum
  values
  low
  medium
  high
  urgent
- status
  Type: stringenum
  values
  open
  in_progress
  resolved
  closed
- subject
  Type: string