class Mandate extends EntityBase (View source)

Direct debit mandate entity.

Properties

string $Id from  EntityBase
string $Tag from  EntityBase
int $CreationDate from  EntityBase
string $BankAccountId

The bank account ID to associate this mandate against

string $Scheme

The type of mandate – it will be « SEPA » or « BACS » but will only be completed once the mandate has been submitted

string $Culture

The language to use for the confirmation web page presented to your user

string $DocumentURL

The URL to view/download the mandate document

string $RedirectURL

Redirect URL

string $ReturnURL

Return URL

string $UserId

ID of the user to which this mandate belongs

string $Status

Status of the mandate

string $ResultCode

The mandate result code

string $ResultMessage

The mandate result Message

string $MandateType

The type of mandate: DIRECT_DEBIT

string $ExecutionType

How the mandate has been created: WEB

string $BankReference

The bank reference

Methods

array
GetSubObjects()

Get array with mapping which property is object and what type of object.

from  Dto
array
GetDependsObjects()

Get array with mapping which property depends on other property To be overridden in child class if has any dependent objects.

from  Dto
array
GetReadOnlyProperties()

Get array with read-only properties

__construct(string $id = null)

Construct

Details

array GetSubObjects()

Get array with mapping which property is object and what type of object.

To be overridden in child class if has any sub objects.

Return Value

array

array GetDependsObjects()

Get array with mapping which property depends on other property To be overridden in child class if has any dependent objects.

Return Value

array

array GetReadOnlyProperties()

Get array with read-only properties

Return Value

array

__construct(string $id = null)

Construct

Parameters

string $id

Entity identifier