freedompay_client

The API for Hosted Payment Controls. To access the swagger.json file open the following link: https://hpc.uat.freedompay.com/api/swagger/docs/v1.5

This Python package is automatically generated by the OpenAPI Generator project:

• API version: v1.5
• Package version: 1.5.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import freedompay_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import freedompay_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import time
import freedompay_client
from freedompay_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://hpc.uat.freedompay.com/api
# See configuration.py for a list of all supported configuration parameters.
configuration = freedompay_client.Configuration(
    host = "https://hpc.uat.freedompay.com/api"
)



# Enter a context with an instance of the API client
with freedompay_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freedompay_client.ControlsApi(api_client)
    request = freedompay_client.InitRequest() # InitRequest | Details about the payment request workflow and its controls.

    try:
        # Initializes a payment request workflow.
        api_response = api_instance.controls_init_v15(request)
        print("The response of ControlsApi->controls_init_v15:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ControlsApi->controls_init_v15: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://hpc.uat.freedompay.com/api

Class	Method	HTTP request	Description
ControlsApi	controls_init_v15	POST /v1.5/controls/init	Initializes a payment request workflow.
ControlsApi	controls_init_v15_0	POST /v1.5/controls/init/paypal	Initializes a PayPal payment request workflow.
ControlsApi	controls_init_v15_1	POST /v1.5/controls/init/paybybank	Initializes a PayByBank payment request workflow.
ControlsApi	init_apple_pay	POST /v1.5/controls/init/apple	Initializes an ApplePay payment request workflow.
ControlsApi	init_google_pay	POST /v1.5/controls/init/google	Initializes a Google Pay payment request workflow.
PaymentsApi	payments_acknowledge	POST /v1.5/payments/acknowledge
PaymentsApi	payments_post_v13	POST /v1.5/payments
PaymentsApi	payments_reverse	POST /v1.5/payments/reverse

Documentation For Models

• AcknowledgeRequest
• AdminService
• ApplePayInitRequest
• AutoRentalData
• BillTo
• ButtonControl
• CCAuthService
• CCCaptureService
• CCCreditService
• CCFollowupService
• Card
• CardNumberControl
• Check
• ClientMetadata
• ConsumerAuthentication
• DccInfo
• DccOptions
• DccService
• DiscountService
• EIDDetail
• EfvOptions
• EodService
• ExpirationDateControl
• FleetData
• FraudCheckOptions
• FraudCheckService
• GoogleBillingAddressRequest
• GooglePayInitRequest
• HealthcareDataWeb
• HotelData
• IncentiveIncentive
• IncentiveService
• InitRequest
• InquiryService
• InvoiceHeader
• InvoiceService
• Item
• KountOptions
• LegalControl
• LoyaltyService
• MemberData
• MerchantDefinedData
• MessageService
• MobileService
• NetworkCustomData
• NetworkData
• OfflineControl
• OrderDetails
• PayByBankInitRequest
• PayPalInitRequest
• Payment
• Pos
• PostalCodeControl
• PromoService
• PurchaseTotals
• RequestIncentives
• RequestMessage
• RestaurantData
• ReversalRequest
• SecurityCodeControl
• SessionService
• ShipFrom
• ShipTo
• TORService
• TaxDetailItem
• TenderType
• TokenCreateService
• TokenInformation
• UserDefinedField
• VendControlService
• VendProduct
• VendProductList
• VoidService

Documentation For Authorization

Endpoints do not require authorization.

Author