Merchant Boarding for Instant Funding

This guide describes the steps required to onboard a merchant for the Instant Funding service using the Netevia HQ API.

📌 Overview

The process involves:

1. Submitting a merchant application in Netevia Banking.
2. (Optional) Checking the application status and retrieving application notes.
3. Updating merchant account details with Netevia Banking DDA account information.
4. Creating a ticket to request Instant Funding enablement.
5. (Optional) Retrieving ticket comments for updates.

🔹 Step 1: Submit Merchant Application in Netevia Banking

Endpoint:POST /api/v1/banking/submit

Request Body Requirement:

• You must include "merchantProfileId": 0 in the request body.
• This ensures the merchant is connected to the correct profile in Netevia Banking.

🔹 Step 2 (Optional): Check Application Status

Endpoint:GET /api/v1/banking/status

This returns the current status of the merchant’s Netevia Banking application.

🔹 Step 3 (Optional): Retrieve Application Notes

Endpoint:GET /api/v1/banking/notes

Application notes may provide:

• Status updates
• Additional information or requirements for the merchant’s banking application

🔹 Step 4: Update Merchant Account with DDA Information

Once the merchant’s Netevia Banking application is approved, update their account details with the Netevia DDA account.

Endpoint: POST /api/v1/merchant/account

Required Request Body Parameters:

{
  "AccountNumber": "Value from Netevia Banking",
  "businessCheckingRoutingNumber": "Value from Netevia Banking"
}

Important:

• The AccountNumber and businessCheckingRoutingNumber must belong to Netevia Banking.
• When a financial account is added in Netevia Banking, a client financial account is automatically created.
• This account data is required to transfer funds to Instant Funding.
• Alternatively, the merchant may create an additional account.

🔹 Step 5: Create Ticket to Enable Instant Funding

After setting the merchant’s DDA information, submit a ticket to request Instant Funding activation.

Endpoint: POST /api/v1/tickets/create

Example Request Body:

{
  "merchantProfileId": 70269,
  "subject": "Instant Funding",
  "priority": "Low",
  "department": "Underwriting",
  "description": "Please enable Instant Funding",
  "contactInformation": {
    "firstName": "John",
    "lastName": "Doe",
    "phone": "1234567890",
    "fax": "1234567890",
    "email": "[email protected]",
    "mobilePhone": "1234567890"
  },
  "merchantInformation": {
    "dba": "Merchant DBA Name",
    "address": "123 Main St",
    "city": "Miami",
    "state": "FL",
    "zip": "33101",
    "merchantType": "Retail",
    "phone": "1234567890",
    "fax": "1234567890",
    "webSite": "https://merchantwebsite.com",
    "email": "[email protected]",
    "mobilePhone": "1234567890"
  }
}

🔹 Step 6 (Optional): Retrieve Ticket Comments

To check updates or responses regarding the Instant Funding enablement request, you can fetch all ticket comments.

Endpoint: GET /api/v1/tickets/getCommentsByTicketId

Example Request:

https://hq.staging.netevia.dev/api/v1/tickets/getCommentsByTicketId?id=70269&ticketId=260900

Parameters:

• id → Merchant Profile ID
• ticketId → Ticket ID returned from Step 5

This returns a list of comments related to the ticket.

✅ Summary

To enable Instant Funding for a merchant:

1. Submit application → /api/v1/banking/submit
2. (Optional) Check application status → /api/v1/banking/status
3. (Optional) Retrieve application notes → /api/v1/banking/notes
4. Update account with Netevia Banking DDA → /api/v1/merchant/account
5. Create ticket to request Instant Funding enablement → /api/v1/tickets/create
6. (Optional) Track ticket responses → /api/v1/tickets/getCommentsByTicketId

API Workflow Diagram

sequenceDiagram
    participant Client as Partner System
    participant API as Netevia HQ API
    participant Bank as Netevia Banking
    participant Ticket as Ticketing System

    Client->>API: POST /api/v1/banking/submit\n(merchantProfileId=0)
    API->>Bank: Process Banking Application

    Client->>API: (Optional) GET /api/v1/banking/status
    Client->>API: (Optional) GET /api/v1/banking/notes

    Client->>API: POST /api/v1/merchant/account\n(Update with DDA Account)
    API->>Bank: Store Account Info

    Client->>API: POST /api/v1/tickets/create\n(Request Instant Funding)
    API->>Ticket: Create Ticket

    Client->>API: (Optional) GET /api/v1/tickets/getCommentsByTicketId
    API->>Ticket: Retrieve Ticket Comments