Class PaymentMethod

Nested Relationships

Nested Types

Inheritance Relationships

Base Type

Class Documentation

class PaymentMethod : public axr::sdk::EntityBase

Stores information needed to make a payment on behalf of a customer.

Public Functions

inline PaymentMethod()
inline PaymentMethod(const PaymentMethod &value)
inline PaymentMethod(PaymentMethod &&value)
inline virtual ~PaymentMethod()
inline virtual PaymentMethod &SetProperties(const std::map<utility::string_t, Variant> &value) override

Sets the object’s underlying map of stored values.

inline virtual PaymentMethod &SetProperties(std::map<utility::string_t, Variant> &&value) override

Sets the underlying map of stored values for the object.

inline virtual PaymentMethod &SetProperty(const utility::char_t *name, const Variant &value) override

Sets the property of the given name to the provided value.

inline virtual PaymentMethod &SetProperty(const utility::string_t &name, const Variant &value) override

Sets the property of the given name to the provided value.

inline virtual PaymentMethod &SetRemoteUrl(const utility::string_t &url) override

Returns the URL of the remote server endpoint where the object is managed.

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

Sets the value of the Uid property.

Parameters

value – The value to set.

inline virtual PaymentMethod &SetDateCreated(const datetime &value) override

Sets the value of the DateCreated property.

Parameters

value – The value to set.

inline virtual PaymentMethod &SetDateModified(const datetime &value) override

Sets the value of the DateModified property.

Parameters

value – The value to set.

inline virtual PaymentMethod &SetVersion(const uint64_t value) override

Sets the value of the Version property.

Parameters

value – The value to set.

virtual void Validate() override
std::shared_ptr<Object> GetData() const

Custom data to store about this payment.

PaymentMethod &SetData(std::shared_ptr<Object> value)

Custom data to store about this payment.

bool IsDefault() const

Indicates if this the default payment method for a given wallet.

PaymentMethod &SetDefault(bool value)

Indicates if this the default payment method for a given wallet.

const ProviderType *GetProvider() const

The payment provider type that the method uses.

PaymentMethod &SetProvider(const ProviderType *value)

The payment provider type that the method uses.

const Status *GetStatus() const

Indicates whether or not this payment method can be used for transactions.

utility::string_t GetWalletUid() const

The unique identifier of the wallet associated with this payment method.

PaymentMethod &SetWalletUid(const utility::string_t &value)

The unique identifier of the wallet associated with this payment method.

Public Static Functions

static inline const utility::char_t *ClassName()

Returns the fully qualified name of the class.

class Status : public axr::sdk::StringEnum<Status>

The current status of a payment method.

Public Static Attributes

static const Status *CREATED

Indicates that the payment method has been created.

static const Status *CANCELED

Indicates that the payment method was canceled by the customer.

static const Status *ACTION_NEEDED

Indicates that action is needed by the customer to proceed.

static const Status *READY

Indicates that the payment was successfully setup with the payment processor.

static const Status *ERROR

Indicates that an error occurred while processing the payment method.