Skip to content
Pulse Docs

POST   /applications

Create a new application

Create a new application with the provided data

Authentication Required

Authorization: Bearer {token}   header string

This header is required to access this endpoint

Required Parameters

x-account-id   header string

Account ID for the request

Request Body

{}

Try it out

Loading...

Output:

Responses

Description

Application created successfully

{
  "id": "string",
  "repcode": "string",
  "custom_domain": "string",
  "system": {
    "appKey": "string",
    "appStatus": "string",
    "submitted": false,
    "submittedBy": "string",
    "submittedDate": "string",
    "appFlags": "string",
    "applicationLog": "string",
    "appCreatedDate": "string",
    "appUpdatedDate": "string",
    "appCompletedByMerchantBool": "string",
    "appCompletedByMerchantDate": "string",
    "appSubmittedBool": "string",
    "appSubmittedDate": "string",
    "appSentForEsignDate": "string",
    "merchantSignedDate": "string",
    "appAcceptedBool": "string",
    "appAcceptedDate": "string",
    "agentCode": "string",
    "documentId": "string"
  },
  "basics": {
    "dbaCity": "string",
    "dbaContact": "string",
    "dbaEmail": "string",
    "dbaName": "string",
    "dbaPhone": "string",
    "dbaState": "string",
    "dbaStreet1": "string",
    "dbaStreet2": "string",
    "dbaStruct": "string",
    "dbaTaxId": "string",
    "dbaTraded": "string",
    "dbaZip": "string",
    "locAddr1": "string",
    "locAddr2": "string",
    "locationDifferent": false,
    "locCity": "string",
    "locContact": "string",
    "locEmail": "string",
    "locName": "string",
    "locPhone": "string",
    "locState": "string",
    "locZip": "string",
    "primaryLanguage": "string",
    "tinType": "string"
  },
  "businessDetails": {
    "b2BSalesPercent": 0,
    "businessAdvertising": "string",
    "geographicSalesArea": "string",
    "marketType": "string",
    "mccCategory": "string",
    "mccNumber": 0,
    "naicsNumber": 0,
    "productsServicesSold": "string",
    "publicSalesPercent": 0,
    "salesMethods": "string",
    "seasonalMerchantBool": "string",
    "seasonalJanBool": false,
    "seasonalFebBool": false,
    "seasonalMarBool": false,
    "seasonalAprBool": false,
    "seasonalMayBool": false,
    "seasonalJunBool": false,
    "seasonalJulBool": false,
    "seasonalAugBool": false,
    "seasonalSepBool": false,
    "seasonalOctBool": false,
    "seasonalNovBool": false,
    "seasonalDecBool": false,
    "seasonalMerchantExplain": "string",
    "sicNumber": 0,
    "website": "string"
  },
  "businessHistory": {
    "bankruptcyBool": false,
    "cardAcceptTerminationBool": false,
    "cardAcceptTerminationExplain": "string",
    "chargebacksLastYear": 0,
    "chargebackTotalAmount": 0,
    "creditAcceptHistoryBool": "string",
    "explainBankruptcy": "string",
    "monthsInBiz": 0,
    "previousCcProcessor": "string",
    "yearsInBiz": 0
  },
  "businessBanking": {
    "bankAccount": "string",
    "bankContact": "string",
    "bankName": "string",
    "bankRouting": "string"
  },
  "businessOwners": [
    {
      "id": 0,
      "name": "string",
      "socialSecurityNumber": "string",
      "driversLicenseNumber": "string",
      "dateOfBirth": "string",
      "uniqueId": "string"
    }
  ],
  "orderProcessing": {
    "afterAuthShipDelay": "string",
    "cardAcceptanceMethods": "string",
    "cardDescriptor": "string",
    "cardInfoEnteredBy": "string",
    "customerServicePhone": "string",
    "customerServiceEmail": "string",
    "deliveryReceiptBool": false,
    "ordersProcessedBy": "string",
    "refundPolicy": "string",
    "shippedVia": "string",
    "shippingServices": "string",
    "whoShipsProduct": "string",
    "cardSwipePercent": 0,
    "cardKeyedPercent": 0,
    "cardMoToPercent": 0,
    "cardInternetPercent": 0
  },
  "scheduleABasics": {
    "avgAmexCardSales": 0,
    "avgCreditCardSales": 0,
    "avgSaleAmount": 0,
    "maxSaleAmount": 0,
    "highMonthlyVolume": 0
  },
  "scheduleADiscountRates": {
    "billType": "string",
    "flatRate": 0,
    "combinedMidQualRate": 0,
    "combinedNonQualRate": 0,
    "combinedQualRate": 0,
    "costPlusAobRate": 0,
    "costPlusRate": 0,
    "optBlueAcceptBool": false,
    "assessmentsBool": false,
    "interchangeBool": false,
    "pinDebitNetworkFees": false,
    "sepAobMidQualRate": 0,
    "sepAobNonQualRate": 0,
    "sepAobQualRate": 0,
    "sepCardMidQualRate": 0,
    "sepCardNonQualRate": 0,
    "sepCardQualRate": 0,
    "sepDebitMidQualRate": 0,
    "sepDebitNonQualRate": 0,
    "sepDebitQualRate": 0
  },
  "scheduleAPerItemFees": {
    "authFeeFlat": 0,
    "authFeeIntChg": 0,
    "authFeeTiered": 0,
    "addressVerificationFee": 0,
    "batchFee": 0,
    "chargebackFee": 0,
    "creditTranFee": 0,
    "debitTranFee": 0,
    "midQualItem": 0,
    "nonQualItem": 0,
    "retreivalFee": 0,
    "returnFee": 0,
    "teAuthFee": 0,
    "wirelessTranFee": 0
  },
  "admin": {},
  "createdAt": "string",
  "updatedAt": "string",
  "createdBy": "string",
  "auditLog": [
    {
      "id": 0,
      "event": "string",
      "user": "string",
      "apiKey": "string",
      "data": {},
      "created": "string",
      "requestMethod": "string",
      "requestPath": "string",
      "requestHeaders": {},
      "requestIpAddress": "string",
      "account_id": "string"
    }
  ],
  "documentRequirements": {
    "total": 0,
    "byCategory": {
      "identification": [
        {}
      ],
      "business": [
        {}
      ],
      "financial": [
        {}
      ],
      "operational": [
        {}
      ],
      "banking": [
        {}
      ]
    },
    "ownerSpecific": [
      {}
    ],
    "businessGeneral": [
      {}
    ],
    "allDocuments": [
      {
        "key": "string",
        "name": "string",
        "category": "string",
        "ownerName": "string",
        "uploaded": false,
        "uploadInfo": {}
      }
    ],
    "uploadedDocuments": {},
    "requiredDocuments": [
      {
        "key": "string",
        "name": "string",
        "category": "string",
        "required": false,
        "uploaded": false
      }
    ],
    "completeness": {
      "uploaded": 0,
      "required": 0,
      "percentage": 0
    }
  },
  "validation": {}
}

