CreateMerchantRequest

  • dba
    Type: string
    required

    Doing Business As name

  • legalName
    Type: string
    required

    Legal business name

  • mcc
    Type: string
    required

    Merchant category code

  • merchantName
    Type: string
    required

    Business trading name

  • addresses
    Type: array object[]
    • city
      Type: string
      required
    • postalCode
      Type: string
      required
    • state
      Type: string
      required
    • street1
      Type: string
      required
    • type
      Type: stringenum
      required
      values
      • business
      • legal
      • mailing
    • country
      Type: string
    • street2
      Type: string
  • agentAccountId
    Type: string

    Agent account ID reference

  • agentName
    Type: string

    Agent name

  • banking
    Type: object
    • accountNumber
      Type: string
      required
    • accountType
      Type: stringenum
      required
      values
      • checking
      • savings
    • bankName
      Type: string
      required
    • routingNumber
      Type: string
      required
  • compliance
    Type: object
    • certificateUrl
      Type: string
    • documentsRequired
      Type: array object[]
    • lastPciDate
      Type: stringFormat: date

      full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

    • nextPciDue
      Type: stringFormat: date

      full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

    • pciCompliant
      Type: boolean
    • pciLevel
      Type: string
  • isoName
    Type: string

    ISO name

  • mccDescription
    Type: string

    Description of the MCC

  • principals
    Type: array object[]
    • email
      Type: string
      required
    • firstName
      Type: string
      required
    • lastName
      Type: string
      required
    • type
      Type: stringenum
      required
      values
      • FOUNDER
      • CO_FOUNDER
      • INVESTOR
      • SHAREHOLDER
      • PARTNER
    • dateOfBirth
      Type: string
    • driversLicenseNumber
      Type: string
    • driversLicenseState
      Type: string
    • equityOwnership
      Type: integer

      Integer numbers.

    • homeCity
      Type: string
    • homeState
      Type: string
    • homeStreet1
      Type: string
    • homeStreet2
      Type: string
    • homeZipCode
      Type: string
    • phone
      Type: string
    • ssn
      Type: string
  • processing
    Type: object
    • averageTicket
      Type: numberFormat: decimal
    • dailyLimit
      Type: numberFormat: decimal
    • highTicket
      Type: numberFormat: decimal
    • monthlyLimit
      Type: numberFormat: decimal
    • monthlyVolume
      Type: numberFormat: decimal
    • processingLimit
      Type: numberFormat: decimal
  • rates
    Type: object
    • discountRate
      Type: numberFormat: decimal
      required
    • effectiveDate
      Type: stringFormat: date
      required

      full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

    • transactionFee
      Type: numberFormat: decimal
      required
    • agentSplit
      Type: numberFormat: decimal
    • annualFee
      Type: numberFormat: decimal
    • batchFee
      Type: numberFormat: decimal
    • chargebackFee
      Type: numberFormat: decimal
    • isoSplit
      Type: numberFormat: decimal
    • monthlyFee
      Type: numberFormat: decimal
    • pciComplianceFee
      Type: numberFormat: decimal
    • statementFee
      Type: numberFormat: decimal
  • riskMetrics
    Type: object
    • chargebackCount
      Type: integer

      Integer numbers.

    • chargebackRatio
      Type: numberFormat: decimal
    • lastRiskReview
      Type: stringFormat: date

      full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

    • nextRiskReview
      Type: stringFormat: date

      full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

    • refundRatio
      Type: numberFormat: decimal
    • riskScore
      Type: integer

      Integer numbers.

    • suspiciousActivity
      Type: boolean