Skip to main content

Getting Started with Batches

Introduction

A Batch represents a group of transactions that commence the funding process together. Batches have aggregate amount and count totals of all the transactions in the batch. Once a batch is closed all transactions assigned to that batch will be funded to the merchant. Once a batch is closed no more transactions can be added or removed from that batch. Transactions that are in a closed batch cannot be cancelled/reversed and must be refunded.

Install the Package

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

pip install apimatic-gp-sdk==0.0.1

You can also view the package at: https://pypi.python.org/pypi/apimatic-gp-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:

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

The API client can be initialized as follows:

Code-Based Client Initialization

import logging

from batches.batches_client import BatchesClient
from batches.configuration import Environment
from batches.logging.configuration.api_logging_configuration import LoggingConfiguration
from batches.logging.configuration.api_logging_configuration import RequestLoggingConfiguration
from batches.logging.configuration.api_logging_configuration import ResponseLoggingConfiguration

client = BatchesClient(
    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 batches.batches_client import BatchesClient

# Specify the path to your .env file if it’s located outside the project’s root directory.
client = BatchesClient.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 Sandbox Environment
ENVIRONMENT2 Production Environment

List of APIs

SDK Infrastructure

Configuration

HTTP

Utilities

Metadata

Release files for apimatic-gp-sdk 0.0.1

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

Source distribution (sdist)

Source distribution for apimatic-gp-sdk 0.0.1
File Size Uploaded Provenance Actions
apimatic_gp_sdk-0.0.1.tar.gz 41.4 kB Without provenance Details for apimatic_gp_sdk-0.0.1.tar.gz

Built distribution (wheel)

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

Total release size: 154.3 kB

Release files / apimatic_gp_sdk-0.0.1.tar.gz

Download URL apimatic_gp_sdk-0.0.1.tar.gz
Size 41.4 kB
Tags Source
SHA-256 checksum
How to use checksums
f0c9c71c9f2e52f435e2f57198fe66d08ec871b1d830dce7d820fc2428754408
BLAKE2b-256 checksum
How to use checksums
91c7943cccbd6b58bc6e4c3a6fb255ed362fd3eafdd4fec9a18edbae3fe262a5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Release files / apimatic_gp_sdk-0.0.1-py3-none-any.whl

Download URL apimatic_gp_sdk-0.0.1-py3-none-any.whl
Size 112.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
5ed90a8238568c40da96a3870397e114c9f88cfea3dedae3d53374190002b2f3
BLAKE2b-256 checksum
How to use checksums
02f297bacaf09a761b3270296b51844589156b7efafae084bd3f59dcf4a4dc5d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Security for apimatic-gp-sdk 0.0.1

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

0.0.1 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