POST api/commerce/admin/settlements/approve

Request Information

URI Parameters

None.

Body Parameters

CommerceSettlementActionDTO
NameDescriptionTypeAdditional 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": "ddc050c8-5080-4ea0-b053-76203d39778a",
  "EventKey": "sample string 2",
  "ReasonCode": "sample string 3",
  "Note": "sample string 4",
  "PaymentReference": "sample string 5",
  "PaidAt": "2026-10-27T10:31:46.1043418+08:00",
  "OperatorMemberID": "c91998cb-3be9-4f2e-80df-ce464d7db8d0"
}

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>c91998cb-3be9-4f2e-80df-ce464d7db8d0</OperatorMemberID>
  <PaidAt>2026-10-27T10:31:46.1043418+08:00</PaidAt>
  <PaymentReference>sample string 5</PaymentReference>
  <ReasonCode>sample string 3</ReasonCode>
  <SettlementBatchID>ddc050c8-5080-4ea0-b053-76203d39778a</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.