cross group settlements

Preview settlement

Preview cross-group settlement between two users

post/settlements/cross-group/preview

Request

  • Base URL: http://localhost:3001
  • URL: http://localhost:3001/settlements/cross-group/preview
  • Auth: HTTP bearer

Request body

userIdstring required

User ID requesting the settlement

otherUserIdstring required

Other user ID in the settlement

groupIdsstring[]

List of group IDs to include (optional)

Response

Settlement preview calculated successfully

dataobject nullable
successboolean
messagestring

Example response

{
  "success": true,
  "message": "Success"
}

Changes

No recorded changes to this operation across all 1 revision of this API.