Prerequisites
Before you begin, make sure you have:- A SignaPay PayHub account with API access enabled
- A long-lived API key issued for your client
- An HTTP client such as
curl, Postman, or your preferred SDK
Step 1 — Authenticate with your API key
API keys are the only supported authentication method for API integrations. Pass your key in every request using theAuthorization header:
Step 2 — Make your first request
With your API key in hand, try fetching the list of agents in your account:200 response returns a paginated list of agent records. If the list is empty, your account may not have any agents configured yet — that’s fine; the important thing is that the request authenticated successfully.
Step 3 — Explore what you can do
From here, the API covers the full merchant lifecycle. Jump to the section that fits your use case:Agents
Manage sales agents, their merchant assignments, documents, and notes.
Applications
Create and board merchant applications through the full underwriting workflow.
Merchants
Manage active merchants, pricing schedules, equipment, and documents.
Partners
Manage partner organizations, processor settings, and pricing.
Reporting
KPI metrics and summary data for agents, merchants, and partners.
Tickets
Create and manage support tickets, activities, and document attachments.
Next steps
- Full API reference — Browse every available endpoint in the API Reference overview.
- Pagination — All list endpoints return paged results. Learn the request parameters and response envelope before building list-fetching logic.
- Errors — All errors follow a consistent structure. Review response codes and error shapes before building error-handling logic.
- Board a merchant — Ready to integrate? Follow the end-to-end boarding walkthrough from lead creation through MID assignment.