regis

<back to all web services

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 .other suffix or ?format=other

HTTP + OTHER

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: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"payload":[{"studentGuid":"String","academicPeriodGUID":"String","paymentType":"String","paidOn":"String","comments":"String","amount":"String","currency":"String","id":"String","studentResidenceType":"String"}],"stamp":"String","hash":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"success":false}