Payrexx API Documentation

This is the complete API documentation for connecting to the Payrexx 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 Payrexx: Payrexx is a payments platform for managing gateways, transactions, subscriptions, invoices, paylinks, payouts, and POS payment flows. Keep reading to get started.

Quickstart

Before you run your first Payrexx 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 Payrexx connection — create or choose one in Connections. Note its connectionId.

Every Payrexx action uses the same URL pattern:

https://connect.mindcloud.co/v1/universal/payrexx/latest/actions/{actionSlug}

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

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/payrexx/latest/actions/list-designs" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --get \
  --data-urlencode "connectionId=$CONNECTION_ID"

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 Payrexx account. See Payrexx API Authentication for the full flow and how to get your connection credentials.

Payrexx actions

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

• PUTCancel Waiting Transaction
• PUTCapture Transaction
• PUTCharge Pre-Authorized Reserved Transaction
• POSTCreate Gateway
• POSTCreate Invoice
• POSTCreate Manual Payout
• POSTCreate Paylink
• POSTCreate QR Code
• POSTCreate Subscription
• DELETEDelete Gateway
• DELETEDelete Invoice
• DELETEDelete Paylink
• DELETEDelete Reserved Transaction
• GETGet Design
• GETGet Gateway
• GETGet Invoice
• GETGet Paylink
• GETGet Payment Method
• GETGet Transaction
• POSTHelper Create Design
• GETList Designs
• GETList Invoices
• GETList Payment Methods
• GETList Payment Providers
• GETList Payouts
• GETList Subscriptions
• GETList Transactions
• POSTPre-Authorize Tokenization
• PUTRefund Transaction
• PUTSend Mail Receipt
• PUTUpdate Invoice
• PUTUpdate Pre-Authorization Tokenization Contact Details
• PUTUpdate Tokenization

Related apps

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

StripeShopifySquareXeroThinkificWhopGumroadEcwid