POST api/CentralPayoutProcessor/CreatePayoutInterval

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Id	integer	None.
PayoutCycleName	string	None.
PayoutTypeId	PayoutType	None.
Status	boolean	None.
IntervalId	Intervals	None.
DayOfWeek	DayOfWeek	None.
DayOfMonth	integer	None.
TimeOfOperation	string	None.
CreatedBy	integer	None.
DateCreated	date	None.
UpdatedBy	integer	None.
DateUpdated	date	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "PayoutCycleName": "sample string 2",
  "PayoutTypeId": 1,
  "Status": true,
  "IntervalId": 1,
  "DayOfWeek": 0,
  "DayOfMonth": 1,
  "TimeOfOperation": "sample string 4",
  "CreatedBy": 5,
  "DateCreated": "2025-11-03T16:00:33.5255898+00:00",
  "UpdatedBy": 7,
  "DateUpdated": "2025-11-03T16:00:33.5255898+00:00"
}

application/xml, text/xml

Sample:

<PayoutIntervals xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <CreatedBy>5</CreatedBy>
  <DateCreated>2025-11-03T16:00:33.5255898+00:00</DateCreated>
  <DateUpdated>2025-11-03T16:00:33.5255898+00:00</DateUpdated>
  <UpdatedBy>7</UpdatedBy>
  <DayOfMonth>1</DayOfMonth>
  <DayOfWeek>Sunday</DayOfWeek>
  <Id>1</Id>
  <IntervalId>Immediately</IntervalId>
  <PayoutCycleName>sample string 2</PayoutCycleName>
  <PayoutTypeId>DepotPayout</PayoutTypeId>
  <Status>true</Status>
  <TimeOfOperation>sample string 4</TimeOfOperation>
</PayoutIntervals>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

VCAPIResponse

Name	Type	Additional information
Version	string	None.
dateTime	string	None.
StatusCode	integer	None.
ErrorMessage	string	None.
Result	Object	None.

Response Formats

application/json, text/json

Sample:

{
  "Version": "1.0.0",
  "dateTime": "2025/11/03 16:00:33",
  "StatusCode": 1,
  "ErrorMessage": "sample string 2",
  "Result": {}
}

application/xml, text/xml

Sample:

<VCAPIResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <ErrorMessage>sample string 2</ErrorMessage>
  <Result />
  <StatusCode>1</StatusCode>
</VCAPIResponse>