Composable Commerce PHP SDKPHP SDK
  • Namespace
  • Class
  • Tree

Namespaces

  • Commercetools
    • Commons
      • Helper
    • Core
      • Builder
        • Request
        • Update
      • Cache
      • Client
        • Adapter
        • OAuth
      • Error
      • Helper
        • Annotate
        • State
          • Renderer
        • Subscriber
          • Log
      • Model
        • ApiClient
        • Cart
        • CartDiscount
        • Category
        • Channel
        • Common
        • Customer
        • CustomerGroup
        • CustomField
        • CustomObject
        • DiscountCode
        • Extension
        • Inventory
        • Message
        • Order
        • OrderEdit
        • Payment
        • Product
          • Search
        • ProductDiscount
        • ProductSelection
        • ProductType
        • Project
        • Review
        • ShippingMethod
        • ShoppingList
        • State
        • Store
        • Subscription
        • TaxCategory
        • Type
        • Zone
      • Request
        • ApiClients
        • CartDiscounts
          • Command
        • Carts
          • Command
        • Categories
          • Command
        • Channels
          • Command
        • CustomerGroups
          • Command
        • Customers
          • Command
        • CustomField
          • Command
        • CustomObjects
        • DiscountCodes
          • Command
        • Extensions
          • Command
        • GraphQL
        • InStores
        • Inventory
          • Command
        • Me
          • Command
        • Messages
        • OrderEdits
          • Command
          • StagedOrder
            • Command
        • Orders
          • Command
        • Payments
          • Command
        • ProductDiscounts
          • Command
        • Products
          • Command
        • ProductSelections
          • Command
        • ProductTypes
          • Command
        • Project
          • Command
        • Query
        • Reviews
          • Command
        • ShippingMethods
          • Command
        • ShoppingLists
          • Command
        • States
          • Command
        • Stores
          • Command
        • Subscriptions
          • Command
        • TaxCategories
          • Command
        • Types
          • Command
        • Zones
          • Command
      • Response

Classes

  • Payment
  • PaymentCollection
  • PaymentDraft
  • PaymentInfo
  • PaymentMethodInfo
  • PaymentReference
  • PaymentReferenceCollection
  • PaymentStatus
  • Transaction
  • TransactionCollection
  • TransactionState
  • TransactionType

Class PaymentDraft

Commercetools\Core\Model\Common\AbstractJsonDeserializeObject implements Commercetools\Core\Model\Common\JsonDeserializeInterface, Commercetools\Core\Model\Common\ObjectTreeInterface uses Commercetools\Core\Model\Common\ObjectTreeTrait
Extended by Commercetools\Core\Model\Common\JsonObject implements JsonSerializable uses Commercetools\Core\Model\Common\ContextTrait
Extended by Commercetools\Core\Model\Payment\PaymentDraft
Namespace: Commercetools\Core\Model\Payment
API documentation: https://docs.commercetools.com/http-api-projects-payments.html#paymentdraft
Located at Core/Model/Payment/PaymentDraft.php

Methods summary

public string
# getExternalId( )

Deprecated

Returns

string
public Commercetools\Core\Model\Payment\PaymentDraft
# setExternalId( string $externalId = null )

Deprecated

use setKey() instead

Parameters

$externalId

Returns

Commercetools\Core\Model\Payment\PaymentDraft
public Commercetools\Core\Model\Common\Money
# getAmountAuthorized( )

Deprecated

Returns

Commercetools\Core\Model\Common\Money
public Commercetools\Core\Model\Payment\PaymentDraft
# setAmountAuthorized( Commercetools\Core\Model\Common\Money $amountAuthorized = null )

Deprecated

Parameters

$amountAuthorized

Returns

Commercetools\Core\Model\Payment\PaymentDraft
public Commercetools\Core\Model\Common\Money
# getAmountPaid( )

Deprecated

Returns

Commercetools\Core\Model\Common\Money
public Commercetools\Core\Model\Payment\PaymentDraft
# setAmountPaid( Commercetools\Core\Model\Common\Money $amountPaid = null )

Deprecated

Parameters

$amountPaid

Returns

Commercetools\Core\Model\Payment\PaymentDraft
public Commercetools\Core\Model\Common\Money
# getAmountRefunded( )

Deprecated

Returns

Commercetools\Core\Model\Common\Money
public Commercetools\Core\Model\Payment\PaymentDraft
# setAmountRefunded( Commercetools\Core\Model\Common\Money $amountRefunded = null )

Deprecated

Parameters

$amountRefunded

Returns

Commercetools\Core\Model\Payment\PaymentDraft
public Commercetools\Core\Model\Common\Money
# getAuthorizedUntil( )

Deprecated

Returns

Commercetools\Core\Model\Common\Money
public Commercetools\Core\Model\Payment\PaymentDraft
# setAuthorizedUntil( Commercetools\Core\Model\Common\Money $amountUntil = null )

Deprecated

Parameters

$amountUntil

Returns

Commercetools\Core\Model\Payment\PaymentDraft
public static Commercetools\Core\Model\Payment\PaymentDraft
# ofAmountPlanned( Commercetools\Core\Model\Common\Money $amountPlanned, Commercetools\Core\Model\Common\Context|callable $context = null )

Parameters

$amountPlanned
$context

Returns

Commercetools\Core\Model\Payment\PaymentDraft
public static Commercetools\Core\Model\Payment\PaymentDraft
# ofKeyExternalIdAndAmountPlanned( string $key, string $externalId, Commercetools\Core\Model\Common\Money $amountPlanned, Commercetools\Core\Model\Common\Context|callable $context = null )

Parameters

$key
$externalId
$amountPlanned
$context

Returns

