README

Introduction

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

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

Environments

These are the BaseUrls for the APIs on different environments:

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

Authentication

To access the API, you must acquire your unique API key from the merchant dashboard -> 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.

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."

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

Use these headers on every API call unless noted.

Header	Value	Required	Notes
Content-Type	application/json	Yes	All endpoints. Send JSON payloads.
Authorization	Bearer {MERCHANT_API_KEY}	Yes	All endpoints. Replace with your merchant API key.
BrandId	{YOUR_BRAND_ID}	Conditional	Session and CustomerAPIs. optional in customer APIs but Mandatory in Session APIs

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: https://packagist.org/packages/ps-apimatic/ps-apimatic-sdk#0.0.2

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.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	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:

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

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

Fields

Name	Description
PRODUCTION	Default

Authorization

This API uses the following authentication schemes.

• bearer (OAuth 2 Bearer token)

List of APIs

• Payin AP Is
• Payout AP Is
• Get Balance API
• Refund API
• 🌎 Paypal Wallet
• 💳 Virtual Cards Payout
• Trust Score
• Cashier AP Is
• Transaction Reporting
• Get Balance API V2-Orchestration
• Global Collection
• Payout Manual Review
• AP Is
• Payout
• Payin
• API

SDK Infrastructure

Configuration

• ProxyConfigurationBuilder
• LoggingConfigurationBuilder
• RequestLoggingConfigurationBuilder
• ResponseLoggingConfigurationBuilder

HTTP

• HttpRequest

Utilities

• FileWrapper
• ApiResponse