# PayOut Overview

## How PayOut works

PayOut lets you send funds to recipients globally - to suppliers, employees, marketplace sellers, or any beneficiary you need to pay. Recipients receive the funds in their preferred payment method and local currency.

PayOut is a three-step flow:

1. **Add a sender** - once per legal entity initiating payouts. You receive a `senderID` to reuse.
2. **Send the payout** - submit the recipient details and the stored `senderID`.
3. **Check the status** - check the transaction status.

The sender is created once and reused across all subsequent payouts from the same underlying entity.

### The flow at a glance

```mermaid
sequenceDiagram
    participant App as Your System
    participant NXP as Nexterpay
    participant Provider as Payment Provider
    participant Recipient as Recipient

    Note over App,NXP: One-time setup
    App->>NXP: 1. Add sender
    NXP-->>App: senderID returned

    Note over App,NXP: Per-transaction flow
    App->>NXP: 2. Send payout
    Note right of App: POST with externalID,<br/>senderID, recipient details
    
    NXP->>Provider: Initiate disbursement
    NXP-->>App: orderID + Pending status
    
    Provider->>Recipient: Credit funds
    Provider->>NXP: Confirmation
    
    App->>NXP: 3. Check status (poll)
    NXP-->>App: Pending / Processing /<br/>Completed / Failed

    App->>App: Update transaction record
```

### Endpoints

| Endpoint                                              | Method | Purpose                                   |
| ----------------------------------------------------- | ------ | ----------------------------------------- |
| [Add a sender](/payout/add-a-sender.md)               | `POST` | Register a sender. Run once.              |
| [Send a payout](/payout/send-a-payout.md)             | `POST` | Initiate a disbursement to a recipient.   |
| [Check payout status](/payout/check-payout-status.md) | `POST` | Look up the status of an existing payout. |

### Sender lifecycle

The `senderID` returned from `AddPayOutSender` persists indefinitely. You only need to create a new sender if:

* The legal entity initiating payouts changes.
* You operate on behalf of multiple entities (in which case create one sender per entity).

For most integrations, you create one sender at onboarding and reuse the `senderID` for every payout that follows.


---

# Agent Instructions: 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:

```
GET https://docs.nexterpay.io/payout/payout-overview.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
