Documentation Index
Fetch the complete documentation index at: https://qomon-86428773.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
How it works
Financial data in Qomon is organised around transaction bundles. A bundle represents a single payment event and groups together:- Transactions — the payment itself (amount, method, payer)
- Memberships — membership subscriptions attached to the payment
- Donations — donations attached to the payment
One API key = one space
The bundle is recorded in the space whose API key you use. The contact can belong to a different space — their profile will still show the transaction. This is the correct pattern for multi-space organisations (e.g. a national federation and local chapters).Payer vs. beneficiary
| Field | Meaning |
|---|---|
contact_id in transactions | The payer — who made the payment |
contact_id in memberships | The beneficiary — who receives the membership |
contact_id in donations | The beneficiary — who receives the donation credit |
Getting required IDs
Before creating a bundle, retrieve the IDs valid for your group:| What you need | Endpoint |
|---|---|
| Allowed payment methods | GET /v1/transaction_settings → payment_method_kinds |
| Default valid status ID | GET /v1/transaction_settings → default_status_id |
| All transaction statuses | GET /v1/transaction_statuses |
| Membership price IDs | GET /v1/membership_prices |
| Donation price IDs | GET /v1/donation_prices |
| Campaign codes | GET /v1/code_campaigns |
Updating and refunds
Bundles are updated viaPATCH /v1/transaction_bundles/{id}. Updates are additive — items not included in the request remain unchanged.
Always resend all required fields on an item you are updating. Missing required fields may be cleared.For a partial refund: PATCH the transaction with the reimbursed status and
reimbursed_amount, and also update the amount on the linked membership or donation.
For a full cancellation: DELETE the bundle and recreate it with corrected data.