HamzaPaymentsQuerySDK 1.0.0

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

If you are building with .NET CLI tools then you can also use the following command:

dotnet add package HamzaPaymentsQuerySDK --version 1.0.0

You can also view the package at: https://www.nuget.org/packages/HamzaPaymentsQuerySDK/1.0.0

Test the SDK

The generated SDK also contain one or more Tests, which are contained in the Tests project. In order to invoke these test cases, you will need NUnit 3.0 Test Adapter Extension for Visual Studio. Once the SDK is complied, the test cases should appear in the Test Explorer window. Here, you can click Run All to execute these test cases.

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

The API client can be initialized as follows:

using Payments.Standard;
using Payments.Standard.Authentication;

namespace ConsoleApp;

PaymentsClient client = new PaymentsClient.Builder()
    .BasicAuthCredentials(
        new BasicAuthModel.Builder(
            "BasicAuthUserName",
            "BasicAuthPassword"
        )
        .Build())
    .Environment(Payments.Standard.Environment.Production)
    .Build();

Environments

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

Fields

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

• HttpClientConfiguration
• HttpClientConfigurationBuilder
• ProxyConfigurationBuilder

HTTP

• HttpCallback
• HttpContext
• HttpRequest
• HttpResponse
• HttpStringResponse

Utilities

• ApiException
• ApiHelper
• CustomDateTimeConverter
• UnixDateTimeConverter