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:

  • 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

  • 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 gem from the command line:

gem install univapay-apimatic-sdk -v 0.0.4

Or add the gem to your Gemfile and run bundle:

gem 'univapay-apimatic-sdk', '0.0.4'

For additional gem details, see the RubyGems page for the univapay-apimatic-sdk gem.

IRB Console Usage

You can explore the SDK interactively using IRB in two ways

1. Use IRB with Installed Gem

Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and type the following command to start the irb console.

irb

Now you can load the SDK in the IRB

require 'univapay_client_sdk'
include UnivapayClientSdk

2. Use IRB within SDK

Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and navigate to the root folder of SDK.

cd path/to/univapay_client_sdk

Now you can start the preconfigured irb console by running the following command

ruby bin/console

Note: This automatically loads the SDK from lib/

Test the SDK

To run the tests, navigate to the root directory of the SDK in your terminal and execute the following command:

rake

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
base_url String Base URL for the API
Default: 'https://api.univapay.com'
environment Environment The API environment.
Default: Environment.PRODUCTION
connection Faraday::Connection The Faraday connection object passed by the SDK user for making requests
adapter Faraday::Adapter The Faraday adapter object passed by the SDK user for performing http requests
timeout Float The value to use for connection timeout.
Default: 30
max_retries Integer The number of times to retry an endpoint call if it fails.
Default: 0
retry_interval Float Pause in seconds between retries.
Default: 1
backoff_factor Float The amount to multiply each successive retry's interval amount by in order to provide backoff.
Default: 2
retry_statuses Array A list of HTTP statuses to retry.
Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods Array A list of HTTP methods to retry.
Default: %i[get put]
http_callback HttpCallBack The Http CallBack allows defining callables for pre and post API calls.
proxy_settings ProxySettings Optional proxy configuration to route HTTP requests through a proxy server.
logging_configuration LoggingConfiguration The SDK logging configuration for API calls
bearer_auth_credentials BearerAuthCredentials The credential object for OAuth 2 Bearer token

The API client can be initialized as follows:

Code-Based Client Initialization

require 'univapay_client_sdk'
include UnivapayClientSdk

client = Client.new(
  bearer_auth_credentials: BearerAuthCredentials.new(
    access_token: 'AccessToken'
  ),
  environment: Environment::PRODUCTION,
  base_url: 'https://api.univapay.com',
  logging_configuration: LoggingConfiguration.new(
    log_level: Logger::INFO,
    request_logging_config: RequestLoggingConfiguration.new(
      log_body: true
    ),
    response_logging_config: ResponseLoggingConfiguration.new(
      log_headers: true
    )
  )
)

Environment-Based Client Initialization

require 'univapay_client_sdk'
include UnivapayClientSdk

# Create client from environment
client = Client.from_env

See the Environment-Based Client Initialization section for details.

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