PHPackages univapay-apimatic/univapay-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. [Utility & Helpers](/categories/utility) 4. / 5. univapay-apimatic/univapay-apimatic-sdk ActiveLibrary[Utility & Helpers](/categories/utility) univapay-apimatic/univapay-apimatic-sdk ======================================= Sample SDKs for Univapay by APIMatic 0.0.4(1mo ago)03MITPHPPHP ^7.2 || ^8.0 Since Jul 8Pushed 1mo agoCompare [ Source](https://github.com/sdks-io/univapay-apimatic-php-sdk)[ Packagist](https://packagist.org/packages/univapay-apimatic/univapay-apimatic-sdk)[ Docs](https://univapay.com/)[ RSS](/packages/univapay-apimatic-univapay-apimatic-sdk/feed)WikiDiscussions main Synced 1w ago READMEChangelogDependencies (7)Versions (4)Used By (0) Getting Started with Univapay Public API ======================================== [](#getting-started-with-univapay-public-api) Introduction ------------ [](#introduction) OpenAPI specification for the Univapay Online Payment API. ### Authentication (JWT) [](#authentication-jwt) This API uses JWT (JSON Web Tokens) for authentication via the HTTP `Authorization` header. To authenticate, you must generate an **Application Token** in the Univapay dashboard. This generates two components: 1. **Token (`{jwt}`)** 2. **Secret (`{secret}`)** #### ⚠️ Security Warning [](#️-security-warning) The **Secret** grants extensive privileges (e.g., creating charges, capturing authorized card charges, refunding). **NEVER expose the `{secret}` in frontend application code** (e.g., consumer browsers) or public repositories. It is strictly for backend server-to-server communication. *Univapay is not responsible for accidents caused by leaked secrets.* #### Bearer Auth Formats [](#bearer-auth-formats) Depending on where you are calling the API from, the Bearer format changes: - **Frontend / Browser (No Secret)**: `Bearer {jwt}`*(Used for Widgets or Inline Forms. You must register your allowed domains in the dashboard when creating the token).* - **Backend / Server (With Secret)**: `Bearer {secret}.{jwt}`*(Required for all backend processing).* We will assume that all requests are going to originate from a backend server thus, all requests will require the secret #### Token Types [](#token-types) - **Store Token**: Grants full access to requests for that specific store. - **Merchant Token**: Can't create transaction tokens but can access data from multiple stores. Install 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 "univapay-apimatic/univapay-apimatic-sdk:0.0.4" ``` Or add it to the composer.json file manually as given below: ``` "require": { "univapay-apimatic/univapay-apimatic-sdk": "0.0.4" } ``` You can also view the package at: Test the SDK ------------ [](#test-the-sdk) Unit tests in this SDK can be run using PHPUnit. 1. First install the dependencies using composer including the `require-dev` dependencies. 2. Run `vendor\bin\phpunit --verbose` from commandline to execute tests. If you have installed PHPUnit globally, run tests using `phpunit --verbose` instead. You can change the PHPUnit test configuration in the `phpunit.xml` file. Initialize the API Client ------------------------- [](#initialize-the-api-client) ***Note:*** Documentation for the client can be found [here.](https://www.github.com/sdks-io/univapay-apimatic-php-sdk/tree/0.0.4/doc/client.md) The following parameters are configurable for the API Client: ParameterTypeDescriptionbaseUrl`string`Base URL for the API *Default*: `'https://api.univapay.com'`environment[`Environment`](https://www.github.com/sdks-io/univapay-apimatic-php-sdk/tree/0.0.4/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/univapay-apimatic-php-sdk/tree/0.0.4/doc/logging-configuration-builder.md)Represents the logging configurations for API callsproxyConfiguration[`ProxyConfigurationBuilder`](https://www.github.com/sdks-io/univapay-apimatic-php-sdk/tree/0.0.4/doc/proxy-configuration-builder.md)Represents the proxy configurations for API callsbearerAuthCredentials[`BearerAuthCredentials`](https://www.github.com/sdks-io/univapay-apimatic-php-sdk/tree/0.0.4/doc/auth/oauth-2-bearer-token.md)The Credentials Setter for OAuth 2 Bearer tokenThe API client can be initialized as follows: ``` use UnivaPay\Logging\LoggingConfigurationBuilder; use UnivaPay\Logging\RequestLoggingConfigurationBuilder; use UnivaPay\Logging\ResponseLoggingConfigurationBuilder; use Psr\Log\LogLevel; use UnivaPay\Environment; use UnivaPay\Authentication\BearerAuthCredentialsBuilder; use UnivaPay\UnivapayClientSdkClientBuilder; $client = UnivapayClientSdkClientBuilder::init() ->bearerAuthCredentials( BearerAuthCredentialsBuilder::init( 'AccessToken' ) ) ->environment(Environment::PRODUCTION) ->baseUrl('https://api.univapay.com') ->loggingConfiguration( LoggingConfigurationBuilder::init() ->level(LogLevel::INFO) ->requestConfiguration(RequestLoggingConfigurationBuilder::init()->body(true)) ->responseConfiguration(ResponseLoggingConfigurationBuilder::init()->headers(true)) ) ->build(); ``` Environments ------------ [](#environments) The SDK can be configured to use a different environment for making API calls. Available environments are: ### Fields [](#fields) NameDescriptionPRODUCTION**Default** Production ServerAuthorization ------------- [](#authorization) This API uses the following authentication schemes. - [`JWT_TOKEN (OAuth 2 Bearer token)`](https://www.github.com/sdks-io/univapay-apimatic-php-sdk/tree/0.0.4/doc/auth/oauth-2-bearer-token.md) List of APIs ------------ [](#list-of-apis) - [Transaction Tokens](https://www.github.com/sdks-io/univapay-apimatic-php-sdk/tree/0.0.4/doc/controllers/transaction-tokens.md) - [Charges](https://www.github.com/sdks-io/univapay-apimatic-php-sdk/tree/0.0.4/doc/controllers/charges.md) - [Refunds](https://www.github.com/sdks-io/univapay-apimatic-php-sdk/tree/0.0.4/doc/controllers/refunds.md) - [Subscriptions](https://www.github.com/sdks-io/univapay-apimatic-php-sdk/tree/0.0.4/doc/controllers/subscriptions.md) - [Cancels](https://www.github.com/sdks-io/univapay-apimatic-php-sdk/tree/0.0.4/doc/controllers/cancels.md) - [Merchants](https://www.github.com/sdks-io/univapay-apimatic-php-sdk/tree/0.0.4/doc/controllers/merchants.md) - [Stores](https://www.github.com/sdks-io/univapay-apimatic-php-sdk/tree/0.0.4/doc/controllers/stores.md) - [Webhooks](https://www.github.com/sdks-io/univapay-apimatic-php-sdk/tree/0.0.4/doc/controllers/webhooks.md) Webhooks -------- [](#webhooks) - [Charge Updated](https://www.github.com/sdks-io/univapay-apimatic-php-sdk/tree/0.0.4/doc/events/webhooks/charge-updated-handler.md) - [Charge Finished](https://www.github.com/sdks-io/univapay-apimatic-php-sdk/tree/0.0.4/doc/events/webhooks/charge-finished-handler.md) - [Token Created](https://www.github.com/sdks-io/univapay-apimatic-php-sdk/tree/0.0.4/doc/events/webhooks/token-created-handler.md) - [Token Updated](https://www.github.com/sdks-io/univapay-apimatic-php-sdk/tree/0.0.4/doc/events/webhooks/token-updated-handler.md) - [Token Three Ds Updated](https://www.github.com/sdks-io/univapay-apimatic-php-sdk/tree/0.0.4/doc/events/webhooks/token-three-ds-updated-handler.md) - [Token Cvv Auth Updated](https://www.github.com/sdks-io/univapay-apimatic-php-sdk/tree/0.0.4/doc/events/webhooks/token-cvv-auth-updated-handler.md) - [Token Cvv Auth Check Updated](https://www.github.com/sdks-io/univapay-apimatic-php-sdk/tree/0.0.4/doc/events/webhooks/token-cvv-auth-check-updated-handler.md) - [Token Replaced](https://www.github.com/sdks-io/univapay-apimatic-php-sdk/tree/0.0.4/doc/events/webhooks/token-replaced-handler.md) - [Recurring Token Deleted](https://www.github.com/sdks-io/univapay-apimatic-php-sdk/tree/0.0.4/doc/events/webhooks/recurring-token-deleted-handler.md) - [Refund](https://www.github.com/sdks-io/univapay-apimatic-php-sdk/tree/0.0.4/doc/events/webhooks/refund-handler.md) - [Cancel](https://www.github.com/sdks-io/univapay-apimatic-php-sdk/tree/0.0.4/doc/events/webhooks/cancel-handler.md) - [Subscription Created](https://www.github.com/sdks-io/univapay-apimatic-php-sdk/tree/0.0.4/doc/events/webhooks/subscription-created-handler.md) - [Subscription Payment](https://www.github.com/sdks-io/univapay-apimatic-php-sdk/tree/0.0.4/doc/events/webhooks/subscription-payment-handler.md) - [Subscription Completed](https://www.github.com/sdks-io/univapay-apimatic-php-sdk/tree/0.0.4/doc/events/webhooks/subscription-completed-handler.md) - [Subscription Failure](https://www.github.com/sdks-io/univapay-apimatic-php-sdk/tree/0.0.4/doc/events/webhooks/subscription-failure-handler.md) - [Subscription Canceled](https://www.github.com/sdks-io/univapay-apimatic-php-sdk/tree/0.0.4/doc/events/webhooks/subscription-canceled-handler.md) - [Subscription Suspended](https://www.github.com/sdks-io/univapay-apimatic-php-sdk/tree/0.0.4/doc/events/webhooks/subscription-suspended-handler.md) - [Bank-Transfer](https://www.github.com/sdks-io/univapay-apimatic-php-sdk/tree/0.0.4/doc/events/webhooks/bank-transfer-handler.md) - [Customs](https://www.github.com/sdks-io/univapay-apimatic-php-sdk/tree/0.0.4/doc/events/webhooks/customs-handler.md) SDK Infrastructure ------------------ [](#sdk-infrastructure) ### Configuration [](#configuration) - [ProxyConfigurationBuilder](https://www.github.com/sdks-io/univapay-apimatic-php-sdk/tree/0.0.4/doc/proxy-configuration-builder.md) - [LoggingConfigurationBuilder](https://www.github.com/sdks-io/univapay-apimatic-php-sdk/tree/0.0.4/doc/logging-configuration-builder.md) - [RequestLoggingConfigurationBuilder](https://www.github.com/sdks-io/univapay-apimatic-php-sdk/tree/0.0.4/doc/request-logging-configuration-builder.md) - [ResponseLoggingConfigurationBuilder](https://www.github.com/sdks-io/univapay-apimatic-php-sdk/tree/0.0.4/doc/response-logging-configuration-builder.md) ### HTTP [](#http) - [HttpRequest](https://www.github.com/sdks-io/univapay-apimatic-php-sdk/tree/0.0.4/doc/http-request.md) ### Utilities [](#utilities) - [ApiResponse](https://www.github.com/sdks-io/univapay-apimatic-php-sdk/tree/0.0.4/doc/api-response.md) ### Health Score 34 — LowBetter than 74% of packages Maintenance90 Actively maintained with recent releases Popularity3 Limited adoption so far Community6 Small or concentrated contributor base Maturity31 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 3 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 (3 commits)") ### Code Quality TestsPHPUnit Code StylePHP\_CodeSniffer ### Embed Badge ![Health badge](/badges/univapay-apimatic-univapay-apimatic-sdk/health.svg) ``` [![Health](https://phpackages.com/badges/univapay-apimatic-univapay-apimatic-sdk/health.svg)](https://phpackages.com/packages/univapay-apimatic-univapay-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) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)