Skip to main content
The Merchants API is a REST interface over HTTPS. Request and response bodies use JSON. Use standard HTTP methods (GET, POST, PUT, PATCH, DELETE). Base URL:

​
Initial setup

  1. Create or join an organisation in the merchant dashboard.
  2. Configure Settlement Overview so collections can complete.
  3. Create an API key. See Authentication.
For a first end-to-end call, follow the Quickstart.

​
Guides

Authentication

API keys (X-API-KEY) and when HMAC request signing is required.

Response Patterns

Success envelopes, paginated lists, errors, and common HTTP status codes.

​
Endpoint groups

The API reference groups operations by product area: | Partners | Multi-merchant partner workflows | | Instruments / Quotes / Orders | Trading and OTC conversion | Interactive request samples and schemas are on each endpoint page in the groups that follow.