Overview

The Stax API is organized around REST, providing predictable, resource-oriented URLs and standard HTTP response codes for indicating errors. This makes it easy to integrate with, whether you're a seasoned developer or just getting started.

Getting Started

globe
Base URL

All API requests should be made to the following base URL:

https://apiprod.fattlabs.com

When using a live or sandbox API key, you will use the same production URL. However, your sandbox will be linked to a test gateway and will not use real money.

key
Authentication

To access the API, you need an API key. All requests must include this key in the Authorization header as a Bearer Token.

Authorization: Bearer YOUR_SECRET_KEY

⚠️ Keep your API key secure and never expose it in client-side code or public repositories.

Example Request

curl -X GET "https://apiprod.fattlabs.com/"\
-H "Authorization: Bearer YOUR_SECRET_KEY"\
-H "Content-Type: application/json"

API Features

code
Content-Type Header

The Content-Type header must always be set to:

application/json

This ensures the API understands your requests and responds with JSON.

exchange-alt
HTTP Methods

The Stax API supports standard HTTP methods:

  • GET: Retrieve a resource
  • POST: Create a new resource
  • PUT: Update an existing resource
  • DELETE: Delete a resource

Important Information

tachometer-altRate Limits

The API enforces a rate limit of 100 requests per minute. If you exceed this limit, you'll receive a 429 Too Many Requests response.

The Retry-After header in the response indicates when you can retry your request.

exclamation-triangleError Handling

The Stax API uses standard HTTP status codes to indicate the success or failure of requests:

Status CodeMeaningDescription
200 OK✅ SuccessThe request was successful
400 Bad Request❌ Client ErrorInvalid request (missing parameters)
401 Unauthorized🔒 Auth ErrorAuthentication failed (missing/incorrect API key)
404 Not Found🔍 Not FoundThe requested resource does not exist
429 Too Many Requests⏰ Rate LimitedYou've exceeded the rate limit
500 Internal Server Error🔧 Server ErrorSomething went wrong on our end
shield-altCross-Origin Resource Sharing (CORS)

The Stax API supports CORS, allowing secure interaction from client-side applications.

⚠️ Important: Never expose your secret API key in public client-side code.


Need Help?

question-circle
Support & Documentation

If you have any questions or run into issues:

  • Check out our comprehensive API Documentation
  • Contact our support team for assistance
  • Review the examples and guides in this documentation