Getting Started with Payrix

Install the Package

Run the following command to install the package and automatically add the dependency to your composer.json file:

composer require "apimatic-payrix-sdk/payrix-api-sdk-php:1.0.3"

Or add it to the composer.json file manually as given below:

"require": {
    "apimatic-payrix-sdk/payrix-api-sdk-php": "1.0.3"
}

You can also view the package at: https://packagist.org/packages/apimatic-payrix-sdk/payrix-api-sdk-php#1.0.3

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
timeout	int	Timeout for API calls in seconds. Default: 0
enableRetries	bool	Whether to enable retries and backoff feature. Default: false
numberOfRetries	int	The number of retries to make. Default: 0
retryInterval	float	The retry time interval between the endpoint calls. Default: 1
backOffFactor	float	Exponential backoff factor to increase interval between retries. Default: 2
maximumRetryWaitTime	int	The maximum wait time in seconds for overall retrying requests. Default: 0
retryOnTimeout	bool	Whether to retry on request timeout. Default: true
httpStatusCodesToRetry	array	Http status codes to retry against. Default: 408, 413, 429, 500, 502, 503, 504, 521, 522, 524
httpMethodsToRetry	array	Http methods to retry against. Default: 'GET', 'PUT'
proxyConfiguration	ProxyConfigurationBuilder	Represents the proxy configurations for API calls
apiKeyCredentials	ApiKeyCredentials	The Credentials Setter for Custom Header Signature
sessionKeyCredentials	SessionKeyCredentials	The Credentials Setter for Custom Header Signature
txnSessionKeyCredentials	TxnSessionKeyCredentials	The Credentials Setter for Custom Header Signature
usernameCredentials	UsernameCredentials	The Credentials Setter for Custom Header Signature
passwordCredentials	PasswordCredentials	The Credentials Setter for Custom Header Signature

The API client can be initialized as follows:

use PayrixLib\Environment;
use PayrixLib\Authentication\ApiKeyCredentialsBuilder;
use PayrixLib\Authentication\SessionKeyCredentialsBuilder;
use PayrixLib\Authentication\TxnSessionKeyCredentialsBuilder;
use PayrixLib\Authentication\UsernameCredentialsBuilder;
use PayrixLib\Authentication\PasswordCredentialsBuilder;
use PayrixLib\PayrixClientBuilder;

$client = PayrixClientBuilder::init()
    ->apiKeyCredentials(
        ApiKeyCredentialsBuilder::init(
            'APIKEY'
        )
    )
    ->sessionKeyCredentials(
        SessionKeyCredentialsBuilder::init(
            'SESSIONKEY'
        )
    )
    ->txnSessionKeyCredentials(
        TxnSessionKeyCredentialsBuilder::init(
            'TXNSESSIONKEY'
        )
    )
    ->usernameCredentials(
        UsernameCredentialsBuilder::init(
            'USERNAME'
        )
    )
    ->passwordCredentials(
        PasswordCredentialsBuilder::init(
            'PASSWORD'
        )
    )
    ->environment(Environment::SANDBOX)
    ->build();

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

• ProxyConfigurationBuilder

HTTP

• HttpRequest
• HttpResponse

Utilities

• FileWrapper
• ApiException