digitaluapi

<back to all web services

PayFastRequestCheckoutSession2

The following routes are available for this service:
All Verbs/payfast-checkout-session-2
<?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 PayFastCheckoutSessionResponse implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Url=null
    ) {
    }

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

class PayFastRequestCheckoutSession2 implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $SuccessUrl=null,
        /** @var string|null */
        public ?string $CancelUrl=null,
        /** @var string|null */
        public ?string $Description=null,
        /** @var string|null */
        public ?string $Email=null,
        /** @var string */
        public string $CommsGuid='',
        /** @var int */
        public int $CampaignActionsRequestsId=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['SuccessUrl'])) $this->SuccessUrl = $o['SuccessUrl'];
        if (isset($o['CancelUrl'])) $this->CancelUrl = $o['CancelUrl'];
        if (isset($o['Description'])) $this->Description = $o['Description'];
        if (isset($o['Email'])) $this->Email = $o['Email'];
        if (isset($o['CommsGuid'])) $this->CommsGuid = $o['CommsGuid'];
        if (isset($o['CampaignActionsRequestsId'])) $this->CampaignActionsRequestsId = $o['CampaignActionsRequestsId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->SuccessUrl)) $o['SuccessUrl'] = $this->SuccessUrl;
        if (isset($this->CancelUrl)) $o['CancelUrl'] = $this->CancelUrl;
        if (isset($this->Description)) $o['Description'] = $this->Description;
        if (isset($this->Email)) $o['Email'] = $this->Email;
        if (isset($this->CommsGuid)) $o['CommsGuid'] = $this->CommsGuid;
        if (isset($this->CampaignActionsRequestsId)) $o['CampaignActionsRequestsId'] = $this->CampaignActionsRequestsId;
        return empty($o) ? new class(){} : $o;
    }
}

PHP PayFastRequestCheckoutSession2 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 /payfast-checkout-session-2 HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	SuccessUrl: String,
	CancelUrl: String,
	Description: String,
	Email: String,
	CommsGuid: 00000000000000000000000000000000,
	CampaignActionsRequestsId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Url: String
}