# Flowlix API

- [Introduction](https://docs.ecomm365.eu/introduction.md): Integrate card payments, refunds, payouts, and payment notifications
- [Authentication](https://docs.ecomm365.eu/guides/authentication.md): Authenticate API requests and keep your secret key server-side
- [Quickstart](https://docs.ecomm365.eu/guides/quickstart.md): Choose Hosted Payment Page or Direct API and create a Sandbox payment in about five minutes
- [Hosted Payment Page Quickstart](https://docs.ecomm365.eu/guides/hosted-payment-page.md): Create a Sandbox payment, redirect the customer, and confirm the final Payment status
- [Direct API Quickstart](https://docs.ecomm365.eu/guides/direct-api.md): Submit a Sandbox card payment from your server and confirm the final Payment status
- [Sandbox testing](https://docs.ecomm365.eu/guides/testing.md): Verify payment, refund, payout, retry, and failure handling without moving real money
- [Payment lifecycle](https://docs.ecomm365.eu/guides/payment-lifecycle.md): Interpret every Payment status and decide when to poll, fulfil, or start a new attempt
- [Refunds](https://docs.ecomm365.eu/guides/refunds.md): Create a full or partial Refund and track it through the parent Payment
- [Payouts](https://docs.ecomm365.eu/guides/payouts.md): Create card payouts and track their processing and final result
- [Webhooks](https://docs.ecomm365.eu/guides/webhooks.md): Receive and verify Payment, Refund, and Payout events on your server
- [Idempotency](https://docs.ecomm365.eu/guides/idempotency.md): Retry every create operation without duplicating a Payment, Refund, or Payout
- [Errors](https://docs.ecomm365.eu/guides/errors.md): Handle every public HTTP error by code, operation, and retry policy
- [Operation failures](https://docs.ecomm365.eu/guides/operation-failures.md): Distinguish HTTP errors from terminal Payment, Refund, and Payout outcomes
- [Get aggregate API availability](https://docs.ecomm365.eu/payments-api/health/get-aggregate-api-availability.md): Returns the current aggregate availability of the Flowlix API. This operation is public and always returns HTTP 200 when the gateway can answer. Inspect `status` instead of the HTTP status code.
- [List payments](https://docs.ecomm365.eu/payments-api/payments/list-payments.md): Returns a paginated list of payments, sorted by creation time in descending order (newest first). If no payments match the filters, the response is `200 OK` with an empty `data` array.
- [Create a Direct API payment](https://docs.ecomm365.eu/payments-api/payments/create-a-direct-api-payment.md): Creates a payment using exactly one merchant-facing payment method. Submit ordinary card details under `payment_method_data.card`, or submit a prepared decrypted Apple Pay or Google Pay credential under its wallet object. Google Pay PAN_ONLY also requires `browser_information`. The shopper IP belong…
- [Create a hosted payment page payment](https://docs.ecomm365.eu/payments-api/payments/create-a-hosted-payment-page-payment.md): Creates a hosted payment page payment attempt. Redirect the customer to `next_action.redirect_url` to complete the `next_action.reason` customer action. The required-action URL is opaque and may later change from the hosted page to a 3D Secure browser action. Use the latest `next_action.redirect_url…
- [Retrieve a payment](https://docs.ecomm365.eu/payments-api/payments/retrieve-a-payment.md): Retrieves a payment by ID.
- [List card payouts](https://docs.ecomm365.eu/payments-api/payouts/list-card-payouts.md): Returns merchant-scoped card payouts ordered newest first. `total_count` is the exact number matching the filters before cursor pagination.
- [Submit a card payout](https://docs.ecomm365.eu/payments-api/payouts/submit-a-card-payout.md): Submits a Host-to-Host Original Credit Transaction to a recipient Visa or Mastercard. Inspect the response status: `PENDING` and `PROCESSING` are nonterminal; `SUCCEEDED` and `FAILED` are terminal. `PROCESSING` does not confirm delivery or settlement.
- [Retrieve a card payout](https://docs.ecomm365.eu/payments-api/payouts/retrieve-a-card-payout.md): Retrieves one payout within the authenticated merchant and mode scope.
- [Create a refund](https://docs.ecomm365.eu/payments-api/refunds/create-a-refund.md): Refunds a payment that has already succeeded. The `amount` is always required. To refund the full payment, set `amount` to the payment's remaining refundable amount. The refund uses the same currency as the original payment; currency is not accepted on the refund request.

## OpenAPI Specs

- [payments-api](/api-reference/payments-api.yaml)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.