payrix-api-sdk 1.0.0

SDKs for Payrix API

Getting Started with Payrix

Install the Package

The package is compatible with Python versions 3.7+. Install the package from PyPi using the following pip command:

pip install payrix-api-sdk==1.0.0

You can also view the package at: https://pypi.python.org/pypi/payrix-api-sdk/1.0.0

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

Parameter	Type	Description
environment	Environment	The API environment. Default: Environment.SANDBOX
http_client_instance	Union[Session, HttpClientProvider]	The Http Client passed from the sdk user for making requests
override_http_client_configuration	bool	The value which determines to override properties of the passed Http Client from the sdk user
http_call_back	HttpCallBack	The callback value that is invoked before and after an HTTP call is made to an endpoint
timeout	float	The value to use for connection timeout. Default: 60
max_retries	int	The number of times to retry an endpoint call if it fails. Default: 0
backoff_factor	float	A backoff factor to apply between attempts after the second try. Default: 2
retry_statuses	Array of int	The http statuses on which retry is to be done. Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods	Array of string	The http methods on which retry is to be done. Default: ['GET', 'PUT']
proxy_settings	ProxySettings	Optional proxy configuration to route HTTP requests through a proxy server.
api_key_credentials	ApiKeyCredentials	The credential object for Custom Header Signature
session_key_credentials	SessionKeyCredentials	The credential object for Custom Header Signature
txn_session_key_credentials	TxnSessionKeyCredentials	The credential object for Custom Header Signature
username_credentials	UsernameCredentials	The credential object for Custom Header Signature
password_credentials	PasswordCredentials	The credential object for Custom Header Signature

The API client can be initialized as follows:

from payrix.configuration import Environment
from payrix.http.auth.api_key import ApiKeyCredentials
from payrix.http.auth.password import PasswordCredentials
from payrix.http.auth.session_key import SessionKeyCredentials
from payrix.http.auth.txn_session_key import TxnSessionKeyCredentials
from payrix.http.auth.username import UsernameCredentials
from payrix.payrix_client import PayrixClient

client = PayrixClient(
    api_key_credentials=ApiKeyCredentials(
        apikey='APIKEY'
    ),
    session_key_credentials=SessionKeyCredentials(
        sessionkey='SESSIONKEY'
    ),
    txn_session_key_credentials=TxnSessionKeyCredentials(
        txnsessionkey='TXNSESSIONKEY'
    ),
    username_credentials=UsernameCredentials(
        username='USERNAME'
    ),
    password_credentials=PasswordCredentials(
        password='PASSWORD'
    ),
    environment=Environment.SANDBOX
)

Environments

The SDK can be configured to use a different environment for making API calls. Available environments are:

Fields

Name	Description
sandbox	Default
canada sandbox	-

Authorization

This API uses the following authentication schemes.

• apiKey (Custom Header Signature)
• sessionKey (Custom Header Signature)
• txnSessionKey (Custom Header Signature)
• username (Custom Header Signature)
• password (Custom Header Signature)

List of APIs

• API Keys
• Apple Domains
• Apple Domains Mass Enablement
• Accounts Verifications
• Aggregation Result Groups
• Aggregation Results
• Alert Actions
• Alert Triggers
• Authentication Tokens
• Batches Settlements
• Billing Modifiers
• Billing Events
• Change Requests
• Chargeback Documents
• Chargeback Message Results
• Chargeback Messages
• Chargeback Statuses
• Confirmation Codes
• Decision Actions
• Decision Rules
• Disbursement Entries
• Disbursement Reference
• Disbursement Results
• Embedded Finance
• Entity Debts
• Entity Reserves
• Entity Returns
• Entity Terms
• Entry Origin
• Fee Modifiers
• Fee Rules
• Fraud Sight Enablements
• Host Themes
• Fund Origins
• IP Address Lists
• Invoice Items
• Invoice Parameters
• Invoice Line Items
• Invoice Results
• Logins Helpers
• Merchant Results
• Merchant Platform Statuses
• Message Threads
• Note Documents
• Orgs VAS Efe Products
• Orgs VAS Omni Tokens
• Orgs VAS Revenue Boosts
• Orgs VAS Safer Payments
• Orgs VA Stax Form Enablements
• Org Entities
• Org Flow Actions
• Org Flows
• Org Flow Rules
• Payment Update Groups
• Payment Updates
• Payout Flows
• Pending Entry
• Profit Share Results
• Profit Share Rules
• Profit Shares
• Reserve Entry
• Revenue Boosts
• Rev Share Schedules
• Rev Share Statements
• Safer Payments
• Statement Entry
• Subscription Tokens
• Tax Form Requests
• Team Logins
• Terminal Transaction Reference
• Terminal Transactions Datas
• Terminal Transactions
• Terminal Transaction Results
• Terminal Transactions Metadatas
• Token Results
• Transaction Datas
• Transaction Metadatas
• Transaction Holds
• Transaction Items
• Transactions Results
• Fee Refunds
• Transactions Txns
• Tax Form Enablements
• Txn Sessions
• VAS Efe Offers
• VAS Efe Offer Updates
• Orgs VA Sfraud Sight Enablements
• Fraud Sight Results
• Accounts
• Adjustments
• Aggregations
• Alerts
• Assessments
• Billing
• Bins
• Chargebacks
• Contacts
• Credentials
• Customers
• Decisions
• Disbursements
• Divisions
• Entities
• Entity Refs
• Entity Data
• Entities Custom Fields
• Entries
• Fees
• Funds
• Invoices
• Logins
• Mappings
• Members
• Merchants
• Messages
• Notes
• Omni Tokens
• Orgs
• Payouts
• Plans
• Reserves
• Secrets
• Sessions
• Statements
• Subscriptions
• Teams
• Terminals
• Tokens
• Vendors

SDK Infrastructure

Configuration

• ProxySettings

HTTP

• HttpResponse
• HttpRequest

Utilities

• ApiHelper
• HttpDateTime
• RFC3339DateTime
• UnixDateTime