Wt: Wt::Payment::PayPalService Class Reference

Wt 3.3.0

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes

- Class List
- Class Hierarchy
- Class Members

Public Member Functions
Wt::Payment::PayPalService Class Reference
Payment module (Wt::Payment)

This is a PayPal service class. More...

`#include <Wt/Payment/PayPal>`

List of all members.

## Public Member Functions
| PayPalService ()
| Default constructor.
bool | configureFromProperties ()
| Configures the service using properties.
void | configureTestSandbox ()
| Configures the service for the PayPal test sandbox.
void | setUser (const std::string &user)
| Sets the user.
std::string | user () const
| Returns the user.
void | setPassword (const std::string &password)
| Sets the password.
std::string | password () const
| Returns the password.
void | setSignature (const std::string &signature)
| Sets the signature.
std::string | signature () const
| Returns the signature.
void | setVersion (const std::string &version)
| Sets the version.
std::string | version () const
| Returns version.
void | setApiServerUrl (const std::string &url)
| Sets the PayPal API server url.
std::string | apiServerUrl () const
| Returns PayPal API server url.
void | setPayServerUrl (const std::string &url)
| Sets the payment server url.
std::string | payServerUrl () const
| Returns the payment server url.
PayPalExpressCheckout * | createExpressCheckout (const Customer &customer, const Order &order)
| Starts a PayPal checkout process.

## Detailed Description

This is a PayPal service class.

This class holds the PayPal configuration, and is usually shared between sessions.

## Constructor & Destructor Documentation

Wt::Payment::PayPalService::PayPalService | ( |  | ) |

Default constructor.

You can call configureFromProperties() to configure the service from properties in the configuration, or configureTestSandbox() to configure the PayPal sanbox (for testing).

Alternatively, you could set a suitable configuration using the individual methods.

## Member Function Documentation

std::string Wt::Payment::PayPalService::apiServerUrl | ( |  | ) | const

Returns PayPal API server url.

See also:
  setApiServerUrl()

bool Wt::Payment::PayPalService::configureFromProperties | ( |  | ) |

Configures the service using properties.

Returns `true` if values were found for all required properties:

- paypal-user
- paypal-password
- paypal-signature
- paypal-api-server-url
- paypal-pay-server-url
- paypal-version

Note:
  the PayPalExpressCheckout process assumes version 92.0

PayPalExpressCheckout * Wt::Payment::PayPalService::createExpressCheckout | ( | const Customer & | customer,
|  | const Order & | order
| ) |  |

Starts a PayPal checkout process.

Every distinct PayPal checkout process is managed by a PayPalExpressCheckout instance, which tracks the state and progress of the payment.

std::string Wt::Payment::PayPalService::password | ( |  | ) | const

Returns the password.

See also:
  setPassword()

std::string Wt::Payment::PayPalService::payServerUrl | ( |  | ) | const

Returns the payment server url.

See also:
  setPayServerUrl()

void Wt::Payment::PayPalService::setApiServerUrl | ( | const std::string & | url | ) |

Sets the PayPal API server url.

This is the server that is communicated with using the PayPal API.

void Wt::Payment::PayPalService::setPayServerUrl | ( | const std::string & | url | ) |

Sets the payment server url.

This is the server to which the user is redirected for the payment.

void Wt::Payment::PayPalService::setVersion | ( | const std::string & | version | ) |

Sets the version.

The Paypal version that is used.

Note:
  the PayPalExpressCheckout process assumes version 92.0

std::string Wt::Payment::PayPalService::signature | ( |  | ) | const

Returns the signature.

See also:
  setSignature()

std::string Wt::Payment::PayPalService::user | ( |  | ) | const

Returns the user.

See also:
  setUser()

std::string Wt::Payment::PayPalService::version | ( |  | ) | const

Returns version.

See also:
  setVersion()

All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator