ZenPayments
  1. Events
ZenPayments
  • General Information
    • Authentication
    • Errors
    • Responses
    • Filters
      • Example - gte
      • Example - between
      • Example - like
      • Example - in
      • Example - non-empty
    • Pagination
      • 10 results per page
    • Data Types
  • Merchants
    • Sandbox
      • Sandbox Payment Gateway
    • Card Payments
      • Authorization
      • Sale
      • Capture
      • Partial Capture
      • Refund
      • Partial Refund
      • Soft/Dynamic Descriptor
      • Card Authentication
      • Card Tokenization
      • Card Tokenization with Global Token
      • Sale with a Fee Terminal
    • Hosted Form
      • Generate
      • Generate with Billing and Contact Information
    • Hosted Fields
      • How it Works
      • Hosted Fields Token
        • Hosted Fields Token
      • Integration Guide
        • Step 1: Include the JavaScript Library
        • Step 2: Add HTML Elements for all payment fields
        • Step 3: Set the AccessToken and Configure the rest of the form
        • Step 4: Add styling
        • Step 5: Listen for Events
        • Step 6: Get the tokenized card
          • Get the tokenized card
        • Add Payment Method Page
        • Testing your integration
    • CustomerVault
      • Sandbox
        • Sandbox Dashboard
      • Hosted Card Form
        • Generate
      • Customers
        • List
        • View
        • Create
        • Update
        • Archive
        • Delete
      • Cards
        • List Cards
        • View
        • Add Card
        • Update Exp Date
        • Archive
        • Unarchive
        • Delete
      • Billing Information
        • List
        • View
        • Update
        • Create
      • Shipping Information
        • List
        • View
        • Update
        • Create
      • Recurring Payment
        • List
        • View
        • Update
        • Create
    • Transaction Reporting
      • List
      • View
    • Response Codes
      • Verification Response Codes
    • 3DSecure
      • Version
      • Create
        • Create
      • Check
        • Check
      • Test Cards
    • Account Updater
      • Card Compatibility
      • How It Works
        • Sale with Account Updater
    • ACH Payments
      • General Information
      • Transactions
        • SEC Codes
        • Statuses
        • Actions
          • Action
        • History Log
          • Log
        • List
        • View
        • Create ACH
        • Create ACH & Save Customer
        • Create ACH for an existing Customer
        • Create ACH for an existing Customer and specific Account
        • Remove
      • Hosted Form
        • Example Request
      • Customers
        • List Customers
        • View specific Customer
        • Create Customer
        • Update Customer
        • Delete a Customer
      • Customer Accounts
        • List Customer Accounts
        • Create Customer Account
        • Update Customer Account
        • Delete a Customer Account
      • Bank Information
        • View
      • ACH Settlements
        • List
        • View
      • ACH Webhooks
        • New ACH Record
        • ACH Status Update
        • New ACH Customer
    • Reporting
      • Sandbox
        • Sandbox Dashboard
      • Authorizations
        • List
        • List with Filters
      • Batches
        • List
        • List with Filters
        • Summary
      • Payouts
        • List
        • View
        • Export
      • Chargebacks
        • Disputes
          • Upload a temporary file
          • Create a Dispute
          • Preview
          • Submit
        • Webhooks
          • Signatures
          • Events
            • Chargeback
              • New Chargeback Record
              • Chargeback Update
        • View
          • List
          • View
      • Statements
        • List
        • Download
      • Reserve
        • List
      • Fraud Report
        • Generate
      • Visa Verifi
        • Submiting External Transactions
          • Submit
        • List
      • Other Reports
        • Request a Report
        • Check Status
        • Download
    • Gateway Test Cards
  • Platforms
    • Sandbox
      • Sandbox Dashboard
    • Onboarding
      • Boarding Applications
        • Campaigns
          • List
        • Equipment
          • Terminals
            • List
            • View
          • View
          • Update
        • List
          • List Boarding Applications
        • Create
          • Create Boarding Application
        • Delete
          • Delete Boarding Application
        • View
          • View Boarding Application
        • Update
          • Update Boarding Application
        • Principals
          • List Principals
          • Create Principal
          • Update a Single Principal
          • Mass update Principals
          • Delete Principal
        • Processing
          • View Processing section
          • Update Processing section
        • Merchant Category Codes (MCCs)
          • List MCCs
        • ACH
          • View ACH section
          • Update ACH section
        • Documents
          • Attachment About
            • List All Document Categories
          • View all documents
          • MPA
          • Assign a single document
          • Assign multiple documents
          • Update a single document
          • Delete a single document
        • Fees
          • Types
            • List
          • Other Fees
            • Add
            • Update
            • Delete
          • List all fees
          • View a specific fee
          • Update a single fee
          • Update multiple fees
        • Bank Accounts
          • Add
          • Update
          • Change
        • Validate
          • Validate a Boarding Application
        • URL
          • GET URL of Boarding Application
        • Signature
          • Request E-sign
            • Request Signature
          • Embed E-sign
            • Embeded E-sign Example Flow 1
            • Embeded E-sign Example Flow 2
            • Request Embed
          • Manually Signing
            • Manual Sign
          • External eSign Signing
            • External eSign
        • Automation
          • AutoSign
            • Set AutoSign
          • AutoUnderwriting
            • Set AutoUnderwriting
        • Status
          • Set status to Underwriting
        • Notes
          • List
          • Create
      • Merchants
        • Terminals
          • List Terminals
          • View a specific Terminal
          • VAR Sheet
          • VAR View
        • List Merchants
      • DBA
        • List
        • View
      • Attachments
        • Temporary Upload
          • Temporary Upload
        • Chunk Upload
          • Initialize
          • Upload Request 1/2
          • Upload Request 2/2
        • Standard Upload
        • List attachments
        • View
        • View in browser
        • Download
        • Delete
      • Webhooks
        • Signatures
        • Events
          • Boarding Application
          • Merchant
            • Account
              • New Acquiring Account
              • New ACH Account
              • Closed Acquiring Account
              • Closed ACH Account
            • Terminal
              • New Terminal Record
              • Update Terminal Record
              • Delete Terminal Record
    • Reporting
      • Authorizations
        • List
        • List with Filters
      • Batches
        • List
        • List with Filters
        • Summary
      • Payouts
        • List
        • View
        • Export
      • Chargebacks
        • View
          • List
          • View
        • Disputes
          • Upload a temporary file
          • Create a Dispute
          • Preview
          • Submit
        • Webhooks
          • Signatures
          • Events
            • Chargeback
              • New Chargeback Record
              • Chargeback Update
      • Statements
        • List
        • Download
      • Reserve
        • List
      • Fraud Report
        • Generate
      • Other Reports
        • Request a Report
        • Check Status
        • Download
    • Residuals
      • List
      • View
    • Tickets
      • Update Ticket Status
        • Close
        • Re-Open
      • Responses
        • List
        • Create
        • Add an Attachment
      • Attachments
        • List
        • View
        • Create
        • Delete
      • Categories
        • List
      • Notes
        • List
        • View
        • Create
        • Update
        • Delete
        • Attachments
      • List
      • Create
      • View a specific ticket
    • Connect
      • Webhooks
        • Access Granted
        • Access Updated
        • Access Revoked
    • Misc
      • Address Checker
        • List Countries
        • List States
        • List Cities and Zip Codes
        • Filter by City and State
      • BIN Check
        • Get BIN Information
  1. Events

Boarding Application

Notifications related to our Boarding Applications.
This webhook will be triggered when a new Boarding Applicaiton is created and when there are status change events related to the Application.
{
  "id": 1763,
  "module": "boardingApplication",
  "action": "statusChanged",
  "date": "2023-08-18 11:08:06",
  "data": {
    "id": 246146,
    "processingMethod": "Acquiring",
    "mcc": "1750",
    "campaign": {
      "id": 19859
    },
    "company": {
      "name": "Auto Application - Axiom ACQ - a4b3f",
      "type": "Corporation",
      "federalTaxId": "123456789",
      "address": {
        "street": "451 99e29 Street",
        "city": "Anchorage",
        "zip": "99502",
        "state": {
          "id": 2
        },
        "country": {
          "id": 199
        }
      },
      "founded": "2021-01-21"
    },
    "dba": {
      "id": 102510,
      "sameAsCompany": "Yes",
      "name": null,
      "address": {
        "street": null,
        "city": null,
        "zip": null,
        "state": {
          "id": null
        },
        "country": {
          "id": 199
        }
      }
    },
    "merchant": {
      "id": 89890
    },
    "website": "http://en.wikipedia.org/wiki/Carpentry",
    "serviceDescription": "We sell carpentry",
    "mailingAddress": "legal",
    "businessLocation": {
      "buildingType": "Office Building",
      "numberOfLocations": "9",
      "buildingOwnership": "Owns",
      "areaZoned": "Industrial",
      "squareFootage": "0-501"
    },
    "customerServiceContact": {
      "phone": "+1 202-555-0174",
      "email": "email@email.com"
    },
    "corporateContact": {
      "phone": "+1 202-555-0174",
      "fax": "+1 202-555-0114",
      "email": "email@email.com"
    },
    "bankruptcy": {
      "hasBankruptcy": "Business Bankruptcy",
      "description": "Bankrupted once in 1982 due to mismanagement"
    },
    "principals": [
      {
        "id": 296046,
        "title": "Director",
        "name": {
          "first": "John",
          "last": "Doe"
        },
        "dayOfBirth": "2020-01-21",
        "ssn": "123-45-6781",
        "nationalId": null,
        "nationality": {
          "id": 199
        },
        "driverLicense": {
          "number": "13371337",
          "expiration": "2024-01-21",
          "state": {
            "id": 2
          }
        },
        "address": {
          "street": "346 26923 Street",
          "city": "Anchorage",
          "zip": "99502",
          "state": {
            "id": 2
          },
          "country": {
            "id": 199
          }
        },
        "phone": "+1 202-555-0103",
        "email": "1da6a29@email.com",
        "ownershipPercentage": 52,
        "isManagement": "Yes"
      }
    ],
    "processing": {
      "bank": {
        "accountNumber": "31337",
        "routingNumber": "1337"
      },
      "volumes": {
        "monthlyTransactionAmount": 25000,
        "avgTransactionAmount": 400,
        "maxTransactionAmount": 500
      },
      "sales": {
        "swiped": 50,
        "mail": 25,
        "internet": 25
      },
      "alreadyProcessing": {
        "isProcessing": "Yes",
        "processor": "PayPal"
      },
      "terminated": {
        "isTerminated": "Yes",
        "description": "text"
      },
      "customers": {
        "type": {
          "individual": 0,
          "business": 100,
          "government": 0
        },
        "location": {
          "local": 0,
          "national": 100,
          "international": 0
        }
      },
      "fulfillmentPolicy": {
        "fulfillment": "2-days",
        "fulfillmentOther": null,
        "delivery": "24-hours",
        "deliveryOther": null
      },
      "recurringPayments": {
        "hasRecurring": "No",
        "description": null
      },
      "intendedUsage": {
        "creditCards": "Yes",
        "pinDebit": "No",
        "ebt": "Yes",
        "fns": "4454",
        "notes": "notes"
      },
      "seasonalBusiness": {
        "isSeasonal": "No",
        "months": []
      },
      "inventory": {
        "onSite": "Yes",
        "offSite": "No",
        "offSiteAddress": null,
        "thirdParty": "No",
        "serviceOnly": "No"
      },
      "retailLocation": "18A Testing Lane blvd.",
      "externalFulfillment": "No",
      "customerCharged": "time-offer-order",
      "equipmentUsed": "We have an old PoS Terminal",
      "advertise": "Adsense and physical billboards",
      "refundPolicy": "NO REFUNDS!",
      "feeSchedule": {
        "fees": [
          {
            "id": 6062030,
            "type": {
              "id": 1
            },
            "value": "1.00000"
          },
          {
            "id": 6062031,
            "type": {
              "id": 2
            },
            "value": "2.00000"
          },
          {
            "id": 6062032,
            "type": {
              "id": 3
            },
            "value": "3.00000"
          },
          {
            "id": 6062033,
            "type": {
              "id": 4
            },
            "value": "4.00000"
          },
          {
            "id": 6062034,
            "type": {
              "id": 5
            },
            "value": "5.00000"
          },
          {
            "id": 6062035,
            "type": {
              "id": 6
            },
            "value": "6.00000"
          },
          {
            "id": 6062036,
            "type": {
              "id": 7
            },
            "value": "7.00000"
          },
          {
            "id": 6062037,
            "type": {
              "id": 8
            },
            "value": "8.00000"
          },
          {
            "id": 6062038,
            "type": {
              "id": 9
            },
            "value": "9.00000"
          },
          {
            "id": 6062039,
            "type": {
              "id": 10
            },
            "value": "10.00000"
          },
          {
            "id": 6062040,
            "type": {
              "id": 11
            },
            "value": "11.00000"
          },
          {
            "id": 6062041,
            "type": {
              "id": 12
            },
            "value": "12.00000"
          },
          {
            "id": 6062042,
            "type": {
              "id": 13
            },
            "value": "13.00000"
          },
          {
            "id": 6062043,
            "type": {
              "id": 14
            },
            "value": "14.00000"
          },
          {
            "id": 6062044,
            "type": {
              "id": 15
            },
            "value": "15.00000"
          },
          {
            "id": 6062045,
            "type": {
              "id": 16
            },
            "value": "16.00000"
          },
          {
            "id": 6062046,
            "type": {
              "id": 17
            },
            "value": "17.00000"
          },
          {
            "id": 6062047,
            "type": {
              "id": 18
            },
            "value": "0.00000"
          },
          {
            "id": 6062048,
            "type": {
              "id": 18
            },
            "value": "0.00000"
          },
          {
            "id": 6062049,
            "type": {
              "id": 18
            },
            "value": "0.00000"
          },
          {
            "id": 6062050,
            "type": {
              "id": 19
            },
            "value": "19.00000"
          },
          {
            "id": 6062051,
            "type": {
              "id": 20
            },
            "value": "20.00000"
          },
          {
            "id": 6062052,
            "type": {
              "id": 21
            },
            "value": "21.00000"
          },
          {
            "id": 6062053,
            "type": {
              "id": 22
            },
            "value": "22.00000"
          }
        ],
        "note": "notes"
      }
    },
    "ach": null,
    "documents": [
      {
        "attachment": {
          "id": 5340728,
          "deletedOn": null
        },
        "about": [
          6
        ],
        "principal": {
          "id": null
        }
      },
      {
        "attachment": {
          "id": 5340735,
          "deletedOn": null
        },
        "about": [
          18
        ],
        "principal": {
          "id": 296046
        }
      },
      {
        "attachment": {
          "id": 5340744,
          "deletedOn": null
        },
        "about": [
          33
        ],
        "principal": {
          "id": null
        }
      },
      {
        "attachment": {
          "id": 5340791,
          "deletedOn": null
        },
        "about": [
          21
        ],
        "principal": {
          "id": null
        }
      },
      {
        "attachment": {
          "id": 5340793,
          "deletedOn": null
        },
        "about": [
          309
        ],
        "principal": {
          "id": null
        }
      },
      {
        "attachment": {
          "id": 5340794,
          "deletedOn": null
        },
        "about": [
          51
        ],
        "principal": {
          "id": null
        }
      }
    ],
    "agent": {
      "id": 109689
    },
    "signature": {
      "status": "Signed",
      "via": "eSign"
    },
    "auto": {
      "sign": "Yes",
      "underwriting": "Yes"
    },
    "status": "Approved",
    "updatedOn": "2023-08-18 11:08:06",
    "createdOn": "2023-06-03 15:29:29"
  }
}
Modified at 2025-08-09 05:39:42
Previous
Events
Next
Merchant
Built with