POST api/commerce/admin/settlements/cancel

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
SettlementBatchID	globally unique identifier	None.
EventKey	string	None.
ReasonCode	string	None.
Note	string	None.
PaymentReference	string	None.
PaidAt	date	None.
OperatorMemberID	globally unique identifier	None.

Request Formats

application/json, text/json

Sample:

{
  "SettlementBatchID": "56fae965-b951-46be-be63-343dd0dc7e3d",
  "EventKey": "sample string 2",
  "ReasonCode": "sample string 3",
  "Note": "sample string 4",
  "PaymentReference": "sample string 5",
  "PaidAt": "2026-10-27T10:31:29.1030967+08:00",
  "OperatorMemberID": "4ab97d0f-814e-41fc-ad12-16c7115f7d49"
}

application/xml, text/xml

Sample:

<CommerceSettlementActionDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIProject.API.Models.DTO">
  <EventKey>sample string 2</EventKey>
  <Note>sample string 4</Note>
  <OperatorMemberID>4ab97d0f-814e-41fc-ad12-16c7115f7d49</OperatorMemberID>
  <PaidAt>2026-10-27T10:31:29.1030967+08:00</PaidAt>
  <PaymentReference>sample string 5</PaymentReference>
  <ReasonCode>sample string 3</ReasonCode>
  <SettlementBatchID>56fae965-b951-46be-be63-343dd0dc7e3d</SettlementBatchID>
</CommerceSettlementActionDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.