Download the PHP package univapay/client-sdk without Composer

On this page you can find all versions of the php package univapay/client-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of univapay/client-sdk

Informations about the package client-sdk

Getting Started with Univapay Public API

Introduction

OpenAPI specification for the Univapay Online Payment API.

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

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

Depending on where you are calling the API from, the Bearer format changes:

We will assume that all requests are going to originate from a backend server thus, all requests will require the secret

Token Types

Install the Package

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

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

You can also view the package at: https://packagist.org/packages/univapay/client-sdk#1.2.3

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

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

Parameter Type Description
baseUrl string Base URL for the API
Default: 'https://api.univapay.com'
directDebitBaseUrl string Base URL for the Direct Debit API
Default: 'https://direct-debit.gopay-services.com'
environment Environment 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, 408, 413, 429, 500, 502, 503, 504, 521, 522, 524
httpMethodsToRetry array Http methods to retry against.
Default: 'GET', 'PUT', 'GET', 'PUT'
loggingConfiguration LoggingConfigurationBuilder Represents the logging configurations for API calls
proxyConfiguration ProxyConfigurationBuilder Represents the proxy configurations for API calls
bearerAuthCredentials BearerAuthCredentials The Credentials Setter for OAuth 2 Bearer token

The API client can be initialized as follows:

Environments

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

Fields

Name Description
PRODUCTION Default Production Server

Authorization

This API uses the following authentication schemes.

List of APIs

Webhooks

SDK Infrastructure

Configuration

HTTP

Utilities

All versions of client-sdk with dependencies

PHP Build Version
Package Version
Requires php Version ^7.2 || ^8.0
ext-json Version *
ext-curl Version *
apimatic/unirest-php Version ^4.0.6
apimatic/core-interfaces Version ~0.1.5
apimatic/core Version ~0.3.17
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package univapay/client-sdk contains the following files

Loading the files please wait ...