References

#/components/parameters/xAccountIdHeader

in: header
name: x-account-id
schema:
  type: string
description: Account ID for the request
required: true
example: "2311"

#/components/schemas/ApplicationBasics

type: object
properties:
  dbaCity:
    type: string
  dbaContact:
    type: string
  dbaEmail:
    type: string
  dbaName:
    type: string
    description: Business name (DBA)
  dbaPhone:
    type: string
  dbaState:
    type: string
  dbaStreet1:
    type: string
  dbaStreet2:
    type: string
  dbaStruct:
    type: string
  dbaTaxId:
    type: string
    description: 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

#/components/schemas/ApplicationBusinessDetails

type: object
properties:
  b2BSalesPercent:
    type: integer
  businessAdvertising:
    type: string
  geographicSalesArea:
    type: string
  marketType:
    type: string
  mccCategory:
    type: string
  mccNumber:
    type: integer
  naicsNumber:
    type: integer
  productsServicesSold:
    type: string
  publicSalesPercent:
    type: integer
  salesMethods:
    type: string
  seasonalMerchantBool:
    type: string
  seasonalJanBool:
    type: boolean
  seasonalFebBool:
    type: boolean
  seasonalMarBool:
    type: boolean
  seasonalAprBool:
    type: boolean
  seasonalMayBool:
    type: boolean
  seasonalJunBool:
    type: boolean
  seasonalJulBool:
    type: boolean
  seasonalAugBool:
    type: boolean
  seasonalSepBool:
    type: boolean
  seasonalOctBool:
    type: boolean
  seasonalNovBool:
    type: boolean
  seasonalDecBool:
    type: boolean
  seasonalMerchantExplain:
    type: string
  sicNumber:
    type: integer
  website:
    type: string

#/components/schemas/ApplicationBusinessHistory

type: object
properties:
  bankruptcyBool:
    type: boolean
  cardAcceptTerminationBool:
    type: boolean
  cardAcceptTerminationExplain:
    type: string
  chargebacksLastYear:
    type: integer
  chargebackTotalAmount:
    type: integer
  creditAcceptHistoryBool:
    type: string
  explainBankruptcy:
    type: string
  monthsInBiz:
    type: integer
  previousCcProcessor:
    type: string
  yearsInBiz:
    type: integer

#/components/schemas/ApplicationBusinessBanking

type: object
properties:
  bankAccount:
    type: string
    description: Bank account information (redacted in unauthenticated responses)
  bankContact:
    type: string
  bankName:
    type: string
  bankRouting:
    type: string

