Class PayoutStatusDTO

description: A DTO class that consists of a status property only and can be used to determine the state of individual payouts, i.e. to determine whether a payout was executed before.
since: v0.4.0

Hierarchy

BaseDTO
- PayoutStatusDTO

Index

Constructors

constructor

Properties

status

Methods

create

Constructors

constructor

new PayoutStatusDTO(data?: any): PayoutStatusDTO

Inherited from BaseDTO.constructor
- Defined in src/common/models/BaseDTO.ts:28
Constructs an instance of this DTO.

Parameters
- data: any = {}
Returns PayoutStatusDTO

Properties

status

status: PayoutState

Contains the status of executing a payout. This property may contain one of the following values as listed in PayoutState.

example: 1 or 0 or -1
access: public
var: {number}

Methods

Static create

create(code: number): PayoutStatusDTO

- Defined in src/payout/models/PayoutStatusDTO.ts:65
Creates an object instance of this DTO.

access
public

static
Parameters
- code: number
  
  The status code as defined by PayoutState
Returns PayoutStatusDTO
The created instance of this class, with provided code.

Generated using TypeDoc