POST api/v{version}/DynamicPayout/CollectFees

Request Information

URI Parameters

NameDescriptionTypeAdditional information
version

string

None.

Body Parameters

DynamicPayoutFeeCollectionHistoryModel
NameDescriptionTypeAdditional information
AlternativeMerchantId

string

None.

Id

string

None.

Inserted

date

None.

Amount

decimal number

None.

GrossFeesSinceLastCollection

decimal number

None.

MerchantId

string

None.

ReportGroup

string

None.

User

string

None.

VendorTransactionId

string

None.

VendorResponseCode

string

None.

VendorResponseMessage

string

None.

VendorResponseTime

date

None.

Request Formats

application/json, text/json

Sample:
{
  "AlternativeMerchantId": "sample string 1",
  "Id": "sample string 2",
  "Inserted": "2024-12-03T19:55:27.7826524-05:00",
  "Amount": 4.0,
  "GrossFeesSinceLastCollection": 5.0,
  "MerchantId": "sample string 6",
  "ReportGroup": "sample string 7",
  "User": "sample string 8",
  "VendorTransactionId": "sample string 9",
  "VendorResponseCode": "sample string 10",
  "VendorResponseMessage": "sample string 11",
  "VendorResponseTime": "2024-12-03T19:55:27.7826524-05:00"
}

application/xml, text/xml

Sample:
<DynamicPayoutFeeCollectionHistoryModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/K12.Shared.Models.DynamicPayout">
  <AlternativeMerchantId>sample string 1</AlternativeMerchantId>
  <Amount>4</Amount>
  <GrossFeesSinceLastCollection>5</GrossFeesSinceLastCollection>
  <Id>sample string 2</Id>
  <Inserted>2024-12-03T19:55:27.7826524-05:00</Inserted>
  <MerchantId>sample string 6</MerchantId>
  <ReportGroup>sample string 7</ReportGroup>
  <User>sample string 8</User>
  <VendorResponseCode>sample string 10</VendorResponseCode>
  <VendorResponseMessage>sample string 11</VendorResponseMessage>
  <VendorResponseTime>2024-12-03T19:55:27.7826524-05:00</VendorResponseTime>
  <VendorTransactionId>sample string 9</VendorTransactionId>
</DynamicPayoutFeeCollectionHistoryModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.