Commercetools\Core\Model\Payment\PaymentDraft
public static Commercetools\Core\Model\Payment\PaymentDraft
# ofKeyExternalIdAmountPlannedAndPaymentMethodInfo( string $key, string $externalId, Commercetools\Core\Model\Common\Money $amountPlanned, Commercetools\Core\Model\Payment\PaymentMethodInfo $paymentMethodInfo, Commercetools\Core\Model\Common\Context|callable $context = null )

Parameters

$key
$externalId
$amountPlanned
$paymentMethodInfo
$context

Returns

Commercetools\Core\Model\Payment\PaymentDraft

Methods inherited from Commercetools\Core\Model\Common\JsonObject

__construct(), __get(), hasField(), isOptional()

Methods inherited from Commercetools\Core\Model\Common\AbstractJsonDeserializeObject

__sleep(), fromArray(), jsonSerialize(), of(), toArray()

Methods inherited from Commercetools\Core\Model\Common\ContextAwareInterface

getContext(), getContextCallback(), setContext(), setContextIfNull()

Methods inherited from Commercetools\Core\Model\Common\ObjectTreeInterface

parentSet(), rootGet(), rootSet()

Methods used from Commercetools\Core\Model\Common\ContextTrait

getContext(), getContextCallback(), setContext(), setContextIfNull()

Methods used from Commercetools\Core\Model\Common\ObjectTreeTrait

parentSet(), rootGet(), rootSet()

Magic methods summary

public Commercetools\Core\Model\Customer\CustomerReference
# getCustomer( )

Returns

Commercetools\Core\Model\Customer\CustomerReference
public Commercetools\Core\Model\Payment\PaymentDraft
# setCustomer( Commercetools\Core\Model\Customer\CustomerReference $customer = null )

Parameters

$customer

Returns

Commercetools\Core\Model\Payment\PaymentDraft
public string
# getInterfaceId( )

Returns

string
public Commercetools\Core\Model\Payment\PaymentDraft
# setInterfaceId( string $interfaceId = null )

Parameters

$interfaceId

Returns

Commercetools\Core\Model\Payment\PaymentDraft
public Commercetools\Core\Model\Common\Money
# getAmountPlanned( )

Returns

Commercetools\Core\Model\Common\Money
public Commercetools\Core\Model\Payment\PaymentDraft
# setAmountPlanned( Commercetools\Core\Model\Common\Money $amountPlanned = null )

Parameters

$amountPlanned

Returns

Commercetools\Core\Model\Payment\PaymentDraft
public Commercetools\Core\Model\Payment\PaymentMethodInfo
# getPaymentMethodInfo( )

Returns

Commercetools\Core\Model\Payment\PaymentMethodInfo
public Commercetools\Core\Model\Payment\PaymentDraft
# setPaymentMethodInfo( Commercetools\Core\Model\Payment\PaymentMethodInfo $paymentMethodInfo = null )

Parameters

$paymentMethodInfo

Returns

Commercetools\Core\Model\Payment\PaymentDraft
public Commercetools\Core\Model\CustomField\CustomFieldObjectDraft
# getCustom( )

Returns

Commercetools\Core\Model\CustomField\CustomFieldObjectDraft
public Commercetools\Core\Model\Payment\PaymentDraft
# setCustom( Commercetools\Core\Model\CustomField\CustomFieldObjectDraft $custom = null )

Parameters

$custom

Returns

Commercetools\Core\Model\Payment\PaymentDraft
public Commercetools\Core\Model\Payment\PaymentStatus
# getPaymentStatus( )

Returns

Commercetools\Core\Model\Payment\PaymentStatus
public Commercetools\Core\Model\Payment\PaymentDraft
# setPaymentStatus( Commercetools\Core\Model\Payment\PaymentStatus $paymentStatus = null )

Parameters

$paymentStatus

Returns

Commercetools\Core\Model\Payment\PaymentDraft
public Commercetools\Core\Model\Payment\TransactionCollection
# getTransactions( )

Returns

Commercetools\Core\Model\Payment\TransactionCollection
public Commercetools\Core\Model\Payment\PaymentDraft
# setTransactions( Commercetools\Core\Model\Payment\TransactionCollection $transactions = null )

Parameters

$transactions

Returns

Commercetools\Core\Model\Payment\PaymentDraft
public Commercetools\Core\Model\CustomField\CustomFieldObjectDraftCollection
# getInterfaceInteractions( )

Returns

Commercetools\Core\Model\CustomField\CustomFieldObjectDraftCollection
public Commercetools\Core\Model\Payment\PaymentDraft
# setInterfaceInteractions( Commercetools\Core\Model\CustomField\CustomFieldObjectDraftCollection $interfaceInteractions = null )

Parameters

$interfaceInteractions

Returns

Commercetools\Core\Model\Payment\PaymentDraft
public string
# getKey( )

Returns

string
public Commercetools\Core\Model\Payment\PaymentDraft
# setKey( string $key = null )

Parameters

$key

Returns

Commercetools\Core\Model\Payment\PaymentDraft
public string
# getAnonymousId( )

Returns

string
public Commercetools\Core\Model\Payment\PaymentDraft
# setAnonymousId( string $anonymousId = null )

Parameters

$anonymousId

Returns

Commercetools\Core\Model\Payment\PaymentDraft

Constants summary

Constants inherited from Commercetools\Core\Model\Common\JsonObject

DECORATOR, ELEMENT_TYPE, INITIALIZED, OPTIONAL, TYPE

Constants inherited from Commercetools\Core\Model\Common\AbstractJsonDeserializeObject

JSON_DESERIALIZE_INTERFACE, TYPEABLE_INTERFACE

PHP SDK API documentation generated by ApiGen