class Settlement extends EntityBase (View source)

Properties

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

The unique identifier of the settlement object

string $Status

The status of the settlement

int $SettlementDate

The date at which the settlement was created by the external provider

string $ExternalProviderName

The name of the external provider

int $DeclaredIntentAmount

The total amount declared through intent API calls with the following calculation: (Sum of captured intents) - (Sum of refunds amounts) + (Sum of refund reversed amounts) - (Sum of DISPUTED disputes) + (Sum of WON disputes)

int $ExternalProcessorFeesAmount

The total fees charged by the external provider

int $ActualSettlementAmount

The total amount due to the platform (to be held in escrow wallet).

int $FundsMissingAmount

The difference between ActualSettlementAmount and the amount received on the escrow wallet

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