README

Introduction

Combined OpenAPI 3.0 specification for DNA Payments' Partner Tools: the Reporting API (Ecommerce & POS transaction reporting, Merchants) and the Settlement API. Generated from https://developer.dnapayments.com/docs/partner-tools/reporting/ documentation.

NOTE: The 'Reference' page (https://developer.dnapayments.com/docs/partner-tools/reporting/reporting-api/ecommerce/reference) which defines the full canonical enumerations of Transaction Statuses, Transaction Types, and Payment Methods for the Ecommerce endpoints could not be retrieved (the page returned a redirect error). Fields that rely on that reference (status, type, paymentMethod, cardType on Ecommerce transactions) are therefore modeled as free-form strings with illustrative examples rather than strict enums. Supply that page's content to tighten these definitions.

All URLs shown are the TEST/sandbox environment URLs published in the documentation; no production base URLs were provided in the source documentation.

Install the Package

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

composer require "dna-payments/dna-apimatic-sdk:0.0.1"

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

"require": {
    "dna-payments/dna-apimatic-sdk": "0.0.1"
}

You can also view the package at: https://packagist.org/packages/dna-payments/dna-apimatic-sdk#0.0.1

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:

use DnaPaymentsPartnerReportingSettlementApIsLib\Logging\LoggingConfigurationBuilder;
use DnaPaymentsPartnerReportingSettlementApIsLib\Logging\RequestLoggingConfigurationBuilder;
use DnaPaymentsPartnerReportingSettlementApIsLib\Logging\ResponseLoggingConfigurationBuilder;
use Psr\Log\LogLevel;
use DnaPaymentsPartnerReportingSettlementApIsLib\Environment;
use DnaPaymentsPartnerReportingSettlementApIsLib\Authentication\ClientCredentialsAuthCredentialsBuilder;
use DnaPaymentsPartnerReportingSettlementApIsLib\Models\OauthScope;
use DnaPaymentsPartnerReportingSettlementApIsLib\DnaPaymentsPartnerReportingSettlementApIsClientBuilder;

$client = DnaPaymentsPartnerReportingSettlementApIsClientBuilder::init()
    ->clientCredentialsAuthCredentials(
        ClientCredentialsAuthCredentialsBuilder::init(
            'OAuthClientId',
            'OAuthClientSecret'
        )
            ->oauthScopes(
                [
                    OauthScope::PARTNERS_REPORTING
                ]
            )
    )
    ->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

Authorization

This API uses the following authentication schemes.

• BearerAuth (OAuth 2 Client Credentials Grant)

List of APIs

• Ecommerce Transactions
• POS Transactions
• Authentication
• Merchants
• Settlements

SDK Infrastructure

Configuration

• ProxyConfigurationBuilder
• LoggingConfigurationBuilder
• RequestLoggingConfigurationBuilder
• ResponseLoggingConfigurationBuilder

HTTP

• HttpRequest

Utilities

• ApiResponse