#/components/schemas/ApplicationOrderProcessing

type: object
properties:
  afterAuthShipDelay:
    type: string
  cardAcceptanceMethods:
    type: string
  cardDescriptor:
    type: string
  cardInfoEnteredBy:
    type: string
  customerServicePhone:
    type: string
  customerServiceEmail:
    type: string
  deliveryReceiptBool:
    type: boolean
  ordersProcessedBy:
    type: string
  refundPolicy:
    type: string
  shippedVia:
    type: string
  shippingServices:
    type: string
  whoShipsProduct:
    type: string
  cardSwipePercent:
    type: integer
  cardKeyedPercent:
    type: integer
  cardMoToPercent:
    type: integer
  cardInternetPercent:
    type: integer

#/components/schemas/ApplicationScheduleABasics

type: object
properties:
  avgAmexCardSales:
    type: integer
  avgCreditCardSales:
    type: integer
  avgSaleAmount:
    type: integer
  maxSaleAmount:
    type: integer
  highMonthlyVolume:
    type: integer

#/components/schemas/ApplicationScheduleADiscountRates

type: object
properties:
  billType:
    type: string
  flatRate:
    type: integer
  combinedMidQualRate:
    type: integer
  combinedNonQualRate:
    type: integer
  combinedQualRate:
    type: integer
  costPlusAobRate:
    type: integer
  costPlusRate:
    type: integer
  optBlueAcceptBool:
    type: boolean
  assessmentsBool:
    type: boolean
  interchangeBool:
    type: boolean
  pinDebitNetworkFees:
    type: boolean
  sepAobMidQualRate:
    type: integer
  sepAobNonQualRate:
    type: integer
  sepAobQualRate:
    type: integer
  sepCardMidQualRate:
    type: integer
  sepCardNonQualRate:
    type: integer
  sepCardQualRate:
    type: integer
  sepDebitMidQualRate:
    type: integer
  sepDebitNonQualRate:
    type: integer
  sepDebitQualRate:
    type: integer

#/components/schemas/ApplicationScheduleAPerItemFees

type: object
properties:
  authFeeFlat:
    type: integer
  authFeeIntChg:
    type: integer
  authFeeTiered:
    type: integer
  addressVerificationFee:
    type: integer
  batchFee:
    type: integer
  chargebackFee:
    type: integer
  creditTranFee:
    type: integer
  debitTranFee:
    type: integer
  midQualItem:
    type: integer
  nonQualItem:
    type: integer
  retreivalFee:
    type: integer
  returnFee:
    type: integer
  teAuthFee:
    type: integer
  wirelessTranFee:
    type: integer

#/components/schemas/ApplicationInput

type: object
description: Input for creating or updating an application
properties:
  repcode:
    type: string
    description: Representative code associated with the application
  basics:
    $ref: "#/components/schemas/ApplicationBasics"
  businessDetails:
    $ref: "#/components/schemas/ApplicationBusinessDetails"
  businessHistory:
    $ref: "#/components/schemas/ApplicationBusinessHistory"
  businessBanking:
    $ref: "#/components/schemas/ApplicationBusinessBanking"
  businessOwners:
    type: array
    items:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        socialSecurityNumber:
          type: string
        driversLicenseNumber:
          type: string
        dateOfBirth:
          type: string
        uniqueId:
          type: string
          description: Unique identifier for the owner, used for document associations
  orderProcessing:
    $ref: "#/components/schemas/ApplicationOrderProcessing"
  scheduleABasics:
    $ref: "#/components/schemas/ApplicationScheduleABasics"
  scheduleADiscountRates:
    $ref: "#/components/schemas/ApplicationScheduleADiscountRates"
  scheduleAPerItemFees:
    $ref: "#/components/schemas/ApplicationScheduleAPerItemFees"
  system:
    type: object
    properties:
      appStatus:
        type: string
      appFlags:
        type: string
      applicationLog:
        type: string

#/components/schemas/Application

