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:

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

List of APIs

• Geta Batch
• Closea Batch
• Get Transactions Withina Batch

SDK Infrastructure

Configuration

• ProxySettings
• Environment-Based Client Initialization
• AbstractLogger
• LoggingConfiguration
• RequestLoggingConfiguration
• ResponseLoggingConfiguration

HTTP

• HttpResponse
• HttpRequest

Utilities

• ApiResponse
• ApiHelper
• HttpDateTime
• RFC3339DateTime
• UnixDateTime