Payrexx Platforms
PaymentsPayrexx Platforms is the white-label marketplace side of Payrexx. Agents onboard and manage merchant instances, read and charge their transactions, and run the point-of-sale terminal estate from models and stock to orders and returns.
What This Integration Enables
Payrexx Platforms is the operator's side of a white-label payments business, and it is worth being clear that most of it is not about taking payments at all. The daily work here is tenancy and hardware: onboarding merchants onto their own Payrexx instances, publishing the terminal catalog they order from, pricing rentals, running discount codes, approving order positions, assigning specific devices out of stock, tracking shipping, and handling returns. The payments surface is deliberately thin, four operations that let a platform read a merchant's transaction, charge a tokenized card on their behalf, refund, and mark an invoice paid.
That makes this a connector about physical inventory with a payments contract attached, and physical inventory has consequences software usually does not. A device deregistered in the system is a device that stops taking money in a shop. FlowRunner agents can carry the whole estate: reconcile the fleet against your own records, chase unverified stores before hardware ships, and keep order positions moving. The operations that reach into a merchant's trading day are the ones that stop and ask, which is what human-in-the-loop is for.
Without FlowRunner
With FlowRunner
Use Case Scenarios
-
Onboarding that is accepted the first time
A deal closes in HubSpot. Before creating anything, the agent calls List Business Categories and List Business Types for the merchant's country, because Payrexx expects numeric codes in those fields rather than free text and the legal form list differs by country. Create Merchant then provisions the instance on a subdomain, which has to be free across all of Payrexx rather than just your platform, so the agent handles the rejection and proposes an alternative instead of failing the onboarding. With the tenant live, List Orderable Models and Get Terminal Model Price build the hardware quote, Validate Discount Code checks the promotion is still alive before it is quoted, and Create Order puts the devices on their way.
-
A fleet audit that does not miss the deployed devices
On a schedule, the agent lists terminals in fleet view rather than stock view, because stock view returns only devices in stock or on order and would silently omit every device already in a merchant's hands. Each row is resolved with Get Merchant By Terminal, and the result is written to Google Sheets against your own asset register. Discrepancies go to Slack: devices the register says are deployed that Payrexx has in stock, devices Payrexx says are deployed to a merchant your records closed months ago, and warranty cases that never came back.
-
Shipping status that the platform cannot see by itself
Own-stock devices ship on your carrier, not on Payrexx's, which means Payrexx has no way of knowing a parcel moved unless you say so. The agent listens to the carrier's tracking events and calls Update Position Shipping Status to mark a position sent and then delivered. The merchant's onboarding timeline stays accurate, and the estate owner gets an alert on positions approved days ago that have never been marked sent, which is usually a box still sitting in the warehouse rather than a tracking gap.
Human-in-Loop Highlight
Resolve Return has two settings and they are not two flavors of the same act. Cancel restores the position to delivered and records why. Complete returns the position, unpairs the terminal, and deregisters it, and Payrexx states that this is not reversible from here. Recovery means Update Terminal Status, which is an innocuous name for an operation that runs the full unpair lifecycle and tears down the acquirer and ECR registrations before restocking the device. So a returns agent that completes a return because the tracking number went quiet can deregister a terminal that is still on a merchant's counter taking cards, and the merchant finds out at the till. The agent therefore assembles the case and stops: "Return DSP-4471, terminal serial N910-4471, merchant Bergli Cafe. Opened 9 days ago. Carrier shows no scan. Last transaction on this device: yesterday 17:20. Complete the return, or cancel it and chase the merchant?" The last transaction is the field that matters, and a person reads it before the deregistration happens.
Agent Capabilities
49 actionsMerchants
6- Create Merchant Onboards a merchant onto your platform with their own instance and an administrator account. Restricted defaults to on for a marketplace, so a full-product merchant is a deliberate choice.
- List Merchants Lists the merchants on your platform. It pages by cursor rather than offset, unlike every point of sale route here.
- Get Merchant Reads one merchant: their subdomain, administrator email, language, and stored company details.
- Update Merchant Updates a merchant. Setting active off closes the account rather than hiding it, and an empty string is how a field is cleared.
- Delete Merchant Removes a merchant and their instance from the platform. Closing an account while keeping the record is a different operation.
- Get Merchant By Terminal Finds which merchant a terminal belongs to, from its identifier or the serial number printed on the device. This is the operation that turns a device in your hand into an account.
Transactions
4- Get Transaction Reads one transaction across the platform, including whether it is live or test, which two otherwise identical figures do not tell you.
- Charge Tokenization Charges a card a merchant's customer previously tokenized, from the platform side rather than the merchant's own instance.
- Refund Transaction Refunds a merchant's transaction from the platform. The result can come back partially refunded, so read it rather than assuming.
- Mark Transaction Invoice Paid Sets a transaction invoice to paid. It is a single-purpose switch and does nothing else.
Reference
3- Get API User Reads the platform user the key belongs to, which is the cheapest way to confirm which tenant a key opens before running anything that writes.
- List Business Categories Lists the business categories Payrexx recognizes with their numeric codes, which is what merchant onboarding expects.
- List Business Types Lists the legal business types for one country. The list is country specific, so a code from one country is not portable.
Terminal Models
6- List Terminal Models Lists the terminal catalog with each model's available device count for your platform.
- Get Terminal Model Reads one model with its label, hardware type, solution provider, and availability.
- Get Terminal Model Factsheet Reads the factsheet links for a model by language, which is what you put in front of a merchant choosing a device.
- Get Terminal Model Price Reads the rental price matrix for a model. A period with no price reads as null rather than zero, which is a different thing when quoting.
- Get Terminal Model Setting Reads your platform's settings for a model: rental status, default source, and how many devices you hold in stock.
- Update Terminal Model Setting Switches rental on or off and sets where orders are fulfilled from. It is also the only route that creates a missing setting row.
Terminals
4- List Terminals Lists terminals in scope. Stock view returns only stock and ordered devices, so an estate audit has to use fleet view or it misses everything deployed.
- Get Terminal By Serial Looks up one physical device by the serial number printed on it, safely enough to call with whatever a warehouse hands you.
- Get Terminal History Reads a device's history: the position it is assigned to now, or null when it sits in stock, and every position it has held.
- Update Terminal Status Moves a stock terminal between reserve, available, and blocked. On a deregistration or warranty case it runs the full unpair lifecycle first, which is more than the name suggests.
Discount Codes
6- List Discount Codes Lists point of sale discount codes, filtered by state, code text, or the model a code is limited to.
- Create Discount Code Creates a percentage discount merchants apply when ordering hardware. A default window makes a code apply automatically without the merchant typing it.
- Get Discount Code Reads one code with its percentage, duration, and the models it covers.
- Update Discount Code Updates a code. A soft deleted code cannot be updated, and the linked model set replaces rather than merges.
- Delete Discount Code Soft deletes a code. It is idempotent, and since a deleted code can no longer be updated it is permanent in practice.
- Validate Discount Code Checks a code is currently valid, optionally for a specific model, before it is attached to an order. This is what makes a quote accurate rather than optimistic.
Orders
14- List Orders Lists terminal orders. It pages by position rather than by order, so an order spanning a page boundary can appear on more than one page.
- Create Order Creates a manual order putting terminals in a merchant's hands. The merchant and delivery address sit on the order, while each position carries its own device, terms, and discount.
- Get Order Reads one order in full, with every position and its discount, availability, approval state, and invoices.
- Get Order Position Reads one position. The answer is the parent order carrying only that position, so the order context travels with it.
- Update Order Position Updates a position's price, billing period, billing mode, or discount. Sending null explicitly clears a value rather than leaving it alone.
- Approve Order Position Approves an unassigned position and assigns a terminal from the pool, or pins an exact device when you name one.
- Cancel Order Position Cancels a position that has no terminal assigned yet, and only for positions fulfilled from your own stock.
- Update Position Terminal Source Switches a position between your own stock and the Payrexx rental pool, which changes who manages the device and how it comes back.
- Update Position Shipping Status Marks a position sent or delivered. It exists because you ship on your own carrier and Payrexx cannot see the parcel move.
- Search Order Merchants Searches merchants by name for manual order creation. It is a picker rather than a listing, with a minimum query length and a capped result.
- List Order Stores Lists one merchant's stores, each with a verification status worth checking before hardware ships to it.
- Get Default Model Price Reads the default rental price matrix for a model, which is what prefills a position's price.
- List Orderable Models Lists the models the platform can actually source, which is narrower than the full catalog.
- List Assignable Terminals Lists the devices available to assign to a position, which is the pool approval draws from.
Returns
4- Initiate Return Starts a return for an assigned, active position. What happens next is decided by who owns the device, not by anything you send: a rental device gets a label and an instruction email, an own-stock device is entirely self service.
- List Returns Lists returns filtered by status, reason, or merchant, newest first.
- Get Return Reads one return with its status, reason, note, support ticket, and any cancellation note.
- Resolve Return Completes or cancels a pending return. Completing unpairs and deregisters the terminal, which is the operation this page's human gate exists for.
Configuration
2- Get POS Config Reads the platform's point of sale configuration: whether incoming orders are auto approved, the terms links by language, and per model settings.
- Update POS Config Updates that configuration. Blank terms links are dropped by the vendor, and settings rows can be changed here but not created.
Frequently Asked Questions
What can FlowRunner do with Payrexx Platforms?
FlowRunner agents can run Create Merchant, List Merchants, and Get Merchant in Payrexx Platforms, plus 46 more actions.
Does connecting Payrexx Platforms to FlowRunner require OAuth?
No. Payrexx Platforms connects to FlowRunner with an API key, no OAuth flow required.
Can Payrexx Platforms trigger a FlowRunner workflow automatically?
Payrexx Platforms doesn't currently expose triggers in FlowRunner. It connects as an action step inside workflows started by another trigger.
Start building with Payrexx Platforms
Free plan, no card required. Connect in minutes.