The Transaction API Reference provides detailed technical information for every Transaction API endpoint, including request and response schemas, field definitions, authentication requirements, response codes, and error definitions.
Use the API Reference when implementing, testing, or troubleshooting an integration.
Using the API Reference
The API Reference is organised by endpoint.
Each endpoint includes:
- The HTTP method and URL
- Required and optional parameters
- Request and response schemas
- Example requests and responses
- Response codes
You can also make test requests directly from the API Reference after authorising with a valid access token.
Before you begin
If you're new to the Transaction API, start with the guides section:
These topics explain common workflows and concepts before you begin working directly with the API endpoints.
OpenAPI specification
The Transaction API is described using the OpenAPI specification.
You can use the OpenAPI definition to generate API clients, import the API into development tools, and validate requests and responses.