regis

<back to all web services

FinancePayStudentAccountByCardRequest

Requires Authentication
Required permission:CreatePayments
The following routes are available for this service:
POST/Finance/Pay/{regent_id}
POST/Finance/Pay
"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 FinancePayStudentAccountByCardRequest {
    /** @param {{regent_id?:number,amount?:number,is_visa?:boolean,is_mastercard?:boolean,is_interac?:boolean,is_paymytuition?:boolean,payment_id?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    regent_id;
    /** @type {number} */
    amount;
    /** @type {boolean} */
    is_visa;
    /** @type {boolean} */
    is_mastercard;
    /** @type {boolean} */
    is_interac;
    /** @type {boolean} */
    is_paymytuition;
    /** @type {string} */
    payment_id;
}

JavaScript FinancePayStudentAccountByCardRequest DTOs

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

HTTP + JSV

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

POST /Finance/Pay/{regent_id} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	regent_id: 0,
	amount: 0,
	is_visa: False,
	is_mastercard: False,
	is_interac: False,
	is_paymytuition: False,
	payment_id: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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
}