Inheritance diagram for Commercetools\Api\Models\Payment\PaymentDraft:

Public Member Functions
	getCustomer ()

	getAnonymousId ()

	getInterfaceId ()

	getAmountPlanned ()

	getPaymentMethodInfo ()

	getPaymentStatus ()

	getTransactions ()

	getInterfaceInteractions ()

	getCustom ()

	getKey ()

	setCustomer (?CustomerResourceIdentifier $customer)

	setAnonymousId (?string $anonymousId)

	setInterfaceId (?string $interfaceId)

	setAmountPlanned (?Money $amountPlanned)

	setPaymentMethodInfo (?PaymentMethodInfo $paymentMethodInfo)

	setPaymentStatus (?PaymentStatusDraft $paymentStatus)

	setTransactions (?TransactionDraftCollection $transactions)

	setInterfaceInteractions (?CustomFieldsDraftCollection $interfaceInteractions)

	setCustom (?CustomFieldsDraft $custom)

	setKey (?string $key)

Public Member Functions inherited from Commercetools\Base\JsonObject
	get (string $field)

	with (callable $callable=null)

Public Attributes
const	FIELD_CUSTOMER = 'customer'

const	FIELD_ANONYMOUS_ID = 'anonymousId'

const	FIELD_INTERFACE_ID = 'interfaceId'

const	FIELD_AMOUNT_PLANNED = 'amountPlanned'

const	FIELD_PAYMENT_METHOD_INFO = 'paymentMethodInfo'

const	FIELD_PAYMENT_STATUS = 'paymentStatus'

const	FIELD_TRANSACTIONS = 'transactions'

const	FIELD_INTERFACE_INTERACTIONS = 'interfaceInteractions'

const	FIELD_CUSTOM = 'custom'

const	FIELD_KEY = 'key'

Additional Inherited Members
Static Public Member Functions inherited from Commercetools\Base\JsonObject
static	of ($data=null)

static	fromArray (array $data=[])

static	fromStdClass (stdClass $data=null)

Detailed Description

Definition at line 18 of file PaymentDraft.php.

Member Function Documentation

◆ getAmountPlanned()

Commercetools\Api\Models\Payment\PaymentDraft::getAmountPlanned ( )

Money value the Payment intends to receive from the customer. The value typically matches the Cart or Order gross total.

Returns: null|Money

Implemented in Commercetools\Api\Models\Payment\PaymentDraftModel.

◆ getAnonymousId()

Commercetools\Api\Models\Payment\PaymentDraft::getAnonymousId ( )

Anonymous session associated with the Payment.

Returns: null|string

Implemented in Commercetools\Api\Models\Payment\PaymentDraftModel.

◆ getCustom()

Commercetools\Api\Models\Payment\PaymentDraft::getCustom ( )

Custom Fields for the Payment.

Returns: null|CustomFieldsDraft

Implemented in Commercetools\Api\Models\Payment\PaymentDraftModel.

◆ getCustomer()

Commercetools\Api\Models\Payment\PaymentDraft::getCustomer ( )

Reference to a Customer associated with the Payment.

Returns: null|CustomerResourceIdentifier

Implemented in Commercetools\Api\Models\Payment\PaymentDraftModel.

◆ getInterfaceId()

Commercetools\Api\Models\Payment\PaymentDraft::getInterfaceId ( )

Identifier used by the payment service that processes the Payment (for example, a PSP). The combination of interfaceId and the paymentInterface field on PaymentMethodInfo must be unique. Once set, it cannot be changed.

Returns: null|string

Implemented in Commercetools\Api\Models\Payment\PaymentDraftModel.

◆ getInterfaceInteractions()

Commercetools\Api\Models\Payment\PaymentDraft::getInterfaceInteractions ( )

Represents information exchange with the payment service, for example, a PSP. An interaction may be a request sent, or a response or notification received from the payment service.

Returns: null|CustomFieldsDraftCollection

Implemented in Commercetools\Api\Models\Payment\PaymentDraftModel.

◆ getKey()

Commercetools\Api\Models\Payment\PaymentDraft::getKey ( )

User-defined unique identifier for the Payment.

Returns: null|string

Implemented in Commercetools\Api\Models\Payment\PaymentDraftModel.

◆ getPaymentMethodInfo()

Commercetools\Api\Models\Payment\PaymentDraft::getPaymentMethodInfo ( )

Information regarding the payment interface (for example, a PSP), and the specific payment method used.

Returns: null|PaymentMethodInfo

Implemented in Commercetools\Api\Models\Payment\PaymentDraftModel.

◆ getPaymentStatus()

Commercetools\Api\Models\Payment\PaymentDraft::getPaymentStatus ( )

Current status of the Payment.

Returns: null|PaymentStatusDraft

Implemented in Commercetools\Api\Models\Payment\PaymentDraftModel.

◆ getTransactions()

Commercetools\Api\Models\Payment\PaymentDraft::getTransactions ( )

Financial transactions of the Payment. Each Transaction has a TransactionType and a TransactionState.

Returns: null|TransactionDraftCollection

Implemented in Commercetools\Api\Models\Payment\PaymentDraftModel.

◆ setAmountPlanned()

Commercetools\Api\Models\Payment\PaymentDraft::setAmountPlanned ( ?Money $amountPlanned )

Parameters

?Money $amountPlanned

Implemented in Commercetools\Api\Models\Payment\PaymentDraftModel.

◆ setAnonymousId()

Commercetools\Api\Models\Payment\PaymentDraft::setAnonymousId ( ?string $anonymousId )

Parameters

?string $anonymousId

Implemented in Commercetools\Api\Models\Payment\PaymentDraftModel.

◆ setCustom()

