POST api/Student/payments

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
CustomerRef	CustomerRef	None.
Line	Collection of Line	None.
TotalAmt	string	None.
PaymentRefNum	string	None.
TxnDate	string	None.
PrivateNote	string	None.
CustomField	string	None.
StudentNo	string	None.

Request Formats

application/json, text/json

Sample:

{
  "CustomerRef": {
    "value": "sample string 1",
    "name": "sample string 2"
  },
  "Line": [
    {
      "Amount": "sample string 1",
      "LinkedTxn": [
        {
          "TxnId": "sample string 1",
          "TxnType": "sample string 2"
        },
        {
          "TxnId": "sample string 1",
          "TxnType": "sample string 2"
        }
      ]
    },
    {
      "Amount": "sample string 1",
      "LinkedTxn": [
        {
          "TxnId": "sample string 1",
          "TxnType": "sample string 2"
        },
        {
          "TxnId": "sample string 1",
          "TxnType": "sample string 2"
        }
      ]
    }
  ],
  "TotalAmt": "sample string 1",
  "PaymentRefNum": "sample string 2",
  "TxnDate": "sample string 3",
  "PrivateNote": "sample string 4",
  "CustomField": "sample string 5",
  "StudentNo": "sample string 6"
}

application/xml, text/xml

Sample:

<PaymentData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Customer.Models">
  <CustomField>sample string 5</CustomField>
  <CustomerRef>
    <name>sample string 2</name>
    <value>sample string 1</value>
  </CustomerRef>
  <Line>
    <Line>
      <Amount>sample string 1</Amount>
      <LinkedTxn>
        <LinkedTxn>
          <TxnId>sample string 1</TxnId>
          <TxnType>sample string 2</TxnType>
        </LinkedTxn>
        <LinkedTxn>
          <TxnId>sample string 1</TxnId>
          <TxnType>sample string 2</TxnType>
        </LinkedTxn>
      </LinkedTxn>
    </Line>
    <Line>
      <Amount>sample string 1</Amount>
      <LinkedTxn>
        <LinkedTxn>
          <TxnId>sample string 1</TxnId>
          <TxnType>sample string 2</TxnType>
        </LinkedTxn>
        <LinkedTxn>
          <TxnId>sample string 1</TxnId>
          <TxnType>sample string 2</TxnType>
        </LinkedTxn>
      </LinkedTxn>
    </Line>
  </Line>
  <PaymentRefNum>sample string 2</PaymentRefNum>
  <PrivateNote>sample string 4</PrivateNote>
  <StudentNo>sample string 6</StudentNo>
  <TotalAmt>sample string 1</TotalAmt>
  <TxnDate>sample string 3</TxnDate>
</PaymentData>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.