Banner showing base of Eiffel tower

Github

Download version 1.4.8: Windows or Linux

Network Library: PayPal Payments Standard Button Manager API

Classes

ECF: paypal.ecf

Directory source listing

Overview

An Eiffel interface to the PayPal Payments Standard Button Manager NVP HTTP API.

Directory: library/network/paypal

. /button

. /connection

. /data

. /enums

. /enums/shared

. /enums/values

. /helper

. /methods

. /parameters

. /parameters/lists

. /test

button

PP_BUTTON_DETAIL

Details of Paypal button. Just to confuse matters, Paypal names these fields using lower_snake_case rather than UPPERCAMELCASE.

PP_BUTTON_DETAILS_QUERY_RESULTS

Pp button details query results

PP_BUTTON_LOCALE

Button locale parameters as for example: en_US, de_DE

PP_BUTTON_META_DATA

Pp button meta data

PP_BUTTON_OPTION

Pp button option

PP_BUTTON_QUERY_RESULTS

Results of a NVP button API query

PP_BUTTON_SEARCH_RESULTS

Pp button search results

PP_HOSTED_BUTTON

Hosted button ID

connection

PP_HTTP_CONNECTION

Pp http connection

PP_NVP_API_CONNECTION

Paypal NVP API connection accessible via {PP_SHARED_CONNECTION}.paypal

PP_SHARED_CONNECTION

Access to shared instance of PP_NVP_API_CONNECTION

data

PP_ADDRESS

Postal address

PP_ADDRESS_STATUS

address_status: Whether the customer provided a confirmed address. Value is:

confirmed - Customer provided a confirmed address.

unconfirmed - Customer provided an unconfirmed address.

See: Buyer information variables

PP_API_VERSION

Paypal API version

PP_CREDENTIALS

Reads name value pairs from file encrypted using the Eiffel-Loop el_toolkit -crypto command line utility.

See sub-application class: CRYPTO_APP

Example file:

# This is a comment

USER: finnian
SIGNATURE: A87F87C8789-AF89AA
PWD: dragon-legend1

PP_DATE_TIME

Object representing Paypal payment transaction time. It assumes the following format and is converted to UTC.

HH:MM:SS Mmm DD, YYYY PST

Used in {PP_TRANSACTION}.payment_date

Further Information

Click on class link to see notes.

PP_DATE_TIME_RANGE

Paypal date-time range

PP_PRODUCT_INFO

Product button information reflectively convertible to type PP_BUTTON_SUB_PARAMETER_LIST

PP_TRANSACTION

Reflectively settable Payment transaction information. See Payment information variables in IPN integration guide.

enums

PP_L_VARIABLE_ENUM

Enumeration of Paypal 'L' variables

PP_PAYMENT_PENDING_REASON_ENUM

Reasons for pending payment. See payment information variables in IPN integration guide.

PP_PAYMENT_STATUS_ENUM

Payment status codes. See Payment information variables in IPN integration guide.

PP_TRANSACTION_TYPE_ENUM

IPN transaction types for {PP_TRANSACTION}.txn_type

Further Information

Click on class link to see notes.

enums/shared

PP_SHARED_L_VARIABLE_ENUM

Shared instance of PP_L_VARIABLE_ENUM

PP_SHARED_PAYMENT_PENDING_REASON_ENUM

Pp shared payment pending reason enum

PP_SHARED_PAYMENT_STATUS_ENUM

Pp shared payment status enum

PP_SHARED_TRANSACTION_TYPE_ENUM

Pp shared transaction type enum

enums/values

PP_PAYMENT_PENDING_REASON

Pending reason code with values defined by enumeration PP_PAYMENT_PENDING_REASON_ENUM

PP_PAYMENT_STATUS

Payment status code with values defined by enumeration PP_PAYMENT_STATUS_ENUM

PP_TRANSACTION_TYPE

Transaction type code with values defined by enumeration PP_TRANSACTION_TYPE_ENUM

helper

PP_CONVERTABLE_TO_PARAMETER_LIST

Object that is reflectively convertable to a Paypal HTTP parameter list

PP_HTTP_RESPONSE

Deserialized response to Paypal HTTP method call

PP_L_VARIABLE

Indexed Paypal variable. Initializing with Paypal variable L_BUTTONTYPE0 for example, will set code to the enumeration value of L_BUTTONTYPE specified in class PP_L_VARIABLE_ENUM. index will be set to 0 + 1 since Eiffel generally uses 1 based indices.

PP_NAMING_ROUTINES

Eiffel to Paypal and Paypal to Eiffel field name conversion

PP_REFLECTIVELY_SETTABLE

Pp reflectively settable

PP_REFLECTIVELY_SETTABLE_LIST

List of objects conforming to PP_SETTABLE_FROM_UPPER_CAMEL_CASE

PP_SETTABLE_FROM_UPPER_CAMEL_CASE

Object that is reflectively settable from Paypal upper-camelCase variable names

methods

PP_BUTTON_METHOD

Parameters for a NVP API button method call

PP_BUTTON_SEARCH_METHOD

Pp button search method

PP_CREATE_BUTTON_METHOD

Pp create button method

PP_GET_BUTTON_DETAILS_METHOD

Pp get button details method

PP_MANAGE_BUTTON_STATUS_METHOD

Pp manage button status method

PP_UPDATE_BUTTON_METHOD

Pp update button method

parameters

PP_BUTTON_PARAMETER

Button parameter

PP_NUMBERED_VARIABLE_NAME_SEQUENCE

Numbered variable name sequence

PP_VARIABLE_NAME_SEQUENCE

Numbered variable name sequence

parameters/lists

PP_BUTTON_SUB_PARAMETER_LIST

List of button variables for requests BMCreateButton and BMUpdateButton

Createable from instance of PP_PRODUCT_INFO using make_from_object.

PP_BUY_OPTIONS

Pp buy options

PP_NUMBERED_VARIABLE_PARAMETER_LIST

Parameter list with numbered variable names as for example:

L_OPTION0PRICE1
L_OPTION0PRICE2

L_OPTION1PRICE1
L_OPTION1PRICE2

PP_OPTION_PRICE_PARAMETER_LIST

Buy-button create/update option. (Optional) The price associated with the n'th menu item.

L_OPTIONnPRICEx

It is a list of variables for each OPTIONnNAME, in which x is a digit between 0 and 9, inclusive

PP_OPTION_SELECT_SUB_PARAMETER_LIST

Buy-button create/update option. (Optional) The menu item's name.

L_OPTIONnSELECTx

It is a list of variables for each OPTIONnNAME, in which x is a digit between 0 and 9, inclusive

PP_SUB_PARAMETER_LIST

List of NVP API sub-parameters as for example:

L_BUTTONVAR0: currency_code=HUF
L_BUTTONVAR1: item_name=Single PC subscription pack
L_BUTTONVAR2: item_number=1.en.HUF

test

PP_TEST_COMMAND_SHELL

Command shell that can be used for testing purposes. Use the class EL_COMMAND_SHELL_SUB_APPLICATION in conjunction with this class to make a sub-application. The source page has some links to examples that demonstrates how it's done.

PP_TEST_SET

Pp test set

Further Information

Click on class link to see client examples.