Getting Started with Payments

Introduction

Use a single API that orchestrates the payment flow to include FraudSight, 3DS and Token creation.

Authentication

Set your headers

Authorization: {your_credentials}    
Content-Type: application/json    
WP-Api-Version: 2024-06-01

Replace {your_credentials} with your base64-encoded Basic Auth username and password.

DNS whitelisting

Whitelist the following URLs:

• https://try.access.worldpay.com/
• https://access.worldpay.com/

Please ensure you use DNS whitelisting, not explicit IP whitelisting. When you make a request within Access Worldpay, you should always cache the response returned.

API collection

A full set of API examples based on different scenarios.

• Download Postman collection

This API also includes Payment Queries functionality to retrieve and query payment information.

Install the Package

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

composer require "hamza-payments-query-sdk/hamza-payments-query-sdk:1.0.0"

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

"require": {
    "hamza-payments-query-sdk/hamza-payments-query-sdk": "1.0.0"
}

You can also view the package at: https://packagist.org/packages/hamza-payments-query-sdk/hamza-payments-query-sdk#1.0.0

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
environment	Environment	The API environment. Default: Environment.PRODUCTION
timeout	int	Timeout for API calls in seconds. Default: 0
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'
proxyConfiguration	ProxyConfigurationBuilder	Represents the proxy configurations for API calls
basicAuthCredentials	BasicAuthCredentials	The Credentials Setter for Basic Authentication

The API client can be initialized as follows:

use PaymentsLib\Environment;
use PaymentsLib\Authentication\BasicAuthCredentialsBuilder;
use PaymentsLib\PaymentsClientBuilder;

$client = PaymentsClientBuilder::init()
    ->basicAuthCredentials(
        BasicAuthCredentialsBuilder::init(
            'BasicAuthUserName',
            'BasicAuthPassword'
        )
    )
    ->environment(Environment::PRODUCTION)
    ->build();

Environments

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

Fields

Name	Description
production	Default Try
environment2	Live

Authorization

This API uses the following authentication schemes.

• BasicAuth (Basic Authentication)

List of APIs

• 3 DS Actions
• Manage Payments
• Payment Queries
• Payment

SDK Infrastructure

Configuration

• ProxyConfigurationBuilder

HTTP

• HttpRequest
• HttpResponse

Utilities

• ApiException