
# Getting Started with Visa Acceptance Merged Spec

## Introduction

All Visa Acceptance API specs merged together. These are available at https://developer.visaacceptance.com/api/reference/api-reference.html

## Install the Package

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

```bash
pip install acceptance-api-sdk==0.0.1
```

You can also view the package at:
https://pypi.python.org/pypi/acceptance-api-sdk/0.0.1

## Initialize the API Client

**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/acceptance-api-python-sdk/tree/0.0.1/doc/client.md)

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. <br> **Default: 60** |
| max_retries | `int` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
| backoff_factor | `float` | A backoff factor to apply between attempts after the second try. <br> **Default: 2** |
| retry_statuses | `Array of int` | The http statuses on which retry is to be done. <br> **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. <br> **Default: ["GET", "PUT"]** |
| proxy_settings | [`ProxySettings`](https://www.github.com/sdks-io/acceptance-api-python-sdk/tree/0.0.1/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
| logging_configuration | [`LoggingConfiguration`](https://www.github.com/sdks-io/acceptance-api-python-sdk/tree/0.0.1/doc/logging-configuration.md) | The SDK logging configuration for API calls |
| bearer_auth_credentials | [`BearerAuthCredentials`](https://www.github.com/sdks-io/acceptance-api-python-sdk/tree/0.0.1/doc/auth/custom-header-signature.md) | The credential object for Custom Header Signature |
| accept_credentials | [`AcceptCredentials`](https://www.github.com/sdks-io/acceptance-api-python-sdk/tree/0.0.1/doc/auth/custom-header-signature-1.md) | The credential object for Custom Header Signature |

The API client can be initialized as follows:

### Code-Based Client Initialization

```python
import logging

from visaacceptancemergedspec.configuration import Environment
from visaacceptancemergedspec.http.auth.accept import AcceptCredentials
from visaacceptancemergedspec.http.auth.bearer_auth import BearerAuthCredentials
from visaacceptancemergedspec.logging.configuration.api_logging_configuration import LoggingConfiguration
from visaacceptancemergedspec.logging.configuration.api_logging_configuration import RequestLoggingConfiguration
from visaacceptancemergedspec.logging.configuration.api_logging_configuration import ResponseLoggingConfiguration
from visaacceptancemergedspec.visaacceptancemergedspec_client import VisaacceptancemergedspecClient

client = VisaacceptancemergedspecClient(
    bearer_auth_credentials=BearerAuthCredentials(
        authorization='authorization'
    ),
    accept_credentials=AcceptCredentials(
        accept='Accept'
    ),
    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

```python
from visaacceptancemergedspec.visaacceptancemergedspec_client import VisaacceptancemergedspecClient

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

See the [Environment-Based Client Initialization](https://www.github.com/sdks-io/acceptance-api-python-sdk/tree/0.0.1/doc/environment-based-client-initialization.md) section for details.

## Authorization

This API uses the following authentication schemes.

* [`BearerAuth (Custom Header Signature)`](https://www.github.com/sdks-io/acceptance-api-python-sdk/tree/0.0.1/doc/auth/custom-header-signature.md)
* [`Accept (Custom Header Signature)`](https://www.github.com/sdks-io/acceptance-api-python-sdk/tree/0.0.1/doc/auth/custom-header-signature-1.md)

## List of APIs

* [Customer Shipping Address](https://www.github.com/sdks-io/acceptance-api-python-sdk/tree/0.0.1/doc/controllers/customer-shipping-address.md)
* [Customer Payment Instrument](https://www.github.com/sdks-io/acceptance-api-python-sdk/tree/0.0.1/doc/controllers/customer-payment-instrument.md)
* [Payment Instrument](https://www.github.com/sdks-io/acceptance-api-python-sdk/tree/0.0.1/doc/controllers/payment-instrument.md)
* [Instrument Identifier](https://www.github.com/sdks-io/acceptance-api-python-sdk/tree/0.0.1/doc/controllers/instrument-identifier.md)
* [Unified Checkout Capture Context](https://www.github.com/sdks-io/acceptance-api-python-sdk/tree/0.0.1/doc/controllers/unified-checkout-capture-context.md)
* [Transient Token Data](https://www.github.com/sdks-io/acceptance-api-python-sdk/tree/0.0.1/doc/controllers/transient-token-data.md)
* [Tokenized Card](https://www.github.com/sdks-io/acceptance-api-python-sdk/tree/0.0.1/doc/controllers/tokenized-card.md)
* [Payments](https://www.github.com/sdks-io/acceptance-api-python-sdk/tree/0.0.1/doc/controllers/payments.md)
* [Capture](https://www.github.com/sdks-io/acceptance-api-python-sdk/tree/0.0.1/doc/controllers/capture.md)
* [Reversal](https://www.github.com/sdks-io/acceptance-api-python-sdk/tree/0.0.1/doc/controllers/reversal.md)
* [Refund](https://www.github.com/sdks-io/acceptance-api-python-sdk/tree/0.0.1/doc/controllers/refund.md)
* [Credit](https://www.github.com/sdks-io/acceptance-api-python-sdk/tree/0.0.1/doc/controllers/credit.md)
* [Void](https://www.github.com/sdks-io/acceptance-api-python-sdk/tree/0.0.1/doc/controllers/void.md)
* [Transaction Batches](https://www.github.com/sdks-io/acceptance-api-python-sdk/tree/0.0.1/doc/controllers/transaction-batches.md)
* [Billing Agreements](https://www.github.com/sdks-io/acceptance-api-python-sdk/tree/0.0.1/doc/controllers/billing-agreements.md)
* [Orders](https://www.github.com/sdks-io/acceptance-api-python-sdk/tree/0.0.1/doc/controllers/orders.md)
* [Payment-Tokens](https://www.github.com/sdks-io/acceptance-api-python-sdk/tree/0.0.1/doc/controllers/payment-tokens.md)
* [Customer](https://www.github.com/sdks-io/acceptance-api-python-sdk/tree/0.0.1/doc/controllers/customer.md)
* [Token](https://www.github.com/sdks-io/acceptance-api-python-sdk/tree/0.0.1/doc/controllers/token.md)
* [Transaction Details](https://www.github.com/sdks-io/acceptance-api-python-sdk/tree/0.0.1/doc/controllers/transaction-details.md)

## SDK Infrastructure

### Configuration

* [ProxySettings](https://www.github.com/sdks-io/acceptance-api-python-sdk/tree/0.0.1/doc/proxy-settings.md)
* [Environment-Based Client Initialization](https://www.github.com/sdks-io/acceptance-api-python-sdk/tree/0.0.1/doc/environment-based-client-initialization.md)
* [AbstractLogger](https://www.github.com/sdks-io/acceptance-api-python-sdk/tree/0.0.1/doc/abstract-logger.md)
* [LoggingConfiguration](https://www.github.com/sdks-io/acceptance-api-python-sdk/tree/0.0.1/doc/logging-configuration.md)
* [RequestLoggingConfiguration](https://www.github.com/sdks-io/acceptance-api-python-sdk/tree/0.0.1/doc/request-logging-configuration.md)
* [ResponseLoggingConfiguration](https://www.github.com/sdks-io/acceptance-api-python-sdk/tree/0.0.1/doc/response-logging-configuration.md)

### HTTP

* [HttpResponse](https://www.github.com/sdks-io/acceptance-api-python-sdk/tree/0.0.1/doc/http-response.md)
* [HttpRequest](https://www.github.com/sdks-io/acceptance-api-python-sdk/tree/0.0.1/doc/http-request.md)

### Utilities

* [ApiResponse](https://www.github.com/sdks-io/acceptance-api-python-sdk/tree/0.0.1/doc/api-response.md)
* [ApiHelper](https://www.github.com/sdks-io/acceptance-api-python-sdk/tree/0.0.1/doc/api-helper.md)
* [HttpDateTime](https://www.github.com/sdks-io/acceptance-api-python-sdk/tree/0.0.1/doc/http-date-time.md)
* [RFC3339DateTime](https://www.github.com/sdks-io/acceptance-api-python-sdk/tree/0.0.1/doc/rfc3339-date-time.md)
* [UnixDateTime](https://www.github.com/sdks-io/acceptance-api-python-sdk/tree/0.0.1/doc/unix-date-time.md)

