cross group settlements

Execute balance simplification

Execute balance simplification for specified opportunities

post/cross-group-settlements/simplification/execute

Request

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

Request body

descriptionstring

Description for the generated settlement transfers

currencystring

Three-letter currency code to settle

otherUserIdstring required

The other user in the balance relationship

targetGroupIdstring required

Group that will hold the consolidated balance

Response

Balance simplification executed 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.