regis

<back to all web services

FinancePayMyTuitionRequest

Requires Authentication
Required permission:CreatePayments
The following routes are available for this service:
POST/Finance/PayMyTuition

export class FinancePayStudentAccountByCardResponse
{
    public responseStatus: ResponseStatus;
    public success: boolean;

    public constructor(init?: Partial<FinancePayStudentAccountByCardResponse>) { (Object as any).assign(this, init); }
}

export class FinancePayMyTuitionPayloadRequest
{
    public studentGuid: string;
    public academicPeriodGUID: string;
    public paymentType: string;
    public paidOn: string;
    public comments: string;
    public amount: string;
    public currency: string;
    public id: string;
    public studentResidenceType: string;

    public constructor(init?: Partial<FinancePayMyTuitionPayloadRequest>) { (Object as any).assign(this, init); }
}

export class FinancePayMyTuitionRequest
{
    public payload: FinancePayMyTuitionPayloadRequest[];
    public stamp: string;
    public hash: string;

    public constructor(init?: Partial<FinancePayMyTuitionRequest>) { (Object as any).assign(this, init); }
}

TypeScript FinancePayMyTuitionRequest DTOs

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

HTTP + CSV

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/csv
Content-Type: text/csv
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/csv
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}