POST api/v{version}/TransferPayment/ProcessTransferPayment

Request Information

URI Parameters

Name	Description	Type	Additional information
version		string	None.

Body Parameters

TransferPaymentBindingModel

Name	Type	Additional information
DistrictId	integer	Required
TransferId	string	None.
TransactionDT	date	None.
FromStudentNumber	string	Required
ToStudentNumber	string	Required
TransferAmount	decimal number	Required Range: inclusive between 0 and 999
Deleted	boolean	None.
FromStudentName	string	None.
ToStudentName	string	None.
FromStudentBalance	decimal number	None.
ToStudentBalance	decimal number	None.

Request Formats

application/json, text/json

Sample:

{
  "DistrictId": 1,
  "TransferId": "sample string 2",
  "TransactionDT": "2024-11-21T03:51:24.4607321-05:00",
  "FromStudentNumber": "sample string 4",
  "ToStudentNumber": "sample string 5",
  "TransferAmount": 6.0,
  "Deleted": true,
  "FromStudentName": "sample string 8",
  "ToStudentName": "sample string 9",
  "FromStudentBalance": 10.0,
  "ToStudentBalance": 11.0
}

application/xml, text/xml

Sample:

<TransferPaymentBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/K12.Shared.APIModels">
  <Deleted>true</Deleted>
  <DistrictId>1</DistrictId>
  <FromStudentBalance>10</FromStudentBalance>
  <FromStudentName>sample string 8</FromStudentName>
  <FromStudentNumber>sample string 4</FromStudentNumber>
  <ToStudentBalance>11</ToStudentBalance>
  <ToStudentName>sample string 9</ToStudentName>
  <ToStudentNumber>sample string 5</ToStudentNumber>
  <TransactionDT>2024-11-21T03:51:24.4607321-05:00</TransactionDT>
  <TransferAmount>6</TransferAmount>
  <TransferId>sample string 2</TransferId>
</TransferPaymentBindingModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OperationResult

Name	Description	Type	Additional information
result		string	None.

Response Formats

application/json, text/json

Sample:

{
  "result": "sample string 1"
}

application/xml, text/xml

Sample:

<OperationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/K12.Shared.Models">
  <Result>sample string 1</Result>
</OperationResult>