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
<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class FinancePayStudentAccountByCardResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null,
        /** @var bool|null */
        public ?bool $success=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
        if (isset($o['success'])) $this->success = $o['success'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        if (isset($this->success)) $o['success'] = $this->success;
        return empty($o) ? new class(){} : $o;
    }
}

class FinancePayStudentAccountByCardRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $regent_id=0,
        /** @var float */
        public float $amount=0.0,
        /** @var bool|null */
        public ?bool $is_visa=null,
        /** @var bool|null */
        public ?bool $is_mastercard=null,
        /** @var bool|null */
        public ?bool $is_interac=null,
        /** @var bool|null */
        public ?bool $is_paymytuition=null,
        /** @var string|null */
        public ?string $payment_id=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['regent_id'])) $this->regent_id = $o['regent_id'];
        if (isset($o['amount'])) $this->amount = $o['amount'];
        if (isset($o['is_visa'])) $this->is_visa = $o['is_visa'];
        if (isset($o['is_mastercard'])) $this->is_mastercard = $o['is_mastercard'];
        if (isset($o['is_interac'])) $this->is_interac = $o['is_interac'];
        if (isset($o['is_paymytuition'])) $this->is_paymytuition = $o['is_paymytuition'];
        if (isset($o['payment_id'])) $this->payment_id = $o['payment_id'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->regent_id)) $o['regent_id'] = $this->regent_id;
        if (isset($this->amount)) $o['amount'] = $this->amount;
        if (isset($this->is_visa)) $o['is_visa'] = $this->is_visa;
        if (isset($this->is_mastercard)) $o['is_mastercard'] = $this->is_mastercard;
        if (isset($this->is_interac)) $o['is_interac'] = $this->is_interac;
        if (isset($this->is_paymytuition)) $o['is_paymytuition'] = $this->is_paymytuition;
        if (isset($this->payment_id)) $o['payment_id'] = $this->payment_id;
        return empty($o) ? new class(){} : $o;
    }
}

PHP 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
}