Transaction

Inheritance diagram for Transaction:

Description

A transaction.

See also

https://help.shopify.com/en/api/reference/orders/transaction

Public Properties
const	DIR = 'transactions'
const	KIND_AUTH = 'authorization'
const	KIND_CAPTURE = 'capture'
const	KIND_REFUND = 'refund'
const	KIND_SALE = 'sale'
const	KIND_VOID = 'void'
const	MAP
const	TYPE = 'transaction'
Public Properties inherited from AbstractEntity
const	DIR = ''
	All subclasses must redeclare this to match their REST directory (without container). More...
const	TYPE = ''
	All subclasses must redeclare this to match their types. More...
Public Properties inherited from Data
const	MAP = []
const	PATCH = []

Public Methods
magic string	getAmount ()
magic string	getAuthorization ()
magic string	getCreatedAt ()
magic string	getCurrency ()
magic string	getDeviceId ()
magic string	getErrorCode ()
magic string	getGateway ()
magic string	getKind ()
magic string	getLocationId ()
magic string	getMessage ()
	getOrder ()
magic string	getOrderId ()
	injected More...
magic string	getParentId ()
magic null Payment	getPaymentDetails ()
magic string	getProcessedAt ()
magic array	getReceipt ()
magic string	getSourceName ()
magic string	getStatus ()
magic string	getUserId ()
magic bool	isTest ()
magic $this	setAmount (string $amount)
	@when new More...
magic $this	setAuthorization (string $auth)
	@when new More...
magic $this	setCurrency (string $iso4217)
	@when new More...
magic $this	setKind (string $kind)
	@when new More...
magic $this	setParentId (string $id)
	@when new More...
magic $this	setProcessedAt (string $iso8601)
	@when new More...
magic $this	setTest (bool $test)
	@when new More...
magic $this	setUserId (string $id)
	@when new More...
Public Methods inherited from AbstractEntity
string	__toString ()
null string	getId ()
string[]	getPoolKeys ()
bool	hasId ()
$this	reload ()
	Fully reloads the entity from Shopify. More...
Public Methods inherited from Data
mixed	__call (string $method, array $args)
	__construct ($caller, array $data=[])
string	serialize ()
	Dehydrated JSON encode. More...
array	toArray ()
void	unserialize ($serialized)
Public Methods inherited from CreateTrait
$this	create ()

Protected Methods
	_container ()
	The container/owner object, if any. More...
Protected Methods inherited from AbstractEntity
mixed	_get (string $field)
	Lazy-loads missing fields. More...
void	_onDelete ()
void	_onSave ()
void	_reload (string $field)
Protected Methods inherited from Data
mixed	_hydrate (string $class, $item)
	A factory that also hydrates / caches entities. More...
array	_select ($subject, callable $filter,... $args)
	Magic method: selectField(callable $filter) More...
$this	_setData (array $data)
	Clears all diffs and sets all data, hydrating mapped fields. More...
$this	_setField (string $field, $value)
	Sets a value, hydrating if mapped, and clears the diff. More...
Protected Methods inherited from CreateTrait
string	_dir ()
	The POST directory. More...

Additional Inherited Members
Protected Properties inherited from Data
Api	$api
Pool	$pool
Public Static Methods inherited from AbstractEntity
static null self	load ($caller, string $id, array $query=[])
static self[]	loadAll ($caller, string $path, array $query=[])

Properties

MAP

const MAP

Initial value:

= [
        'payment_details' => Payment::class
    ]

Methods

_container()

_container ( )

protected

The container/owner object, if any.

Returns

null|AbstractEntity

Reimplemented from AbstractEntity.

getAmount()

magic string getAmount

(

)

Returns

string

getAuthorization()

magic string getAuthorization

(

)

Returns

string

getCreatedAt()

magic string getCreatedAt

(

)

Returns

string

getCurrency()

magic string getCurrency

(

)

Returns

string

getDeviceId()

magic string getDeviceId

(

)

Returns

string

getErrorCode()

magic string getErrorCode

(

)

Returns

string

getGateway()

magic string getGateway

(

)

Returns

string

getKind()

magic string getKind

(

)

Returns

string

getLocationId()

magic string getLocationId

(

)

Returns

string

getMessage()

magic string getMessage

(

)

Returns

string

getOrderId()

magic string getOrderId

(

)

injected

Returns

string

getParentId()

magic string getParentId

(

)

Returns

string

getPaymentDetails()

magic null Payment getPaymentDetails

(

)

Returns

null|Payment

getProcessedAt()

magic string getProcessedAt

(

)

Returns

string

getReceipt()

magic array getReceipt

(

)

Returns

array

getSourceName()

magic string getSourceName

(

)

Returns

string

getStatus()

magic string getStatus

(

)

Returns

string

getUserId()

magic string getUserId

(

)

Returns

string

isTest()

magic bool isTest

(

)

Returns

bool

setAmount()

magic $this setAmount

(

string

$amount

)

@when new

Returns

$this

setAuthorization()

magic $this setAuthorization

(

string

$auth

)

@when new

Returns

$this

setCurrency()

magic $this setCurrency

(

string

$iso4217

)

@when new

Returns

$this

setKind()

magic $this setKind

(

string

$kind

)

@when new

Returns

$this

setParentId()

magic $this setParentId

(

string

$id

)

@when new

Returns

$this

setProcessedAt()

magic $this setProcessedAt

(

string

$iso8601

)

@when new

Returns

$this

setTest()

magic $this setTest

(

bool

$test

)

@when new

Returns

$this

setUserId()

magic $this setUserId

(

string

$id

)

@when new

Returns

$this