---
title: "Execute cross-group settlement"
method: POST
path: "/cross-group-settlements/execute/{id}"
tags: ["cross group settlements"]
---

# Execute cross-group settlement

`POST /cross-group-settlements/execute/{id}`

## Request

- Base URL: `http://localhost:3001`
- URL: `http://localhost:3001/cross-group-settlements/execute/{id}`
- Auth: HTTP bearer

Execute cross-group settlement for a specific user

## Path parameters

- `id` string, required

## Query parameters

- `currency` string, required

## Request body

- CrossGroupSettlementExecuteWithFxBodyDto
  - `description` string: Description for the generated settlement transfers
  - `currency` string: Three-letter currency code to settle
  - `paidIn` SettlementFxPaymentDto
    - `currency` string, required: Currency actually handed over; must differ from the settled currency
    - `amount` number, required: Amount handed over, in `currency`
    - `rate` number, required: Agreed exchange rate exactly as the user saw it
    - `rateBase` 'paid' | 'settled', required: 'paid': 1 unit of the paid currency = rate units of the settled currency; 'settled': the inverse

## Response `200`

Cross-group settlement executed successfully

- object
  - `data` object, nullable
  - `success` boolean
  - `message` string

## Other responses

- `400`: Bad Request - Invalid input or validation failed
- `401`: Unauthorized - Authentication required or invalid token
- `403`: Forbidden - Insufficient permissions to access this resource
- `404`: Not Found - The requested resource does not exist
- `500`: Internal Server Error - An unexpected error occurred

---

[API](https://skmtc.dev/spliteo/apis/spliteo-api.md) · [All operations](https://skmtc.dev/spliteo/apis/spliteo-api/llms.txt) · [OpenAPI document](https://skmtc.dev/spliteo/apis/spliteo-api/revisions/bd9b84f4e407?raw)