Application

Application object representing a merchant or customer application

admin
Type: object

Administrative information about the application
auditLog
Type: array object[]
read-only

Comprehensive audit log of all significant events and actions performed on the application
- account_id
  Type: string
  
  Account ID associated with the action
- apiKey
  Type: string nullable
  
  API key identifier if the action was performed via API key authentication
- created
  Type: stringFormat: date-time
  
  Timestamp when the event occurred
- data
  Type: object
  
  Event-specific data containing details about what was changed or accessed
- event
  Type: string
  
  Type of event (e.g., application_created, application_updated, application_sensitive_data_revealed)
- id
  Type: integer
  
  Unique identifier for the audit log entry
- requestHeaders
  Type: object
  
  Sanitized HTTP headers from the request (sensitive values are masked)
- requestIpAddress
  Type: string
  
  IP address of the request origin
- requestMethod
  Type: string
  
  HTTP method used (GET, POST, PATCH, DELETE)
- requestPath
  Type: string
  
  API endpoint path that was called
- user
  Type: string
  
  Email address or identifier of the user who performed the action
basics
Type: object
- dbaCity
  Type: string
- dbaContact
  Type: string
- dbaEmail
  Type: string
- dbaName
  Type: string
  
  Business name (DBA)
- dbaPhone
  Type: string
- dbaState
  Type: string
- dbaStreet1
  Type: string
- dbaStreet2
  Type: string
- dbaStruct
  Type: string
- dbaTaxId
  Type: string
  
  Tax ID (redacted in unauthenticated responses)
- dbaTraded
  Type: string
- dbaZip
  Type: string
- locAddr1
  Type: string
- locAddr2
  Type: string
- locationDifferent
  Type: boolean
- locCity
  Type: string
- locContact
  Type: string
- locEmail
  Type: string
- locName
  Type: string
- locPhone
  Type: string
- locState
  Type: string
- locZip
  Type: string
- primaryLanguage
  Type: string
- tinType
  Type: string
businessBanking
Type: object
- bankAccount
  Type: string
  
  Bank account information (redacted in unauthenticated responses)
- bankContact
  Type: string
- bankName
  Type: string
- bankRouting
  Type: string
businessDetails
Type: object
- b2BSalesPercent
  Type: integer
  
  Integer numbers.
- businessAdvertising
  Type: string
- geographicSalesArea
  Type: string
- marketType
  Type: string
- mccCategory
  Type: string
- mccNumber
  Type: integer
  
  Integer numbers.
- naicsNumber
  Type: integer
  
  Integer numbers.
- productsServicesSold
  Type: string
- publicSalesPercent
  Type: integer
  
  Integer numbers.
- salesMethods
  Type: string
- seasonalAprBool
  Type: boolean
- seasonalAugBool
  Type: boolean
- seasonalDecBool
  Type: boolean
- seasonalFebBool
  Type: boolean
- seasonalJanBool
  Type: boolean
- seasonalJulBool
  Type: boolean
- seasonalJunBool
  Type: boolean
- seasonalMarBool
  Type: boolean
- seasonalMayBool
  Type: boolean
- seasonalMerchantBool
  Type: string
- seasonalMerchantExplain
  Type: string
- seasonalNovBool
  Type: boolean
- seasonalOctBool
  Type: boolean
- seasonalSepBool
  Type: boolean
- sicNumber
  Type: integer
  
  Integer numbers.
- website
  Type: string
businessHistory
Type: object
- bankruptcyBool
  Type: boolean
- cardAcceptTerminationBool
  Type: boolean
- cardAcceptTerminationExplain
  Type: string
- chargebacksLastYear
  Type: integer
  
  Integer numbers.
- chargebackTotalAmount
  Type: integer
  
  Integer numbers.
- creditAcceptHistoryBool
  Type: string
- explainBankruptcy
  Type: string
- monthsInBiz
  Type: integer
  
  Integer numbers.
- previousCcProcessor
  Type: string
- yearsInBiz
  Type: integer
  
  Integer numbers.
businessOwners
Type: array object[]
- dateOfBirth
  Type: string
  
  Date of birth (redacted in unauthenticated responses)
- driversLicenseNumber
  Type: string
  
  Driver's license number (redacted in unauthenticated responses)
- id
  Type: integer
  
  Owner ID
- name
  Type: string
- socialSecurityNumber
  Type: string
  
  SSN (redacted in unauthenticated responses)
- uniqueId
  Type: string
  
  Unique identifier for the owner, used for document associations
createdAt
Type: stringFormat: date-time

When the application was created
createdBy
Type: string

Email of the user who created the application
custom_domain
Type: string

Custom domain information for the account (only included in GET responses)
documentRequirements
Type: object

Document requirements and upload status (included when includeDocuments=true or includeFullResponse=true)
- allDocuments
  Type: array object[]
  
  Complete list of all documents with upload status
- businessGeneral
  Type: array object[]
  
  General business documents
  
  Empty object
- byCategory
  Type: object
  
  Documents categorized by type
- completeness
  Type: object
  
  Document upload completeness metrics
