Skip to Content
APIs & ToolsREST APIOverview

REST API Overview

Our REST API is designed to be simple and predictable, following standard RESTful conventions. All requests and responses use JSON format.

API Basics

  • Each merchant has a unique API base URL, e.g., https://merchant-zfds.api.myfinqu.com/3.0/.
  • The API is organized around standard HTTP methods (GET, POST, PUT, DELETE).
  • All data sent to and received from the API is in JSON format.

Request Format

  • Set the Content-Type: application/json header for all requests with a body.
  • Authentication is required for all endpoints (see Authentication section). Access tokens are used for authentication.
  • Example request:
POST https://merchant-zfds.api.myfinqu.com/3.0/orders
Content-Type: application/json
Authorization: Bearer YOUR_API_TOKEN
 
{
  "customer_id": "12345",
  "items": [ ... ]
}

Response Format

  • All responses are returned as JSON.
  • Standard HTTP status codes are used to indicate success or failure.
  • Example response:
{
  "id": "order-67890",
  "status": "created",
  ...
}

API Versioning

  • The API version is specified as part of the URL path (e.g., /3.0/).
  • API versioning follows semantic versioning principles (major.minor.patch), but only the major and minor versions are included in the path. Patch versions are not part of the path, as they do not introduce breaking changes.
  • Backwards-incompatible changes will result in a new major version.
Last updated on
Authentication