class Recipient extends EntityBase (View source)

Recipient entity

Properties

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

The status

string $DisplayName

A unique external identifier for the recipient's bank account.

string $PayoutMethodType

Defines the payout method (e.g., LocalBankTransfer, InternationalBankTransfer).

string $RecipientType

Specifies whether the recipient is an Individual or a Business.

string $Currency

3-letter ISO 4217 destination currency code (e.g. EUR, USD, GBP, AUD, CAD,HKD, SGD, MXN).

string $RecipientScope

The scope of the recipient:

string $UserId

The unique identifier of the user.

IndividualRecipient $IndividualRecipient

Individual recipient

BusinessRecipient $BusinessRecipient

Business recipient

array<string,mixed> $LocalBankTransfer

Each currency has specific bank details that must be provided based on the recipient's location and payout requirements.

array<string,mixed> $InternationalBankTransfer

The account details if PayoutMethodType is InternationalBankTransfer.

PendingUserAction $PendingUserAction

Information about the action required from the user

Methods

array
GetSubObjects()

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

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

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