Jump to Content
Request API Access
Guides
API Reference
v1.0
Request API Access
Log In
API Reference
Log In
v1.0
Guides
API Reference
SFTP Export Data Documentation
All
Pages
Start typing to search…
JUMP TO
Netevia HQ | API Documentation
Submit Merchant Application
Create merchant application.
post
Create and submit merchant application. Initial status of application is "UW Level 1"
post
/api/v2/merchant/submit
post
/api/v2/merchant/create
post
Merchant applications/Merchants status management
Get current merchant status
get
Get merchant status
get
Change merchant application status from "UW Level 1: Pending" to "UW Level 1: Pending Review"
post
Change merchant application status to "UW Level 1: Pending"
post
Submit merchant for approval and initialize auto underwriting process based on API user's ISO settings
post
Set merchant status to specified value
post
Data Collections and Variables
Retrieve allowed SIF names based on API user's ISO
get
Get agent details
get
Retrieve agent profiles for merchant boarding based on API user's ISO
get
Retrieve bording settings based on API user's ISO
get
Returns a list of cities eligible for a given zip code
get
Returns by a given zip code
get
Retrieve list of equipment funders for terminal boarding
get
Retrieve list of POS equipment for merchant boarding
get
Retrieve list of Non-POS equipment available for merchant boarding
get
Retrieve list of available merchant statuses
get
Get agent details
get
Merchant applications/Merchants notes and attachments
Add note
post
Retrieve notes for the merchant application
get
Retrieve pending notes for the merchant application
get
Add attachments to the merchant application
post
Connect Financial Account
Generate financial account connect link. Callback example [CallbackURL]?id=&status=success&accounts=[{bankName,routing,account}]
get
Returns data about whether Finicity is connected or not
get
Banking API Methods
Application statuses
/api/v1/banking/status
get
Application notes
/api/v1/banking/notes/{profileId}
get
Submit Banking Services Application
Create and submit banking services application
post
Submit Banking Personal Application
/api/v1/banking/submit/personal
post
Merchant applications/Merchants data management
Get merchant's information
get
/api/v1/merchant/info
post
Get merchant's business and owner information
get
Update merchant's business and owner information
post
Get merchant's sales and business profile
get
Update merchant's sales and business profile
post
Get merchant's site inspection
get
Update merchant's site inspection
post
Get merchant's service acceptance
get
Update merchant's service acceptance
post
Get merchant's fees
get
Update merchant's fees
post
Get full merchant profile including equipment
get
/api/v2/merchant/info
get
/api/v2/merchant/info
post
/api/v2/merchant/fees
get
/api/v2/merchant/fees
post
Get merchant terminals
get
Get merchant varsheet by terminal ID
get
Get full merchant profile
get
Merchant Processing Agreement and Online Signature
Get Merchant Processing Agreement (PDF) with completed merchant's information
get
Generate signature request link for merchant processing agreement
post
Retrieve signature request status
get
Get signed PDF
get
/api/v1/merchant/signatureCertificate
post
Generate a new Merchant Processing Agreement (PDF) populated with the merchant’s information and save it to the merchant's ticket.
post
Online Merchant Application Settings
Get data from OMA settings
get
Merchant Cash Discount Compliance Link
Get a link to Cash Discount Compliance
get
Charge Anywhere Gateway
Get the connection status of the Charge Anywhere
get
Get the created terminals of the Charge Anywhere
get
Create the terminal of the Charge Anywhere
post
/api/v1/merchant/chargeAnywhere/keepLicenseActive
post
Returns a list of licenses for the merchant's devices.
get
Merchant applications/Merchants equipment management
Get merchant's equipment
get
Add terminal file build by terminal alias
post
Add stage only terminal file build by terminal alias
post
Add POS equipment to the merchant application
post
Add Non-POS equipment to the merchant application
post
Search merchants
/api/v1/merchants/tsys-direct/search
get
Underwriting
Get list of UW tasks of the merchant
get
/api/v1/merchant/getAutoUwResults
get
Change UW task status to In Review
post
Add an attachment to UW Task ticket
post
Add a comment to UW Task ticket
post
Get comment from UW task
get
Get all attachments from UW task
get
Get Attachment by ID from UW Task
get
Subscribe to UW Task events
post
Unsubscribe from UW Task events
post
Get profile info of a profile assigned to merchant
get
/api/v1/underwriting/statuses
get
Get merchant underwriting status history
get
This method is called after the merchant's comments have been corrected. Set merchant underwriting status to Pending Review
post
Ticket
Creates a new ticket.
post
Updates an existing ticket.
post
Add Attachment
post
Get all attachments from ticket
get
Get Attachment by ID
get
Add Comment
post
Get all comments from ticket
get
Get Comment by ID
get
Subscribe to Ticket events
post
Unsubscribe from Ticket events
post
/api/v1/tickets/getTickets
get
/api/v1/tickets/getTicketById
get
Netevia HQ | Export Data Documentation
SFTP Export Data Documentation
/download/YYYYMMDD/Transactions
get
/download/YYYYMMDD/ACH
get
/download/YYYYMMDD/TransAuth
get
/download/YYYYMMDD/Chargeback
get
/download/YYYYMMDD/ACHRejectsCollects
get
/download/YYYYMMDD/MASM1001
get
/download/YYYYMMDD/MASD1001
get
/download/YYYYMMDD/SimplifiedFormat
get
/download/YYYYMMDD/TransactionsExtendedData
get
/download/YYYYMMDD/TINMismatch
get
/download/YYYYMMDD/PCIStatuses
get
Powered by
SFTP Export Data Documentation
Ask AI
