settlements

Get settlement preview

Get settlement preview without committing to any transactions

get/groups/{groupId}/settlement/preview

Request

  • Base URL: http://localhost:3001
  • URL: http://localhost:3001/groups/{groupId}/settlement/preview
  • Auth: HTTP bearer

Path parameters

groupIdstring required

Group UUID

Response

Settlement preview retrieved successfully

successboolean
messagestring

Example response

{
  "data": {
    "groupId": "550e8400-e29b-41d4-a716-446655440000",
    "transactionsByCurrency": {
      "USD": [
        {
          "from": "user-a",
          "to": "user-b",
          "amount": 20,
          "currency": "USD"
        },
        {
          "from": "user-c",
          "to": "user-a",
          "amount": 10,
          "currency": "USD"
        }
      ]
    },
    "totalTransactions": 3,
    "currenciesUsed": [
      "USD",
      "EUR"
    ],
    "defaultCurrency": "USD",
    "previewOnly": true
  },
  "success": true,
  "message": "Success"
}

Changes