Class Payment

Contents

Class Payment#

Defined in File Payment.h

Inheritance Relationships#

Base Type#

public xbe::sdk::EntityBase (Class EntityBase)

Class Documentation#

class Payment : public xbe::sdk::EntityBase #

Tracks the lifecycle of a payment for a given customer.

Public Functions

inline Payment()#

inline Payment(const Payment &value)#

inline Payment(Payment &&value)#

inline virtual ~Payment()#

inline virtual Payment &SetProperties(const std::map<utility::string_t, Variant> &value) override#: Sets the object’s underlying map of stored values.

inline virtual Payment &SetProperties(std::map<utility::string_t, Variant> &&value) override#: Sets the underlying map of stored values for the object.

inline virtual Payment &SetProperty(const utility::char_t *name, const Variant &value) override#: Sets the property of the given name to the provided value.

inline virtual Payment &SetProperty(const utility::string_t &name, const Variant &value) override#: Sets the property of the given name to the provided value.

inline virtual Payment &SetRemoteUrl(const utility::string_t &url) override#: Returns the URL of the remote server endpoint where the object is managed.

inline virtual Payment &SetUid(const utility::string_t &value) override#

Sets the value of the Uid property.

Parameters:: value – The value to set.

inline virtual Payment &SetDateCreated(const datetime &value) override#

Sets the value of the DateCreated property.

Parameters:: value – The value to set.

inline virtual Payment &SetDateModified(const datetime &value) override#

Sets the value of the DateModified property.

Parameters:: value – The value to set.

inline virtual Payment &SetVersion(const uint64_t value) override#

Sets the value of the Version property.

Parameters:: value – The value to set.

virtual void Validate() override#

float GetAmount() const#: The amount of the payment to be made.

Payment &SetAmount(float value)#: The amount of the payment to be made.

const Currency *GetCurrency() const#: The form of currency pertaining to the price.

Payment &SetCurrency(const Currency *value)#: The form of currency pertaining to the price.

utility::string_t GetConfirmation() const#: The digital confirmation code that was received from the payment processor.

std::shared_ptr<Object> GetData() const#: Custom data to store about this payment.

Payment &SetData(std::shared_ptr<Object> value)#: Custom data to store about this payment.

bool IsOffline() const#: Indicates that the payment will be made when the customer is offline.

Payment &SetOffline(bool value)#: Indicates that the payment will be made when the customer is offline.

utility::string_t GetOrderUid() const#: The optional unique identifier of the order that the payment is being made for.

Payment &SetOrderUid(const utility::string_t &value)#: The optional unique identifier of the order that the payment is being made for.

const ProviderType *GetProvider() const#: The backend provider that will process this payment.

Payment &SetProvider(const ProviderType *value)#: The backend provider that will process this payment.

const Status *GetStatus() const#: The current status of the payment.

utility::string_t GetWalletUid() const#: The unique identifier of the wallet that the payment was made with.

Payment &SetWalletUid(const utility::string_t &value)#: The unique identifier of the wallet that the payment was made with.

Public Static Functions

static inline const utility::char_t *ClassName()#: Returns the fully qualified name of the class.