PHPackages                             ps-apimatic/ps-apimatic-sdk - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. ps-apimatic/ps-apimatic-sdk

ActiveLibrary[API Development](/categories/api)

ps-apimatic/ps-apimatic-sdk
===========================

Sample SDKs for PS by APIMatic

0.0.2(1mo ago)01MITPHPPHP ^7.2 || ^8.0

Since Jul 2Pushed 1mo agoCompare

[ Source](https://github.com/sdks-io/ps-apimatic-php-sdk)[ Packagist](https://packagist.org/packages/ps-apimatic/ps-apimatic-sdk)[ Docs](https://paysecure.com/)[ RSS](/packages/ps-apimatic-ps-apimatic-sdk/feed)WikiDiscussions main Synced 1w ago

READMEChangelogDependencies (5)Versions (3)Used By (0)

Getting Started with Paysecure API Documentation - Live
=======================================================

[](#getting-started-with-paysecure-api-documentation---live)

Introduction
------------

[](#introduction)

### Overview

[](#overview)

---

Paysecure is a payment gateway optimization and intelligence service that merchants can use to provide a remote and frictionless payment experience.

This documentation will help you get started with integrating Paysecure but if you have any questions, please do not hesitate to reach out to us via email at [info@paysecure.net](https://)

Please be advised that our support team is only available during standard business hours.

### Environments

[](#environments)

---

These are the BaseUrls for the APIs on different environments:

**Environment****Base URL**Production[https://api.paysecure.net/api/v1](https://)Sandbox[https://api.paysecure.net/api/v1](https://)
`Note: set the Sandbox flag true (checked) in your merchant account. As shown in the image below`### Authentication

[](#authentication)

---

To access the API, you must acquire your unique API key from the merchant dashboard -&gt; API Keys section in your account. Make sure to use this key as a **bearer token** in the Authorization header for every request you send.

`AUTHORIZATION: Bearer Token`

`Token: {{APIKey}} .`

Access your sandbox API key credentials by navigating to your merchant login and checking the 'is sandbox' option, located in the top right corner under merchant profile.

[![](https://camo.githubusercontent.com/edface3d8d7b7b5d7f4bae3bfe4889affb6c2ef3857bf6852417c45b21219755/68747470733a2f2f636f6e74656e742e7073746d6e2e696f2f64666536346136362d383639392d343563382d396631302d6230306637646633383062372f55324e795a57567563326876644341794d44497a4c5441354c54453149474630494445324c6a55324c6a51794c6e42755a773d3d)](https://camo.githubusercontent.com/edface3d8d7b7b5d7f4bae3bfe4889affb6c2ef3857bf6852417c45b21219755/68747470733a2f2f636f6e74656e742e7073746d6e2e696f2f64666536346136362d383639392d343563382d396631302d6230306637646633383062372f55324e795a57567563326876644341794d44497a4c5441354c54453149474630494445324c6a55324c6a51794c6e42755a773d3d)

To get to the live API key, uncheck the **'Is Sandbox'** option in the top right corner of your merchant dashboard. After unchecking, the page will refresh, and you can generate an API key for live transactions in this environment."

[![](https://camo.githubusercontent.com/dd1b7931da104ffccafd04ed737285172af414d3c911f199ef9dfd8013cf8813/68747470733a2f2f636f6e74656e742e7073746d6e2e696f2f61666132353734642d383433382d346136332d396232392d3831666562306637353565352f55324e795a57567563326876644341794d44497a4c5441354c54453149474630494445334c6a45304c6a49344c6e42755a773d3d)](https://camo.githubusercontent.com/dd1b7931da104ffccafd04ed737285172af414d3c911f199ef9dfd8013cf8813/68747470733a2f2f636f6e74656e742e7073746d6e2e696f2f61666132353734642d383433382d346136332d396232392d3831666562306637353565352f55324e795a57567563326876644341794d44497a4c5441354c54453149474630494445334c6a45304c6a49344c6e42755a773d3d)

Reiterating, the API keys in Sandbox mode are for testing (when 'is sandbox' is CHECKED in the top right corner under merchant profile). The live API key credentials are for processing actual card transactions in Live mode (when 'is sandbox' is UNCHECKED in the same location)

### Request Headers

[](#request-headers)

---

Use these headers on every API call unless noted.

HeaderValueRequiredNotes`Content-Type``application/json`YesAll endpoints. Send JSON payloads.`Authorization``Bearer {MERCHANT_API_KEY}`YesAll endpoints.
Replace with your merchant API key.`BrandId``{YOUR_BRAND_ID}`Conditional**Session** and **Customer**APIs.
optional in customer APIs but Mandatory in Session APIsInstall the Package
-------------------

[](#install-the-package)

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

```
composer require "ps-apimatic/ps-apimatic-sdk:0.0.2"
```

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

```
"require": {
    "ps-apimatic/ps-apimatic-sdk": "0.0.2"
}
```

You can also view the package at:

Initialize the API Client
-------------------------

[](#initialize-the-api-client)

***Note:*** Documentation for the client can be found [here.](https://www.github.com/sdks-io/ps-apimatic-php-sdk/tree/0.0.2/doc/client.md)

The following parameters are configurable for the API Client:

ParameterTypeDescriptionenvironment[`Environment`](https://www.github.com/sdks-io/ps-apimatic-php-sdk/tree/0.0.2/README.md#environments)The API environment.
 **Default: `Environment.PRODUCTION`**timeout`int`Timeout for API calls in seconds.
*Default*: `30`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'`loggingConfiguration[`LoggingConfigurationBuilder`](https://www.github.com/sdks-io/ps-apimatic-php-sdk/tree/0.0.2/doc/logging-configuration-builder.md)Represents the logging configurations for API callsproxyConfiguration[`ProxyConfigurationBuilder`](https://www.github.com/sdks-io/ps-apimatic-php-sdk/tree/0.0.2/doc/proxy-configuration-builder.md)Represents the proxy configurations for API callsbearerAuthCredentials[`BearerAuthCredentials`](https://www.github.com/sdks-io/ps-apimatic-php-sdk/tree/0.0.2/doc/auth/oauth-2-bearer-token.md)The Credentials Setter for OAuth 2 Bearer tokenThe API client can be initialized as follows:

```
use PaysecureApiDocumentationLiveLib\Logging\LoggingConfigurationBuilder;
use PaysecureApiDocumentationLiveLib\Logging\RequestLoggingConfigurationBuilder;
use PaysecureApiDocumentationLiveLib\Logging\ResponseLoggingConfigurationBuilder;
use Psr\Log\LogLevel;
use PaysecureApiDocumentationLiveLib\Environment;
use PaysecureApiDocumentationLiveLib\Authentication\BearerAuthCredentialsBuilder;
use PaysecureApiDocumentationLiveLib\PaysecureApiDocumentationLiveClientBuilder;

$client = PaysecureApiDocumentationLiveClientBuilder::init()
    ->bearerAuthCredentials(
        BearerAuthCredentialsBuilder::init(
            'AccessToken'
        )
    )
    ->environment(Environment::PRODUCTION)
    ->loggingConfiguration(
        LoggingConfigurationBuilder::init()
            ->level(LogLevel::INFO)
            ->requestConfiguration(RequestLoggingConfigurationBuilder::init()->body(true))
            ->responseConfiguration(ResponseLoggingConfigurationBuilder::init()->headers(true))
    )
    ->build();
```

Environments
------------

[](#environments-1)

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

### Fields

[](#fields)

NameDescriptionPRODUCTION**Default**Authorization
-------------

[](#authorization)

This API uses the following authentication schemes.

- [`bearer (OAuth 2 Bearer token)`](https://www.github.com/sdks-io/ps-apimatic-php-sdk/tree/0.0.2/doc/auth/oauth-2-bearer-token.md)

List of APIs
------------

[](#list-of-apis)

- [Payin AP Is](https://www.github.com/sdks-io/ps-apimatic-php-sdk/tree/0.0.2/doc/controllers/payin-ap-is.md)
- [Payout AP Is](https://www.github.com/sdks-io/ps-apimatic-php-sdk/tree/0.0.2/doc/controllers/payout-ap-is.md)
- [Get Balance API](https://www.github.com/sdks-io/ps-apimatic-php-sdk/tree/0.0.2/doc/controllers/get-balance-api.md)
- [Refund API](https://www.github.com/sdks-io/ps-apimatic-php-sdk/tree/0.0.2/doc/controllers/refund-api.md)
- [🌎 Paypal Wallet](https://www.github.com/sdks-io/ps-apimatic-php-sdk/tree/0.0.2/doc/controllers/paypal-wallet.md)
- [💳 Virtual Cards Payout](https://www.github.com/sdks-io/ps-apimatic-php-sdk/tree/0.0.2/doc/controllers/virtual-cards-payout.md)
- [Trust Score](https://www.github.com/sdks-io/ps-apimatic-php-sdk/tree/0.0.2/doc/controllers/trust-score.md)
- [Cashier AP Is](https://www.github.com/sdks-io/ps-apimatic-php-sdk/tree/0.0.2/doc/controllers/cashier-ap-is.md)
- [Transaction Reporting](https://www.github.com/sdks-io/ps-apimatic-php-sdk/tree/0.0.2/doc/controllers/transaction-reporting.md)
- [Get Balance API V2-Orchestration](https://www.github.com/sdks-io/ps-apimatic-php-sdk/tree/0.0.2/doc/controllers/get-balance-api-v2-orchestration.md)
- [Global Collection](https://www.github.com/sdks-io/ps-apimatic-php-sdk/tree/0.0.2/doc/controllers/global-collection.md)
- [Payout Manual Review](https://www.github.com/sdks-io/ps-apimatic-php-sdk/tree/0.0.2/doc/controllers/payout-manual-review.md)
- [AP Is](https://www.github.com/sdks-io/ps-apimatic-php-sdk/tree/0.0.2/doc/controllers/ap-is.md)
- [Payout](https://www.github.com/sdks-io/ps-apimatic-php-sdk/tree/0.0.2/doc/controllers/payout.md)
- [Payin](https://www.github.com/sdks-io/ps-apimatic-php-sdk/tree/0.0.2/doc/controllers/payin.md)
- [API](https://www.github.com/sdks-io/ps-apimatic-php-sdk/tree/0.0.2/doc/controllers/api.md)

SDK Infrastructure
------------------

[](#sdk-infrastructure)

### Configuration

[](#configuration)

- [ProxyConfigurationBuilder](https://www.github.com/sdks-io/ps-apimatic-php-sdk/tree/0.0.2/doc/proxy-configuration-builder.md)
- [LoggingConfigurationBuilder](https://www.github.com/sdks-io/ps-apimatic-php-sdk/tree/0.0.2/doc/logging-configuration-builder.md)
- [RequestLoggingConfigurationBuilder](https://www.github.com/sdks-io/ps-apimatic-php-sdk/tree/0.0.2/doc/request-logging-configuration-builder.md)
- [ResponseLoggingConfigurationBuilder](https://www.github.com/sdks-io/ps-apimatic-php-sdk/tree/0.0.2/doc/response-logging-configuration-builder.md)

### HTTP

[](#http)

- [HttpRequest](https://www.github.com/sdks-io/ps-apimatic-php-sdk/tree/0.0.2/doc/http-request.md)

### Utilities

[](#utilities)

- [FileWrapper](https://www.github.com/sdks-io/ps-apimatic-php-sdk/tree/0.0.2/doc/file-wrapper.md)
- [ApiResponse](https://www.github.com/sdks-io/ps-apimatic-php-sdk/tree/0.0.2/doc/api-response.md)

###  Health Score

33

—

LowBetter than 72% of packages

Maintenance90

Actively maintained with recent releases

Popularity1

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity30

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~0 days

Total

2

Last Release

48d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/ef06f97b4ff5db714f2a124525216538f97338487cd4e2bca22baa32c0bf90cd?d=identicon)[developer-sdksio](/maintainers/developer-sdksio)

---

Top Contributors

[![developer-sdksio](https://avatars.githubusercontent.com/u/135820708?v=4)](https://github.com/developer-sdksio "developer-sdksio (2 commits)")

###  Code Quality

Code StylePHP\_CodeSniffer

### Embed Badge

![Health badge](/badges/ps-apimatic-ps-apimatic-sdk/health.svg)

```
[![Health](https://phpackages.com/badges/ps-apimatic-ps-apimatic-sdk/health.svg)](https://phpackages.com/packages/ps-apimatic-ps-apimatic-sdk)
```

###  Alternatives

[square/square

Use Square APIs to manage and run business including payment, customer, product, inventory, and employee management.

784.1M31](/packages/square-square)[paypal/paypal-server-sdk

PayPal's SDK for interacting with the REST APIs

61964.3k20](/packages/paypal-paypal-server-sdk)[pagarme/pagarme-php-sdk

Pagarme API

10187.3k](/packages/pagarme-pagarme-php-sdk)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
