Table View (All APIs)

Quick lookup for methods and paths across common areas. Use the environment base URL from Environments and Base URLs, then append the paths below.

Authentication and Health

Method	Path	Summary
POST	/realms/<realm>/protocol/openid-connect/token	Obtain an OAuth access token
GET	/health	Basic service health check

Onboarding

Method	Path	Summary
POST	/merchant-onboarding/application	Create application; signer email is sent automatically
GET	/merchant-onboarding/application/{applicationId}	Get application status
GET	/merchant-onboarding/application/{applicationId}/resume-signing	Get a fresh signing URL
PUT	/merchant-onboarding/{partnerId}/webhook	Register onboarding webhook
GET	/merchant-onboarding/callback	Signing callback (informational)
POST	/merchant-onboarding/{applicationId}/feedback	Submit manual review decision

Locations

Method	Path	Summary
POST	/Merchants/{id}/locations	Create a new location under a merchant
GET	/Merchants/{id}/locations	List locations for a merchant
GET	/Locations/{id}	Get a single location
PUT	/Locations/{id}	Update a location with a full replacement body
DELETE	/Locations/{id}	Delete a location that has no terminals
GET	/Locations/{id}/terminals	List terminals for a location

Terminals and Webhooks

Method	Path	Summary
GET	/Terminals/{id}	Get a single terminal
POST	/Locations/{id}/terminals	Create a terminal under a location
PUT	/Terminals/{id}/webhook	Set or update the terminal webhook using webhookUrl in the body
GET	/Terminals/{id}/webhook	Retrieve the current webhook configuration for a terminal
DELETE	/Terminals/{id}/webhook	Remove the webhook configuration for a terminal
DELETE	/Terminals/{id}	Delete a terminal

Terminal webhook body

Field	Type	Required	Notes
webhookUrl	string	Yes	HTTPS endpoint that receives payment events

Payments and Reporting

Method	Path	Summary
GET	/Reporting/partners/{id}/payments	Partner level payment history with pagination and filters
GET	/Reporting/merchants/{id}/payments	Merchant level payment history with pagination and filters

Standard query parameters for payment history

Name	Type	Required	Notes
from	string (ISO 8601)	No	Inclusive start timestamp in UTC
to	string (ISO 8601)	No	Exclusive end timestamp in UTC
status	string	No	Payment status filter. Use the status enums shown in Payment Webhooks and Event Reference
tenderType	string	No	One of the tender strings listed on the Tender Types pages
locationId	string	No	Filter by a specific location when using merchant history
page	integer	No	One based page number. Defaults to 1
pageSize	integer	No	Items per page. Defaults to a sensible limit for reporting

Response envelope for payment history

Field	Type	Notes
data	array	Array of payments that match the filters
total	integer	Total count across all pages
page	integer	Current page number

Partners and Merchants

Method	Path	Summary
GET	/Partners/{id}	Get a single partner
POST	/Partners/{parentId}/partners	Create a child partner under a parent partner
GET	/Merchants/{id}	Get a single merchant
POST	/Partners/{id}/merchants	Create a merchant under a partner

Error handling and headers

Topic	Guidance
Authorization header	Send Authorization: Bearer <access_token> on every call
Accept and Content Type	Use Accept: application/json and Content-Type: application/json for JSON bodies
Error model	Client code should handle 400, 401, 403, 404. Some flows can return 409 for duplicates and 422 for business rule failures

Notes

Topic	Guidance
Pagination convention	Payment history uses page and pageSize with a data envelope and a total field
Tender inheritance	A location can inherit merchant defaults when tenderTypes is omitted. A terminal inherits from its parent location unless you override it
Immutable fields	Identifiers and timestamp fields are read only on read calls and must not be included in write bodies except where shown in examples