Required permission: | CreatePayments |
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 .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<FinancePayStudentAccountByCardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
<amount>0</amount>
<is_interac>false</is_interac>
<is_mastercard>false</is_mastercard>
<is_paymytuition>false</is_paymytuition>
<is_visa>false</is_visa>
<payment_id>String</payment_id>
<regent_id>0</regent_id>
</FinancePayStudentAccountByCardRequest>
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>