Skip to main content

Getting Started with Reporting: Settlement Research API

Introduction

API used to search and retrieve settled transactions. This API is used to search settled transactions and retrieve individual transaction details based on card types.

Install the Package

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

pip install wp-sdk==1.0.0

You can also view the package at: https://pypi.python.org/pypi/wp-sdk/1.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
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: 60
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
custom_header_authentication_credentials CustomHeaderAuthenticationCredentials The credential object for Custom Header Signature

The API client can be initialized as follows:

Code-Based Client Initialization

import logging

from reportingsettlementresearchapi.configuration import Environment
from reportingsettlementresearchapi.http.auth.custom_header_authentication import CustomHeaderAuthenticationCredentials
from reportingsettlementresearchapi.logging.configuration.api_logging_configuration import LoggingConfiguration
from reportingsettlementresearchapi.logging.configuration.api_logging_configuration import RequestLoggingConfiguration
from reportingsettlementresearchapi.logging.configuration.api_logging_configuration import ResponseLoggingConfiguration
from reportingsettlementresearchapi.reportingsettlementresearchapi_client import ReportingsettlementresearchapiClient

client = ReportingsettlementresearchapiClient(
    custom_header_authentication_credentials=CustomHeaderAuthenticationCredentials(
        authorization='Authorization'
    ),
    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 reportingsettlementresearchapi.reportingsettlementresearchapi_client import ReportingsettlementresearchapiClient

# Specify the path to your .env file if it’s located outside the project’s root directory.
client = ReportingsettlementresearchapiClient.from_environment(dotenv_path='/path/to/.env')

See the Environment-Based Client Initialization section for details.

Authorization

This API uses the following authentication schemes.

List of APIs

SDK Infrastructure

Configuration

HTTP

Utilities

Metadata

Release files for wp-sdk 1.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 wp-sdk 1.0.0
File Size Uploaded Provenance Actions
wp_sdk-1.0.0.tar.gz 107.9 kB Without provenance Details for wp_sdk-1.0.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for wp-sdk 1.0.0
File Interpreter ABI Platform Actions
wp_sdk-1.0.0-py3-none-any.whl Python 3 none any Details for wp_sdk-1.0.0-py3-none-any.whl

Total release size: 447.4 kB

Release files / wp_sdk-1.0.0.tar.gz

Download URL wp_sdk-1.0.0.tar.gz
Size 107.9 kB
Tags Source
SHA-256 checksum
How to use checksums
906914eef204cbf0ff369a7aa1f9f7b204dd33719448a452229ca12940249ade
BLAKE2b-256 checksum
How to use checksums
15059b7da4a0478bdeb754d866d788ea74696826037ef5b2542b5f575bf09721
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Release files / wp_sdk-1.0.0-py3-none-any.whl

Download URL wp_sdk-1.0.0-py3-none-any.whl
Size 339.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
eb3d3006ef426aa52b9d11ff0a6158ce0067ba54d9536a85203602ac1bd149bd
BLAKE2b-256 checksum
How to use checksums
b773eb6a8116f4feb0e99425b8a74f3de07905aece418f2344af54597aa6ea7c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Security for wp-sdk 1.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

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