regis

FinancePayMyTuitionRequest

**Requires Authentication**
Required permission:	CreatePayments

The following routes are available for this service:
POST	/Finance/PayMyTuition

"use strict";
export class FinancePayStudentAccountByCardResponse {
    /** @param {{responseStatus?:ResponseStatus,success?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {boolean} */
    success;
}
export class FinancePayMyTuitionPayloadRequest {
    /** @param {{studentGuid?:string,academicPeriodGUID?:string,paymentType?:string,paidOn?:string,comments?:string,amount?:string,currency?:string,id?:string,studentResidenceType?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    studentGuid;
    /** @type {string} */
    academicPeriodGUID;
    /** @type {string} */
    paymentType;
    /** @type {string} */
    paidOn;
    /** @type {string} */
    comments;
    /** @type {string} */
    amount;
    /** @type {string} */
    currency;
    /** @type {string} */
    id;
    /** @type {string} */
    studentResidenceType;
}
export class FinancePayMyTuitionRequest {
    /** @param {{payload?:FinancePayMyTuitionPayloadRequest[],stamp?:string,hash?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {FinancePayMyTuitionPayloadRequest[]} */
    payload;
    /** @type {string} */
    stamp;
    /** @type {string} */
    hash;
}

JavaScript FinancePayMyTuitionRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Finance/PayMyTuition HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FinancePayMyTuitionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <hash>String</hash>
  <payload>
    <FinancePayMyTuitionPayloadRequest>
      <AcademicPeriodGUID>String</AcademicPeriodGUID>
      <Currency>String</Currency>
      <Id>String</Id>
      <PaymentType>String</PaymentType>
      <StudentGuid>String</StudentGuid>
      <StudentResidenceType>String</StudentResidenceType>
      <amount>String</amount>
      <comments>String</comments>
      <paidOn>String</paidOn>
    </FinancePayMyTuitionPayloadRequest>
  </payload>
  <stamp>String</stamp>
</FinancePayMyTuitionRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FinancePayStudentAccountByCardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <success>false</success>
</FinancePayStudentAccountByCardResponse>