> For the complete documentation index, see [llms.txt](https://docs.xyb.co/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.xyb.co/xyb-platform-1/xyb-payments/getting-started-with-payments/xyb-payments-overview.md).

# XYB Payments overview

Welcome to the XYB Payments Platform! A modern, API-first payment orchestration layer built for banks, fintechs, and financial institutions who want full control over how money moves.

Whether you're sending payroll, processing user transfers, or integrating card payouts, our platform helps you **build it faster, scale it confidently, and stay compliant.**

***

### What You Can Do

With the Payments Platform, you can:

* **Send Payments Anywhere**\
  Domestic, international, internal transfers, with support for cards, bank accounts, and payment partners.
* **Orchestrate Complex Workflows**\
  Define how payments are processed: risk checks, ledger steps, approvals, settlement rules, all fully customizable.
* **Integrate with Core Banking**\
  Seamless connections with account, card, and ledger services to enrich, validate, and manage payments end to end.
* **Track Every Step**\
  From creation to settlement, monitor the full lifecycle of each payment with real-time visibility.
* **Take Action When Needed**\
  Cancel, retry, roll back payment operations can be triggered manually or programmatically.

***

### How It Works (At a Glance)

Here’s what happens when you initiate a payment:

1. **You send a payment request** using our API, including details like sender, amount, and receiver.
2. **We validate and enrich the data** by fetching account, card, and beneficiary details from your ecosystem.
3. **We identify the workflow**, i.e., what steps are required for this payment type (e.g., ledger auth, risk check).
4. **The Payment Engine takes over** to orchestrate all steps: reserving funds, calling partners, and updating statuses.
5. **You get real-time updates** as the payment moves through the pipeline.
6. **Once complete**, payment data is stored in the Payment History service and made available via APIs or admin tools.
7. **If needed**, use Payment Operations UI to intervene (cancel, retry, etc.). (coming soon)

***

### Built for Developers

We’ve designed this platform to be:

* **API-first** with detailed OpenAPI documentation
* Easy to test in sandbox environments
* Fully event-driven (via Kafka) for real-time use cases
* Extensible with custom workflows and adapters

***

### Key Components

| Component              | Role                                                             |
| ---------------------- | ---------------------------------------------------------------- |
| **Payment Service**    | Entry point receives and validates payment request               |
| **Payment Engine**     | Orchestrates the full payment workflow                           |
| **Workflow Engine**    | Defines and configures how each payment should be processed      |
| **Payment History**    | Stores finalized payments for end-user visibility and audits     |
| **Payment Operations** | Allows support teams to cancel, retry, or manage payments        |
| **Adapters**           | Integrations with third-party payment partners (e.g., Visa, TCC) |

***

### Typical Use Cases

* **Fintech App**: Offer real-time SEPA and internal transfers to users across Europe
* **Marketplace Platform**: Payout seller earnings to cards and bank accounts
* **Corporate Treasury**: Automate bulk payroll, vendor payments, and FX transfers
* **Regulated Institution**: Perform multi-step approval flows with full audit trails


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.xyb.co/xyb-platform-1/xyb-payments/getting-started-with-payments/xyb-payments-overview.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.