Stax API Documentation

This is the complete API documentation for connecting to the Stax API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet Stax: Stax is a payments platform for processing merchant payments, customers, transactions, invoices, payment methods, and related billing workflows through the Stax Pay API. Keep reading to get started.

Quickstart

Before you run your first Stax request, you need three things:

1. A MindCloud account — sign in or create an account at MindCloud.
2. A MindCloud API Key — create one in API Keys. Keep it on your server.
3. At least one Stax connection — create or choose one in Connections. Note its connectionId.

Every Stax action uses the same URL pattern:

POST https://connect.mindcloud.co/v2/universal/apps/stax/actions/{actionSlug}/run

You need a MindCloud API Key and a Stax connection. Then call an action such as List Customers:

curl --request POST \
  --url "https://connect.mindcloud.co/v2/universal/apps/stax/actions/list-customers/run" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "connectionId": "$CONNECTION_ID",
  "arguments": {}
}'

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authenticate with a MindCloud API Key plus a connectionId for your Stax account. See Stax API Authentication for the full flow and how to get your connection credentials.

Stax actions

All 41 published actions for this Stax version. Each page documents the endpoint, arguments, and response controls.

• PUTCapture Pre-Auth Transaction
• POSTCharge Payment Method
• POSTCreate Card Payment Method
• POSTCreate Customer
• POSTCreate Payment Link
• DELETEDelete Customer
• DELETEDelete Payment Link
• DELETEDelete Payment Method
• GETGet Customer
• GETGet Daily Sales
• GETGet Deposit Details
• GETGet Invoice
• GETGet Payment Link
• GETGet Payment Link Active Status
• GETGet Payment Method
• GETGet Related Transactions
• GETGet Statement ACH Rejections
• GETGet Statement Card Processing
• GETGet Statement Disputes
• GETGet Statement Fees
• GETGet Statement Refunds and Adjustments
• GETGet Statement Surcharging
• GETGet Statement Volumes by Card Type
• GETGet Team Summary
• GETGet Transaction
• GETGet Transaction Funding Instructions
• GETGet User and Team Info
• GETList Customer Payment Methods
• GETList Customers
• GETList Deposits
• GETList Invoices
• GETList Merchant Payment Methods
• GETList Payment Links
• GETList Team Users
• GETList Transactions
• GETReview Transaction Surcharge
• PUTUpdate Customer
• PUTUpdate Payment Link
• PUTUpdate Payment Method
• POSTVerify Payment Method
• POSTVoid or Refund Transaction

Related apps

More Commerce apps on the Universal API, behind the same REST shape. Or browse all apps.

StripeShopifySquareXeroThinkificWhopGumroadEcwid