type: object
description: Application object representing a merchant or customer application
properties:
  id:
    type: string
    description: Unique identifier for the application
  repcode:
    type: string
    description: Representative code associated with the application
  custom_domain:
    type: string
    description: Custom domain information for the account (only included in GET responses)
  system:
    type: object
    properties:
      appKey:
        type: string
        description: Key for unauthenticated access to the application
      appStatus:
        type: string
        description: Status of the application (e.g., pending, submitted)
        enum:
          - pending
          - submitted
          - approved
          - rejected
      submitted:
        type: boolean
        description: Whether the application has been submitted
      submittedBy:
        type: string
        description: Who submitted the application (e.g., merchant)
      submittedDate:
        type: string
        format: date-time
        description: When the application was submitted
      appFlags:
        type: string
      applicationLog:
        type: string
      appCreatedDate:
        type: string
      appUpdatedDate:
        type: string
      appCompletedByMerchantBool:
        type: string
      appCompletedByMerchantDate:
        type: string
      appSubmittedBool:
        type: string
      appSubmittedDate:
        type: string
      appSentForEsignDate:
        type: string
      merchantSignedDate:
        type: string
      appAcceptedBool:
        type: string
      appAcceptedDate:
        type: string
      agentCode:
        type: string
      documentId:
        type: string
  basics:
    $ref: "#/components/schemas/ApplicationBasics"
  businessDetails:
    $ref: "#/components/schemas/ApplicationBusinessDetails"
  businessHistory:
    $ref: "#/components/schemas/ApplicationBusinessHistory"
  businessBanking:
    $ref: "#/components/schemas/ApplicationBusinessBanking"
  businessOwners:
    type: array
    items:
      type: object
      properties:
        id:
          type: integer
          description: Owner ID
        name:
          type: string
        socialSecurityNumber:
          type: string
          description: SSN (redacted in unauthenticated responses)
        driversLicenseNumber:
          type: string
          description: Driver's license number (redacted in unauthenticated responses)
        dateOfBirth:
          type: string
          description: Date of birth (redacted in unauthenticated responses)
        uniqueId:
          type: string
          description: Unique identifier for the owner, used for document associations
  orderProcessing:
    $ref: "#/components/schemas/ApplicationOrderProcessing"
  scheduleABasics:
    $ref: "#/components/schemas/ApplicationScheduleABasics"
  scheduleADiscountRates:
    $ref: "#/components/schemas/ApplicationScheduleADiscountRates"
  scheduleAPerItemFees:
    $ref: "#/components/schemas/ApplicationScheduleAPerItemFees"
  admin:
    type: object
    description: Administrative information about the application
  createdAt:
    type: string
    format: date-time
    description: When the application was created
  updatedAt:
    type: string
    format: date-time
    description: When the application was last updated
  createdBy:
    type: string
    description: Email of the user who created the application
  auditLog:
    type: array
    description: Comprehensive audit log of all significant events and actions
      performed on the application
    readOnly: true
    items:
      type: object
      properties:
        id:
          type: integer
          description: Unique identifier for the audit log entry
        event:
          type: string
          description: Type of event (e.g., application_created, application_updated,
            application_sensitive_data_revealed)
        user:
          type: string
          description: Email address or identifier of the user who performed the action
        apiKey:
          type: string
          nullable: true
          description: API key identifier if the action was performed via API key
            authentication
        data:
          type: object
          description: Event-specific data containing details about what was changed or
            accessed
        created:
          type: string
          format: date-time
          description: Timestamp when the event occurred
        requestMethod:
          type: string
          description: HTTP method used (GET, POST, PATCH, DELETE)
        requestPath:
          type: string
          description: API endpoint path that was called
        requestHeaders:
          type: object
          description: Sanitized HTTP headers from the request (sensitive values are masked)
        requestIpAddress:
          type: string
          description: IP address of the request origin
        account_id:
          type: string
          description: Account ID associated with the action
  documentRequirements:
    type: object
    description: Document requirements and upload status (included when
      includeDocuments=true or includeFullResponse=true)
    properties:
      total:
        type: integer
        description: Total number of required documents
      byCategory:
        type: object
        description: Documents categorized by type
        properties:
          identification:
            type: array
            items:
              type: object
          business:
            type: array
            items:
              type: object
          financial:
            type: array
            items:
              type: object
          operational:
            type: array
            items:
              type: object
          banking:
            type: array
            items:
              type: object
      ownerSpecific:
        type: array
        description: Documents specific to business owners
        items:
          type: object
      businessGeneral:
        type: array
        description: General business documents
        items:
          type: object
      allDocuments:
        type: array
        description: Complete list of all documents with upload status
        items:
          type: object
          properties:
            key:
              type: string
            name:
              type: string
            category:
              type: string
            ownerName:
              type: string
            uploaded:
              type: boolean
            uploadInfo:
              type: object
      uploadedDocuments:
        type: object
        description: Map of document keys to upload information
        additionalProperties:
          type: object
          properties:
            key:
              type: string
            files:
              type: array
              items:
                type: object
      requiredDocuments:
        type: array
        description: Array of required document objects
        items:
          type: object
          properties:
            key:
              type: string
            name:
              type: string
            category:
              type: string
            required:
              type: boolean
            uploaded:
              type: boolean
      completeness:
        type: object
        description: Document upload completeness metrics
        properties:
          uploaded:
            type: integer
          required:
            type: integer
          percentage:
            type: number
  validation:
    type: object
    description: Application validation results (included when includeFullResponse=true)

Route Source Code

Check out the source code for this route entrypoint here: /applications/route.ts

Or the swagger.yaml spec this documentation was generated from: /applications/swagger.yaml