Skip to main content

Getting Started with DNA Payments Partner Reporting & Settlement APIs

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

The package is compatible with Python versions 3.7+. Install the package from PyPi using the following pip command:

pip install dna-apimatic-sdk==5.0.0

You can also view the package at: https://pypi.python.org/pypi/dna-apimatic-sdk/5.0.0

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
http_client_instance Union[Session, HttpClientProvider] The Http Client passed from the sdk user for making requests
override_http_client_configuration bool The value which determines to override properties of the passed Http Client from the sdk user
http_call_back HttpCallBack The callback value that is invoked before and after an HTTP call is made to an endpoint
timeout float The value to use for connection timeout.
Default: 30
max_retries int The number of times to retry an endpoint call if it fails.
Default: 0
backoff_factor float A backoff factor to apply between attempts after the second try.
Default: 2
retry_statuses Array of int The http statuses on which retry is to be done.
Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods Array of string The http methods on which retry is to be done.
Default: ["GET", "PUT"]
proxy_settings ProxySettings Optional proxy configuration to route HTTP requests through a proxy server.
logging_configuration LoggingConfiguration The SDK logging configuration for API calls
client_credentials_auth_credentials ClientCredentialsAuthCredentials The credential object for OAuth 2 Client Credentials Grant

The API client can be initialized as follows:

Code-Based Client Initialization

import logging

from dnapaymentspartnerreportingsettlementapis.configuration import Environment
from dnapaymentspartnerreportingsettlementapis.dnapaymentspartnerreportingsettlementapis_client import DnapaymentspartnerreportingsettlementapisClient
from dnapaymentspartnerreportingsettlementapis.http.auth.oauth_2 import ClientCredentialsAuthCredentials
from dnapaymentspartnerreportingsettlementapis.logging.configuration.api_logging_configuration import LoggingConfiguration
from dnapaymentspartnerreportingsettlementapis.logging.configuration.api_logging_configuration import RequestLoggingConfiguration
from dnapaymentspartnerreportingsettlementapis.logging.configuration.api_logging_configuration import ResponseLoggingConfiguration
from dnapaymentspartnerreportingsettlementapis.models.oauth_scope import OauthScope

client = DnapaymentspartnerreportingsettlementapisClient(
    client_credentials_auth_credentials=ClientCredentialsAuthCredentials(
        oauth_client_id='OAuthClientId',
        oauth_client_secret='OAuthClientSecret',
        oauth_scopes=[
            OauthScope.PARTNERS_REPORTING
        ]
    ),
    environment=Environment.PRODUCTION,
    logging_configuration=LoggingConfiguration(
        log_level=logging.INFO,
        request_logging_config=RequestLoggingConfiguration(
            log_body=True
        ),
        response_logging_config=ResponseLoggingConfiguration(
            log_headers=True
        )
    )
)

Environment-Based Client Initialization

from dnapaymentspartnerreportingsettlementapis.dnapaymentspartnerreportingsettlementapis_client import DnapaymentspartnerreportingsettlementapisClient

# Specify the path to your .env file if it’s located outside the project’s root directory.
client = DnapaymentspartnerreportingsettlementapisClient.from_environment(dotenv_path='/path/to/.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 Test/Sandbox API server (Reporting & Settlement APIs)
ENVIRONMENT2 Test/Sandbox OAuth2 authorization server

Authorization

This API uses the following authentication schemes.

List of APIs

SDK Infrastructure

Configuration

HTTP

Utilities

Metadata

Release files for dna-apimatic-sdk 5.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for dna-apimatic-sdk 5.0.0
File Size Uploaded Provenance Actions
dna_apimatic_sdk-5.0.0.tar.gz 40.2 kB Without provenance Details for dna_apimatic_sdk-5.0.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for dna-apimatic-sdk 5.0.0
File Interpreter ABI Platform Actions
dna_apimatic_sdk-5.0.0-py3-none-any.whl Python 3 none any Details for dna_apimatic_sdk-5.0.0-py3-none-any.whl

Total release size: 121.3 kB

Release files / dna_apimatic_sdk-5.0.0.tar.gz

Download URL dna_apimatic_sdk-5.0.0.tar.gz
Size 40.2 kB
Tags Source
SHA-256 checksum
How to use checksums
c064f077950d732fff28a84a6698de8b952ab8e2f8e59fe61c6c8f5d6426b531
BLAKE2b-256 checksum
How to use checksums
15ce7390c0d41c166afacf7c11879de8d7987fb015b606280d5edd6e11ffb6c9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Release files / dna_apimatic_sdk-5.0.0-py3-none-any.whl

Download URL dna_apimatic_sdk-5.0.0-py3-none-any.whl
Size 81.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
744fb8fc95f09c29a2d0dae2640d6cb2e2f74a40cebf6bc870796a9f50b7900e
BLAKE2b-256 checksum
How to use checksums
7e9bacccceb877e0113c9f843dfa09a4e3453603c103e49c268d7845be7ffdd3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Security for dna-apimatic-sdk 5.0.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

5.0.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page