Commercetools\Api\Models\Payment\PaymentDraft::setCustom ( ?CustomFieldsDraft $custom )

Parameters

?CustomFieldsDraft $custom

Implemented in Commercetools\Api\Models\Payment\PaymentDraftModel.

◆ setCustomer()

Commercetools\Api\Models\Payment\PaymentDraft::setCustomer ( ?CustomerResourceIdentifier $customer )

Parameters

?CustomerResourceIdentifier $customer

Implemented in Commercetools\Api\Models\Payment\PaymentDraftModel.

◆ setInterfaceId()

Commercetools\Api\Models\Payment\PaymentDraft::setInterfaceId ( ?string $interfaceId )

Parameters

?string $interfaceId

Implemented in Commercetools\Api\Models\Payment\PaymentDraftModel.

◆ setInterfaceInteractions()

Commercetools\Api\Models\Payment\PaymentDraft::setInterfaceInteractions ( ?CustomFieldsDraftCollection $interfaceInteractions )

Parameters

?CustomFieldsDraftCollection $interfaceInteractions

Implemented in Commercetools\Api\Models\Payment\PaymentDraftModel.

◆ setKey()

Commercetools\Api\Models\Payment\PaymentDraft::setKey ( ?string $key )

Parameters

?string $key

Implemented in Commercetools\Api\Models\Payment\PaymentDraftModel.

◆ setPaymentMethodInfo()

Commercetools\Api\Models\Payment\PaymentDraft::setPaymentMethodInfo ( ?PaymentMethodInfo $paymentMethodInfo )

Parameters

?PaymentMethodInfo $paymentMethodInfo

Implemented in Commercetools\Api\Models\Payment\PaymentDraftModel.

◆ setPaymentStatus()

Commercetools\Api\Models\Payment\PaymentDraft::setPaymentStatus ( ?PaymentStatusDraft $paymentStatus )

Parameters

?PaymentStatusDraft $paymentStatus

Implemented in Commercetools\Api\Models\Payment\PaymentDraftModel.

◆ setTransactions()

Commercetools\Api\Models\Payment\PaymentDraft::setTransactions ( ?TransactionDraftCollection $transactions )

Parameters

?TransactionDraftCollection $transactions

Implemented in Commercetools\Api\Models\Payment\PaymentDraftModel.

Member Data Documentation

◆ FIELD_AMOUNT_PLANNED

const Commercetools\Api\Models\Payment\PaymentDraft::FIELD_AMOUNT_PLANNED = 'amountPlanned'

Definition at line 23 of file PaymentDraft.php.

◆ FIELD_ANONYMOUS_ID

const Commercetools\Api\Models\Payment\PaymentDraft::FIELD_ANONYMOUS_ID = 'anonymousId'

Definition at line 21 of file PaymentDraft.php.

◆ FIELD_CUSTOM

const Commercetools\Api\Models\Payment\PaymentDraft::FIELD_CUSTOM = 'custom'

Definition at line 28 of file PaymentDraft.php.

◆ FIELD_CUSTOMER

const Commercetools\Api\Models\Payment\PaymentDraft::FIELD_CUSTOMER = 'customer'

Definition at line 20 of file PaymentDraft.php.

◆ FIELD_INTERFACE_ID

const Commercetools\Api\Models\Payment\PaymentDraft::FIELD_INTERFACE_ID = 'interfaceId'

Definition at line 22 of file PaymentDraft.php.

◆ FIELD_INTERFACE_INTERACTIONS

const Commercetools\Api\Models\Payment\PaymentDraft::FIELD_INTERFACE_INTERACTIONS = 'interfaceInteractions'

Definition at line 27 of file PaymentDraft.php.

◆ FIELD_KEY

const Commercetools\Api\Models\Payment\PaymentDraft::FIELD_KEY = 'key'

Definition at line 29 of file PaymentDraft.php.

◆ FIELD_PAYMENT_METHOD_INFO

const Commercetools\Api\Models\Payment\PaymentDraft::FIELD_PAYMENT_METHOD_INFO = 'paymentMethodInfo'

Definition at line 24 of file PaymentDraft.php.

◆ FIELD_PAYMENT_STATUS

const Commercetools\Api\Models\Payment\PaymentDraft::FIELD_PAYMENT_STATUS = 'paymentStatus'

Definition at line 25 of file PaymentDraft.php.

◆ FIELD_TRANSACTIONS

const Commercetools\Api\Models\Payment\PaymentDraft::FIELD_TRANSACTIONS = 'transactions'

Definition at line 26 of file PaymentDraft.php.

The documentation for this interface was generated from the following file:

lib/commercetools-api/src/Models/Payment/PaymentDraft.php

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getAmountPlanned()

◆ getAnonymousId()

◆ getCustom()

◆ getCustomer()

◆ getInterfaceId()

◆ getInterfaceInteractions()

◆ getKey()

◆ getPaymentMethodInfo()

◆ getPaymentStatus()

◆ getTransactions()

◆ setAmountPlanned()

◆ setAnonymousId()

◆ setCustom()

◆ setCustomer()

◆ setInterfaceId()

◆ setInterfaceInteractions()

◆ setKey()

◆ setPaymentMethodInfo()

◆ setPaymentStatus()

◆ setTransactions()

Member Data Documentation

◆ FIELD_AMOUNT_PLANNED

◆ FIELD_ANONYMOUS_ID

◆ FIELD_CUSTOM

◆ FIELD_CUSTOMER

◆ FIELD_INTERFACE_ID

◆ FIELD_INTERFACE_INTERACTIONS

◆ FIELD_KEY

◆ FIELD_PAYMENT_METHOD_INFO

◆ FIELD_PAYMENT_STATUS

◆ FIELD_TRANSACTIONS