- ownerSpecific
  Type: array object[]
  
  Documents specific to business owners
  
  Empty object
- requiredDocuments
  Type: array object[]
  
  Array of required document objects
- total
  Type: integer
  
  Total number of required documents
- uploadedDocuments
  Type: object
  
  Map of document keys to upload information
id
Type: string

Unique identifier for the application
orderProcessing
Type: object
- afterAuthShipDelay
  Type: string
- cardAcceptanceMethods
  Type: string
- cardDescriptor
  Type: string
- cardInfoEnteredBy
  Type: string
- cardInternetPercent
  Type: integer
  
  Integer numbers.
- cardKeyedPercent
  Type: integer
  
  Integer numbers.
- cardMoToPercent
  Type: integer
  
  Integer numbers.
- cardSwipePercent
  Type: integer
  
  Integer numbers.
- customerServiceEmail
  Type: string
- customerServicePhone
  Type: string
- deliveryReceiptBool
  Type: boolean
- ordersProcessedBy
  Type: string
- refundPolicy
  Type: string
- shippedVia
  Type: string
- shippingServices
  Type: string
- whoShipsProduct
  Type: string
repcode
Type: string

Representative code associated with the application
scheduleABasics
Type: object
- avgAmexCardSales
  Type: integer
  
  Integer numbers.
- avgCreditCardSales
  Type: integer
  
  Integer numbers.
- avgSaleAmount
  Type: integer
  
  Integer numbers.
- highMonthlyVolume
  Type: integer
  
  Integer numbers.
- maxSaleAmount
  Type: integer
  
  Integer numbers.
scheduleADiscountRates
Type: object
- assessmentsBool
  Type: boolean
- billType
  Type: string
- combinedMidQualRate
  Type: integer
  
  Integer numbers.
- combinedNonQualRate
  Type: integer
  
  Integer numbers.
- combinedQualRate
  Type: integer
  
  Integer numbers.
- costPlusAobRate
  Type: integer
  
  Integer numbers.
- costPlusRate
  Type: integer
  
  Integer numbers.
- flatRate
  Type: integer
  
  Integer numbers.
- interchangeBool
  Type: boolean
- optBlueAcceptBool
  Type: boolean
- pinDebitNetworkFees
  Type: boolean
- sepAobMidQualRate
  Type: integer
  
  Integer numbers.
- sepAobNonQualRate
  Type: integer
  
  Integer numbers.
- sepAobQualRate
  Type: integer
  
  Integer numbers.
- sepCardMidQualRate
  Type: integer
  
  Integer numbers.
- sepCardNonQualRate
  Type: integer
  
  Integer numbers.
- sepCardQualRate
  Type: integer
  
  Integer numbers.
- sepDebitMidQualRate
  Type: integer
  
  Integer numbers.
- sepDebitNonQualRate
  Type: integer
  
  Integer numbers.
- sepDebitQualRate
  Type: integer
  
  Integer numbers.
scheduleAPerItemFees
Type: object
- addressVerificationFee
  Type: integer
  
  Integer numbers.
- authFeeFlat
  Type: integer
  
  Integer numbers.
- authFeeIntChg
  Type: integer
  
  Integer numbers.
- authFeeTiered
  Type: integer
  
  Integer numbers.
- batchFee
  Type: integer
  
  Integer numbers.
- chargebackFee
  Type: integer
  
  Integer numbers.
- creditTranFee
  Type: integer
  
  Integer numbers.
- debitTranFee
  Type: integer
  
  Integer numbers.
- midQualItem
  Type: integer
  
  Integer numbers.
- nonQualItem
  Type: integer
  
  Integer numbers.
- retreivalFee
  Type: integer
  
  Integer numbers.
- returnFee
  Type: integer
  
  Integer numbers.
- teAuthFee
  Type: integer
  
  Integer numbers.
- wirelessTranFee
  Type: integer
  
  Integer numbers.
system
Type: object
- agentCode
  Type: string
- appAcceptedBool
  Type: string
- appAcceptedDate
  Type: string
- appCompletedByMerchantBool
  Type: string
- appCompletedByMerchantDate
  Type: string
- appCreatedDate
  Type: string
- appFlags
  Type: string
- appKey
  Type: string
  
  Key for unauthenticated access to the application
- applicationLog
  Type: string
- appSentForEsignDate
  Type: string
- appStatus
  Type: stringenum
  
  Current application state. Matches the ApplicationState enum surfaced by GET /applications/statistics.
  
  values
  DRAFT
  INCOMPLETE
  PENDING_COMPLETION
  COMPLETED
  INITIAL_REVIEW
- appSubmittedBool
  Type: string
- appSubmittedDate
  Type: string
- appUpdatedDate
  Type: string
- documentId
  Type: string
- merchantSignedDate
  Type: string
- submitted
  Type: boolean
  
  Whether the application has been submitted
- submittedBy
  Type: string
  
  Who submitted the application (e.g., merchant)
- submittedDate
  Type: stringFormat: date-time
  
  When the application was submitted
updatedAt
Type: stringFormat: date-time

When the application was last updated
validation
Type: object

Application validation results (included when includeFullResponse=true)