Getting started

Terminology

When working with the Qualy API you may find in our documentation and our API specific terms that may not be used outside of the payments industry or Qualy itself. Use this table to understand what these terms mean.


These are the most common terms used by Qualy:

TermMeaning
ContactContact is the end-user, it's your customer. The one performing the payment. The term "Customer" may also be used interchangeably.
TenantThis is Qualy's customer, a business that is using Qualy to receive payments.
Payment intentA payment intent is a payment entry. It may be on different status and it's what Qualy uses to send reminders, and accept payments/transactions against. It's called a payment intent, as it may never become "paid".
TransactionA transaction is created when Qualy needs to receive money or register money has been received. It's also used for refunds.
Method/Payment methodA payment may be paid by different methods (e.g. Credit Card, PayID, etc). Different entities in Qualy will have multiple methods associated to them.
UserA user is created by a "super admin" on Qualy, and it has access to the Dashboard.
Order / Order itemAn order groups what a contact bought; each product or service in it is an order item. An order can be paid by one or many payment intents (e.g. a payment plan). See Creating orders.
ServiceA product or service in your catalog (e.g. "Diploma of Business"). Orders, order items, and subscriptions reference services.
SubscriptionA recurring billing arrangement that automatically generates payment intents on a schedule. See Creating subscriptions.
PartnershipAnother party you transact with or on behalf of — an agent, institution, or supplier. Suppliers on orders and splits affect how money is divided. See payment splits.
Payment splitThe portion of a payment owed to a partnership (also called a split intent). Splits are calculated from the payment's items and the supplier attached to them.
PayoutMoney Qualy sends out — to you (settlement) or to your partners. Distinct from a transaction, which records money coming in.
Settlement currencyWhen you want a contact to pay in a currency different from the payment's currency, the settlement currency is what they actually pay in. Qualy handles the FX. See Creating payment intents.
Amounts (minor units)Every monetary amount in the API is an integer in the currency's minor units (cents). 100000 means $1,000.00.
AuthorizationA direct-debit mandate — a contact's standing permission to debit their bank account (e.g. PayTo, PayID). Not to be confused with API authorization (your API key).
DisputeA chargeback: a cardholder questions a payment with their bank, and the amount is held until it resolves. See Handling disputes.
DunningChasing overdue receivables — sending reminders (notices), logging attempts (chases), and tracking responses. Communications only; it never moves money. See Dunning.
ApprovalA maker-checker sign-off. An approval policy can require one or more approvers to authorize a money-moving action before it proceeds. See Approvals.
Previous
Webhook events reference