Ingenico Connect Python SDK

Introduction

The Python SDK helps you to communicate with the Ingenico Connect Server API. Its primary features are:

• convenient Python library for the API calls and responses
  • marshalls Python request objects to HTTP requests
  • unmarshalls HTTP responses to Python response objects or Python exceptions
• handling of all the details concerning authentication
• handling of required meta data

Its use is demonstrated by an example for each possible call. The examples execute a call using the provided API keys.

See the Ingenico Connect Developer Hub for more information on how to use the SDK.

Structure of this repository

This repository consists out of four main components:

1. The source code of the SDK itself: /ingenico/connect/sdk/
2. The source code of the SDK unit tests: /tests/unit/
3. The source code of the SDK integration tests: /tests/integration/
4. Usage examples: /examples/

Note that the source code of the unit tests and integration tests and the examples can only be found on GitHub.

Requirements

Python 2.7 is required. In addition, the following packages are required:

• requests 2.25.0 or higher
• requests-toolbelt 0.8.0 or higher

These packages will be installed automatically if the SDK is installed manually or using pip following the below instructions.

Installation

To install the SDK using pip, execute the following command:

pip install connect-sdk-python2

Alternatively, you can install the SDK from a source distribution file:

1. Download the latest version of the Python SDK from GitHub. Choose the connect-sdk-python2-x.y.z.zip file from the releases page, where x.y.z is the version number.

2. Execute the following command in the folder where the SDK was downloaded to:

   pip install connect-sdk-python2-x.y.z.zip
   

Uninstalling

After the Python SDK has been installed, it can be uninstalled using the following command:

pip uninstall connect-sdk-python2

The required packages can be uninstalled in the same way.

Running tests

There are two types of tests: unit tests and integration tests. The unit tests will work out-of-the-box; for the integration tests some configuration is required. First, some environment variables need to be set:

• connect.api.apiKeyId for the API key id to use. This can be retrieved from the Configuration Center.
• connect.api.secretApiKey for the secret API key to use. This can be retrieved from the Configuration Center.
• connect.api.merchantId for your merchant ID.

In addition, to run the proxy integration tests, the proxy URI, username and password should be set in the tests/resources/configuration.proxy.ini file.

In order to run the unit and integration tests, the mock backport and mockito are required. These can be installed using the following command:

pip install mock 'mockito<1.3.1'

The following commands can now be executed from the tests directory to execute the tests:

• Unit tests:

  python run_unit_tests.py
  

• Integration tests:

  python run_integration_tests.py
  

• Both unit and integration tests:

  python run_all_tests.py
  

Note: in the current version of the unit tests, two errors will pop up ([Errno 10053] for Windows and [Errno 32] for Linux), indicating that there was a client disconnect. These errors occur during cleanup of the tests and do not hinder the tests in any way, and should therefore be ignored.

API Reference

exception ingenico.connect.sdk.api_exception.ApiException(status_code, response_body, error_id, errors, message='the Ingenico ePayments platform returned an error response')

Bases: exceptions.RuntimeError

Represents an error response from the Ingenico ePayments platform which contains an ID and a list of errors.

error_id

Returns:The error ID received from the Ingenico ePayments platform if available.

errors

Returns:The error list received from the Ingenico ePayments platform if available. Never None.

response_body

Returns:The raw response body that was returned by the Ingenico ePayments platform.

status_code

Returns:The HTTP status code that was returned by the Ingenico ePayments platform.

class ingenico.connect.sdk.api_resource.ApiResource(arg, path_context, client_meta_info=None)

Bases: object

Base class of all Ingenico ePayments platform API resources.

__init__(arg, path_context, client_meta_info=None)

Parameters:arg – communicator or parent

class ingenico.connect.sdk.authenticator.Authenticator

Used to sign requests to the Ingenico ePayments platform.

create_simple_authentication_signature(http_method, resource_uri, request_headers)

Creates a signature for the simple security model.

Parameters:

• http_method – The HTTP method.
• resource_uri – The URI of the resource.
• request_headers – A sequence of RequestHeaders. This sequence may not be modified and may not contain headers with the same name.

exception ingenico.connect.sdk.authorization_exception.AuthorizationException(status_code, response_body, error_id, errors, message='the Ingenico ePayments platform returned an authorization error response')

Bases: ingenico.connect.sdk.api_exception.ApiException

Represents an error response from the Ingenico ePayments platform when authorization failed.

class ingenico.connect.sdk.call_context.CallContext(idempotence_key=None)

A call context can be used to send extra information with a request, and to receive extra information from a response.

Please note that this class is not thread-safe. Each request should get its own call context instance.

__init__(idempotence_key=None)

Sets the idempotence key to use for the next request for which this call context is used.

idempotence_key

Returns:The idempotence key.

idempotence_request_timestamp

Returns:The idempotence request timestamp from the response to the last request for which this call context was used, or None if no idempotence request timestamp was present.

class ingenico.connect.sdk.client.Client(communicator, client_meta_info=None)

Bases: ingenico.connect.sdk.api_resource.ApiResource, ingenico.connect.sdk.log.logging_capable.LoggingCapable, ingenico.connect.sdk.log.obfuscation_capable.ObfuscationCapable

Ingenico ePayments platform client.

This client and all its child clients are bound to one specific value for the X-GCS-ClientMetaInfo header. To get a new client with a different header value, use with_client_meta_info.

Thread-safe.

static API_VERSION()

__abstractmethods__ = frozenset([])

__enter__()

__exit__(exc_type, exc_val, exc_tb)

__init__(communicator, client_meta_info=None)

Parameters:

• communicator – ingenico.connect.sdk.communicator.Communicator
• client_meta_info – str

close()

Releases any system resources associated with this object.

close_expired_connections()

Utility method that delegates the call to this client’s communicator.

close_idle_connections(idle_time)

Utility method that delegates the call to this client’s communicator.

Parameters:idle_time – a datetime.timedelta object indicating the idle time

disable_logging()

Turns off logging.

enable_logging(communicator_logger)

Turns on logging using the given communicator logger.

Raise:ValueError If the given communicator logger is None.

merchant(merchant_id)

Resource /{merchantId}

Parameters:merchant_id – str Returns:ingenico.connect.sdk.merchant.merchant_client.MerchantClient

set_body_obfuscator(body_obfuscator)

Sets the current body obfuscator to use.

set_header_obfuscator(header_obfuscator)

Sets the current header obfuscator to use.

with_client_meta_info(client_meta_info)

Parameters:client_meta_info – JSON string containing the meta data for the client Returns:a new Client which uses the passed meta data for the X-GCS-ClientMetaInfo header. Raise:MarshallerSyntaxException if the given clientMetaInfo is not a valid JSON string

exception ingenico.connect.sdk.communication_exception.CommunicationException(exception)

Bases: exceptions.RuntimeError

Indicates an exception regarding the communication with the Ingenico ePayments platform such as a connection exception.

class ingenico.connect.sdk.communicator.Communicator(session, marshaller)

Bases: ingenico.connect.sdk.log.logging_capable.LoggingCapable, ingenico.connect.sdk.log.obfuscation_capable.ObfuscationCapable

Used to communicate with the Ingenico ePayments platform web services.

It contains all the logic to transform a request object to an HTTP request and an HTTP response to a response object.

__abstractmethods__ = frozenset([])

__enter__()

__exit__(exc_type, exc_val, exc_tb)

close()

Releases any system resources associated with this object.

close_expired_connections()

Utility method that delegates the call to this communicator’s session’s connection if that’s an instance of PooledConnection. If not this method does nothing.

close_idle_connections(idle_time)

Utility method that delegates the call to this communicator’s session’s connection if that’s an instance of PooledConnection. If not this method does nothing.

Parameters:idle_time – a datetime.timedelta object indicating the idle time

delete(relative_path, request_headers, request_parameters, response_type, context)

Corresponds to the HTTP DELETE method.

Parameters:

• relative_path – The path to call, relative to the base URI.
• request_headers – An optional list of request headers.
• request_parameters – An optional set of request parameters.
• response_type – The type of response to return.
• context – The optional call context to use.

Raise:

CommunicationException when an exception occurred communicating with the Ingenico ePayments platform

Raise:

ResponseException when an error response was received from the Ingenico ePayments platform

Raise:

ApiException when an error response was received from the Ingenico ePayments platform which contained a list of errors

delete_with_binary_response(relative_path, request_headers, request_parameters, context)

Corresponds to the HTTP DELETE method.

Parameters:

• relative_path – The path to call, relative to the base URI.
• request_headers – An optional list of request headers.
• request_parameters – An optional set of request parameters.
• context – The optional call context to use.

Raise:

CommunicationException when an exception occurred communicating with the Ingenico ePayments platform

Raise:

ResponseException when an error response was received from the Ingenico ePayments platform

Raise:

ApiException when an error response was received from the Ingenico ePayments platform which contained a list of errors

disable_logging()

Turns off logging.

enable_logging(communicator_logger)

Turns on logging using the given communicator logger.

Raise:ValueError If the given communicator logger is None.

get(relative_path, request_headers, request_parameters, response_type, context)

Corresponds to the HTTP GET method.

Parameters:

• relative_path – The path to call, relative to the base URI.
• request_headers – An optional list of request headers.
• request_parameters – An optional set of request parameters.
• response_type – The type of response to return.
• context – The optional call context to use.

Raise:

CommunicationException when an exception occurred communicating with the Ingenico ePayments platform

Raise:

ResponseException when an error response was received from the Ingenico ePayments platform

Raise:

ApiException when an error response was received from the Ingenico ePayments platform which contained a list of errors

get_with_binary_response(relative_path, request_headers, request_parameters, context)

Corresponds to the HTTP GET method.

Parameters:

• relative_path – The path to call, relative to the base URI.
• request_headers – An optional list of request headers.
• request_parameters – An optional set of request parameters.
• context – The optional call context to use.

Raise:

CommunicationException when an exception occurred communicating with the Ingenico ePayments platform

Raise:

ResponseException when an error response was received from the Ingenico ePayments platform

Raise:

ApiException when an error response was received from the Ingenico ePayments platform which contained a list of errors

marshaller

Returns:The Marshaller object associated with this communicator. Never None.

post(relative_path, request_headers, request_parameters, request_body, response_type, context)

Corresponds to the HTTP POST method.

Parameters:

• relative_path – The path to call, relative to the base URI.
• request_headers – An optional list of request headers.
• request_parameters – An optional set of request parameters.
• request_body – The optional request body to send.
• response_type – The type of response to return.
• context – The optional call context to use.

Raise:

CommunicationException when an exception occurred communicating with the Ingenico ePayments platform

Raise:

ResponseException when an error response was received from the Ingenico ePayments platform

Raise:

ApiException when an error response was received from the Ingenico ePayments platform which contained a list of errors

post_with_binary_response(relative_path, request_headers, request_parameters, request_body, context)

Corresponds to the HTTP POST method.

Parameters:

• relative_path – The path to call, relative to the base URI.
• request_headers – An optional list of request headers.
• request_parameters – An optional set of request parameters.
• request_body – The optional request body to send.
• context – The optional call context to use.

Raise:

CommunicationException when an exception occurred communicating with the Ingenico ePayments platform

Raise:

ResponseException when an error response was received from the Ingenico ePayments platform

Raise:

ApiException when an error response was received from the Ingenico ePayments platform which contained a list of errors

put(relative_path, request_headers, request_parameters, request_body, response_type, context)

Corresponds to the HTTP PUT method.

Parameters:

• relative_path – The path to call, relative to the base URI.
• request_headers – An optional list of request headers.
• request_parameters – An optional set of request parameters.
• request_body – The optional request body to send.
• response_type – The type of response to return.
• context – The optional call context to use.

Raise:

CommunicationException when an exception occurred communicating with the Ingenico ePayments platform

Raise:

ResponseException when an error response was received from the Ingenico ePayments platform

Raise:

ApiException when an error response was received from the Ingenico ePayments platform which contained a list of errors

put_with_binary_response(relative_path, request_headers, request_parameters, request_body, context)

Corresponds to the HTTP PUT method.

Parameters:

• relative_path – The path to call, relative to the base URI.
• request_headers – An optional list of request headers.
• request_parameters – An optional set of request parameters.
• request_body – The optional request body to send.
• context – The optional call context to use.

Raise:

CommunicationException when an exception occurred communicating with the Ingenico ePayments platform

Raise:

ResponseException when an error response was received from the Ingenico ePayments platform

Raise:

ApiException when an error response was received from the Ingenico ePayments platform which contained a list of errors

set_body_obfuscator(body_obfuscator)

Sets the current body obfuscator to use.

set_header_obfuscator(header_obfuscator)

Sets the current header obfuscator to use.

class ingenico.connect.sdk.communicator_configuration.CommunicatorConfiguration(properties=None, api_endpoint=False, api_key_id=False, secret_api_key=False, authorization_type=False, connect_timeout=False, socket_timeout=False, max_connections=False, proxy_configuration=False, integrator=False, shopping_cart_extension=False)

Bases: ingenico.connect.sdk.endpoint_configuration.EndpointConfiguration

Configuration for the communicator.

Parameters:

• properties – a ConfigParser.ConfigParser object containing configuration data
• connect_timeout – connection timeout for the network communication in seconds
• socket_timeout – socket timeout for the network communication in seconds
• max_connections – The maximum number of connections in the connection pool

api_endpoint

The Ingenico ePayments platform API endpoint URI.

api_key_id

An identifier for the secret API key. The api_key_id can be retrieved from the Configuration Center. This identifier is visible in the HTTP request and is also used to identify the correct account.

authorization_type

secret_api_key

A shared secret. The shared secret can be retrieved from the Configuration Center. An api_key_id and secret_api_key always go hand-in-hand, the difference is that secret_api_key is never visible in the HTTP request. This secret is used as input for the HMAC algorithm.

class ingenico.connect.sdk.connection.Connection

Bases: ingenico.connect.sdk.log.logging_capable.LoggingCapable

Represents a connection to the Ingenico ePayments platform server.

close()

Releases any system resources associated with this object.

delete(url, request_headers)

Send a DELETE request to the Ingenico ePayments platform and return the response.

Parameters:

• url – The URI to call, including any necessary query parameters.
• request_headers – An optional sequence of request headers.

Returns:

The response from the Ingenico ePayments platform as a tuple with the status code, headers and a generator of body chunks

Raise:

CommunicationException when an exception occurred communicating with the Ingenico ePayments platform

get(url, request_headers)

Send a GET request to the Ingenico ePayments platform and return the response.

Parameters:

• url – The URI to call, including any necessary query parameters.
• request_headers – An optional sequence of request headers.

Returns:

The response from the Ingenico ePayments platform as a tuple with the status code, headers and a generator of body chunks

Raise:

CommunicationException when an exception occurred communicating with the Ingenico ePayments platform

post(url, request_headers, body)

Send a POST request to the Ingenico ePayments platform and return the response.

Parameters:

• url – The URI to call, including any necessary query parameters.
• request_headers – An optional sequence of request headers.
• body – The optional body to send.

Returns:

The response from the Ingenico ePayments platform as a tuple with the status code, headers and a generator of body chunks

Raise:

CommunicationException when an exception occurred communicating with the Ingenico ePayments platform

put(url, request_headers, body)

Send a PUT request to the Ingenico ePayments platform and return the response.

Parameters:

• url – The URI to call, including any necessary query parameters.
• request_headers – An optional sequence of request headers.
• body – The optional body to send.

Returns:

The response from the Ingenico ePayments platform as a tuple with the status code, headers and a generator of body chunks

Raise:

CommunicationException when an exception occurred communicating with the Ingenico ePayments platform

class ingenico.connect.sdk.data_object.DataObject

Bases: object

from_dictionary(dictionary)

to_dictionary()

exception ingenico.connect.sdk.declined_payment_exception.DeclinedPaymentException(status_code, response_body, errors)

Bases: ingenico.connect.sdk.declined_transaction_exception.DeclinedTransactionException

Represents an error response from a create payment call.

create_payment_result

Returns:The result of creating a payment if available, otherwise None.

exception ingenico.connect.sdk.declined_payout_exception.DeclinedPayoutException(status_code, response_body, errors)

Bases: ingenico.connect.sdk.declined_transaction_exception.DeclinedTransactionException

Represents an error response from a payout call.

payout_result

Returns:The result of creating a payout if available, otherwise None.

exception ingenico.connect.sdk.declined_refund_exception.DeclinedRefundException(status_code, response_body, errors)

Bases: ingenico.connect.sdk.declined_transaction_exception.DeclinedTransactionException

Represents an error response from a refund call.

refund_result

Returns:The result of creating a refund if available, otherwise None.

exception ingenico.connect.sdk.declined_transaction_exception.DeclinedTransactionException(status_code, response_body, error_id, errors, message=False)

Bases: ingenico.connect.sdk.api_exception.ApiException

Represents an error response from a create payment, payout or refund call.

class ingenico.connect.sdk.endpoint_configuration.EndpointConfiguration(properties=None, prefix=None)

Bases: object

Base class for endpoint configurations.

DEFAULT_MAX_CONNECTIONS = 10

connect_timeout

Connection timeout for the underlying network communication in seconds

integrator

max_connections

proxy_configuration

shopping_cart_extension

socket_timeout

Socket timeout for the underlying network communication in seconds

class ingenico.connect.sdk.factory.Factory

Ingenico ePayments platform factory for several SDK components.

static create_client_from_communicator(communicator)

Create a Client based on the settings stored in the Communicator argument

static create_client_from_configuration(communicator_configuration)

Create a Client based on the configuration stored in the CommunicatorConfiguration argument

static create_client_from_file(configuration_file_name, api_key_id, secret_api_key)

Creates a Client based on the configuration values in configuration_file_name, api_key_id and secret_api_key.

static create_client_from_session(session)

Create a Client based on the settings stored in the Session argument

static create_communicator_from_configuration(communicator_configuration)

Create a Communicator based on the configuration stored in the CommunicatorConfiguration argument

static create_communicator_from_file(configuration_file_name, api_key_id, secret_api_key)

Creates a Communicator based on the configuration values in configuration_file_name, api_key_id and secret_api_key.

static create_communicator_from_session(session)

Create a Communicator based on the settings stored in the Session argument

static create_configuration(configuration_file_name, api_key_id, secret_api_key)

Creates a CommunicatorConfiguration based on the configuration values in configuration_file_name, api_key_id and secret_api_key.

static create_session_from_configuration(communicator_configuration, meta_data_provider=None, connection=None, authenticator=None)

Creates a Session based on the configuration stored in the CommunicatorConfiguration argument

static create_session_from_file(configuration_file_name, api_key_id, secret_api_key, meta_data_provider=None, connection=None, authenticator=None)

Creates a Session based on the configuration values in configuration_file_name, api_id_key and secret_api_key.

exception ingenico.connect.sdk.global_collect_exception.GlobalCollectException(status_code, response_body, error_id, errors, message='the Ingenico ePayments platform returned an error response')

Bases: ingenico.connect.sdk.api_exception.ApiException

Represents an error response from the Ingenico ePayments platform when something went wrong at the Ingenico ePayments platform or further downstream.

exception ingenico.connect.sdk.idempotence_exception.IdempotenceException(idempotence_key, idempotence_request_timestamp, status_code, response_body, error_id, errors, message='the Ingenico ePayments platform returned a duplicate request error response')

Bases: ingenico.connect.sdk.api_exception.ApiException

Represents an error response from the Ingenico ePayments platform when an idempotent request failed because the first request has not finished yet.

idempotence_key

Returns:The key that was used for the idempotent request.

idempotence_request_timestamp

Returns:The request timestamp of the first idempotent request with the same key.

class ingenico.connect.sdk.marshaller.Marshaller

Bases: object

Used to marshal and unmarshal Ingenico ePayments platform request and response objects to and from JSON.

marshal(request_object)

Marshal a request object to a JSON string.

Parameters:request_object – the object to marshal into a serialized JSON string Returns:the serialized JSON string of the request_object

unmarshal(response_json, type_class)

Unmarshal a JSON string to a response object.

Parameters:

• response_json – the json body that should be unmarshalled
• type_class – The class to which the response_json should be unmarshalled

Raise:

MarshallerSyntaxException if the JSON is not a valid representation for an object of the given type

exception ingenico.connect.sdk.marshaller_syntax_exception.MarshallerSyntaxException(cause=False)

Bases: exceptions.RuntimeError

Thrown when a JSON string cannot be converted to a response object.

class ingenico.connect.sdk.meta_data_provider.MetaDataProvider(integrator, shopping_cart_extension=None, additional_request_headers=())

Provides meta info about the server.

meta_data_headers

Returns:The server related headers containing the META data to be associated with the request (if any). This will always contain at least an automatically generated header X-GCS-ServerMetaInfo.

prohibited_headers = ('Authorization', 'Content-Type', 'Date', 'X-GCS-Idempotence-Key', 'X-GCS-ServerMetaInfo')

class ingenico.connect.sdk.multipart_form_data_object.MultipartFormDataObject

A representation of a multipart/form-data object.

add_file(parameter_name, uploadable_file)

add_value(parameter_name, value)

boundary

content_type

files

values

class ingenico.connect.sdk.multipart_form_data_request.MultipartFormDataRequest

A representation of a multipart/form-data request.

to_multipart_form_data_object()

Returns:ingenico.connect.sdk.MultipartFormDataObject

exception ingenico.connect.sdk.not_found_exception.NotFoundException(exception, message=None)

Bases: exceptions.RuntimeError

Indicates an exception that occurs when the requested resource is not found. In normal usage of the SDK, this exception should not occur, however it is possible. For example when path parameters are set with invalid values.

class ingenico.connect.sdk.param_request.ParamRequest

Bases: object

Represents a set of request parameters.

to_request_parameters()

Returns:list[ingenico.connect.sdk.RequestParam] representing the HTTP request parameters

class ingenico.connect.sdk.pooled_connection.PooledConnection

Bases: ingenico.connect.sdk.connection.Connection

Represents a pooled connection to the Ingenico ePayments platform server. Instead of setting up a new HTTP connection for each request, this connection uses a pool of HTTP connections.

close_expired_connections()

Closes all expired HTTP connections.

close_idle_connections(idle_time)

Closes all HTTP connections that have been idle for the specified time. This should also include all expired HTTP connections.

Parameters:idle_time – a datetime.timedelta object indicating the idle time

class ingenico.connect.sdk.proxy_configuration.ProxyConfiguration(host, port, scheme='http', username=None, password=None)

HTTP proxy configuration.

Can be initialised directly from a host and port or can be constructed from a uri using fromuri

__str__()

Return a proxy string in the form scheme://username:password@host:port or scheme://host:port if authentication is absent

Supports HTTP Basic Auth

static from_uri(uri, username=None, password=None)

Constructs a ProxyConfiguration from a URI; if username and/or password are given they will be used instead of corresponding data in the URI

host

password

port

scheme

username

exception ingenico.connect.sdk.reference_exception.ReferenceException(status_code, response_body, error_id, errors, message='the Ingenico ePayments platform returned a reference error response')

Bases: ingenico.connect.sdk.api_exception.ApiException

Represents an error response from the Ingenico ePayments platform when a non-existing or removed object is trying to be accessed.

class ingenico.connect.sdk.request_header.RequestHeader(name, value)

A single request header. Immutable.

name

Returns:The header name.

value

Returns:The un-encoded value.

ingenico.connect.sdk.request_header.get_header(headers, header_name)

Returns:The header with the given name, or None if there was no such header.

ingenico.connect.sdk.request_header.get_header_value(headers, header_name)

Returns:The value of the header with the given name, or None if there was no such header.

class ingenico.connect.sdk.request_param.RequestParam(name, value)

Bases: object

A single request parameter. Immutable.

name

Returns:The parameter name.

value

Returns:The un-encoded value.

exception ingenico.connect.sdk.response_exception.ResponseException(status, body, headers)

Bases: exceptions.RuntimeError

Thrown when a response was received from the Ingenico ePayments platform which indicates an error.

body

Returns:The raw response body that was returned by the Ingenico ePayments platform.

get_header(header_name)

Returns:The header with the given name, or None if there was no such header.

get_header_value(header_name)

Returns:The value header with the given name, or None if there was no such header.

headers

Returns:The headers that were returned by the Ingenico ePayments platform. Never None.

status_code

Returns:The HTTP status code that was returned by the Ingenico ePayments platform.

ingenico.connect.sdk.response_header.get_disposition_filename(headers)

Returns:The value of the filename parameter of the Content-Disposition header, or None if there was no such header or parameter.

ingenico.connect.sdk.response_header.get_header(headers, header_name)

Returns:The header with the given name as a tuple with the name and value, or None if there was no such header.

ingenico.connect.sdk.response_header.get_header_value(headers, header_name)

Returns:The value of the header with the given name, or None if there was no such header.

class ingenico.connect.sdk.session.Session(api_endpoint, connection, authenticator, meta_data_provider)

Bases: object

Contains the components needed to communicate with the Ingenico ePayments platform.

Parameters:api_endpoint – the address of the target server as a string or ParseResult object

api_endpoint

Returns:The Ingenico ePayments platform API endpoint URI. This URI’s path will be None or empty.

authenticator

Returns:The Authenticator object associated with this session. Never None.

connection

Returns:The Connection object associated with this session. Never None.

meta_data_provider

Returns:The MetaDataProvider object associated with this session. Never None.

class ingenico.connect.sdk.uploadable_file.UploadableFile(file_name, content, content_type, content_length=-1)

A file that can be uploaded.

The allowed forms of content are defined by the Connection implementation. The default implementation supports strings, file descriptors and io.BytesIO objects.

content

Returns:The file’s content.

content_length

Returns:The file’s content length, or -1 if not known.

content_type

Returns:The file’s content type.

file_name

Returns:The name of the file.

exception ingenico.connect.sdk.validation_exception.ValidationException(status_code, response_body, error_id, errors, message='the Ingenico ePayments platform returned an incorrect request error response')

Bases: ingenico.connect.sdk.api_exception.ApiException

Represents an error response from the Ingenico ePayments platform when validation of requests failed.

class ingenico.connect.sdk.defaultimpl.authorization_type.AuthorizationType

AUTHORIZATION_TYPES = ['v1HMAC']

V1HMAC = 'v1HMAC'

static get_authorization(name)

class ingenico.connect.sdk.defaultimpl.default_authenticator.DefaultAuthenticator(authorization_type, api_id_key, secret_api_key)

Bases: ingenico.connect.sdk.authenticator.Authenticator

Default Authenticator implementation.

__init__(authorization_type, api_id_key, secret_api_key)

Parameters:

• authorization_type – Based on this value both the Ingenico ePayments platform and the merchant know which security implementation is used. A version number is used for backward compatibility in the future.
• api_id_key – An identifier for the secret API key. The api_key_id can be retrieved from the Configuration Center. This identifier is visible in the HTTP request and is also used to identify the correct account.
• secret_api_key – A shared secret. The shared secret can be retrieved from the Configuration Center. An api_key_id and secret_api_key always go hand-in-hand, the difference is that secret_api_key is never visible in the HTTP request. This secret is used as input for the HMAC algorithm.

create_authentication_signature(data_to_sign)

create_simple_authentication_signature(http_method, resource_uri, http_headers)

Returns a v1HMAC authentication signature header

to_canonicalize_header_value(original_value)

to_data_to_sign(http_method, resource_uri, http_headers)

class ingenico.connect.sdk.defaultimpl.default_connection.DefaultConnection(connect_timeout, socket_timeout, max_connections=10, proxy_configuration=None)

Bases: ingenico.connect.sdk.pooled_connection.PooledConnection, ingenico.connect.sdk.log.obfuscation_capable.ObfuscationCapable

Provides an HTTP request interface, thread-safe

Parameters:

• connect_timeout – timeout in seconds before a pending connection is dropped
• socket_timeout – timeout in seconds before dropping an established connection. This is the time the server is allowed for a response
• max_connections – the maximum number of connections in the connection pool
• proxy_configuration – ProxyConfiguration object that contains data about proxy settings if present. It should be writeable as string and have a scheme attribute.

Use the methods get, delete, post and put to perform the corresponding HTTP request. Alternatively you can use request with the request method as the first parameter.

URI, headers and body should be given on a per-request basis.

__abstractmethods__ = frozenset([])

__enter__()

__exit__(exc_type, exc_val, exc_tb)

close()

Explicitly closes the connection

close_expired_connections()

Closes all expired HTTP connections.

close_idle_connections(idle_time)

Parameters:idle_time – a datetime.timedelta object indicating the idle time

connect_timeout

Connection timeout in seconds

delete(url, request_headers)

Perform a request to the server given by url

Parameters:

• url – the url to the server, given as a parsed url
• request_headers – a sequence containing RequestHeader objects representing the request headers

disable_logging()

Turns off logging.

enable_logging(communicator_logger)

Turns on logging using the given communicator logger.

Raise:ValueError If the given communicator logger is None.

get(url, request_headers)

Perform a request to the server given by url

Parameters:

• url – the url to the server, given as a parsed url
• request_headers – a sequence containing RequestHeader objects representing the request headers

post(url, request_headers, body)

Perform a request to the server given by url

Parameters:

• url – the url to the server, given as a parsed url
• request_headers – a sequence containing RequestHeader objects representing the request headers
• body – the request body

put(url, request_headers, body)

Perform a request to the server given by url

Parameters:

• url – the url to the server, given as a parsed url
• request_headers – a sequence containing RequestHeader objects representing the request headers
• body – the request body

set_body_obfuscator(body_obfuscator)

Sets the current body obfuscator to use.

set_header_obfuscator(header_obfuscator)

Sets the current header obfuscator to use.

socket_timeout

Socket timeout in seconds

class ingenico.connect.sdk.defaultimpl.default_marshaller.DefaultMarshaller

Bases: ingenico.connect.sdk.marshaller.Marshaller

Marshaller implementation based on json.

static INSTANCE()

marshal(request_object)

Marshal a request object to a JSON string.

Parameters:request_object – the object to marshal into a serialized JSON string Returns:the serialized JSON string of the request_object

unmarshal(response_json, type_class)

Unmarshal a JSON string to a response object.

Parameters:

• response_json – the json body that should be unmarshalled
• type_class – The class to which the response_json should be unmarshalled

Raise:

MarshallerSyntaxException if the JSON is not a valid representation for an object of the given type

class ingenico.connect.sdk.domain.capture.capture_response.CaptureResponse

Bases: ingenico.connect.sdk.domain.capture.definitions.capture.Capture

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.capture.captures_response.CapturesResponse

Bases: ingenico.connect.sdk.data_object.DataObject

captures

The list of all captures performed on the requested payment.

Type: list[ingenico.connect.sdk.domain.capture.definitions.capture.Capture]

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.capture.definitions.capture.Capture

Bases: ingenico.connect.sdk.domain.definitions.abstract_order_status.AbstractOrderStatus

capture_output

Object containing capture details

Type: ingenico.connect.sdk.domain.capture.definitions.capture_output.CaptureOutput

from_dictionary(dictionary)

status

Current high-level status of the payment in a human-readable form. Possible values are :

• CAPTURE_REQUESTED - The transaction is in the queue to be captured.
• CAPTURED - The transaction has been captured and we have received online confirmation.
• CANCELLED - You have cancelled the transaction.
• REJECTED_CAPTURE - We or one of our downstream acquirers/providers have rejected the capture request.
• REVERSED - The transaction has been reversed.

Please see Statuses <https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/statuses.html> for a full overview of possible values.

Type: str

status_output

This object has the numeric representation of the current capture status, timestamp of last status change and performable action on the current payment resource.

In case of failed payments and negative scenarios, detailed error information is listed.

Type: ingenico.connect.sdk.domain.capture.definitions.capture_status_output.CaptureStatusOutput

to_dictionary()

class ingenico.connect.sdk.domain.capture.definitions.capture_output.CaptureOutput

Bases: ingenico.connect.sdk.domain.payment.definitions.order_output.OrderOutput

amount_paid

Amount that has been paid

Type: long

amount_reversed

Amount that has been reversed

Type: long

bank_transfer_payment_method_specific_output

Object containing the bank transfer payment method details

Type: ingenico.connect.sdk.domain.payment.definitions.bank_transfer_payment_method_specific_output.BankTransferPaymentMethodSpecificOutput

card_payment_method_specific_output

Object containing the card payment method details

Type: ingenico.connect.sdk.domain.payment.definitions.card_payment_method_specific_output.CardPaymentMethodSpecificOutput

cash_payment_method_specific_output

Object containing the cash payment method details

Type: ingenico.connect.sdk.domain.payment.definitions.cash_payment_method_specific_output.CashPaymentMethodSpecificOutput

direct_debit_payment_method_specific_output

Object containing the non SEPA direct debit payment method details

Type: ingenico.connect.sdk.domain.payment.definitions.non_sepa_direct_debit_payment_method_specific_output.NonSepaDirectDebitPaymentMethodSpecificOutput

e_invoice_payment_method_specific_output

Object containing the e-invoice payment method details

Type: ingenico.connect.sdk.domain.payment.definitions.e_invoice_payment_method_specific_output.EInvoicePaymentMethodSpecificOutput

from_dictionary(dictionary)

invoice_payment_method_specific_output

Object containing the invoice payment method details

Type: ingenico.connect.sdk.domain.payment.definitions.invoice_payment_method_specific_output.InvoicePaymentMethodSpecificOutput

mobile_payment_method_specific_output

Object containing the mobile payment method details

Type: ingenico.connect.sdk.domain.payment.definitions.mobile_payment_method_specific_output.MobilePaymentMethodSpecificOutput

payment_method

Payment method identifier used by the our payment engine with the following possible values:

• bankRefund
• bankTransfer
• card
• cash
• directDebit
• eInvoice
• invoice
• redirect

Type: str

redirect_payment_method_specific_output

Object containing the redirect payment product details

Type: ingenico.connect.sdk.domain.payment.definitions.redirect_payment_method_specific_output.RedirectPaymentMethodSpecificOutput

reversal_reason

The reason description given for the reversedAmount property.

Type: str

sepa_direct_debit_payment_method_specific_output

Object containing the SEPA direct debit details

Type: ingenico.connect.sdk.domain.payment.definitions.sepa_direct_debit_payment_method_specific_output.SepaDirectDebitPaymentMethodSpecificOutput

to_dictionary()

class ingenico.connect.sdk.domain.capture.definitions.capture_status_output.CaptureStatusOutput

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

is_retriable

Flag indicating whether a rejected payment may be retried by the merchant without incurring a fee

• true
• false

Type: bool

provider_raw_output

This is the raw response returned by the acquirer. This property contains unprocessed data directly returned by the acquirer. It’s recommended for data analysis only due to its dynamic nature, which may undergo future changes.

Type: list[ingenico.connect.sdk.domain.definitions.key_value_pair.KeyValuePair]

status_code

Numeric status code of the legacy API. It is returned to ease the migration from the legacy APIs to Worldline Connect. You should not write new business logic based on this property as it will be deprecated in a future version of the API. The value can also be found in the GlobalCollect Payment Console, in the Ogone BackOffice and in report files.

Type: int

to_dictionary()

class ingenico.connect.sdk.domain.definitions.abstract_order_status.AbstractOrderStatus

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

id

Every payment entity resource has an identifier or pointer associated with it. This id can be used to uniquely reach the resource.

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.definitions.abstract_payment_method_specific_input.AbstractPaymentMethodSpecificInput

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

payment_product_id

Payment product identifier

Please see payment products <https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/paymentproducts.html> for a full overview of possible values.

Type: int

to_dictionary()

class ingenico.connect.sdk.domain.definitions.additional_order_input_airline_data.AdditionalOrderInputAirlineData

Bases: ingenico.connect.sdk.data_object.DataObject

airline_data

Object that holds airline specific data

Type: ingenico.connect.sdk.domain.definitions.airline_data.AirlineData

from_dictionary(dictionary)

lodging_data

Object that holds lodging specific data

Type: ingenico.connect.sdk.domain.definitions.lodging_data.LodgingData

to_dictionary()

class ingenico.connect.sdk.domain.definitions.address.Address

Bases: ingenico.connect.sdk.data_object.DataObject

additional_info

Additional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform

Type: str

city

City

Note: For payments with product 1503 the maximum length is not 40 but 20.

Type: str

country_code

ISO 3166-1 alpha-2 country code

Type: str

from_dictionary(dictionary)

house_number

House number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform

Type: str

state

Full name of the state or province

Type: str

state_code

ISO 3166-2 alpha-3 state code

Notes:

• The maximum length for 3-D Secure version 2 is AN3 for payments that are processed by the GlobalCollect platform
• The maximum length for paymentProductId 1503 (Boleto) is AN2 for payments that are processed by the GlobalCollect platform
• The maximum length is 3 for payments that are processed by the WL Online Payment Acceptance platform

Type: str

street

Streetname

Type: str

to_dictionary()

zip

Zip code

Note: For payments with product 1503 the maximum length is not 10 but 8.

Type: str

class ingenico.connect.sdk.domain.definitions.airline_data.AirlineData

Bases: ingenico.connect.sdk.data_object.DataObject

agent_numeric_code

Numeric code identifying the agent

Type: str

code

Airline numeric code

Type: str

flight_date

Date of the Flight

Format: YYYYMMDD

Type: str

flight_legs

Object that holds the data on the individual legs of the ticket

Type: list[ingenico.connect.sdk.domain.definitions.airline_flight_leg.AirlineFlightLeg]

from_dictionary(dictionary)

invoice_number

Airline tracing number

Type: str

is_e_ticket

• true = The ticket is an E-Ticket
• false = the ticket is not an E-Ticket

Type: bool

is_registered_customer

• true = a registered known customer
• false = unknown customer

Type: bool

Deprecated; Use Order.customer.accountType instead

is_restricted_ticket

• true - Restricted, the ticket is non-refundable
• false - No restrictions, the ticket is (partially) refundable

Type: bool

is_third_party

• true - The payer is the ticket holder
• false - The payer is not the ticket holder

Type: bool

issue_date

This is the date of issue recorded in the airline systemIn a case of multiple issuances of the same ticket to a cardholder, you should use the last ticket date.

Format: YYYYMMDD

Type: str

merchant_customer_id

Your ID of the customer in the context of the airline data

Type: str

name

Name of the airline

Type: str

number_in_party

Total number of passengers in the party. If the the property numberInParty is not present, then the number of passengers will be used on the WL Online Payment Acceptance Platform.

Type: int

passenger_name

Name of passenger

Type: str

passengers

Object that holds the data on the individual passengers (this object is used for fraud screening on the Ogone Payment Platform)

Type: list[ingenico.connect.sdk.domain.definitions.airline_passenger.AirlinePassenger]

place_of_issue

Place of issue

For sales in the US the last two characters (pos 14-15) must be the US state code.

Type: str

pnr

Passenger name record

Type: str

point_of_sale

IATA point of sale name

Type: str

pos_city_code

city code of the point of sale

Type: str

ticket_delivery_method

Possible values:

• e-ticket
• city-ticket-office
• airport-ticket-office
• ticket-by-mail
• ticket-on-departure

Type: str

ticket_number

The ticket or document number. On the Ogone Payment Platform and the GlobalCollect Payment Platform it contains:

• Airline code: 3-digit airline code number
• Form code: A maximum of 3 digits indicating the type of document, the source of issue and the number of coupons it contains
• Serial number: A maximum of 8 digits allocated on a sequential basis, provided that the total number of digits allocated to the form code and serial number shall not exceed ten
• TICKETNUMBER can be replaced with PNR if the ticket number is unavailable

Type: str

to_dictionary()

total_fare

Total fare for all legs on the ticket, excluding taxes and fees. If multiple tickets are purchased, this is the total fare for all tickets

Type: int

total_fee

Total fee for all legs on the ticket. If multiple tickets are purchased, this is the total fee for all tickets

Type: int

total_taxes

Total taxes for all legs on the ticket. If multiple tickets are purchased, this is the total taxes for all tickets

Type: int

travel_agency_name

Name of the travel agency issuing the ticket. For direct airline integration, leave this property blank on the Ogone Payment Platform.

Type: str

class ingenico.connect.sdk.domain.definitions.airline_flight_leg.AirlineFlightLeg

Bases: ingenico.connect.sdk.data_object.DataObject

airline_class

Reservation Booking Designator

Type: str

arrival_airport

Arrival airport/city code

Type: str

arrival_time

The arrival time in the local time zone

Format: HH:MM

Type: str

carrier_code

IATA carrier code

Type: str

conjunction_ticket

Identifying number of a ticket issued to a passenger in conjunction with this ticket and that constitutes a single contract of carriage

Type: str

coupon_number

The coupon number associated with this leg of the trip. A ticket can contain several legs of travel, and each leg of travel requires a separate coupon

Type: str

date

Date of the leg

Format: YYYYMMDD

Type: str

departure_time

The departure time in the local time at the departure airport

Format: HH:MM

Type: str

endorsement_or_restriction

An endorsement can be an agency-added notation or a mandatory government required notation, such as value-added tax. A restriction is a limitation based on the type of fare, such as a ticket with a 3-day minimum stay

Type: str

exchange_ticket

New ticket number that is issued when a ticket is exchanged

Type: str

fare

Fare of this leg

Type: str

fare_basis

Fare Basis/Ticket Designator

Type: str

fee

Fee for this leg of the trip

Type: int

flight_number

The flight number assigned by the airline carrier with no leading spaces

Should be a numeric string

Type: str

from_dictionary(dictionary)

number

Sequence number of the flight leg

Type: int

origin_airport

Origin airport/city code

Type: str

passenger_class

PassengerClass if this leg

Type: str

service_class

ServiceClass of this leg (this property is used for fraud screening on the Ogone Payment Platform).

Possible values are:

• economy
• premium-economy
• business
• first

Type: str

Deprecated; Use passengerClass instead

stopover_code

Possible values are:

• permitted = Stopover permitted
• non-permitted = Stopover not permitted

Type: str

taxes

Taxes for this leg of the trip

Type: int

to_dictionary()

class ingenico.connect.sdk.domain.definitions.airline_passenger.AirlinePassenger

Bases: ingenico.connect.sdk.data_object.DataObject

first_name

First name of the passenger (this property is used for fraud screening on the Ogone Payment Platform)

Type: str

from_dictionary(dictionary)

surname

Surname of the passenger (this property is used for fraud screening on the Ogone Payment Platform)

Type: str

surname_prefix

Surname prefix of the passenger (this property is used for fraud screening on the Ogone Payment Platform)

Type: str

title

Title of the passenger (this property is used for fraud screening on the Ogone Payment Platform)

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.definitions.amount_of_money.AmountOfMoney

Bases: ingenico.connect.sdk.data_object.DataObject

amount

Amount in cents and always having 2 decimals

Type: long

currency_code

Three-letter ISO currency code representing the currency for the amount

Type: str

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.definitions.bank_account.BankAccount

Bases: ingenico.connect.sdk.data_object.DataObject

account_holder_name

Name in which the account is held.

Type: str

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.definitions.bank_account_bban.BankAccountBban

Bases: ingenico.connect.sdk.domain.definitions.bank_account.BankAccount

account_number

Bank account number

Type: str

bank_code

Bank code

Type: str

bank_name

Name of the bank

Type: str

branch_code

Branch code

Type: str

check_digit

Bank check digit

Type: str

country_code

ISO 3166-1 alpha-2 country code of the country where the bank account is held

For UK payouts this value is automatically set to GB as only payouts to UK accounts are supported.

Type: str

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.definitions.bank_account_iban.BankAccountIban

Bases: ingenico.connect.sdk.domain.definitions.bank_account.BankAccount

from_dictionary(dictionary)

iban

The IBAN is the International Bank Account Number. It is an internationally agreed format for the BBAN and includes the ISO country code and two check digits.

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.definitions.card.Card

Bases: ingenico.connect.sdk.domain.definitions.card_without_cvv.CardWithoutCvv

cvv

Card Verification Value, a 3 or 4 digit code used as an additional security feature for card not present transactions.

Type: str

from_dictionary(dictionary)

partial_pin

The first 2 digits of the card’s PIN code. May be optionally submitted for South Korean cards (paymentProductIds 180, 181, 182, 183, 184, 185 and 186). Submitting this property may improve your authorization rate.

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.definitions.card_essentials.CardEssentials

Bases: ingenico.connect.sdk.data_object.DataObject

card_number

The complete credit/debit card number

Type: str

cardholder_name

The card holder’s name on the card.

Type: str

expiry_date

Expiry date of the card

Format: MMYY

Type: str

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.definitions.card_fraud_results.CardFraudResults

Bases: ingenico.connect.sdk.domain.definitions.fraud_results.FraudResults

Details of the card payment fraud checks that were performed

avs_result

Result of the Address Verification Service checks. Possible values are:

• A - Address (Street) matches, Zip does not
• B - Street address match for international transactions—Postal code not verified due to incompatible formats
• C - Street address and postal code not verified for international transaction due to incompatible formats
• D - Street address and postal code match for international transaction, cardholder name is incorrect
• E - AVS error
• F - Address does match and five digit ZIP code does match (UK only)
• G - Address information is unavailable; international transaction; non-AVS participant
• H - Billing address and postal code match, cardholder name is incorrect (Amex)
• I - Address information not verified for international transaction
• K - Cardholder name matches (Amex)
• L - Cardholder name and postal code match (Amex)
• M - Cardholder name, street address, and postal code match for international transaction
• N - No Match on Address (Street) or Zip
• O - Cardholder name and address match (Amex)
• P - Postal codes match for international transaction—Street address not verified due to incompatible formats
• Q - Billing address matches, cardholder is incorrect (Amex)
• R - Retry, System unavailable or Timed out
• S - Service not supported by issuer
• U - Address information is unavailable
• W - 9 digit Zip matches, Address (Street) does not
• X - Exact AVS Match
• Y - Address (Street) and 5 digit Zip match
• Z - 5 digit Zip matches, Address (Street) does not
• 0 - No service available

Type: str

cvv_result

Result of the Card Verification Value checks. Possible values are:

• M - CVV check performed and valid value
• N - CVV checked and no match
• P - CVV check not performed, not requested
• S - Cardholder claims no CVV code on card, issuer states CVV-code should be on card
• U - Issuer not certified for CVV2
• Y - Server provider did not respond
• 0 - No service available

Type: str

fraugster

Results of Fraugster fraud prevention check. Fraugster collects transaction data points such as name, email address, billing, etc. to analyze whether or not the transaction is fraudulent.

Type: ingenico.connect.sdk.domain.definitions.fraugster_results.FraugsterResults

from_dictionary(dictionary)

retail_decisions

Additional response data returned by RetailDecisions

Type: ingenico.connect.sdk.domain.definitions.fraud_results_retail_decisions.FraudResultsRetailDecisions

to_dictionary()

class ingenico.connect.sdk.domain.definitions.card_without_cvv.CardWithoutCvv

Bases: ingenico.connect.sdk.domain.definitions.card_essentials.CardEssentials

from_dictionary(dictionary)

issue_number

Issue number on the card (if applicable)

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.definitions.company_information.CompanyInformation

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

name

Name of company, as a customer

Type: str

to_dictionary()

vat_number

Local VAT number of the company

Type: str

class ingenico.connect.sdk.domain.definitions.contact_details_base.ContactDetailsBase

Bases: ingenico.connect.sdk.data_object.DataObject

email_address

Email address of the customer

Type: str

email_message_type

Preference for the type of email message markup

• plain-text
• html

Type: str

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.definitions.customer_base.CustomerBase

Bases: ingenico.connect.sdk.data_object.DataObject

Basic information of a customer

company_information

Object containing company information

Type: ingenico.connect.sdk.domain.definitions.company_information.CompanyInformation

from_dictionary(dictionary)

merchant_customer_id

Your identifier for the customer. It can be used as a search criteria in the GlobalCollect Payment Console and is also included in the GlobalCollect report files. It is used in the fraud-screening process for payments on the Ogone Payment Platform.

Type: str

to_dictionary()

vat_number

Local VAT number of the company

Type: str

Deprecated; Use companyInformation.vatNumber instead

class ingenico.connect.sdk.domain.definitions.fraud_fields.FraudFields

Bases: ingenico.connect.sdk.data_object.DataObject

addresses_are_identical

Indicates that invoice and shipping addresses are equal.

Type: bool

Deprecated; For risk assessments there is no replacement. For other calls, use Order.shipping.addressIndicator instead

black_list_data

Additional black list input

Type: str

card_owner_address

The address that belongs to the owner of the card

Type: ingenico.connect.sdk.domain.definitions.address.Address

Deprecated; This should be the same as Order.customer.billingAddress

customer_ip_address

The IP Address of the customer that is making the payment. The ‘+’ character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.

Type: str

default_form_fill

Degree of default form fill, with the following possible values:

• automatically - All fields filled automatically
• automatically-but-modified - All fields filled automatically, but some fields were modified manually
• manually - All fields were entered manually

Type: str

Deprecated; Use Order.customer.device.defaultFormFill instead

device_fingerprint_activated

Indicates that the device fingerprint has been used while processing the order.

Type: bool

Deprecated; No replacement

device_fingerprint_transaction_id

One must set the deviceFingerprintTransactionId received by the response of the endpoint /{merchant}/products/{paymentProductId}/deviceFingerprint

Type: str

Deprecated; Use Order.customer.device.deviceFingerprintTransactionId instead

from_dictionary(dictionary)

gift_card_type

One of the following gift card types:

• celebrate-fall - Celebrate Fall
• grandparents-day - Grandparent’s Day
• independence-day - Independence Day
• anniversary - Anniversary
• birthday - Birthday
• congratulations - Congratulations
• april-fools-day - April Fool’s Day
• easter - Easter
• fathers-day - Father’s Day
• graduation - Graduation
• holiday - Holiday
• seasons-greetings - Season’s Greetings
• passover - Passover
• kwanzaa - Kwanzaa
• halloween - Halloween
• mothers-day - Mother’s Day
• new-years-day - New Year’s Day
• bosses-day - Bosses’ Day
• st-patricks-day - St. Patrick’s Day
• sweetest-day - Sweetest Day
• christmas - Christmas
• baby-shower - Baby Shower
• thanksgiving - Thanksgiving
• other - Other
• valentines-day - Valentine’s Day
• wedding - Wedding
• secretarys-day - Secretary’s Day
• chinese-new-year - Chinese New Year
• hanukkah - Hanukkah

Type: str

gift_message

Gift message

Type: str

has_forgotten_pwd

Specifies if the customer (initially) had forgotten their password

• true - The customer has forgotten their password
• false - The customer has not forgotten their password

Type: bool

Deprecated; Use Order.customer.account.hasForgottenPassword instead

has_password

Specifies if the customer entered a password to gain access to an account registered with the you

• true - The customer has used a password to gain access
• false - The customer has not used a password to gain access

Type: bool

Deprecated; Use Order.customer.account.hasPassword instead

is_previous_customer

Specifies if the customer has a history of online shopping with the merchant

• true - The customer is a known returning customer
• false - The customer is new/unknown customer

Type: bool

Deprecated; Use Order.customer.isPreviousCustomer instead

order_timezone

Timezone in which the order was placed. The ‘+’ character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.

Type: str

ship_comments

Comments included during shipping

Type: str

Deprecated; Use Order.shipping.comments instead

shipment_tracking_number

Shipment tracking number

Type: str

Deprecated; Use Order.shipping.trackingNumber instead

shipping_details

Details on how the order is shipped to the customer

Type: ingenico.connect.sdk.domain.definitions.fraud_fields_shipping_details.FraudFieldsShippingDetails

Deprecated; No replacement

to_dictionary()

user_data

Array of up to 16 userData properties, each with a max length of 256 characters, that can be used for fraudscreening

Type: list[str]

website

The website from which the purchase was made

Type: str

Deprecated; Use Merchant.websiteUrl instead

class ingenico.connect.sdk.domain.definitions.fraud_fields_shipping_details.FraudFieldsShippingDetails

Bases: ingenico.connect.sdk.data_object.DataObject

Deprecated; No replacement

from_dictionary(dictionary)

method_details

Details regarding the shipping method

Type: str

Deprecated; No replacement

method_speed

Shipping method speed indicator

Type: int

Deprecated; No replacement

method_type

Shipping method type indicator

Type: int

Deprecated; No replacement

to_dictionary()

class ingenico.connect.sdk.domain.definitions.fraud_results.FraudResults

Bases: ingenico.connect.sdk.data_object.DataObject

fraud_service_result

Results from the fraud prevention check. Possible values are:

• accepted - Based on the checks performed the transaction can be accepted
• challenged - Based on the checks performed the transaction should be manually reviewed
• denied - Based on the checks performed the transaction should be rejected
• no-advice - No fraud check was requested/performed
• error - The fraud check resulted in an error and the fraud check was thus not performed

Type: str

from_dictionary(dictionary)

in_auth

Object containing device fingerprinting details from InAuth

Type: ingenico.connect.sdk.domain.definitions.in_auth.InAuth

microsoft_fraud_protection

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.

Type: ingenico.connect.sdk.domain.definitions.microsoft_fraud_results.MicrosoftFraudResults

to_dictionary()

class ingenico.connect.sdk.domain.definitions.fraud_results_retail_decisions.FraudResultsRetailDecisions

Bases: ingenico.connect.sdk.data_object.DataObject

fraud_code

Result of the fraud service.

Provides additional information about the fraud result

Type: str

fraud_neural

Returns the raw score of the neural

Type: str

fraud_rcf

Result of the fraud service

Represent sets of fraud rules returned during the evaluation of the transaction

Type: str

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.definitions.fraugster_results.FraugsterResults

Bases: ingenico.connect.sdk.data_object.DataObject

fraud_investigation_points

Result of the Fraugster check

Contains the investigation points used during the evaluation

Type: str

fraud_score

Result of the Fraugster check

Contains the overall Fraud score which is an integer between 0 and 99

Type: int

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.definitions.in_auth.InAuth

Bases: ingenico.connect.sdk.data_object.DataObject

device_category

The type of device used by the customer. Example values:

• SMARTPHONE
• PERSONAL_COMPUTER
• TABLET
• WEARABLE_COMPUTER
• GAME_CONSOLE
• SMART_TV
• PDA
• OTHER
• UNKNOWN

Type: str

device_id

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.

Type: str

from_dictionary(dictionary)

risk_score

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.

Type: str

to_dictionary()

true_ip_address

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.

Type: str

true_ip_address_country

The country of the customer based on the location of the True IP Address determined by inAuth.

Type: str

class ingenico.connect.sdk.domain.definitions.key_value_pair.KeyValuePair

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

key

Name of the key or property

Type: str

to_dictionary()

value

Value of the key or property

Type: str

class ingenico.connect.sdk.domain.definitions.lodging_charge.LodgingCharge

Bases: ingenico.connect.sdk.data_object.DataObject

Object that holds lodging related charges

charge_amount

Amount of additional charges associated with the stay of the guest.

Note: The currencyCode is presumed to be identical to the order.amountOfMoney.currencyCode.

Type: long

charge_amount_currency_code

Currency for Charge amount. The code should be in 3 letter ISO format.

Type: str

charge_type

Type of additional charges associated with the stay of the guest.Allowed values:

• lodging
• telephone
• restaurant
• minibar
• giftshop
• laundry
• transport
• gratuity
• conferenceRoom
• audiovisual
• banquet
• internet
• earlyDeparture
• roomService
• loungeBar
• other

Type: str

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.definitions.lodging_data.LodgingData

Bases: ingenico.connect.sdk.data_object.DataObject

Object that holds lodging specific data

charges

Object that holds lodging related charges

Type: list[ingenico.connect.sdk.domain.definitions.lodging_charge.LodgingCharge]

check_in_date

The date the guest checks into (or plans to check in to) the facility.

Format: YYYYMMDD

Type: str

check_out_date

The date the guest checks out of (or plans to check out of) the facility.

Format: YYYYMMDD

Type: str

folio_number

The Lodging Folio Number assigned to the itemized statement of charges and credits associated with this lodging stay, which can be any combination of characters and numerals defined by the Merchant or authorized Third Party Processor.

Type: str

from_dictionary(dictionary)

is_confirmed_reservation

Indicates whether the room reservation is confirmed.

• true - The room reservation is confirmed
• false - The room reservation is not confirmed

Type: bool

is_facility_fire_safety_conform

Defines whether or not the facility conforms to the requirements of the Hotel and Motel Fire Safety Act of 1990, or similar legislation.

• true - The facility conform to the requirements
• false - The facility doesn’t conform to the requirements

Type: bool

is_no_show

Indicate if this the customer is a no show case. In such case, the lodging property can charge a no show fee.

• true - The customer is a no show
• false - Not applicable

Type: bool

is_preference_smoking_room

Indicated the preference of the customer for a smoking or non-smoking room.

• true - A smoking room is preferred
• false - A non-smoking room is preferred

Type: bool

number_of_adults

The total number of adult guests staying (or planning to stay) at the facility (i.e., all booked rooms)

Type: int

number_of_nights

The number of nights for the lodging stay

Type: int

number_of_rooms

The number of rooms rented for the lodging stay

Type: int

program_code

Code that corresponds to the category of lodging charges detailed in this message.Allowed values:

• lodging - (Default) Submitted charges are for lodging
• noShow - Submitted charges are for the failure of the guest(s) to check in for reserved a room
• advancedDeposit - Submitted charges are for an Advanced Deposit to reserve one or more rooms

If no value is submitted the default value lodging is used.

Type: str

property_customer_service_phone_number

The international customer service phone number of the facility

Type: str

property_phone_number

The local phone number of the facility in an international phone number format

Type: str

renter_name

Name of the person or business entity charged for the reservation and/or lodging stay

Type: str

rooms

Object that holds lodging related room data

Type: list[ingenico.connect.sdk.domain.definitions.lodging_room.LodgingRoom]

to_dictionary()

class ingenico.connect.sdk.domain.definitions.lodging_room.LodgingRoom

Bases: ingenico.connect.sdk.data_object.DataObject

Object that holds lodging related room data

daily_room_rate

Daily room rate exclusive of any taxes and fees

Note: The currencyCode is presumed to be identical to the order.amountOfMoney.currencyCode.

Type: str

daily_room_rate_currency_code

Currency for Daily room rate. The code should be in 3 letter ISO format

Type: str

daily_room_tax_amount

Daily room tax

Note: The currencyCode is presumed to be identical to the order.amountOfMoney.currencyCode.

Type: str

daily_room_tax_amount_currency_code

Currency for Daily room tax. The code should be in 3 letter ISO format

Type: str

from_dictionary(dictionary)

number_of_nights_at_room_rate

Number of nights charged at the rate in the dailyRoomRate property

Type: int

room_location

Location of the room within the facility, e.g. Park or Garden etc.

Type: str

room_number

Room number

Type: str

to_dictionary()

type_of_bed

Size of bed, e.g., king, queen, double.

Type: str

type_of_room

Describes the type of room, e.g., standard, deluxe, suite.

Type: str

class ingenico.connect.sdk.domain.definitions.microsoft_fraud_results.MicrosoftFraudResults

Bases: ingenico.connect.sdk.data_object.DataObject

clause_name

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.

Type: str

device_country_code

The country of the customer determined by Microsoft Device Fingerprinting.

Type: str

device_id

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.

Type: str

fraud_score

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.

Type: int

from_dictionary(dictionary)

policy_applied

Name of the policy that was applied on during the evaluation of this transaction.

Type: str

to_dictionary()

true_ip_address

The true IP address as determined by Microsoft Device Fingerprinting.

Type: str

user_device_type

The type of device used by the customer.

Type: str

class ingenico.connect.sdk.domain.definitions.order_status_output.OrderStatusOutput

Bases: ingenico.connect.sdk.data_object.DataObject

errors

Custom object contains the set of errors

Type: list[ingenico.connect.sdk.domain.errors.definitions.api_error.APIError]

from_dictionary(dictionary)

is_cancellable

Flag indicating if the payment can be cancelled

• true
• false

Type: bool

is_retriable

Flag indicating whether a rejected payment may be retried by the merchant without incurring a fee

• true
• false

Type: bool

provider_raw_output

This is the raw response returned by the acquirer. This property contains unprocessed data directly returned by the acquirer. It’s recommended for data analysis only due to its dynamic nature, which may undergo future changes.

Type: list[ingenico.connect.sdk.domain.definitions.key_value_pair.KeyValuePair]

status_category

Highlevel status of the payment, payout or refund with the following possible values:

• CREATED - The transaction has been created. This is the initial state once a new payment, payout or refund is created. This category groups the following statuses:
• CREATED
• PENDING_PAYMENT: The payment is waiting on customer action. This category groups the following statuses:
• PENDING_PAYMENT
• REDIRECTED
• ACCOUNT_VERIFIED: The account has been verified. This category groups the following statuses:
• ACCOUNT_VERIFIED
• PENDING_MERCHANT: The transaction is awaiting approval to proceed with the payment, payout or refund. This category groups the following statuses:
• PENDING_APPROVAL
• PENDING_COMPLETION
• PENDING_CAPTURE
• PENDING_FRAUD_APPROVAL
• PENDING_CONNECT_OR_3RD_PARTY: The transaction is in the queue to be processed. This category groups the following statuses:
• AUTHORIZATION_REQUESTED
• CAPTURE_REQUESTED
• PAYOUT_REQUESTED
• REFUND_REQUESTED
• COMPLETED: The transaction has completed. This category groups the following statuses:
• CAPTURED
• PAID
• ACCOUNT_CREDITED
• CHARGEBACK_NOTIFICATION
• REVERSED: The transaction has been reversed. This category groups the following statuses:
• CHARGEBACKED
• REVERSED
• REFUNDED: The transaction has been refunded. This category groups the following statuses:
• REFUNDED
• UNSUCCESSFUL: The transaction has been rejected or is in such a state that it will never become successful. This category groups the following statuses:
• CANCELLED
• REJECTED
• REJECTED_CAPTURE
• REJECTED_CREDIT

Please see Statuses <https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/statuses.html> for a full overview of possible values.

Type: str

status_code

Numeric status code of the legacy API. It is returned to ease the migration from the legacy APIs to Worldline Connect. You should not write new business logic based on this property as it will be deprecated in a future version of the API. The value can also be found in the GlobalCollect Payment Console, in the Ogone BackOffice and in report files.

Type: int

status_code_change_date_time

Date and time of payment

Format: YYYYMMDDHH24MISS

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.definitions.payment_product_filter.PaymentProductFilter

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

groups

List containing all payment product groups that should either be restricted to in or excluded from the payment context. Currently, there is only one group, called ‘cards’.

Type: list[str]

products

List containing all payment product ids that should either be restricted to in or excluded from the payment context.

Type: list[int]

to_dictionary()

class ingenico.connect.sdk.domain.definitions.personal_name_base.PersonalNameBase

Bases: ingenico.connect.sdk.data_object.DataObject

first_name

Given name(s) or first name(s) of the customer

Type: str

from_dictionary(dictionary)

surname

Type: str

surname_prefix

Middle name - In between first name and surname - of the customer

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.definitions.redirect_data_base.RedirectDataBase

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

redirect_url

Type: str

returnmac

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.definitions.result_do_risk_assessment.ResultDoRiskAssessment

Bases: ingenico.connect.sdk.data_object.DataObject

category

The Risk Services category with the following possible values:

• retaildecisionsCCFraudCheck - checks performed by Retail Decisions
• globalcollectBlacklistCheckCC - Checked against the blacklist on the GlobalCollect platform
• authorizationCheck - 0$ auth card account validation check
• ddFraudCheck - Check performed for German market via InterCard
• validationbankAccount - Bank account details are algorithmically checked if they could exist
• globalcollectBlacklistCheckDD - Checked against the blacklist on the GlobalCollect platform

Type: str

from_dictionary(dictionary)

result

Risk service result with the following possible results:

• accepted - Based on the checks performed the transaction can be accepted
• challenged - Based on the checks performed the transaction should be manually reviewed
• denied - Based on the checks performed the transaction should be rejected
• no-advice - No fraud check was requested/performed
• error - The fraud check resulted in an error and the fraud check was thus not performed

Type: str

retaildecisions_cc_fraud_check_output

Object containing the results of the fraud checks performed by Retail Decisions

Type: ingenico.connect.sdk.domain.definitions.retail_decisions_cc_fraud_check_output.RetailDecisionsCCFraudCheckOutput

to_dictionary()

validation_bank_account_output

Object containing the results of the fraud checks performed on the bank account data

Type: ingenico.connect.sdk.domain.definitions.validation_bank_account_output.ValidationBankAccountOutput

class ingenico.connect.sdk.domain.definitions.retail_decisions_cc_fraud_check_output.RetailDecisionsCCFraudCheckOutput

Bases: ingenico.connect.sdk.data_object.DataObject

fraud_code

Provides additional information about the fraud result

Type: str

fraud_neural

The raw score returned by the Neural check returned by the evaluation of the transaction

Type: str

fraud_rcf

List of RuleCategoryFlags as setup in the Retail Decisions system that lead to the result

Type: str

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.definitions.validation_bank_account_check.ValidationBankAccountCheck

Bases: ingenico.connect.sdk.data_object.DataObject

code

Code of the bank account validation check

Type: str

description

Description of check performed

Type: str

from_dictionary(dictionary)

result

Result of the bank account validation check performed, with the following possible results:

• PASSED - The check passed
• ERROR - The check did not pass
• WARNING - Depending on your needs this either needs to be treated as a passed or error response. It depends on your business logic and for what purpose you want to use the validated bank account details.
• NOTCHECKED - This check was not performed, usually because one of the earlier checks already caused an error response to be triggered

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.definitions.validation_bank_account_output.ValidationBankAccountOutput

Bases: ingenico.connect.sdk.data_object.DataObject

checks

Array of checks performed with the results of each check

Type: list[ingenico.connect.sdk.domain.definitions.validation_bank_account_check.ValidationBankAccountCheck]

from_dictionary(dictionary)

new_bank_name

Bank name, matching the bank code of the request

Type: str

reformatted_account_number

Reformatted account number according to local clearing rules

Type: str

reformatted_bank_code

Reformatted bank code according to local clearing rules

Type: str

reformatted_branch_code

Reformatted branch code according to local clearing rules

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.dispute.create_dispute_request.CreateDisputeRequest

Bases: ingenico.connect.sdk.data_object.DataObject

amount_of_money

The amount of money that is to be disputed.

Type: ingenico.connect.sdk.domain.definitions.amount_of_money.AmountOfMoney

contact_person

The name of the person on your side who can be contacted regarding this dispute.

Type: str

email_address

The email address of the contact person.

Type: str

from_dictionary(dictionary)

reply_to

The email address to which the reply message will be sent.

Type: str

request_message

The message sent from you to Worldline.

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.dispute.dispute_response.DisputeResponse

Bases: ingenico.connect.sdk.domain.dispute.definitions.dispute.Dispute

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.dispute.disputes_response.DisputesResponse

Bases: ingenico.connect.sdk.data_object.DataObject

disputes

Array containing disputes and their characteristics.

Type: list[ingenico.connect.sdk.domain.dispute.definitions.dispute.Dispute]

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.dispute.upload_dispute_file_response.UploadDisputeFileResponse

Bases: ingenico.connect.sdk.data_object.DataObject

Response of a file upload request

dispute_id

Dispute ID that is associated with the created dispute.

Type: str

file_id

The file ID that is associated with the uploaded file. This ID can be used for further communication regarding the file and retrieval of aforementioned property.

Type: str

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.dispute.definitions.dispute.Dispute

Bases: ingenico.connect.sdk.data_object.DataObject

dispute_output

This property contains the creationDetails and default information regarding a dispute.

Type: ingenico.connect.sdk.domain.dispute.definitions.dispute_output.DisputeOutput

from_dictionary(dictionary)

id

Dispute ID for a given merchant.

Type: str

payment_id

The ID of the payment that is being disputed.

Type: str

status

Current dispute status.

Type: str

status_output

This property contains the output for a dispute regarding the status of the dispute.

Type: ingenico.connect.sdk.domain.dispute.definitions.dispute_status_output.DisputeStatusOutput

to_dictionary()

class ingenico.connect.sdk.domain.dispute.definitions.dispute_creation_detail.DisputeCreationDetail

Bases: ingenico.connect.sdk.data_object.DataObject

dispute_creation_date

The date and time of creation of this dispute, in yyyyMMddHHmmss format.

Type: str

dispute_originator

The originator of this dispute, which is either Worldline or you as our client.

Type: str

from_dictionary(dictionary)

to_dictionary()

user_name

The user account name of the dispute creator.

Type: str

class ingenico.connect.sdk.domain.dispute.definitions.dispute_output.DisputeOutput

Bases: ingenico.connect.sdk.data_object.DataObject

amount_of_money

Object containing amount and ISO currency code attributes

Type: ingenico.connect.sdk.domain.definitions.amount_of_money.AmountOfMoney

contact_person

The name of the person on your side who can be contacted regarding this dispute.

Type: str

creation_details

Object containing various details related to this dispute’s creation.

Type: ingenico.connect.sdk.domain.dispute.definitions.dispute_creation_detail.DisputeCreationDetail

email_address

The email address of the contact person.

Type: str

files

An array containing all files related to this dispute.

Type: list[ingenico.connect.sdk.domain.file.definitions.hosted_file.HostedFile]

from_dictionary(dictionary)

reference

A collection of reference information related to this dispute.

Type: ingenico.connect.sdk.domain.dispute.definitions.dispute_reference.DisputeReference

reply_to

The email address to which the reply message will be sent.

Type: str

request_message

The message sent from you to Worldline.

Type: str

response_message

The return message sent from the GlobalCollect platform to you.

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.dispute.definitions.dispute_reference.DisputeReference

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

merchant_order_id

The merchant’s order ID of the transaction to which this dispute is linked.

Type: str

merchant_reference

Your (unique) reference for the transaction that you can use to reconcile our report files.

Type: str

payment_reference

Payment Reference generated by WebCollect.

Type: str

provider_id

The numerical identifier of the Service Provider (Acquirer).

Type: str

provider_reference

The Service Provider’s reference.

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.dispute.definitions.dispute_status_output.DisputeStatusOutput

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

is_cancellable

Flag indicating if the payment can be cancelled

• true
• false

Type: bool

status_category

Highlevel status of the payment, payout or refund with the following possible values:

• CREATED - The transaction has been created. This is the initial state once a new payment, payout or refund is created. This category groups the following statuses:
• CREATED
• PENDING_PAYMENT: The payment is waiting on customer action. This category groups the following statuses:
• PENDING_PAYMENT
• REDIRECTED
• ACCOUNT_VERIFIED: The account has been verified. This category groups the following statuses:
• ACCOUNT_VERIFIED
• PENDING_MERCHANT: The transaction is awaiting approval to proceed with the payment, payout or refund. This category groups the following statuses:
• PENDING_APPROVAL
• PENDING_COMPLETION
• PENDING_CAPTURE
• PENDING_FRAUD_APPROVAL
• PENDING_CONNECT_OR_3RD_PARTY: The transaction is in the queue to be processed. This category groups the following statuses:
• AUTHORIZATION_REQUESTED
• CAPTURE_REQUESTED
• PAYOUT_REQUESTED
• REFUND_REQUESTED
• COMPLETED: The transaction has completed. This category groups the following statuses:
• CAPTURED
• PAID
• ACCOUNT_CREDITED
• CHARGEBACK_NOTIFICATION
• REVERSED: The transaction has been reversed. This category groups the following statuses:
• CHARGEBACKED
• REVERSED
• REFUNDED: The transaction has been refunded. This category groups the following statuses:
• REFUNDED
• UNSUCCESSFUL: The transaction has been rejected or is in such a state that it will never become successful. This category groups the following statuses:
• CANCELLED
• REJECTED
• REJECTED_CAPTURE
• REJECTED_CREDIT

Please see Statuses <https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/statuses.html> for a full overview of possible values.

Type: str

status_code

Numeric status code of the legacy API. It is returned to ease the migration from the legacy APIs to Worldline Connect. You should not write new business logic based on this property as it will be deprecated in a future version of the API. The value can also be found in the GlobalCollect Payment Console, in the Ogone BackOffice and in report files.

Type: int

status_code_change_date_time

Date and time of payment

Format: YYYYMMDDHH24MISS

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.errors.error_response.ErrorResponse

Bases: ingenico.connect.sdk.data_object.DataObject

error_id

Unique reference, for debugging purposes, of this error response

Type: str

errors

List of one or more errors

Type: list[ingenico.connect.sdk.domain.errors.definitions.api_error.APIError]

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.errors.definitions.api_error.APIError

Bases: ingenico.connect.sdk.data_object.DataObject

category

Category the error belongs to. The category should give an indication of the type of error you are dealing with.Possible values:

• CONNECT_PLATFORM_ERROR - indicating that a functional error has occurred in the Connect platform.
• PAYMENT_PLATFORM_ERROR - indicating that a functional error has occurred in the Payment platform.
• IO_ERROR - indicating that a technical error has occurred within the Connect platform or between Connect and any of the payment platforms or third party systems.

Type: str

code

Error code

Type: str

from_dictionary(dictionary)

http_status_code

HTTP status code for this error that can be used to determine the type of error

Type: int

id

ID of the error. This is a short human-readable message that briefly describes the error.

Type: str

message

Human-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud

Type: str

property_name

Returned only if the error relates to a value that was missing or incorrect.

Contains a location path to the value as a JSonata query <http://docs.jsonata.org/basic.html>.

Some common examples:

• a.b selects the value of property b of root property a,
• a[1] selects the first element of the array in root property a,
• a[b=’some value’] selects all elements of the array in root property a that have a property b with value ‘some value’.

Type: str

request_id

ID of the request that can be used for debugging purposes

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.file.definitions.hosted_file.HostedFile

Bases: ingenico.connect.sdk.data_object.DataObject

File items.

file_name

The name of the file.

Type: str

file_size

The size of the file in bytes.

Type: str

file_type

The type of the file.

Type: str

from_dictionary(dictionary)

id

The numeric identifier of the file.

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.hostedcheckout.create_hosted_checkout_request.CreateHostedCheckoutRequest

Bases: ingenico.connect.sdk.data_object.DataObject

bank_transfer_payment_method_specific_input

Object containing the specific input details for bank transfer payments

Type: ingenico.connect.sdk.domain.payment.definitions.bank_transfer_payment_method_specific_input_base.BankTransferPaymentMethodSpecificInputBase

card_payment_method_specific_input

Object containing the specific input details for card payments

Type: ingenico.connect.sdk.domain.payment.definitions.card_payment_method_specific_input_base.CardPaymentMethodSpecificInputBase

cash_payment_method_specific_input

Object containing the specific input details for cash payments

Type: ingenico.connect.sdk.domain.payment.definitions.cash_payment_method_specific_input_base.CashPaymentMethodSpecificInputBase

e_invoice_payment_method_specific_input

Object containing the specific input details for eInvoice payments

Type: ingenico.connect.sdk.domain.payment.definitions.e_invoice_payment_method_specific_input_base.EInvoicePaymentMethodSpecificInputBase

fraud_fields

Object containing additional data that will be used to assess the risk of fraud

Type: ingenico.connect.sdk.domain.definitions.fraud_fields.FraudFields

from_dictionary(dictionary)

hosted_checkout_specific_input

Object containing hosted checkout specific data

Type: ingenico.connect.sdk.domain.hostedcheckout.definitions.hosted_checkout_specific_input.HostedCheckoutSpecificInput

merchant

Object containing information on you, the merchant

Type: ingenico.connect.sdk.domain.payment.definitions.merchant.Merchant

mobile_payment_method_specific_input

Object containing reference data for Google Pay (paymentProductId 320) and Apple Pay (paymentProductID 302).

Type: ingenico.connect.sdk.domain.hostedcheckout.definitions.mobile_payment_method_specific_input_hosted_checkout.MobilePaymentMethodSpecificInputHostedCheckout

order

Order object containing order related data

Type: ingenico.connect.sdk.domain.payment.definitions.order.Order

redirect_payment_method_specific_input

Object containing the specific input details for payments that involve redirects to 3rd parties to complete, like iDeal and PayPal

Type: ingenico.connect.sdk.domain.payment.definitions.redirect_payment_method_specific_input_base.RedirectPaymentMethodSpecificInputBase

sepa_direct_debit_payment_method_specific_input

Object containing the specific input details for SEPA direct debit payments

Type: ingenico.connect.sdk.domain.payment.definitions.sepa_direct_debit_payment_method_specific_input_base.SepaDirectDebitPaymentMethodSpecificInputBase

to_dictionary()

class ingenico.connect.sdk.domain.hostedcheckout.create_hosted_checkout_response.CreateHostedCheckoutResponse

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

hosted_checkout_id

This is the ID under which the data for this checkout can be retrieved.

Type: str

invalid_tokens

Tokens that are submitted in the request are validated. In case any of the tokens can’t be used anymore they are returned in this array. You should most likely remove those tokens from your system.

Type: list[str]

merchant_reference

If a payment is created during this hosted checkout, then it will use this merchantReference. This is the merchantReference you provided in the Create Hosted Checkout request, or if you did not provide one, a reference generated by Connect. This allows you to to link a webhook related to the created payment back to this hosted checkout using the webhook’s paymentOutput.references.merchantReference.

This property is intended primarily for hosted checkouts on the Ogone Payment Platform. On the GlobalCollect platform, you can also use hostedCheckoutSpecificOutput.hostedCheckoutId.

Type: str

partial_redirect_url

The partial URL as generated by our system. You will need to add the protocol and the relevant subdomain to this URL, before redirecting your customer to this URL. A special ‘payment’ subdomain will always work so you can always add ‘https://payment.’ at the beginning of this response value to view your MyCheckout hosted payment pages.

Type: str

returnmac

When the customer is returned to your site we will append this property and value to the query-string. You should store this data, so you can identify the returning customer.

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.hostedcheckout.get_hosted_checkout_response.GetHostedCheckoutResponse

Bases: ingenico.connect.sdk.data_object.DataObject

created_payment_output

When a payment has been created during the hosted checkout session this object will return the details.

Type: ingenico.connect.sdk.domain.hostedcheckout.definitions.created_payment_output.CreatedPaymentOutput

from_dictionary(dictionary)

status

This is the status of the hosted checkout. Possible values are:

• IN_PROGRESS - The checkout is still in progress and has not finished yet
• PAYMENT_CREATED - A payment has been created
• CANCELLED_BY_CONSUMER - If a customer cancels the payment on the payment product detail page of the MyCheckout hosted payment pages, the status will change to IN_PROGRESS. Since we understand you want to be aware of a customer cancelling the payment on the page we host for you, you can choose to receive the status CANCELLED_BY_CONSUMER instead of the status IN_PROGRESS. In order to receive the status CANCELLED_BY_CONSUMER, you need to have the returnCancelState flag enabled in the Create hosted checkout <https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/hostedcheckouts/create.html> call.
• CLIENT_NOT_ELIGIBLE_FOR_SELECTED_PAYMENT_PRODUCT - With some payment products it might occur that the device of the user is not capable to complete the payment. If the Hosted Checkout Session was restricted to a single project that is not compatible to the user’s device you will receive this Hosted Checkout status. This scenario applies to: Google Pay (Payment Product ID: 320).

Please see Statuses <https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/statuses.html> for a full overview of possible values.

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.hostedcheckout.definitions.created_payment_output.CreatedPaymentOutput

Bases: ingenico.connect.sdk.data_object.DataObject

This object is used when a payment was created during a HostedCheckout. It is part of the response of a GET HostedCheckout object and contains the details of the created payment object.

displayed_data

Object that contains the action, including the needed data, that you should perform next, like showing instruction, showing the transaction results or redirect to a third party to complete the payment

Type: ingenico.connect.sdk.domain.hostedcheckout.definitions.displayed_data.DisplayedData

from_dictionary(dictionary)

is_checked_remember_me

Indicates whether the customer ticked the “Remember my details for future purchases” checkbox on the MyCheckout hosted payment pages

Type: bool

payment

Object that holds the payment data

Type: ingenico.connect.sdk.domain.payment.definitions.payment.Payment

payment_creation_references

Object containing the created references

Type: ingenico.connect.sdk.domain.payment.definitions.payment_creation_references.PaymentCreationReferences

payment_status_category

Highlevel indication of the payment status with the following possible values:

• REJECTED - The payment has been rejected or is in such a state that it will never become successful. This category groups the following statuses:
• CREATED
• REJECTED
• REJECTED CAPTURE
• REJECTED REFUND
• REJECTED PAYOUT
• CANCELLED
• SUCCESSFUL - The payment was not (yet) rejected. Use the payment statuses to determine if it was completed, see Statuses <https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/statuses.html>. This category groups the following statuses:
• PENDING PAYMENT
• ACCOUNT VERIFIED
• PENDING FRAUD APPROVAL
• PENDING APPROVAL
• AUTHORIZATION REQUESTED
• CAPTURE REQUESTED
• REFUND REQUESTED
• PAYOUT REQUESTED
• CAPTURED
• PAID
• ACCOUNT CREDITED
• REVERSED
• CHARGEBACK_NOTIFICATION
• CHARGEBACKED
• REFUNDED
• STATUS_UNKNOWN - The status of the payment is unknown at this moment. This category groups the following statuses:
• REDIRECTED

Please see Statuses <https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/statuses.html> for a full overview of possible values.

Type: str

Deprecated; Use Payment.statusOutput.statusCategory instead

to_dictionary()

tokenization_succeeded

If the payment was attempted to be tokenized, indicates if tokenization was successful or not.

Type: bool

tokens

This property contains the tokens that are associated with the hosted checkout session/customer. You can use the tokens listed in this list for a future checkout of the same customer.

Type: str

class ingenico.connect.sdk.domain.hostedcheckout.definitions.displayed_data.DisplayedData

Bases: ingenico.connect.sdk.data_object.DataObject

displayed_data_type

Action merchants needs to take in the online payment process. Possible values are:

• SHOW_INSTRUCTIONS - The customer needs to be shown payment instruction using the details found in showData. Alternatively the instructions can be rendered by us using the renderingData
• SHOW_TRANSACTION_RESULTS - The customer needs to be shown the transaction results using the details found in showData. Alternatively the instructions can be rendered by us using the renderingData

Type: str

from_dictionary(dictionary)

rendering_data

This property contains the blob with data for the instructions rendering service.

This service will be available at the following endpoint:http(s)://{{merchant specific subdomain}}.{{base MyCheckout hosted payment pages domain}}/instructions/{{merchantId}}/{{clientSessionId}}

This instructions page rendering service accepts the following parameters:

• instructionsRenderingData (required, the content of this property)
• locale (optional, if present overrides default locale, e.g. “en_GB”)
• variant (optional, code of a variant, if present overrides default variant, e.g. “100”)
• customerId (required for Pix, otherwise optional, the customerId from a client session)

You can offer a link to a customer to see an instructions page for a payment done earlier. Because of the size of the instructionsRenderingData this will need to be set in a web form as a value of a hidden field. Before presenting the link you need to obtain a clientSessionId by creating a session using the S2S API. You will need to use the MyCheckout hosted payment pages domain hosted in the same region as the API domain used for the createClientSession call.

The instructionsRenderingData is a String blob that is presented to you via the Server API as part of the merchantAction (if available, and non-redirect) in the JSON return values for the createPayment call or the getHostedCheckoutStatus call (merchantAction inside createdPaymentOutput when available).You are responsible to store the instructionsRenderingData blob in order to be able to present the instructions page at a later time, when this information might no longer be available through Server API calls.

Type: str

show_data

Array of key value pairs of data that needs to be shown to the customer. This is returned for both the SHOW_INSTRUCTION as well as the SHOW_TRANSACTION_RESULTS actionType.

Note: The returned value for the key BARCODE is a base64 encoded gif image. By prepending ‘data:image/gif;base64,’ this value can be used as the source of an HTML inline image.

Type: list[ingenico.connect.sdk.domain.definitions.key_value_pair.KeyValuePair]

to_dictionary()

class ingenico.connect.sdk.domain.hostedcheckout.definitions.frequency.Frequency

Bases: ingenico.connect.sdk.data_object.DataObject

The object containing the frequency and interval between recurring payments.

from_dictionary(dictionary)

interval

The interval between recurring payments specified as days, weeks, quarters, or years.

Type: str

interval_frequency

The number of days, weeks, months, quarters, or years between recurring payments.

Type: int

to_dictionary()

class ingenico.connect.sdk.domain.hostedcheckout.definitions.hosted_checkout_specific_input.HostedCheckoutSpecificInput

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

is_recurring

• true - Only payment products that support recurring payments will be shown. Any transactions created will also be tagged as being a first of a recurring sequence.
• false - Only payment products that support one-off payments will be shown.

The default value for this property is false.

Type: bool

locale

Locale to use to present the MyCheckout payment pages to the customer. Please make sure that a language pack is configured for the locale you are submitting. If you submit a locale that is not setup on your account we will use the default language pack for your account. You can easily upload additional language packs and set the default language pack in the Configuration Center.

Type: str

payment_product_filters

Contains the payment product ids and payment product groups that will be used for manipulating the payment products available for the payment to the customer.

Type: ingenico.connect.sdk.domain.hostedcheckout.definitions.payment_product_filters_hosted_checkout.PaymentProductFiltersHostedCheckout

recurring_payments_data

The object containing reference data for the text that can be displayed on MyCheckout hosted payment page with subscription information.

Note:

The data in this object is only meant for displaying recurring payments-related data on your checkout page.

You still need to submit all the recurring payment-related data in the corresponding payment product-specific input. (example: cardPaymentMethodSpecificInput.recurring and cardPaymentMethodSpecificInput.isRecurring)

Type: ingenico.connect.sdk.domain.hostedcheckout.definitions.recurring_payments_data.RecurringPaymentsData

return_cancel_state

This flag affects the status of a Hosted Checkout when a customer presses the cancel button and is returned to you as a result.

If set to true, then the status will be CANCELLED_BY_CONSUMER. If set to false, then the status will be IN_PROGRESS.

The default value is false. This flag was added to introduce the additional CANCELLED_BY_CONSUMER state as a non-breaking change.

Type: bool

return_url

The URL that the customer is redirect to after the payment flow has finished. You can add any number of key value pairs in the query string that, for instance help you to identify the customer when they return to your site. Please note that we will also append some additional key value pairs that will also help you with this identification process.

Note: The provided URL should be absolute and contain the protocol to use, e.g. http:// or https://. For use on mobile devices a custom protocol can be used in the form of protocol://. This protocol must be registered on the device first.

URLs without a protocol will be rejected.

Type: str

show_result_page

• true - MyCheckout will show a result page to the customer when applicable. Default.
• false - MyCheckout will redirect the customer back to the provided returnUrl when this is possible.

The default value for this property is true.

Type: bool

to_dictionary()

tokens

String containing comma separated tokens (no spaces) associated with the customer of this hosted checkout. Valid tokens will be used to present the customer the option to re-use previously used payment details. This means the customer for instance does not have to re-enter their card details again, which a big plus when the customer is using their mobile phone to complete the checkout.

Type: str

validate_shopping_cart

By default, validation is done for all the information required to display the shopping cart. Set this value to false if you would like to turn that feature off for a hosted checkout on the Ogone Payment Platform, in which case the rendering of the shopping cart will be skipped if any required information is missing. Use this when you want fraud-checks to be performed on the shopping cart, but do not want to suply all data needed for displaying it in the hosted checkout. The default value for this property is true.

Type: bool

variant

Using the Configuration Center it is possible to create multiple variations of your MyCheckout payment pages. By specifying a specific variant you can force the use of another variant then the default. This allows you to test out the effect of certain changes to your MyCheckout payment pages in a controlled manner. Please note that you need to specify the ID of the variant.

Type: str

class ingenico.connect.sdk.domain.hostedcheckout.definitions.mobile_payment_method_specific_input_hosted_checkout.MobilePaymentMethodSpecificInputHostedCheckout

Bases: ingenico.connect.sdk.domain.definitions.abstract_payment_method_specific_input.AbstractPaymentMethodSpecificInput

authorization_mode

Determines the type of the authorization that will be used. Allowed values:

• FINAL_AUTHORIZATION - The payment creation results in an authorization that is ready for capture. Final authorizations can’t be reversed and need to be captured for the full amount within 7 days.
• PRE_AUTHORIZATION - The payment creation results in a pre-authorization that is ready for capture. Pre-authortizations can be reversed and can be captured within 30 days. The capture amount can be lower than the authorized amount.
• SALE - The payment creation results in an authorization that is already captured at the moment of approval.

Only used with some acquirers, ingnored for acquirers that don’t support this. In case the acquirer doesn’t allow this to be specified the authorizationMode is ‘unspecified’, which behaves similar to a final authorization.

Type: str

customer_reference

Reference of the customer for the payment (purchase order #, etc.). Only used with some acquirers.

Type: str

from_dictionary(dictionary)

payment_product302_specific_input

Object containing information specific to Apple Pay

Type: ingenico.connect.sdk.domain.hostedcheckout.definitions.mobile_payment_product302_specific_input_hosted_checkout.MobilePaymentProduct302SpecificInputHostedCheckout

payment_product320_specific_input

Object containing information specific to Google Pay (paymentProductId 320)

Type: ingenico.connect.sdk.domain.hostedcheckout.definitions.mobile_payment_product320_specific_input_hosted_checkout.MobilePaymentProduct320SpecificInputHostedCheckout

requires_approval

• true = the payment requires approval before the funds will be captured using the Capture payment <https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/payments/approve.html> API
• false = the payment does not require approval, and the funds will be captured automatically

Type: bool

skip_fraud_service

• true = Fraud scoring will be skipped for this transaction
• false = Fraud scoring will not be skipped for this transaction

Note: This is only possible if your account in our system is setup for Fraud scoring and if your configuration in our system allows you to override it per transaction.

Type: bool

to_dictionary()

class ingenico.connect.sdk.domain.hostedcheckout.definitions.mobile_payment_product302_specific_input_hosted_checkout.MobilePaymentProduct302SpecificInputHostedCheckout

Bases: ingenico.connect.sdk.data_object.DataObject

business_name

Used as an input for the Apple Pay payment button. Your default business name is configured in the Configuration Center. In case you want to use another business name than the one configured in the Configuration Center, provide your company name in a human readable form.

Type: str

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.hostedcheckout.definitions.mobile_payment_product320_specific_input_hosted_checkout.MobilePaymentProduct320SpecificInputHostedCheckout

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

merchant_name

Used as an input for the Google Pay payment sheet. Provide your company name in a human readable form.

Type: str

merchant_origin

Used as an input for the Google Pay payment sheet. Provide the url of your webshop. For international (non-ASCII) domains, please use Punycode <https://en.wikipedia.org/wiki/Punycode>.

Type: str

three_d_secure

Object containing specific data regarding 3-D Secure

Type: ingenico.connect.sdk.domain.payment.definitions.g_pay_three_d_secure.GPayThreeDSecure

to_dictionary()

class ingenico.connect.sdk.domain.hostedcheckout.definitions.payment_product_filters_hosted_checkout.PaymentProductFiltersHostedCheckout

Bases: ingenico.connect.sdk.data_object.DataObject

exclude

Contains the payment product ids and payment product groups that should be excluded from the payment products available for the payment. Note that excluding a payment product will ensure exclusion, even if the payment product is also present in the restrictTo filter, and that excluding a payment product group will exclude all payment products that are a part of that group, even if one or more of them are present in the restrictTo filters.

Type: ingenico.connect.sdk.domain.definitions.payment_product_filter.PaymentProductFilter

from_dictionary(dictionary)

restrict_to

Contains the payment product ids and payment product groups that should be at most contained in the payment products available for completing the payment. Note that the list of payment products available for completing the payment will only contain payment products present in these filters, but not all payment products in these filters might be present in the list. Some of them might not be allowed in context or they might be present in the exclude filters.

Type: ingenico.connect.sdk.domain.definitions.payment_product_filter.PaymentProductFilter

to_dictionary()

tokens_only

• true - The customer may only complete the payment using one of the provided accounts on file.
• false -The customer can complete the payment using any way they like, as long as it is allowed in the payment context. Default.

Note that the request must contain at least one valid account on file with an allowed payment product (not excluded and allowed in context) if this property is set to true, else the request will fail.

Type: bool

class ingenico.connect.sdk.domain.hostedcheckout.definitions.recurring_payments_data.RecurringPaymentsData

Bases: ingenico.connect.sdk.data_object.DataObject

The object containing reference data for the text that can be displayed on MyCheckout hosted payment page with subscription information.

Note:

The data in this object is only meant for displaying recurring payments-related data on your checkout page.

You still need to submit all the recurring payment-related data in the corresponding payment product-specific input. (example: cardPaymentMethodSpecificInput.recurring and cardPaymentMethodSpecificInput.isRecurring)

from_dictionary(dictionary)

recurring_interval

The object containing the frequency and interval between recurring payments.

Type: ingenico.connect.sdk.domain.hostedcheckout.definitions.frequency.Frequency

to_dictionary()

trial_information

The object containing data of the trial period: no-cost or discounted time-constrained trial subscription period.

Type: ingenico.connect.sdk.domain.hostedcheckout.definitions.trial_information.TrialInformation

class ingenico.connect.sdk.domain.hostedcheckout.definitions.trial_information.TrialInformation

Bases: ingenico.connect.sdk.data_object.DataObject

The object containing data of the trial period: no-cost or discounted time-constrained trial subscription period.

amount_of_money_after_trial

The object containing the amount and ISO currency code attributes of money to be paid after the trial period ends.

Note:

The property order.amountOfMoney should be populated with the amount to be paid during or for the trial period (no-cost or discounted time-constrained trial subscription period).

Type: ingenico.connect.sdk.domain.definitions.amount_of_money.AmountOfMoney

end_date

The date that the trial period ends in YYYYMMDD format.

Type: str

from_dictionary(dictionary)

is_recurring

The property specifying if there will be recurring charges throughout the trial period (when the trial period involves a temporary discounted rate).

True = there will be recurring charges during the trial period

False = there will not be recurring charges during the trial period

Type: bool

to_dictionary()

trial_period

The object containing information on the trial period duration and the interval between payments during that period.

Type: ingenico.connect.sdk.domain.hostedcheckout.definitions.trial_period.TrialPeriod

trial_period_recurring

The object containing the frequency and interval between recurring payments.

Note:

This object should only be populated if the frequency of recurring payments between the trial and regular periods is different.

If you do not populated this object, then the same interval frequency and interval of recurringPaymentsData.recurringInterval will be used

Type: ingenico.connect.sdk.domain.hostedcheckout.definitions.frequency.Frequency

class ingenico.connect.sdk.domain.hostedcheckout.definitions.trial_period.TrialPeriod

Bases: ingenico.connect.sdk.data_object.DataObject

The object containing information on the trial period duration and the interval between payments during that period.

duration

The number of days, weeks, months, or years before the trial period ends.

Type: int

from_dictionary(dictionary)

interval

The interval for the trial period to finish specified as days, weeks, months, quarters, or years.

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.hostedmandatemanagement.create_hosted_mandate_management_request.CreateHostedMandateManagementRequest

Bases: ingenico.connect.sdk.data_object.DataObject

create_mandate_info

Object containing partial information needed for the creation of the mandate. The recurrencetype, signature type of the mandate and reference to the customer are mandatory. You can also supply any personal information you already know about the customer so they have to fill in less details.

Type: ingenico.connect.sdk.domain.hostedmandatemanagement.definitions.hosted_mandate_info.HostedMandateInfo

from_dictionary(dictionary)

hosted_mandate_management_specific_input

Object containing hosted mandate management specific data

Type: ingenico.connect.sdk.domain.hostedmandatemanagement.definitions.hosted_mandate_management_specific_input.HostedMandateManagementSpecificInput

to_dictionary()

class ingenico.connect.sdk.domain.hostedmandatemanagement.create_hosted_mandate_management_response.CreateHostedMandateManagementResponse

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

hosted_mandate_management_id

This is the ID under which the data for this mandate management can be retrieved.

Type: str

partial_redirect_url

The partial URL as generated by our system. You will need to add the protocol and the relevant subdomain to this URL, before redirecting your customer to this URL. A special ‘payment’ subdomain will always work so you can always add ‘https://payment.’ at the beginning of this response value to view your hosted mandate management pages.

Type: str

returnmac

When the customer is returned to your site we will append this property and value to the query-string. You should store this data, so you can identify the returning customer.

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.hostedmandatemanagement.get_hosted_mandate_management_response.GetHostedMandateManagementResponse

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

mandate

When a mandate has been created during the hosted mandate management session this object will return the details.

Type: ingenico.connect.sdk.domain.mandates.definitions.mandate_response.MandateResponse

status

This is the status of the hosted mandate management. Possible values are:

• IN_PROGRESS - The session has been created, but no mandate has been created yet.
• MANDATE_CREATED - A mandate has been created, the customer might still need to sign the mandate.
• FAILED - There was an error while creating the mandate, the session can not continue.
• CANCELLED_BY_CONSUMER - The session was cancelled before a mandate was created

.

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.hostedmandatemanagement.definitions.hosted_mandate_info.HostedMandateInfo

Bases: ingenico.connect.sdk.data_object.DataObject

alias

An alias for the mandate. This can be used to visually represent the mandate.

Do not include any unobfuscated sensitive data in the alias.

Default value if not provided is the obfuscated IBAN of the customer.

Type: str

customer

Customer object containing customer specific inputs

Type: ingenico.connect.sdk.domain.mandates.definitions.mandate_customer.MandateCustomer

customer_reference

The unique identifier of a customer

Type: str

from_dictionary(dictionary)

recurrence_type

Specifies whether the mandate is for one-off or recurring payments. Possible values are:

• UNIQUE
• RECURRING

Type: str

signature_type

Specifies whether the mandate is unsigned or singed by SMS. Possible values are:

• UNSIGNED
• SMS

Type: str

to_dictionary()

unique_mandate_reference

The unique identifier of the mandate

Type: str

class ingenico.connect.sdk.domain.hostedmandatemanagement.definitions.hosted_mandate_management_specific_input.HostedMandateManagementSpecificInput

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

locale

Locale to use to present the hosted mandate pages to the customer. Please make sure that a language pack is configured for the locale you are submitting. If you submit a locale that is not setup on your account we will use the default language pack for your account. You can easily upload additional language packs and set the default language pack in the Configuration Center.

Type: str

return_url

The URL that the customer is redirect to after the mandate flow has finished. You can add any number of key value pairs in the query string that, for instance help you to identify the customer when they return to your site. Please note that we will also append some additional key value pairs that will also help you with this identification process.

Note: The provided URL should be absolute and contain the protocol to use, e.g. http:// or https://. For use on mobile devices a custom protocol can be used in the form of protocol://. This protocol must be registered on the device first.

URLs without a protocol will be rejected.

Type: str

show_result_page

• true - MyMandate will show a result page to the customer when applicable. Default.
• false - MyMandate will redirect the customer back to the provided returnUrl when this is possible.

The default value for this property is true.

Type: bool

to_dictionary()

variant

The ID of the variant used to create the Hosted Mandate Management Session in which the payment was made.

Type: str

class ingenico.connect.sdk.domain.installments.get_installment_request.GetInstallmentRequest

Bases: ingenico.connect.sdk.data_object.DataObject

Using the Installment Service API you can ask us to provide you with information related to the available installment options, based on the country, amount and optionally payment productId and bin number.

amount_of_money

Object containing amount and ISO currency code attributes

Type: ingenico.connect.sdk.domain.definitions.amount_of_money.AmountOfMoney

bin

The first digits of the card number from left to right with a minimum of 6 digits

Type: str

country_code

ISO 3166-1 alpha-2 country code

Type: str

from_dictionary(dictionary)

payment_product_id

Payment product identifier

Please see payment products <https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/paymentproducts.html> for a full overview of possible values.

Type: int

to_dictionary()

class ingenico.connect.sdk.domain.installments.installment_options_response.InstallmentOptionsResponse

Bases: ingenico.connect.sdk.data_object.DataObject

The response contains the details of the installment options

from_dictionary(dictionary)

installment_options

Array containing installment options their details and characteristics

Type: list[ingenico.connect.sdk.domain.installments.definitions.installment_options.InstallmentOptions]

to_dictionary()

class ingenico.connect.sdk.domain.installments.definitions.installment_display_hints.InstallmentDisplayHints

Bases: ingenico.connect.sdk.data_object.DataObject

Object containing information for the client on how best to display this options

display_order

Determines the order in which the installment options should be shown (sorted ascending). In countries like Turkey there are multiple loyalty programs that offer installments

Type: int

from_dictionary(dictionary)

label

Name of the installment option

Type: str

logo

Partial URL that you can reference for the image of this installment provider. You can use our server-side resize functionality by appending ‘?size={{width}}x{{height}}’ to the full URL, where width and height are specified in pixels. The resized image will always keep its correct aspect ratio.

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.installments.definitions.installment_options.InstallmentOptions

Bases: ingenico.connect.sdk.data_object.DataObject

Array containing installment options their details and characteristics

display_hints

Object containing information for the client on how best to display the installment options

Type: ingenico.connect.sdk.domain.installments.definitions.installment_display_hints.InstallmentDisplayHints

from_dictionary(dictionary)

id

The ID of the installment option in our system

Type: str

installment_plans

Object containing information about installment plans

Type: list[ingenico.connect.sdk.domain.payment.definitions.installments.Installments]

to_dictionary()

class ingenico.connect.sdk.domain.mandates.create_mandate_request.CreateMandateRequest

Bases: ingenico.connect.sdk.domain.mandates.definitions.create_mandate_with_return_url.CreateMandateWithReturnUrl

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.mandates.create_mandate_response.CreateMandateResponse

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

mandate

Object containing information on a mandate

Type: ingenico.connect.sdk.domain.mandates.definitions.mandate_response.MandateResponse

merchant_action

Object that contains the action, including the needed data, that you should perform next, showing the redirect to a third party to complete the payment or like showing instructions

Type: ingenico.connect.sdk.domain.mandates.definitions.mandate_merchant_action.MandateMerchantAction

to_dictionary()

class ingenico.connect.sdk.domain.mandates.get_mandate_response.GetMandateResponse

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

mandate

Object containing information on a mandate.

Type: ingenico.connect.sdk.domain.mandates.definitions.mandate_response.MandateResponse

to_dictionary()

class ingenico.connect.sdk.domain.mandates.definitions.create_mandate_base.CreateMandateBase

Bases: ingenico.connect.sdk.data_object.DataObject

alias

An alias for the mandate. This can be used to visually represent the mandate.

Do not include any unobfuscated sensitive data in the alias.

Default value if not provided is the obfuscated IBAN of the customer.

Type: str

customer

Customer object containing customer specific inputs

Type: ingenico.connect.sdk.domain.mandates.definitions.mandate_customer.MandateCustomer

customer_reference

The unique identifier of a customer

Type: str

from_dictionary(dictionary)

language

The language code of the customer, one of de, en, es, fr, it, nl, si, sk, sv.

Type: str

recurrence_type

Specifies whether the mandate is for one-off or recurring payments. Possible values are:

• UNIQUE
• RECURRING

Type: str

signature_type

Specifies whether the mandate is unsigned or singed by SMS. Possible values are:

• UNSIGNED
• SMS

Type: str

to_dictionary()

unique_mandate_reference

The unique identifier of the mandate. If you do not provide one, we will generate one for you.

Type: str

class ingenico.connect.sdk.domain.mandates.definitions.create_mandate_with_return_url.CreateMandateWithReturnUrl

Bases: ingenico.connect.sdk.domain.mandates.definitions.create_mandate_base.CreateMandateBase

from_dictionary(dictionary)

return_url

Return URL to use if the mandate signing requires redirection.

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.mandates.definitions.mandate_address.MandateAddress

Bases: ingenico.connect.sdk.data_object.DataObject

Address details of the consumer

city

City

Type: str

country_code

ISO 3166-1 alpha-2 country code

Type: str

from_dictionary(dictionary)

house_number

House number

Type: str

street

Streetname

Type: str

to_dictionary()

zip

Zip code

Type: str

class ingenico.connect.sdk.domain.mandates.definitions.mandate_contact_details.MandateContactDetails

Bases: ingenico.connect.sdk.data_object.DataObject

Contact details of the consumer

email_address

Email address of the customer

Type: str

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.mandates.definitions.mandate_customer.MandateCustomer

Bases: ingenico.connect.sdk.data_object.DataObject

bank_account_iban

Object containing IBAN information

Type: ingenico.connect.sdk.domain.definitions.bank_account_iban.BankAccountIban

company_name

Name of company, as a customer

Type: str

contact_details

Object containing contact details like email address and phone number

Type: ingenico.connect.sdk.domain.mandates.definitions.mandate_contact_details.MandateContactDetails

from_dictionary(dictionary)

mandate_address

Object containing billing address details

Type: ingenico.connect.sdk.domain.mandates.definitions.mandate_address.MandateAddress

personal_information

Object containing personal information of the customer

Type: ingenico.connect.sdk.domain.mandates.definitions.mandate_personal_information.MandatePersonalInformation

to_dictionary()

class ingenico.connect.sdk.domain.mandates.definitions.mandate_merchant_action.MandateMerchantAction

Bases: ingenico.connect.sdk.data_object.DataObject

action_type

Action merchants needs to take in the online mandate process. Possible values are:

• REDIRECT - The customer needs to be redirected using the details found in redirectData

Type: str

from_dictionary(dictionary)

redirect_data

Object containing all data needed to redirect the customer

Type: ingenico.connect.sdk.domain.mandates.definitions.mandate_redirect_data.MandateRedirectData

to_dictionary()

class ingenico.connect.sdk.domain.mandates.definitions.mandate_personal_information.MandatePersonalInformation

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

name

Object containing the name details of the customer

Type: ingenico.connect.sdk.domain.mandates.definitions.mandate_personal_name.MandatePersonalName

title

Object containing the title of the customer (Mr, Miss or Mrs)

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.mandates.definitions.mandate_personal_name.MandatePersonalName

Bases: ingenico.connect.sdk.data_object.DataObject

first_name

Given name(s) or first name(s) of the customer

Type: str

from_dictionary(dictionary)

surname

Surname(s) or last name(s) of the customer

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.mandates.definitions.mandate_redirect_data.MandateRedirectData

Bases: ingenico.connect.sdk.domain.definitions.redirect_data_base.RedirectDataBase

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.mandates.definitions.mandate_response.MandateResponse

Bases: ingenico.connect.sdk.data_object.DataObject

alias

An alias for the mandate. This can be used to visually represent the mandate.

Do not include any unobfuscated sensitive data in the alias.

Default value if not provided is the obfuscated IBAN of the customer.

Type: str

customer

Customer object containing customer specific inputs

Type: ingenico.connect.sdk.domain.mandates.definitions.mandate_customer.MandateCustomer

customer_reference

The unique identifier of the customer to which this mandate is applicable

Type: str

from_dictionary(dictionary)

recurrence_type

Specifieds whether the mandate is for one-off or recurring payments.

Type: str

status

The status of the mandate. Possible values are:

• ACTIVE
• EXPIRED
• CREATED
• REVOKED
• WAITING_FOR_REFERENCE
• BLOCKED
• USED

Type: str

to_dictionary()

unique_mandate_reference

The unique identifier of the mandate

Type: str

class ingenico.connect.sdk.domain.metadata.shopping_cart_extension.ShoppingCartExtension(creator, name, version, extension_id=None)

Bases: ingenico.connect.sdk.data_object.DataObject

static create_from_dictionary(dictionary)

creator

extension_id

from_dictionary(dictionary)

name

to_dictionary()

version

class ingenico.connect.sdk.domain.payment.approve_payment_request.ApprovePaymentRequest

Bases: ingenico.connect.sdk.data_object.DataObject

amount

In case you want to approve the capture of a different lower amount you can specify this here (specified in cents, where single digit currencies are presumed to have 2 digits)

Type: long

direct_debit_payment_method_specific_input

Object that holds non-SEPA Direct Debit specific input data

Type: ingenico.connect.sdk.domain.payment.definitions.approve_payment_non_sepa_direct_debit_payment_method_specific_input.ApprovePaymentNonSepaDirectDebitPaymentMethodSpecificInput

from_dictionary(dictionary)

order

Object that holds the order data

Type: ingenico.connect.sdk.domain.payment.definitions.order_approve_payment.OrderApprovePayment

sepa_direct_debit_payment_method_specific_input

Object that holds SEPA Direct Debit specific input data

Type: ingenico.connect.sdk.domain.payment.definitions.approve_payment_sepa_direct_debit_payment_method_specific_input.ApprovePaymentSepaDirectDebitPaymentMethodSpecificInput

to_dictionary()

class ingenico.connect.sdk.domain.payment.cancel_approval_payment_response.CancelApprovalPaymentResponse

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

payment

Object that holds the payment related properties

Type: ingenico.connect.sdk.domain.payment.definitions.payment.Payment

to_dictionary()

class ingenico.connect.sdk.domain.payment.cancel_payment_response.CancelPaymentResponse

Bases: ingenico.connect.sdk.data_object.DataObject

Response to the cancelation of a payment

card_payment_method_specific_output

Object that holds specific information on cancelled card payments

Type: ingenico.connect.sdk.domain.payment.definitions.cancel_payment_card_payment_method_specific_output.CancelPaymentCardPaymentMethodSpecificOutput

from_dictionary(dictionary)

mobile_payment_method_specific_output

Object that holds specific information on cancelled mobile payments

Type: ingenico.connect.sdk.domain.payment.definitions.cancel_payment_mobile_payment_method_specific_output.CancelPaymentMobilePaymentMethodSpecificOutput

payment

Object that holds the payment related properties

Type: ingenico.connect.sdk.domain.payment.definitions.payment.Payment

to_dictionary()

class ingenico.connect.sdk.domain.payment.capture_payment_request.CapturePaymentRequest

Bases: ingenico.connect.sdk.data_object.DataObject

amount

Here you can specify the amount that you want to capture (specified in cents, where single digit currencies are presumed to have 2 digits).

The amount can be lower than the amount that was authorized, but not higher.

If left empty, the full amount will be captured and the request will be final.

If the full amount is captured, the request will also be final.

Type: long

from_dictionary(dictionary)

is_final

This property indicates whether this will be the final capture of this transaction.

The default value for this property is false.

Type: bool

to_dictionary()

class ingenico.connect.sdk.domain.payment.complete_payment_request.CompletePaymentRequest

Bases: ingenico.connect.sdk.data_object.DataObject

card_payment_method_specific_input

Object containing the specific input details for card payments

Type: ingenico.connect.sdk.domain.payment.definitions.complete_payment_card_payment_method_specific_input.CompletePaymentCardPaymentMethodSpecificInput

from_dictionary(dictionary)

merchant

Object containing information on you, the merchant

Type: ingenico.connect.sdk.domain.payment.definitions.merchant.Merchant

order

Order object containing order related data

Type: ingenico.connect.sdk.domain.payment.definitions.order.Order

to_dictionary()

class ingenico.connect.sdk.domain.payment.complete_payment_response.CompletePaymentResponse

Bases: ingenico.connect.sdk.domain.payment.definitions.create_payment_result.CreatePaymentResult

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.payment.create_payment_request.CreatePaymentRequest

Bases: ingenico.connect.sdk.data_object.DataObject

bank_transfer_payment_method_specific_input

Object containing the specific input details for bank transfer payments

Type: ingenico.connect.sdk.domain.payment.definitions.bank_transfer_payment_method_specific_input.BankTransferPaymentMethodSpecificInput

card_payment_method_specific_input

Object containing the specific input details for card payments

Type: ingenico.connect.sdk.domain.payment.definitions.card_payment_method_specific_input.CardPaymentMethodSpecificInput

cash_payment_method_specific_input

Object containing the specific input details for cash payments

Type: ingenico.connect.sdk.domain.payment.definitions.cash_payment_method_specific_input.CashPaymentMethodSpecificInput

direct_debit_payment_method_specific_input

Object containing the specific input details for direct debit payments

Type: ingenico.connect.sdk.domain.payment.definitions.non_sepa_direct_debit_payment_method_specific_input.NonSepaDirectDebitPaymentMethodSpecificInput

e_invoice_payment_method_specific_input

Object containing the specific input details for e-invoice payments.

Type: ingenico.connect.sdk.domain.payment.definitions.e_invoice_payment_method_specific_input.EInvoicePaymentMethodSpecificInput

encrypted_customer_input

Data that was encrypted client side containing all customer entered data elements like card data.

Note: Because this data can only be submitted once to our system and contains encrypted card data you should not store it. As the data was captured within the context of a client session you also need to submit it to us before the session has expired.

Type: str

fraud_fields

Object containing additional data that will be used to assess the risk of fraud

Type: ingenico.connect.sdk.domain.definitions.fraud_fields.FraudFields

from_dictionary(dictionary)

invoice_payment_method_specific_input

Object containing the specific input details for invoice payments

Type: ingenico.connect.sdk.domain.payment.definitions.invoice_payment_method_specific_input.InvoicePaymentMethodSpecificInput

merchant

Object containing information on you, the merchant

Type: ingenico.connect.sdk.domain.payment.definitions.merchant.Merchant

mobile_payment_method_specific_input

Object containing the specific input details for mobile payments.

Mobile payments produce the required payment data in encrypted form.

• For Apple Pay, the encrypted payment data is the PKPayment <https://developer.apple.com/documentation/passkit/pkpayment>.token.paymentData object passed as a string (with all quotation marks escaped).
• For Google Pay, the encrypted payment data can be found in property paymentMethodData.tokenizationData.token of the PaymentData <https://developers.google.com/android/reference/com/google/android/gms/wallet/PaymentData>.toJson() result.

Type: ingenico.connect.sdk.domain.payment.definitions.mobile_payment_method_specific_input.MobilePaymentMethodSpecificInput

order

Order object containing order related data

Please note that this object is required to be able to submit the amount.

Type: ingenico.connect.sdk.domain.payment.definitions.order.Order

redirect_payment_method_specific_input

Object containing the specific input details for payments that involve redirects to 3rd parties to complete, like iDeal and PayPal

Type: ingenico.connect.sdk.domain.payment.definitions.redirect_payment_method_specific_input.RedirectPaymentMethodSpecificInput

sepa_direct_debit_payment_method_specific_input

Object containing the specific input details for SEPA direct debit payments

Type: ingenico.connect.sdk.domain.payment.definitions.sepa_direct_debit_payment_method_specific_input.SepaDirectDebitPaymentMethodSpecificInput

to_dictionary()

class ingenico.connect.sdk.domain.payment.create_payment_response.CreatePaymentResponse

Bases: ingenico.connect.sdk.domain.payment.definitions.create_payment_result.CreatePaymentResult

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.payment.device_fingerprint_details.DeviceFingerprintDetails

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

payment_id

The ID of the payment that is linked to the Device Fingerprint data.

Type: str

raw_device_fingerprint_output

The detailed data that was collected during the Device Fingerprint collection. The structure will be different depending on the collection method and device fingerprint partner used. Please contact us if you want more information on the details that are returned in this string.

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.payment.find_payments_response.FindPaymentsResponse

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

limit

The limit you used in the request.

Type: int

offset

The offset you used in the request.

Type: int

payments

A list of payments that matched your filter, starting at the given offset and limited to the given limit.

Type: list[ingenico.connect.sdk.domain.payment.definitions.payment.Payment]

to_dictionary()

total_count

The total number of payments that matched your filter.

Type: int

class ingenico.connect.sdk.domain.payment.payment_approval_response.PaymentApprovalResponse

Bases: ingenico.connect.sdk.data_object.DataObject

card_payment_method_specific_output

Object containing additional card payment method specific details

Type: ingenico.connect.sdk.domain.payment.definitions.approve_payment_card_payment_method_specific_output.ApprovePaymentCardPaymentMethodSpecificOutput

from_dictionary(dictionary)

mobile_payment_method_specific_output

Object containing additional mobile payment method specific details

Type: ingenico.connect.sdk.domain.payment.definitions.approve_payment_mobile_payment_method_specific_output.ApprovePaymentMobilePaymentMethodSpecificOutput

payment

Object that holds the payment data

Type: ingenico.connect.sdk.domain.payment.definitions.payment.Payment

payment_method_specific_output

Object containing additional payment method specific details

Deprecated: this property does not support different outputs for payment methods other than cards. Please use cardPaymentMethodSpecificOutput instead.

Type: ingenico.connect.sdk.domain.payment.definitions.approve_payment_card_payment_method_specific_output.ApprovePaymentCardPaymentMethodSpecificOutput

Deprecated; Use cardPaymentMethodSpecificOutput instead

to_dictionary()

class ingenico.connect.sdk.domain.payment.payment_error_response.PaymentErrorResponse

Bases: ingenico.connect.sdk.data_object.DataObject

error_id

Unique reference, for debugging purposes, of this error response

Type: str

errors

List of one or more errors

Type: list[ingenico.connect.sdk.domain.errors.definitions.api_error.APIError]

from_dictionary(dictionary)

payment_result

Object that contains details on the created payment in case one has been created

Type: ingenico.connect.sdk.domain.payment.definitions.create_payment_result.CreatePaymentResult

to_dictionary()

class ingenico.connect.sdk.domain.payment.payment_response.PaymentResponse

Bases: ingenico.connect.sdk.domain.payment.definitions.payment.Payment

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.payment.third_party_status_response.ThirdPartyStatusResponse

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

third_party_status

The status returned by the third party.Possible values:

• WAITING - The customer has not connected to the third party
• INITIALIZED - Authentication in progress
• AUTHORIZED - Payment in progress
• COMPLETED - The customer has completed the payment at the third party

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.payment.tokenize_payment_request.TokenizePaymentRequest

Bases: ingenico.connect.sdk.data_object.DataObject

alias

An alias for the token. This can be used to visually represent the token.

If no alias is given, a payment product specific default is used, e.g. the obfuscated card number for card payment products.

Do not include any unobfuscated sensitive data in the alias.

Type: str

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.abstract_bank_transfer_payment_method_specific_input.AbstractBankTransferPaymentMethodSpecificInput

Bases: ingenico.connect.sdk.domain.definitions.abstract_payment_method_specific_input.AbstractPaymentMethodSpecificInput

additional_reference

Type: str

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.abstract_card_payment_method_specific_input.AbstractCardPaymentMethodSpecificInput

Bases: ingenico.connect.sdk.domain.definitions.abstract_payment_method_specific_input.AbstractPaymentMethodSpecificInput

acquirer_promotion_code

Type: str

authorization_mode

Type: str

customer_reference

Type: str

from_dictionary(dictionary)

initial_scheme_transaction_id

Type: str

recurring

Type: ingenico.connect.sdk.domain.payment.definitions.card_recurrence_details.CardRecurrenceDetails

recurring_payment_sequence_indicator

Type: str

Deprecated; Use recurring.recurringPaymentSequenceIndicator instead

requires_approval

Type: bool

skip_authentication

Type: bool

Deprecated; Use threeDSecure.skipAuthentication instead

skip_fraud_service

Type: bool

to_dictionary()

token

Type: str

tokenize

Type: bool

transaction_channel

Type: str

unscheduled_card_on_file_indicator

Type: str

Deprecated; Use unscheduledCardOnFileSequenceIndicator instead

unscheduled_card_on_file_requestor

Type: str

unscheduled_card_on_file_sequence_indicator

Type: str

class ingenico.connect.sdk.domain.payment.definitions.abstract_cash_payment_method_specific_input.AbstractCashPaymentMethodSpecificInput

Bases: ingenico.connect.sdk.domain.definitions.abstract_payment_method_specific_input.AbstractPaymentMethodSpecificInput

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.abstract_e_invoice_payment_method_specific_input.AbstractEInvoicePaymentMethodSpecificInput

Bases: ingenico.connect.sdk.domain.definitions.abstract_payment_method_specific_input.AbstractPaymentMethodSpecificInput

from_dictionary(dictionary)

requires_approval

Type: bool

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.abstract_payment_method_specific_output.AbstractPaymentMethodSpecificOutput

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

payment_product_id

Payment product identifier

Please see payment products <https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/paymentproducts.html> for a full overview of possible values.

Type: int

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.abstract_redirect_payment_method_specific_input.AbstractRedirectPaymentMethodSpecificInput

Bases: ingenico.connect.sdk.domain.definitions.abstract_payment_method_specific_input.AbstractPaymentMethodSpecificInput

expiration_period

Type: int

from_dictionary(dictionary)

recurring_payment_sequence_indicator

Type: str

requires_approval

Type: bool

to_dictionary()

token

Type: str

tokenize

Type: bool

class ingenico.connect.sdk.domain.payment.definitions.abstract_redirect_payment_product4101_specific_input.AbstractRedirectPaymentProduct4101SpecificInput

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.abstract_redirect_payment_product840_specific_input.AbstractRedirectPaymentProduct840SpecificInput

Bases: ingenico.connect.sdk.data_object.DataObject

address_selection_at_pay_pal

Type: bool

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.abstract_sepa_direct_debit_payment_method_specific_input.AbstractSepaDirectDebitPaymentMethodSpecificInput

Bases: ingenico.connect.sdk.domain.definitions.abstract_payment_method_specific_input.AbstractPaymentMethodSpecificInput

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.abstract_sepa_direct_debit_payment_product771_specific_input.AbstractSepaDirectDebitPaymentProduct771SpecificInput

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

mandate_reference

Type: str

Deprecated; Use existingUniqueMandateReference or mandate.uniqueMandateReference instead

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.abstract_three_d_secure.AbstractThreeDSecure

Bases: ingenico.connect.sdk.data_object.DataObject

authentication_amount

Type: ingenico.connect.sdk.domain.definitions.amount_of_money.AmountOfMoney

authentication_flow

Type: str

challenge_canvas_size

Type: str

challenge_indicator

Type: str

exemption_request

Type: str

from_dictionary(dictionary)

prior_three_d_secure_data

Type: ingenico.connect.sdk.domain.payment.definitions.three_d_secure_data.ThreeDSecureData

sdk_data

Type: ingenico.connect.sdk.domain.payment.definitions.sdk_data_input.SdkDataInput

skip_authentication

Type: bool

to_dictionary()

transaction_risk_level

Type: str

class ingenico.connect.sdk.domain.payment.definitions.account_funding_recipient.AccountFundingRecipient

Bases: ingenico.connect.sdk.data_object.DataObject

Object containing specific data regarding the recipient of an account funding transaction

account_number

Should be populated with the value of the corresponding accountNumberType of the recipient.

Type: str

account_number_type

Defines the account number type of the recipient. Possible values are:

• cash = Mode of payment is cash to the recipient.
• walletId = Digital wallet ID.
• routingNumber = Routing Transit Number is a code used by financial institutions to identify other financial institutions.
• iban = International Bank Account Number, is a standard international numbering system for identifying bank accounts.
• bicNumber = Bank Identification Code is a number that is used to identify a specific bank.
• giftCard = Gift card is a type of prepaid card that contains a specific amount of money that can be used at participating stores and marketplaces.

Type: str

address

Object containing the address details of the recipient of an account funding transaction.

Type: ingenico.connect.sdk.domain.definitions.address.Address

date_of_birth

The date of birth of the recipient

Format: YYYYMMDD

Type: str

from_dictionary(dictionary)

name

Object containing the name details of the recipient of an account funding transaction.

Type: ingenico.connect.sdk.domain.payment.definitions.afr_name.AfrName

partial_pan

Either partialPan or accountnumber is required for merchants that use Merchant Category Code (MCC) 6012 for transactions involving UK costumers.

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.additional_order_input.AdditionalOrderInput

Bases: ingenico.connect.sdk.data_object.DataObject

account_funding_recipient

Object containing specific data regarding the recipient of an account funding transaction

Type: ingenico.connect.sdk.domain.payment.definitions.account_funding_recipient.AccountFundingRecipient

airline_data

Object that holds airline specific data

Type: ingenico.connect.sdk.domain.definitions.airline_data.AirlineData

from_dictionary(dictionary)

installments

Object containing data related to installments which can be used for card payments and only with some acquirers. In case you send in the details of this object, only the combination of card products and acquirers that do support installments will be shown on the MyCheckout hosted payment pages.

Type: ingenico.connect.sdk.domain.payment.definitions.installments.Installments

level3_summary_data

Object that holds Level3 summary data

Type: ingenico.connect.sdk.domain.payment.definitions.level3_summary_data.Level3SummaryData

Deprecated; Use Order.shoppingCart.amountBreakdown instead

loan_recipient

Object containing specific data regarding the recipient of a loan in the UK

Type: ingenico.connect.sdk.domain.payment.definitions.loan_recipient.LoanRecipient

Deprecated; No replacement

lodging_data

Object that holds lodging specific data

Type: ingenico.connect.sdk.domain.definitions.lodging_data.LodgingData

number_of_installments

The number of installments in which this transaction will be paid, which can be used for card payments. Only used with some acquirers. In case you send in the details of this object, only the combination of card products and acquirers that do support installments will be shown on the MyCheckout hosted payment pages.

Type: long

Deprecated; Use installments.numberOfInstallments instead

order_date

Date and time of order

Format: YYYYMMDDHH24MISS

Type: str

to_dictionary()

type_information

Object that holds the purchase and usage type indicators

Type: ingenico.connect.sdk.domain.payment.definitions.order_type_information.OrderTypeInformation

class ingenico.connect.sdk.domain.payment.definitions.address_personal.AddressPersonal

Bases: ingenico.connect.sdk.domain.definitions.address.Address

from_dictionary(dictionary)

name

Object that holds the name elements

Type: ingenico.connect.sdk.domain.payment.definitions.personal_name.PersonalName

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.afr_name.AfrName

Bases: ingenico.connect.sdk.data_object.DataObject

first_name

Given name(s) or first name(s) of the recipient of an account funding transaction.

Type: str

from_dictionary(dictionary)

surname

Surname(s) or last name(s) of the customer

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.amount_breakdown.AmountBreakdown

Bases: ingenico.connect.sdk.data_object.DataObject

amount

Amount in cents and always having 2 decimals

Type: long

from_dictionary(dictionary)

to_dictionary()

type

Type of the amount. Each type is only allowed to be provided once. Allowed values:

• AIRPORT_TAX - The amount of tax paid for the airport, with the last 2 digits implied as decimal places.
• CONSUMPTION_TAX - The amount of consumption tax paid by the customer, with the last 2 digits implied as decimal places.
• DISCOUNT - Discount on the entire transaction, with the last 2 digits implied as decimal places.
• DUTY - Duty on the entire transaction, with the last 2 digits implied as decimal places.
• HANDLING - Handling cost on the entire transaction, with the last 2 digits implied as decimal places.
• SHIPPING - Shipping cost on the entire transaction, with the last 2 digits implied as decimal places.
• TAX - Total tax paid on the entire transaction, with the last 2 digits implied as decimal places.
• VAT - Total amount of VAT paid on the transaction, with the last 2 digits implied as decimal places.
• BASE_AMOUNT - Order amount excluding all taxes, discount & shipping costs, with the last 2 digits implied as decimal places.Note: BASE_AMOUNT is only supported by the GlobalCollect and Ogone Payment Platforms.

Type: str

class ingenico.connect.sdk.domain.payment.definitions.approve_payment_card_payment_method_specific_output.ApprovePaymentCardPaymentMethodSpecificOutput

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

to_dictionary()

void_response_id

Result of the authorization reversal request

Possible values are:

• 00 - Successful reversal
• 0, 8 or 11 - Reversal request submitted
• 5 or 55 - Reversal request declined or referred
• empty or 98 - The provider did not provide a response

Type: str

class ingenico.connect.sdk.domain.payment.definitions.approve_payment_direct_debit_payment_method_specific_input.ApprovePaymentDirectDebitPaymentMethodSpecificInput

Bases: ingenico.connect.sdk.domain.payment.definitions.approve_payment_payment_method_specific_input.ApprovePaymentPaymentMethodSpecificInput

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.approve_payment_mobile_payment_method_specific_output.ApprovePaymentMobilePaymentMethodSpecificOutput

Bases: ingenico.connect.sdk.data_object.DataObject

Mobile payment specific response data

from_dictionary(dictionary)

to_dictionary()

void_response_id

Result of the authorization reversal request

Possible values are:

• 00 - Successful reversal
• 0, 8 or 11 - Reversal request submitted
• 5 or 55 - Reversal request declined or referred
• empty or 98 - The provider did not provide a response

Type: str

class ingenico.connect.sdk.domain.payment.definitions.approve_payment_non_sepa_direct_debit_payment_method_specific_input.ApprovePaymentNonSepaDirectDebitPaymentMethodSpecificInput

Bases: ingenico.connect.sdk.domain.payment.definitions.approve_payment_direct_debit_payment_method_specific_input.ApprovePaymentDirectDebitPaymentMethodSpecificInput

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.approve_payment_payment_method_specific_input.ApprovePaymentPaymentMethodSpecificInput

Bases: ingenico.connect.sdk.data_object.DataObject

date_collect

The desired date for the collection

Format: YYYYMMDD

Type: str

from_dictionary(dictionary)

to_dictionary()

token

Token containing tokenized bank account details

Type: str

class ingenico.connect.sdk.domain.payment.definitions.approve_payment_sepa_direct_debit_payment_method_specific_input.ApprovePaymentSepaDirectDebitPaymentMethodSpecificInput

Bases: ingenico.connect.sdk.domain.payment.definitions.approve_payment_direct_debit_payment_method_specific_input.ApprovePaymentDirectDebitPaymentMethodSpecificInput

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.bank_transfer_payment_method_specific_input.BankTransferPaymentMethodSpecificInput

Bases: ingenico.connect.sdk.domain.payment.definitions.abstract_bank_transfer_payment_method_specific_input.AbstractBankTransferPaymentMethodSpecificInput

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.bank_transfer_payment_method_specific_input_base.BankTransferPaymentMethodSpecificInputBase

Bases: ingenico.connect.sdk.domain.payment.definitions.abstract_bank_transfer_payment_method_specific_input.AbstractBankTransferPaymentMethodSpecificInput

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.bank_transfer_payment_method_specific_output.BankTransferPaymentMethodSpecificOutput

Bases: ingenico.connect.sdk.domain.payment.definitions.abstract_payment_method_specific_output.AbstractPaymentMethodSpecificOutput

fraud_results

Object containing the results of the fraud screening

Type: ingenico.connect.sdk.domain.definitions.fraud_results.FraudResults

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.browser_data.BrowserData

Bases: ingenico.connect.sdk.data_object.DataObject

Object containing information regarding the browser of the customer

color_depth

ColorDepth in bits. Value is returned from the screen.colorDepth property.

If you use the latest version of our JavaScript Client SDK, we will collect this data and include it in the encryptedCustomerInput property. We will then automatically populate this data if available.

Note: This data can only be collected if JavaScript is enabled in the browser. This means that 3-D Secure version 2.1 requires the use of JavaScript to enabled. In the upcoming version 2.2 of the specification this is no longer a requirement. As we currently support version 2.1 it means that this property is required when cardPaymentMethodSpecifInput.threeDSecure.authenticationFlow is set to “browser”.

Type: int

from_dictionary(dictionary)

inner_height

The innerHeight of the frame in case you are capturing your payments in a frame. We will use this to validate if the height provided in the cardPaymentMethodSpecifInput.threeDSecure.challengeCanvasSize will actually fit in the iFrame you use.

Type: str

inner_width

The innerWidth of the frame in case you are capturing your payments in a frame. We will use this to validate if the width provided in the cardPaymentMethodSpecifInput.threeDSecure.challengeCanvasSize will actually fit in the iFrame you use.

Type: str

java_enabled

true =Java is enabled in the browser

false = Java is not enabled in the browser

Value is returned from the navigator.javaEnabled property.

If you use the latest version of our JavaScript Client SDK, we will collect this data and include it in the encryptedCustomerInput property. We will then automatically populate this data if available.

Note: This data can only be collected if JavaScript is enabled in the browser. This means that 3-D Secure version 2.1 requires the use of JavaScript to enabled. In the upcoming version 2.2 of the specification this is no longer a requirement. As we currently support version 2.1 it means that this property is required when cardPaymentMethodSpecifInput.threeDSecure.authenticationFlow is set to “browser”.

Type: bool

java_script_enabled

true = JavaScript is enabled in the browser

false = JavaScript is not enabled in the browser

Note: Required in future 3-D Secure version 2.2.

Type: bool

screen_height

Height of the screen in pixels. Value is returned from the screen.height property.

If you use the latest version of our JavaScript Client SDK, we will collect this data and include it in the encryptedCustomerInput property. We will then automatically populate this data if available.

Note: This data can only be collected if JavaScript is enabled in the browser. This means that 3-D Secure version 2.1 requires the use of JavaScript to enabled. In the upcoming version 2.2 of the specification this is no longer a requirement. As we currently support version 2.1 it means that this property is required when cardPaymentMethodSpecifInput.threeDSecure.authenticationFlow is set to “browser”.

Type: str

screen_width

Width of the screen in pixels. Value is returned from the screen.width property.

If you use the latest version of our JavaScript Client SDK, we will collect this data and include it in the encryptedCustomerInput property. We will then automatically populate this data if available.

Note: This data can only be collected if JavaScript is enabled in the browser. This means that 3-D Secure version 2.1 requires the use of JavaScript to enabled. In the upcoming version 2.2 of the specification this is no longer a requirement. As we currently support version 2.1 it means that this property is required when cardPaymentMethodSpecifInput.threeDSecure.authenticationFlow is set to “browser”.

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.cancel_payment_card_payment_method_specific_output.CancelPaymentCardPaymentMethodSpecificOutput

Bases: ingenico.connect.sdk.data_object.DataObject

Content of the cardPaymentMethodSpecificOutput object from the CancelPaymentResponse

from_dictionary(dictionary)

to_dictionary()

void_response_id

Result of the authorization reversal request

Possible values are:

• 00 - Successful reversal
• 0, 8 or 11 - Reversal request submitted
• 5 or 55 - Reversal request declined or referred
• empty or 98 - The provider did not provide a response

Type: str

class ingenico.connect.sdk.domain.payment.definitions.cancel_payment_mobile_payment_method_specific_output.CancelPaymentMobilePaymentMethodSpecificOutput

Bases: ingenico.connect.sdk.data_object.DataObject

Content of the mobilePaymentMethodSpecificOutput object from the CancelPaymentResponse

from_dictionary(dictionary)

to_dictionary()

void_response_id

Result of the authorization reversal request

Possible values are:

• 00 - Successful reversal
• 0, 8 or 11 - Reversal request submitted
• 5 or 55 - Reversal request declined or referred
• empty or 98 - The provider did not provide a response

Type: str

class ingenico.connect.sdk.domain.payment.definitions.card_payment_method_specific_input.CardPaymentMethodSpecificInput

Bases: ingenico.connect.sdk.domain.payment.definitions.abstract_card_payment_method_specific_input.AbstractCardPaymentMethodSpecificInput

card

Object containing card details. The card details will be ignored in case the property networkTokenData is present.

Type: ingenico.connect.sdk.domain.definitions.card.Card

external_cardholder_authentication_data

Object containing 3D secure details.

Type: ingenico.connect.sdk.domain.payment.definitions.external_cardholder_authentication_data.ExternalCardholderAuthenticationData

Deprecated; Use threeDSecure.externalCardholderAuthenticationData instead

from_dictionary(dictionary)

is_recurring

Indicates if this transaction is of a one-off or a recurring type

• true - This is recurring
• false - This is one-off

Type: bool

merchant_initiated_reason_indicator

Indicates reason behind the merchant initiated transaction. These are industry specific.

Possible values:

• delayedCharges - Delayed charges are performed to process a supplemental account charge after original services have been rendered and respective payment has been processed. This is typically used in hotel, cruise lines and vehicle rental environments to perform a supplemental payment after the original services are rendered.
• noShow - Cardholders can use their cards to make a guaranteed reservation with certain merchant segments. A guaranteed reservation ensures that the reservation will be honored and allows a merchant to perform a No Show transaction to charge the cardholder a penalty according to the merchant’s cancellation policy. For merchants that accept token-based payment credentials to guarantee a reservation, it is necessary to perform a customer initiated (Account Verification) at the time of reservation to be able perform a No Show transaction later.

Type: str

network_token_data

Object holding data that describes a network token

Type: ingenico.connect.sdk.domain.payment.definitions.scheme_token_data.SchemeTokenData

return_url

The URL that the customer is redirect to after the payment flow has finished. You can add any number of key value pairs in the query string that, for instance help you to identify the customer when they return to your site. Please note that we will also append some additional key value pairs that will also help you with this identification process.

Note: The provided URL should be absolute and contain the protocol to use, e.g. http:// or https://. For use on mobile devices a custom protocol can be used in the form of protocol://. This protocol must be registered on the device first.

URLs without a protocol will be rejected.

Type: str

Deprecated; Use threeDSecure.redirectionData.returnUrl instead

three_d_secure

Object containing specific data regarding 3-D Secure

Type: ingenico.connect.sdk.domain.payment.definitions.three_d_secure.ThreeDSecure

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.card_payment_method_specific_input_base.CardPaymentMethodSpecificInputBase

Bases: ingenico.connect.sdk.domain.payment.definitions.abstract_card_payment_method_specific_input.AbstractCardPaymentMethodSpecificInput

from_dictionary(dictionary)

three_d_secure

Object containing specific data regarding 3-D Secure

Type: ingenico.connect.sdk.domain.payment.definitions.three_d_secure_base.ThreeDSecureBase

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.card_payment_method_specific_output.CardPaymentMethodSpecificOutput

Bases: ingenico.connect.sdk.domain.payment.definitions.abstract_payment_method_specific_output.AbstractPaymentMethodSpecificOutput

Card payment specific response data

authorisation_code

Card Authorization code as returned by the acquirer

Type: str

card

Object containing card details

Type: ingenico.connect.sdk.domain.definitions.card_essentials.CardEssentials

fraud_results

Fraud results contained in the CardFraudResults object

Type: ingenico.connect.sdk.domain.definitions.card_fraud_results.CardFraudResults

from_dictionary(dictionary)

initial_scheme_transaction_id

The unique scheme transactionId of the initial transaction that was performed with SCA.

Should be stored by the merchant to allow it to be submitted in future transactions.

Type: str

scheme_transaction_id

The unique scheme transactionId of this transaction.

Should be stored by the merchant to allow it to be submitted in future transactions. Use this value in case the initialSchemeTransactionId property is empty.

Type: str

three_d_secure_results

3D Secure results object

Type: ingenico.connect.sdk.domain.payment.definitions.three_d_secure_results.ThreeDSecureResults

to_dictionary()

token

If a token was used for or created during the payment, then the ID of that token.

Type: str

class ingenico.connect.sdk.domain.payment.definitions.card_recurrence_details.CardRecurrenceDetails

Bases: ingenico.connect.sdk.data_object.DataObject

end_date

Date in YYYYMMDD after which there will be no further charges. If no value is provided we will set a default value of five years after we processed the first recurring transaction.

Type: str

from_dictionary(dictionary)

min_frequency

Minimum number of days between authorizations. If no value is provided we will set a default value of 30 days.

Type: int

recurring_payment_sequence_indicator

• first = This transaction is the first of a series of recurring transactions
• recurring = This transaction is a subsequent transaction in a series of recurring transactions
• last = This transaction is the last of a series of recurring transactions for payments that are processed by the WL Online Payment Acceptance platform

Note: For any first of a recurring the system will automatically create a token as you will need to use a token for any subsequent recurring transactions. In case a token already exists this is indicated in the response with a value of False for the isNewToken property in the response.

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.cash_payment_method_specific_input.CashPaymentMethodSpecificInput

Bases: ingenico.connect.sdk.domain.payment.definitions.abstract_cash_payment_method_specific_input.AbstractCashPaymentMethodSpecificInput

from_dictionary(dictionary)

payment_product1503_specific_input

Object that holds the specific data for Boleto Bancario in Brazil (payment product 1503)

Type: ingenico.connect.sdk.domain.payment.definitions.cash_payment_product1503_specific_input.CashPaymentProduct1503SpecificInput

Deprecated; No replacement

payment_product1504_specific_input

Object that holds the specific data for Konbini in Japan (payment product 1504)

Type: ingenico.connect.sdk.domain.payment.definitions.cash_payment_product1504_specific_input.CashPaymentProduct1504SpecificInput

payment_product1521_specific_input

Object that holds the specific data for e-Pay (payment product 1521).

Type: ingenico.connect.sdk.domain.payment.definitions.cash_payment_product1521_specific_input.CashPaymentProduct1521SpecificInput

payment_product1522_specific_input

Object that holds the specific data for Tesco - Paysbuy Cash (payment product 1522).

Type: ingenico.connect.sdk.domain.payment.definitions.cash_payment_product1522_specific_input.CashPaymentProduct1522SpecificInput

payment_product1523_specific_input

Object that holds the specific data for ATM Transfers Indonesia(payment product 1523).

Type: ingenico.connect.sdk.domain.payment.definitions.cash_payment_product1523_specific_input.CashPaymentProduct1523SpecificInput

payment_product1524_specific_input

Object that holds the specific data for DragonPay (payment product 1524).

Type: ingenico.connect.sdk.domain.payment.definitions.cash_payment_product1524_specific_input.CashPaymentProduct1524SpecificInput

payment_product1526_specific_input

Object that holds the specific data for 7-11 MOLPay Cash (payment product 1526).

Type: ingenico.connect.sdk.domain.payment.definitions.cash_payment_product1526_specific_input.CashPaymentProduct1526SpecificInput

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.cash_payment_method_specific_input_base.CashPaymentMethodSpecificInputBase

Bases: ingenico.connect.sdk.domain.payment.definitions.abstract_cash_payment_method_specific_input.AbstractCashPaymentMethodSpecificInput

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.cash_payment_method_specific_output.CashPaymentMethodSpecificOutput

Bases: ingenico.connect.sdk.domain.payment.definitions.abstract_payment_method_specific_output.AbstractPaymentMethodSpecificOutput

fraud_results

Object containing the results of the fraud screening

Type: ingenico.connect.sdk.domain.definitions.fraud_results.FraudResults

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.cash_payment_product1503_specific_input.CashPaymentProduct1503SpecificInput

Bases: ingenico.connect.sdk.data_object.DataObject

Deprecated; No replacement

from_dictionary(dictionary)

return_url

The URL that the customer is redirect to after the payment flow has finished. You can add any number of key value pairs in the query string that, for instance help you to identify the customer when they return to your site. Please note that we will also append some additional key value pairs that will also help you with this identification process.

Note: The provided URL should be absolute and contain the protocol to use, e.g. http:// or https://. For use on mobile devices a custom protocol can be used in the form of protocol://. This protocol must be registered on the device first.

URLs without a protocol will be rejected.

Type: str

Deprecated; No replacement, since Boleto Bancario no longer needs a return URL

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.cash_payment_product1504_specific_input.CashPaymentProduct1504SpecificInput

Bases: ingenico.connect.sdk.domain.payment.definitions.cash_payment_product_with_redirect_specific_input_base.CashPaymentProductWithRedirectSpecificInputBase

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.cash_payment_product1521_specific_input.CashPaymentProduct1521SpecificInput

Bases: ingenico.connect.sdk.domain.payment.definitions.cash_payment_product_with_redirect_specific_input_base.CashPaymentProductWithRedirectSpecificInputBase

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.cash_payment_product1522_specific_input.CashPaymentProduct1522SpecificInput

Bases: ingenico.connect.sdk.domain.payment.definitions.cash_payment_product_with_redirect_specific_input_base.CashPaymentProductWithRedirectSpecificInputBase

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.cash_payment_product1523_specific_input.CashPaymentProduct1523SpecificInput

Bases: ingenico.connect.sdk.domain.payment.definitions.cash_payment_product_with_redirect_specific_input_base.CashPaymentProductWithRedirectSpecificInputBase

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.cash_payment_product1524_specific_input.CashPaymentProduct1524SpecificInput

Bases: ingenico.connect.sdk.domain.payment.definitions.cash_payment_product_with_redirect_specific_input_base.CashPaymentProductWithRedirectSpecificInputBase

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.cash_payment_product1526_specific_input.CashPaymentProduct1526SpecificInput

Bases: ingenico.connect.sdk.domain.payment.definitions.cash_payment_product_with_redirect_specific_input_base.CashPaymentProductWithRedirectSpecificInputBase

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.cash_payment_product_with_redirect_specific_input_base.CashPaymentProductWithRedirectSpecificInputBase

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

return_url

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.complete_payment_card_payment_method_specific_input.CompletePaymentCardPaymentMethodSpecificInput

Bases: ingenico.connect.sdk.data_object.DataObject

card

Object containing card details

Type: ingenico.connect.sdk.domain.definitions.card_without_cvv.CardWithoutCvv

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.contact_details.ContactDetails

Bases: ingenico.connect.sdk.domain.definitions.contact_details_base.ContactDetailsBase

fax_number

Fax number of the customer

Type: str

from_dictionary(dictionary)

mobile_phone_number

International version of the mobile phone number of the customer including the leading + (i.e. +16127779311).

Type: str

phone_number

Phone number of the customer. The ‘+’ character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.

Type: str

to_dictionary()

work_phone_number

International version of the work phone number of the customer including the leading + (i.e. +31235671500)

Type: str

class ingenico.connect.sdk.domain.payment.definitions.create_payment_result.CreatePaymentResult

Bases: ingenico.connect.sdk.data_object.DataObject

creation_output

Object containing the details of the created payment

Type: ingenico.connect.sdk.domain.payment.definitions.payment_creation_output.PaymentCreationOutput

from_dictionary(dictionary)

merchant_action

Object that contains the action, including the needed data, that you should perform next, like showing instruction, showing the transaction results or redirect to a third party to complete the payment

Type: ingenico.connect.sdk.domain.payment.definitions.merchant_action.MerchantAction

payment

Object that holds the payment related properties

Type: ingenico.connect.sdk.domain.payment.definitions.payment.Payment

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.customer.Customer

Bases: ingenico.connect.sdk.domain.definitions.customer_base.CustomerBase

Object containing data related to the customer

account

Object containing data related to the account the customer has with you

Type: ingenico.connect.sdk.domain.payment.definitions.customer_account.CustomerAccount

account_type

Type of the customer account that is used to place this order. Can have one of the following values:

• none - The account that was used to place the order with is a guest account or no account was used at all
• created - The customer account was created during this transaction
• existing - The customer account was an already existing account prior to this transaction

Type: str

billing_address

Object containing billing address details

Type: ingenico.connect.sdk.domain.definitions.address.Address

contact_details

Object containing contact details like email address and phone number

Type: ingenico.connect.sdk.domain.payment.definitions.contact_details.ContactDetails

device

Object containing information on the device and browser of the customer

Type: ingenico.connect.sdk.domain.payment.definitions.customer_device.CustomerDevice

fiscal_number

The fiscal registration number of the customer or the tax registration number of the company in case of a business customer. Please find below specifics per country:

• Argentina - Consumer (DNI) with a length of 7 or 8 digits
• Argentina - Company (CUIT) with a length of 11 digits
• Brazil - Consumer (CPF) with a length of 11 digits
• Brazil - Company (CNPJ) with a length of 14 digits
• Chile - Consumer (RUT) with a length of 9 digits
• Colombia - Consumer (NIT) with a length of 8, 9 or 10 digits
• Denmark - Consumer (CPR-nummer or personnummer) with a length of 10 digits
• Dominican Republic - Consumer (RNC) with a length of 11 digits
• Finland - Consumer (Finnish: henkilötunnus (abbreviated as HETU)) with a length of 11 characters
• India - Consumer (PAN) with a length of 10 characters
• Mexico - Consumer (RFC) with a length of 13 digits
• Mexico - Company (RFC) with a length of 12 digits
• Norway - Consumer (fødselsnummer) with a length of 11 digits
• Peru - Consumer (RUC) with a length of 11 digits
• Sweden - Consumer (personnummer) with a length of 10 or 12 digits
• Uruguay - Consumer (CI) with a length of 8 digits
• Uruguay - Consumer (NIE) with a length of 9 digits
• Uruguay - Company (RUT) with a length of 12 digits

Type: str

from_dictionary(dictionary)

is_company

Indicates if the payer is a company or an individual

• true = This is a company
• false = This is an individual

Type: bool

is_previous_customer

Specifies if the customer has a history of online shopping with the merchant

• true - The customer is a known returning customer
• false - The customer is new/unknown customer

Type: bool

locale

The locale that the customer should be addressed in (for 3rd parties). Note that some 3rd party providers only support the languageCode part of the locale, in those cases we will only use part of the locale provided.

Type: str

personal_information

Object containing personal information like name, date of birth and gender.

Type: ingenico.connect.sdk.domain.payment.definitions.personal_information.PersonalInformation

shipping_address

Object containing shipping address details

Type: ingenico.connect.sdk.domain.payment.definitions.address_personal.AddressPersonal

Deprecated; Use Order.shipping.address instead

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.customer_account.CustomerAccount

Bases: ingenico.connect.sdk.data_object.DataObject

Object containing data related to the account the customer has with you

authentication

Object containing data on the authentication used by the customer to access their account

Type: ingenico.connect.sdk.domain.payment.definitions.customer_account_authentication.CustomerAccountAuthentication

change_date

The last date (YYYYMMDD) on which the customer made changes to their account with you. These are changes to billing & shipping address details, new payment account (tokens), or new users(s) added.

Type: str

changed_during_checkout

true = the customer made changes to their account during this checkout

false = the customer didn’t change anything to their account during this checkout/n

The changes ment here are changes to billing & shipping address details, new payment account (tokens), or new users(s) added.

Type: bool

create_date

The date (YYYYMMDD) on which the customer created their account with you

Type: str

from_dictionary(dictionary)

had_suspicious_activity

Specifies if you have experienced suspicious activity on the account of the customer

true = you have experienced suspicious activity (including previous fraud) on the customer account used for this transaction

false = you have experienced no suspicious activity (including previous fraud) on the customer account used for this transaction

Type: bool

has_forgotten_password

Specifies if the customer (initially) had forgotten their password

• true - The customer has forgotten their password
• false - The customer has not forgotten their password

Type: bool

has_password

Specifies if the customer entered a password to gain access to an account registered with the you

• true - The customer has used a password to gain access
• false - The customer has not used a password to gain access

Type: bool

password_change_date

The last date (YYYYMMDD) on which the customer changed their password for the account used in this transaction

Type: str

password_changed_during_checkout

Indicates if the password of an account is changed during this checkout

true = the customer made changes to their password of the account used during this checkout

alse = the customer didn’t change anything to their password of the account used during this checkout

Type: bool

payment_account_on_file

Object containing information on the payment account data on file (tokens)

Type: ingenico.connect.sdk.domain.payment.definitions.payment_account_on_file.PaymentAccountOnFile

payment_account_on_file_type

Indicates the type of account. For example, for a multi-account card product.

• not-applicable = the card used doesn’t support multiple card products
• credit = the card used is a credit card
• debit = the card used is a debit card

Type: str

payment_activity

Object containing data on the purchase history of the customer with you

Type: ingenico.connect.sdk.domain.payment.definitions.customer_payment_activity.CustomerPaymentActivity

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.customer_account_authentication.CustomerAccountAuthentication

Bases: ingenico.connect.sdk.data_object.DataObject

Object containing data on the authentication used by the customer to access their account

data

Data that documents and supports a specific authentication process submitted using the order.customer.account.authentication.method property. The data submitted using this property will be used by the issuer to validate the used authentication method.

For example, if the order.customer.account.authentication.method is:

• federated-id, then this element can carry information about the provider of the federated ID and related information.
• fido-authentication, then this element can carry the FIDO attestation data (including the signature).
• fido-authentication-with-signed-assurance-data, then this element can carry FIDO Attestation data with the FIDO assurance data signed.
• src-assurance-data, then this element can carry the SRC assurance data

Type: str

from_dictionary(dictionary)

method

Authentication used by the customer on your website or app

Possible values :

• guest = no login occurred, customer is ‘logged in’ as guest
• merchant-credentials = the customer logged in using credentials that are specific to you
• federated-id = the customer logged in using a federated ID
• issuer-credentials = the customer logged in using credentials from the card issuer (of the card used in this transaction)
• third-party-authentication = the customer logged in using third-party authentication
• fido-authentication = the customer logged in using a FIDO authenticator
• fido-authentication-with-signed-assurance-data = the customer logged in using a FIDO authenticator which also provides signed assurance data
• src-assurance-data = the customer authenticated themselves during a Secure Remote Commerce session

Type: str

to_dictionary()

utc_timestamp

Timestamp (YYYYMMDDHHmm) of the authentication of the customer to their account with you

Type: str

class ingenico.connect.sdk.domain.payment.definitions.customer_approve_payment.CustomerApprovePayment

Bases: ingenico.connect.sdk.data_object.DataObject

account_type

Type of the customer account that is used to place this order. Can have one of the following values:

• none - The account that was used to place the order is a guest account or no account was used at all
• created - The customer account was created during this transaction
• existing - The customer account was an already existing account prior to this transaction

Type: str

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.customer_device.CustomerDevice

Bases: ingenico.connect.sdk.data_object.DataObject

Object containing information on the device and browser of the customer

accept_header

The accept-header of the customer client from the HTTP Headers.

Type: str

browser_data

Object containing information regarding the browser of the customer

Type: ingenico.connect.sdk.domain.payment.definitions.browser_data.BrowserData

default_form_fill

Degree of default form fill, with the following possible values:

• automatically - All fields filled automatically
• automatically-but-modified - All fields filled automatically, but some fields were modified manually
• manually - All fields were entered manually

Type: str

device_fingerprint_transaction_id

One must set the deviceFingerprintTransactionId received by the response of the endpoint /{merchant}/products/{paymentProductId}/deviceFingerprint

Type: str

from_dictionary(dictionary)

ip_address

The IP address of the customer client from the HTTP Headers.

Type: str

locale

Locale of the client device/browser. Returned in the browser from the navigator.language property.

If you use the latest version of our JavaScript Client SDK, we will collect this data and include it in the encryptedCustomerInput property. We will then automatically populate this data if available.

Type: str

timezone_offset_utc_minutes

Offset in minutes of timezone of the client versus the UTC. Value is returned by the JavaScript getTimezoneOffset() Method.

If you use the latest version of our JavaScript Client SDK, we will collect this data and include it in the encryptedCustomerInput property. We will then automatically populate this data if available.

Type: str

to_dictionary()

user_agent

User-Agent of the client device/browser from the HTTP Headers.

As a fall-back we will use the userAgent that might be included in the encryptedCustomerInput, but this is captured client side using JavaScript and might be different.

Type: str

class ingenico.connect.sdk.domain.payment.definitions.customer_payment_activity.CustomerPaymentActivity

Bases: ingenico.connect.sdk.data_object.DataObject

Object containing data on the purchase history of the customer with you

from_dictionary(dictionary)

number_of_payment_attempts_last24_hours

Number of payment attempts (so including unsuccessful ones) made by this customer with you in the last 24 hours

Type: int

number_of_payment_attempts_last_year

Number of payment attempts (so including unsuccessful ones) made by this customer with you in the last 12 months

Type: int

number_of_purchases_last6_months

Number of successful purchases made by this customer with you in the last 6 months

Type: int

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.decrypted_payment_data.DecryptedPaymentData

Bases: ingenico.connect.sdk.data_object.DataObject

auth_method

The type of payment credential which the customer used.

• For Google Pay, maps to the paymentMethodDetails.authMethod property in the encrypted payment data.

.

Type: str

Deprecated; Use decryptedPaymentData.paymentMethod instead

cardholder_name

Card holder’s name on the card.

• For Apple Pay, maps to the cardholderName property in the encrypted payment data.
• For Google Pay this is not available in the encrypted payment data, and can be omitted.

Type: str

cryptogram

The 3D secure online payment cryptogram.

• For Apple Pay, maps to the paymentData.onlinePaymentCryptogram property in the encrypted payment data.
• For Google Pay, maps to the paymentMethodDetails.cryptogram property in the encrypted payment data.

Not allowed for Google Pay if the authMethod in the response of Google is PAN_ONLY.

Type: str

dpan

The device specific PAN.

• For Apple Pay, maps to the applicationPrimaryAccountNumber property in the encrypted payment data.
• For Google Pay, maps to the paymentMethodDetails.dpan property in the encrypted payment data.

Not allowed for Google Pay if the authMethod in the response of Google is PAN_ONLY.

Type: str

eci

The eci is Electronic Commerce Indicator.

• For Apple Pay, maps to the paymentData.eciIndicator property in the encrypted payment data.
• For Google Pay, maps to the paymentMethodDetails.eciIndicator property in the encrypted payment data.

Type: int

expiry_date

Expiry date of the card

Format: MMYY.

• For Apple Pay, maps to the applicationExpirationDate property in the encrypted payment data. This property is formatted as YYMMDD, so this needs to be converted to get a correctly formatted expiry date.
• For Google Pay, maps to the paymentMethodDetails.expirationMonth and paymentMethodDetails.expirationYear properties in the encrypted payment data. These need to be combined to get a correctly formatted expiry date.

Type: str

from_dictionary(dictionary)

pan

The non-device specific complete credit/debit card number (also know as the PAN).

• For Apple Pay this is not available in the encrypted payment data, and must be omitted.
• For Google Pay, maps to the paymentMethodDetails.pan property in the encrypted payment data.

Not allowed for Google Pay if the authMethod in the response of Google is CRYPTOGRAM_3DS.

Type: str

payment_method

• In case Google provides in the response as authMethod: CRYPTOGRAM_3DS send in as value of this property TOKENIZED_CARD.
• In case Google provides in the response as authMethod: PAN_ONLY send in as value of this property CARD.

For Apple Pay this is not available in the encrypted payment data, and must be omitted.

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.device_render_options.DeviceRenderOptions

Bases: ingenico.connect.sdk.data_object.DataObject

Object containing rendering options of the device

from_dictionary(dictionary)

sdk_interface

Lists all of the SDK Interface types that the device supports for displaying specific challenge user interfaces within the SDK.

• native = The app supports only a native user interface
• html = The app supports only an HTML user interface
• both = Both Native and HTML user interfaces are supported by the app

Type: str

sdk_ui_type

Lists all UI types that the device supports for displaying specific challenge user interfaces within the SDK.

• text = Text interface
• single-select = Select a single option
• multi-select = Select multiple options
• oob = Out of ounds
• html-other = HTML Other (only valid when cardPaymentMethodSpecificInput.threeDSecure.sdkData.deviceRenderOptions.sdkInterface is set to html)

Type: str

Deprecated; Use deviceRenderOptions.sdkUiTypes instead

sdk_ui_types

Lists all UI types that the device supports for displaying specific challenge user interfaces within the SDK.

• text = Text interface
• single-select = Select a single option
• multi-select = Select multiple options
• oob = Out of ounds
• html-other = HTML Other (only valid when cardPaymentMethodSpecificInput.threeDSecure.sdkData.deviceRenderOptions.sdkInterface is set to html)

Type: list[str]

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.e_invoice_payment_method_specific_input.EInvoicePaymentMethodSpecificInput

Bases: ingenico.connect.sdk.domain.payment.definitions.abstract_e_invoice_payment_method_specific_input.AbstractEInvoicePaymentMethodSpecificInput

accepted_terms_and_conditions

Indicates that the customer has read and accepted the terms and conditions of the product before proceeding with the payment. This must be done before the payment can continue. An URL to the terms and conditions can be retrieved with Get payment product <https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/products/get.html>.

Type: bool

from_dictionary(dictionary)

payment_product9000_specific_input

Object that holds the specific data for AfterPay Installments (payment product 9000).

Type: ingenico.connect.sdk.domain.payment.definitions.e_invoice_payment_product9000_specific_input.EInvoicePaymentProduct9000SpecificInput

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.e_invoice_payment_method_specific_input_base.EInvoicePaymentMethodSpecificInputBase

Bases: ingenico.connect.sdk.domain.payment.definitions.abstract_e_invoice_payment_method_specific_input.AbstractEInvoicePaymentMethodSpecificInput

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.e_invoice_payment_method_specific_output.EInvoicePaymentMethodSpecificOutput

Bases: ingenico.connect.sdk.domain.payment.definitions.abstract_payment_method_specific_output.AbstractPaymentMethodSpecificOutput

E-invoice payment specific response data

fraud_results

Object containing the results of the fraud screening

Type: ingenico.connect.sdk.domain.definitions.fraud_results.FraudResults

from_dictionary(dictionary)

payment_product9000_specific_output

AfterPay Installments (payment product 9000) specific details

Type: ingenico.connect.sdk.domain.payment.definitions.e_invoice_payment_product9000_specific_output.EInvoicePaymentProduct9000SpecificOutput

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.e_invoice_payment_product9000_specific_input.EInvoicePaymentProduct9000SpecificInput

Bases: ingenico.connect.sdk.data_object.DataObject

bank_account_iban

Object containing the bank account details of the customer.

Type: ingenico.connect.sdk.domain.definitions.bank_account_iban.BankAccountIban

from_dictionary(dictionary)

installment_id

The ID of the installment plan selected by the customer. Installment plans can be retrieved with Get payment product <https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/products/get.html>.

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.e_invoice_payment_product9000_specific_output.EInvoicePaymentProduct9000SpecificOutput

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

installment_id

The ID of the installment plan used for the payment.

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.exemption_output.ExemptionOutput

Bases: ingenico.connect.sdk.data_object.DataObject

Object containing exemption output

exemption_raised

Type of strong customer authentication (SCA) exemption that was raised towards the acquirer for this transaction.

Type: str

exemption_rejection_reason

The request exemption could not be granted. The reason why is returned in this property.

Type: str

exemption_request

Type of strong customer authentication (SCA) exemption requested by you for this transaction.

Type: str

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.external_cardholder_authentication_data.ExternalCardholderAuthenticationData

Bases: ingenico.connect.sdk.data_object.DataObject

Object containing 3D secure details.

acs_transaction_id

Identifier of the authenticated transaction at the ACS/Issuer.

Type: str

applied_exemption

Exemption code from Carte Bancaire (130) (unknown possible values so far -free format).

Type: str

cavv

The CAVV (cardholder authentication verification value) or AAV (accountholder authentication value) provides an authentication validation value.

Type: str

cavv_algorithm

The algorithm, from your 3D Secure provider, used to generate the authentication CAVV.

Type: str

directory_server_transaction_id

The 3-D Secure Directory Server transaction ID that is used for the 3D Authentication

Type: str

eci

Electronic Commerce Indicator provides authentication validation results returned after AUTHENTICATIONVALIDATION

• 0 = No authentication, Internet (no liability shift, not a 3D Secure transaction)
• 1 = Authentication attempted (MasterCard)
• 2 = Successful authentication (MasterCard)
• 5 = Successful authentication (Visa, Diners Club, Amex)
• 6 = Authentication attempted (Visa, Diners Club, Amex)
• 7 = No authentication, Internet (no liability shift, not a 3D Secure transaction)
• (empty) = Not checked or not enrolled

Type: int

from_dictionary(dictionary)

scheme_risk_score

Global score calculated by the Carte Bancaire (130) Scoring platform. Possible values from 0 to 99.

Type: int

three_d_secure_version

The 3-D Secure version used for the authentication. Possible values:

• v1
• v2
• 1.0.2
• 2.1.0
• 2.2.0

Type: str

three_d_server_transaction_id

The 3-D Secure Server transaction ID that is used for the 3-D Secure version 2 Authentication.

Type: str

Deprecated; No replacement

to_dictionary()

validation_result

The 3D Secure authentication result from your 3D Secure provider.

Type: str

xid

The transaction ID that is used for the 3D Authentication

Type: str

class ingenico.connect.sdk.domain.payment.definitions.g_pay_three_d_secure.GPayThreeDSecure

Bases: ingenico.connect.sdk.data_object.DataObject

challenge_canvas_size

Dimensions of the challenge window that potentially will be displayed to the customer. The challenge content is formatted to appropriately render in this window to provide the best possible user experience.

Preconfigured sizes are width x height in pixels of the window displayed in the customer browser window. Possible values are:

• 250x400 (default)
• 390x400
• 500x600
• 600x400
• full-screen

.

Type: str

challenge_indicator

Allows you to indicate if you want the customer to be challenged for extra security on this transaction.Possible values:

• no-preference - You have no preference whether or not to challenge the customer (default)
• no-challenge-requested - you prefer the cardholder not to be challenged
• challenge-requested - you prefer the customer to be challenged
• challenge-required - you require the customer to be challenged

Type: str

exemption_request

Type of strong customer authentication (SCA) exemption requested for this transaction. Possible values:

• none - No exemption flagging is to be used of this transaction (Default).
• automatic - Our systems will determine the best possible exemption based on the transaction parameters and the risk scores.
• transaction-risk-analysis - You have determined that this transaction is of low risk and are willing to take the liability. Please note that your fraud rate needs to stay below thresholds to allow your use of this exemption.
• low-value - The value of the transaction is below 30 EUR. Please note that the issuer will still require every 5th low-value transaction pithing 24 hours to be strongly authenticated. The issuer will also keep track of the cumulative amount authorized on the card. When this exceeds 100 EUR strong customer authentication is also required.
• whitelist - You have been whitelisted by the customer at the issuer.

Type: str

from_dictionary(dictionary)

redirection_data

Object containing browser specific redirection related data

Type: ingenico.connect.sdk.domain.payment.definitions.redirection_data.RedirectionData

skip_authentication

• true = 3D Secure authentication will be skipped for this transaction. This setting should be used when isRecurring is set to true and recurringPaymentSequenceIndicator is set to recurring.
• false = 3D Secure authentication will not be skipped for this transaction.

Note: This is only possible if your account in our system is setup for 3D Secure authentication and if your configuration in our system allows you to override it per transaction.

Type: bool

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.gift_card_purchase.GiftCardPurchase

Bases: ingenico.connect.sdk.data_object.DataObject

Object containing information on purchased gift card(s)

amount_of_money

Object containing information on an amount of money

Type: ingenico.connect.sdk.domain.definitions.amount_of_money.AmountOfMoney

from_dictionary(dictionary)

number_of_gift_cards

Number of gift cards that are purchased through this transaction

Type: int

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.hosted_checkout_specific_output.HostedCheckoutSpecificOutput

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

hosted_checkout_id

The ID of the Hosted Checkout Session in which the payment was made.

Type: str

to_dictionary()

variant

Using the Configuration Center it is possible to create multiple variations of your MyCheckout payment pages. By specifying a specific variant you can force the use of another variant then the default. This allows you to test out the effect of certain changes to your hosted mandate pages in a controlled manner. Please note that you need to specify the ID of the variant.

Type: str

class ingenico.connect.sdk.domain.payment.definitions.installments.Installments

Bases: ingenico.connect.sdk.data_object.DataObject

Object containing data related to installments which can be used for card payments and only with some acquirers. In case you send in the details of this object, only the combination of card products and acquirers that do support installments will be shown on the MyCheckout hosted payment pages.

amount_of_money_per_installment

The amount that will be paid per installment. The total amount of amountOfMoneyPerInstallment x numberOfInstallments can not be higher than the total amount of this transaction, although we will not validate that.

For the payment product IDs BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596) and Shinhan Card (paymentProductId 8597), this property is not used as the value is decided by the issuer.

Type: ingenico.connect.sdk.domain.definitions.amount_of_money.AmountOfMoney

amount_of_money_total

Object containing the total amount and ISO currency code attributes

Type: ingenico.connect.sdk.domain.definitions.amount_of_money.AmountOfMoney

frequency_of_installments

The frequency in which the installments will be collected from the customer. The possible values are:

• daily
• weekly
• monthly (default)
• quarterly

For the payment product IDs BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596) and Shinhan Card (paymentProductId 8597), only the value monthly is valid.

Type: str

from_dictionary(dictionary)

installment_plan_code

The code for the installment plan. The possible values are:

• 43 No-interest, 3 month Installmentplan
• **46**No-interest, 6 month Installmentplan
• **49**No-interest, 9 month Installmentplan
• **52**No-interest, 12 month Installmentplan

Type: int

interest_rate

The interest rate paid for installments expressed in percentage. So for example 5.75 means 5.75%

For the payment product IDs BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596) and Shinhan Card (paymentProductId 8597), this property is not used as the value is decided by the issuer.

Type: str

number_of_installments

The number of installments in which this transaction will be paid, which can be used for card payments at supported acquirers, or with specific payment products. Only used with some acquirers. In case you send in the details of this object, only the payment products (or combination of card products and acquirers) that support installments will be shown on the MyCheckout hosted payment pages. If this property is not provided the customer will not see details on the installment plan in a HostedCheckout.

For the payment product IDs BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596) and Shinhan Card (paymentProductId 8597), there is a maximum of 12 installments.

Type: long

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.invoice_payment_method_specific_input.InvoicePaymentMethodSpecificInput

Bases: ingenico.connect.sdk.domain.definitions.abstract_payment_method_specific_input.AbstractPaymentMethodSpecificInput

additional_reference

Your (additional) reference identifier for this transaction. Data supplied in this property will also be returned in our report files, allowing you to reconcile the incoming funds.

Type: str

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.invoice_payment_method_specific_output.InvoicePaymentMethodSpecificOutput

Bases: ingenico.connect.sdk.domain.payment.definitions.abstract_payment_method_specific_output.AbstractPaymentMethodSpecificOutput

fraud_results

Object containing the results of the fraud screening

Type: ingenico.connect.sdk.domain.definitions.fraud_results.FraudResults

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.level3_summary_data.Level3SummaryData

Bases: ingenico.connect.sdk.data_object.DataObject

Deprecated; Use ShoppingCart.amountBreakdown instead

discount_amount

Discount on the entire transaction, with the last 2 digits are implied decimal places

Type: long

Deprecated; Use ShoppingCart.amountBreakdown with type DISCOUNT instead

duty_amount

Duty on the entire transaction, with the last 2 digits are implied decimal places

Type: long

Deprecated; Use ShoppingCart.amountBreakdown with type DUTY instead

from_dictionary(dictionary)

shipping_amount

Shippingcost on the entire transaction, with the last 2 digits are implied decimal places

Type: long

Deprecated; Use ShoppingCart.amountBreakdown with type SHIPPING instead

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.line_item.LineItem

Bases: ingenico.connect.sdk.data_object.DataObject

amount_of_money

Object containing amount and ISO currency code attributes

Note: make sure you submit the amount and currency code for each line item

Type: ingenico.connect.sdk.domain.definitions.amount_of_money.AmountOfMoney

from_dictionary(dictionary)

invoice_data

Object containing the line items of the invoice or shopping cart. The ‘+’ character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.

Type: ingenico.connect.sdk.domain.payment.definitions.line_item_invoice_data.LineItemInvoiceData

level3_interchange_information

Object containing additional information that when supplied can have a beneficial effect on the discountrates

Type: ingenico.connect.sdk.domain.payment.definitions.line_item_level3_interchange_information.LineItemLevel3InterchangeInformation

Deprecated; Use orderLineDetails instead

order_line_details

Object containing additional information that when supplied can have a beneficial effect on the discountrates

Type: ingenico.connect.sdk.domain.payment.definitions.order_line_details.OrderLineDetails

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.line_item_invoice_data.LineItemInvoiceData

Bases: ingenico.connect.sdk.data_object.DataObject

description

Shopping cart item description

Type: str

from_dictionary(dictionary)

merchant_linenumber

Line number for printed invoice or order of items in the cart

Should be a numeric string

Type: str

merchant_pagenumber

Page number for printed invoice

Should be a numeric string

Type: str

nr_of_items

Quantity of the item

Type: str

price_per_item

Price per item

Type: long

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.line_item_level3_interchange_information.LineItemLevel3InterchangeInformation

Bases: ingenico.connect.sdk.data_object.DataObject

discount_amount

Discount on the line item, with the last two digits are implied decimal places

Type: long

from_dictionary(dictionary)

line_amount_total

Total amount for the line item

Type: long

product_code

Product or UPC Code, left justified

Note: Must not be all spaces or all zeros

Type: str

product_price

The price of one unit of the product, the value should be zero or greater

Type: long

product_type

Code used to classify items that are purchased

Note: Must not be all spaces or all zeros

Type: str

quantity

Quantity of the units being purchased, should be greater than zero

Note: Must not be all spaces or all zeros

Type: long

tax_amount

Tax on the line item, with the last two digits are implied decimal places

Type: long

to_dictionary()

unit

Indicates the line item unit of measure; for example: each, kit, pair, gallon, month, etc.

Type: str

class ingenico.connect.sdk.domain.payment.definitions.loan_recipient.LoanRecipient

Bases: ingenico.connect.sdk.data_object.DataObject

Deprecated; No replacement

account_number

Should be filled with the last 10 digits of the bank account number of the recipient of the loan.

Type: str

Deprecated; No replacement

date_of_birth

The date of birth of the customer of the recipient of the loan.

Format: YYYYMMDD

Type: str

Deprecated; No replacement

from_dictionary(dictionary)

partial_pan

Should be filled with the first 6 and last 4 digits of the PAN number of the recipient of the loan.

Type: str

Deprecated; No replacement

surname

Surname of the recipient of the loan.

Type: str

Deprecated; No replacement

to_dictionary()

zip

Zip code of the recipient of the loan

Type: str

Deprecated; No replacement

class ingenico.connect.sdk.domain.payment.definitions.merchant.Merchant

Bases: ingenico.connect.sdk.data_object.DataObject

configuration_id

In case your account has been setup with multiple configurations you can use this property to identify the one you would like to use for the transaction. Note that you can only submit preconfigured values in combination with the Worldline Online Payments Acceptance platform. In case no value is supplied a default value of 0 will be submitted to the Worldline Online Payments Acceptance platform. The Worldline Online Payments Acceptance platform internally refers to this as a PosId.

Type: str

contact_website_url

URL to find contact or support details to contact in case of questions.

Type: str

from_dictionary(dictionary)

seller

Object containing seller details

Type: ingenico.connect.sdk.domain.payment.definitions.seller.Seller

to_dictionary()

website_url

The website from which the purchase was made. The ‘+’ character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.

Type: str

class ingenico.connect.sdk.domain.payment.definitions.merchant_action.MerchantAction

Bases: ingenico.connect.sdk.data_object.DataObject

action_type

Action merchants needs to take in the online payment process. Possible values are:

• REDIRECT - The customer needs to be redirected using the details found in redirectData
• SHOW_FORM - The customer needs to be shown a form with the fields found in formFields. You can submit the data entered by the user in a Complete payment <https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/payments/complete.html> request. Additionally:
• for payment product 3012 (Bancontact), to support payments via the Bancontact app, showData contains a QR code and URL intent.
• for payment product 863 (WeChat Pay), to support payments via the WeChat app, showData contains a QR code, URL intent, or signature and nonce combination. The showData property describes when each of these values can be returned.

Note that WeChat Pay does not support completing payments.

• SHOW_INSTRUCTIONS - The customer needs to be shown payment instruction using the details found in showData. Alternatively the instructions can be rendered by us using the instructionsRenderingData
• SHOW_TRANSACTION_RESULTS - The customer needs to be shown the transaction results using the details found in showData
• MOBILE_THREEDS_CHALLENGE - The customer needs to complete a challenge as part of the 3D Secure authentication inside your mobile app. The details contained in mobileThreeDSecureChallengeParameters need to be provided to the EMVco certified Mobile SDK as a challengeParameters object.
• CALL_THIRD_PARTY - The merchant needs to call a third party using the data found in thirdPartyData

Type: str

form_fields

Populated only when the actionType of the merchantAction is SHOW_FORM. In this case, this property contains the list of fields to render, in the format that is also used in the response of Get payment product <https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/products/get.html>.

Type: list[ingenico.connect.sdk.domain.product.definitions.payment_product_field.PaymentProductField]

from_dictionary(dictionary)

mobile_three_d_secure_challenge_parameters

Populated only when the actionType of the merchantAction is MOBILE_THREEDS_CHALLENGE. In this case, this object contains the list of properties to provide to the EMVco certified Mobile SDK as a challengeParameters object.

Type: ingenico.connect.sdk.domain.payment.definitions.mobile_three_d_secure_challenge_parameters.MobileThreeDSecureChallengeParameters

redirect_data

Object containing all data needed to redirect the customer

Type: ingenico.connect.sdk.domain.payment.definitions.redirect_data.RedirectData

rendering_data

This property contains the blob with data for the instructions rendering service.

This service will be available at the following endpoint:http(s)://{{merchant specific subdomain}}.{{base MyCheckout hosted payment pages domain}}/instructions/{{merchantId}}/{{clientSessionId}}

This instructions page rendering service accepts the following parameters:

• instructionsRenderingData (required, the content of this property)
• locale (optional, if present overrides default locale, e.g. “en_GB”)
• variant (optional, code of a variant, if present overrides default variant, e.g. “100”)
• customerId (required for Pix, otherwise optional, the customerId from a client session)

You can offer a link to a customer to see an instructions page for a payment done earlier. Because of the size of the instructionsRenderingData this will need to be set in a web form as a value of a hidden field. Before presenting the link you need to obtain a clientSessionId by creating a session using the S2S API. You will need to use the MyCheckout hosted payment pages domain hosted in the same region as the API domain used for the createClientSession call.

The instructionsRenderingData is a String blob that is presented to you via the Server API as part of the merchantAction (if available, and non-redirect) in the JSON return values for the createPayment call or the getHostedCheckoutStatus call (merchantAction inside createdPaymentOutput when available).You are responsible to store the instructionsRenderingData blob in order to be able to present the instructions page at a later time, when this information might no longer be available through Server API calls.

Type: str

show_data

This is returned for the SHOW_INSTRUCTION, the SHOW_TRANSACTION_RESULTS and the SHOW_FORM actionType.

When returned for SHOW_TRANSACTION_RESULTS or SHOW_FORM, this contains an array of key value pairs of data that needs to be shown to the customer.

Note: The returned value for the key BARCODE is a base64 encoded gif image. By prepending ‘data:image/gif;base64,’ this value can be used as the source of an HTML inline image.

For SHOW_FORM, for payment product 3012 (Bancontact), this contains a QR code and a URL intent that can be used to complete the payment in the Bancontact app.

In this case, the key QRCODE contains a base64 encoded PNG image. By prepending ‘data:image/png;base64,’ this value can be used as the source of an HTML inline image on a desktop or tablet (intended to be scanned by an Android device with the Bancontact app). The key URLINTENT contains a URL intent that can be used as the link of an ‘open the app’ button on an Android device.

For SHOW_FORM, for payment product 863 (WeChat Pay), this contains the PaymentId that WeChat has assigned to the payment. In this case, the key WECHAT_PAYMENTID contains this PaymentId. In addition, this can contain different values depending on the integration type:

• desktopQRCode - contains a QR code that can be used to complete the payment in the WeChat app. In this case, the key QRCODE contains a base64 encoded PNG image. By prepending ‘data:image/png;base64,’ this value can be used as the source of an HTML inline image on a desktop or tablet (intended to be scanned by a mobile device with the WeChat app).
• urlIntent - contains a URL intent that can be used to complete the payment in the WeChat app. In this case, the key URLINTENT contains a URL intent that can be used as the link of an ‘open the app’ button on a mobile device.

Type: list[ingenico.connect.sdk.domain.definitions.key_value_pair.KeyValuePair]

third_party_data

This is returned for the CALL_THIRD_PARTY actionType.

The payment product specific field of the payment product used for the payment will be populated with the third party data that should be used when calling the third party.

Type: ingenico.connect.sdk.domain.payment.definitions.third_party_data.ThirdPartyData

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.mobile_payment_data.MobilePaymentData

Bases: ingenico.connect.sdk.data_object.DataObject

dpan

The obfuscated DPAN. Only the last four digits are visible.

Type: str

expiry_date

Expiry date of the tokenized card

Format: MMYY

Type: str

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.mobile_payment_method_specific_input.MobilePaymentMethodSpecificInput

Bases: ingenico.connect.sdk.domain.definitions.abstract_payment_method_specific_input.AbstractPaymentMethodSpecificInput

authorization_mode

Determines the type of the authorization that will be used. Allowed values:

• FINAL_AUTHORIZATION - The payment creation results in an authorization that is ready for capture. Final authorizations can’t be reversed and need to be captured for the full amount within 7 days.
• PRE_AUTHORIZATION - The payment creation results in a pre-authorization that is ready for capture. Pre-authortizations can be reversed and can be captured within 30 days. The capture amount can be lower than the authorized amount.
• SALE - The payment creation results in an authorization that is already captured at the moment of approval.

Only used with some acquirers, ingnored for acquirers that don’t support this. In case the acquirer doesn’t allow this to be specified the authorizationMode is ‘unspecified’, which behaves similar to a final authorization.

Type: str

customer_reference

Reference of the customer for the payment (purchase order #, etc.). Only used with some acquirers.

Type: str

decrypted_payment_data

The payment data if you do the decryption of the encrypted payment data yourself.

Type: ingenico.connect.sdk.domain.payment.definitions.decrypted_payment_data.DecryptedPaymentData

encrypted_payment_data

The payment data if we will do the decryption of the encrypted payment data.

Typically you’d use encryptedCustomerInput in the root of the create payment request to provide the encrypted payment data instead.

• For Apple Pay, the encrypted payment data is the PKPayment <https://developer.apple.com/documentation/passkit/pkpayment>.token.paymentData object passed as a string (with all quotation marks escaped).
• For Google Pay, the encrypted payment data can be found in property paymentMethodData.tokenizationData.token of the PaymentData <https://developers.google.com/android/reference/com/google/android/gms/wallet/PaymentData>.toJson() result.

Type: str

from_dictionary(dictionary)

payment_product320_specific_input

Object containing information specific to Google Pay

Type: ingenico.connect.sdk.domain.payment.definitions.mobile_payment_product320_specific_input.MobilePaymentProduct320SpecificInput

requires_approval

• true = the payment requires approval before the funds will be captured using the Capture payment <https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/payments/approve.html> API
• false = the payment does not require approval, and the funds will be captured automatically

Type: bool

skip_fraud_service

• true = Fraud scoring will be skipped for this transaction
• false = Fraud scoring will not be skipped for this transaction

Note: This is only possible if your account in our system is setup for Fraud scoring and if your configuration in our system allows you to override it per transaction.

Type: bool

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.mobile_payment_method_specific_output.MobilePaymentMethodSpecificOutput

Bases: ingenico.connect.sdk.domain.payment.definitions.abstract_payment_method_specific_output.AbstractPaymentMethodSpecificOutput

authorisation_code

Card Authorization code as returned by the acquirer

Type: str

fraud_results

Fraud results contained in the CardFraudResults object

Type: ingenico.connect.sdk.domain.definitions.card_fraud_results.CardFraudResults

from_dictionary(dictionary)

network

The network that was used for the refund

Type: str

payment_data

Object containing payment details

Type: ingenico.connect.sdk.domain.payment.definitions.mobile_payment_data.MobilePaymentData

three_d_secure_results

3D Secure results object

Type: ingenico.connect.sdk.domain.payment.definitions.three_d_secure_results.ThreeDSecureResults

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.mobile_payment_product320_specific_input.MobilePaymentProduct320SpecificInput

Bases: ingenico.connect.sdk.data_object.DataObject

cardholder_name

The card holder’s name on the card.

The encrypted payment data can be found in property paymentMethodData.tokenizationData.info.billingAddress.name of the PaymentData <https://developers.google.com/android/reference/com/google/android/gms/wallet/PaymentData>.toJson() result.

Type: str

from_dictionary(dictionary)

three_d_secure

Object containing specific data regarding 3-D Secure

Type: ingenico.connect.sdk.domain.payment.definitions.g_pay_three_d_secure.GPayThreeDSecure

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.mobile_three_d_secure_challenge_parameters.MobileThreeDSecureChallengeParameters

Bases: ingenico.connect.sdk.data_object.DataObject

acs_reference_number

The unique identifier assigned by the EMVCo Secretariat upon testing and approval.

Type: str

acs_signed_content

Contains the JWS object created by the ACS for the challenge (ARes).

Type: str

acs_transaction_id

The ACS Transaction ID for a prior 3-D Secure authenticated transaction (for example, the first recurring transaction that was authenticated with the customer).

Type: str

from_dictionary(dictionary)

three_d_server_transaction_id

The 3-D Secure version 2 transaction ID that is used for the 3D Authentication

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.non_sepa_direct_debit_payment_method_specific_input.NonSepaDirectDebitPaymentMethodSpecificInput

Bases: ingenico.connect.sdk.domain.definitions.abstract_payment_method_specific_input.AbstractPaymentMethodSpecificInput

date_collect

Direct Debit payment collection date

Format: YYYYMMDD

Type: str

direct_debit_text

Descriptor intended to identify the transaction on the customer’s bank statement

Type: str

from_dictionary(dictionary)

is_recurring

Indicates if this transaction is of a one-off or a recurring type

• true - This is recurring
• false - This is one-off

Type: bool

payment_product705_specific_input

Object containing UK Direct Debit specific details

Type: ingenico.connect.sdk.domain.payment.definitions.non_sepa_direct_debit_payment_product705_specific_input.NonSepaDirectDebitPaymentProduct705SpecificInput

payment_product730_specific_input

Object containing ACH specific details

Type: ingenico.connect.sdk.domain.payment.definitions.non_sepa_direct_debit_payment_product730_specific_input.NonSepaDirectDebitPaymentProduct730SpecificInput

recurring_payment_sequence_indicator

• first = This transaction is the first of a series of recurring transactions
• recurring = This transaction is a subsequent transaction in a series of recurring transactions
• last = This transaction is the last transaction of a series of recurring transactions

Type: str

requires_approval

• true - The payment requires approval before the funds will be captured using the Approve payment or Capture payment API.
• false - The payment does not require approval, and the funds will be captured automatically.

Type: bool

to_dictionary()

token

ID of the stored token that contains the bank account details to be debited

Type: str

tokenize

Indicates if this transaction should be tokenized

• true - Tokenize the transaction
• false - Do not tokenize the transaction, unless it would be tokenized by other means such as auto-tokenization of recurring payments.

Type: bool

class ingenico.connect.sdk.domain.payment.definitions.non_sepa_direct_debit_payment_method_specific_output.NonSepaDirectDebitPaymentMethodSpecificOutput

Bases: ingenico.connect.sdk.domain.payment.definitions.abstract_payment_method_specific_output.AbstractPaymentMethodSpecificOutput

fraud_results

Object containing the results of the fraud screening

Type: ingenico.connect.sdk.domain.definitions.fraud_results.FraudResults

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.non_sepa_direct_debit_payment_product705_specific_input.NonSepaDirectDebitPaymentProduct705SpecificInput

Bases: ingenico.connect.sdk.data_object.DataObject

UK Direct Debit specific input fields

authorisation_id

Core reference number for the direct debit instruction in UK

Type: str

bank_account_bban

Object containing account holder name and bank account information

Type: ingenico.connect.sdk.domain.definitions.bank_account_bban.BankAccountBban

from_dictionary(dictionary)

to_dictionary()

transaction_type

• first-payment - First payment direct debit
• nth-payment - Direct Debit (n-th payment)
• re-presented - Re-presented direct debit (after failed attempt)
• final-payment - Final payment direct debit
• new-or-reinstated - (zero N) New or reinstated direct debit instruction
• cancellation - (zero C) Cancellation of direct debit instruction
• conversion-of-paper-DDI-to-electronic-DDI - (zero S) Conversion of paper DDI to electronic DDI (only used once, when migrating from traditional direct debit to AUDDIS

Type: str

class ingenico.connect.sdk.domain.payment.definitions.non_sepa_direct_debit_payment_product730_specific_input.NonSepaDirectDebitPaymentProduct730SpecificInput

Bases: ingenico.connect.sdk.data_object.DataObject

ACH specific input fields

bank_account_bban

Object containing account holder name and bank account information

Type: ingenico.connect.sdk.domain.definitions.bank_account_bban.BankAccountBban

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.order.Order

Bases: ingenico.connect.sdk.data_object.DataObject

additional_input

Object containing additional input on the order

Type: ingenico.connect.sdk.domain.payment.definitions.additional_order_input.AdditionalOrderInput

amount_of_money

Object containing amount and ISO currency code attributes

Type: ingenico.connect.sdk.domain.definitions.amount_of_money.AmountOfMoney

customer

Object containing the details of the customer

Type: ingenico.connect.sdk.domain.payment.definitions.customer.Customer

from_dictionary(dictionary)

items

Shopping cart data

Type: list[ingenico.connect.sdk.domain.payment.definitions.line_item.LineItem]

Deprecated; Use shoppingCart.items instead

references

Object that holds all reference properties that are linked to this transaction

Type: ingenico.connect.sdk.domain.payment.definitions.order_references.OrderReferences

seller

Object containing seller details

Type: ingenico.connect.sdk.domain.payment.definitions.seller.Seller

Deprecated; Use Merchant.seller instead

shipping

Object containing information regarding shipping / delivery

Type: ingenico.connect.sdk.domain.payment.definitions.shipping.Shipping

shopping_cart

Shopping cart data, including items and specific amounts.

Type: ingenico.connect.sdk.domain.payment.definitions.shopping_cart.ShoppingCart

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.order_approve_payment.OrderApprovePayment

Bases: ingenico.connect.sdk.data_object.DataObject

additional_input

Object containing additional input on the order

Type: ingenico.connect.sdk.domain.definitions.additional_order_input_airline_data.AdditionalOrderInputAirlineData

customer

Object containing data related to the customer

Type: ingenico.connect.sdk.domain.payment.definitions.customer_approve_payment.CustomerApprovePayment

from_dictionary(dictionary)

references

Object that holds all reference properties that are linked to this transaction

Type: ingenico.connect.sdk.domain.payment.definitions.order_references_approve_payment.OrderReferencesApprovePayment

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.order_invoice_data.OrderInvoiceData

Bases: ingenico.connect.sdk.data_object.DataObject

additional_data

Additional data for printed invoices

Type: str

from_dictionary(dictionary)

invoice_date

Date and time on invoice

Format: YYYYMMDDHH24MISS

Type: str

invoice_number

Your invoice number (on printed invoice) that is also returned in our report files

Type: str

text_qualifiers

Array of 3 text qualifiers, each with a max length of 10 characters

Type: list[str]

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.order_line_details.OrderLineDetails

Bases: ingenico.connect.sdk.data_object.DataObject

discount_amount

Discount on the line item, with the last two digits implied as decimal places

Type: long

from_dictionary(dictionary)

google_product_category_id

The Google product category ID for the item.

Type: long

line_amount_total

Total amount for the line item

Type: long

product_category

The category of the product (i.e. home appliance). This property can be used for fraud screening on the Ogone Platform.

Type: str

product_code

Product or UPC Code, left justified

Note: Must not be all spaces or all zeros

Type: str

product_name

The name of the product. The ‘+’ character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.

Type: str

product_price

The price of one unit of the product, the value should be zero or greater

Type: long

product_sku

Product SKU number

Type: str

product_type

Code used to classify items that are purchased

Note: Must not be all spaces or all zeros

Type: str

quantity

Quantity of the units being purchased, should be greater than zero

Note: Must not be all spaces or all zeros

Type: long

tax_amount

Tax on the line item, with the last two digits implied as decimal places

Type: long

to_dictionary()

unit

Indicates the line item unit of measure; for example: each, kit, pair, gallon, month, etc.

Type: str

class ingenico.connect.sdk.domain.payment.definitions.order_output.OrderOutput

Bases: ingenico.connect.sdk.data_object.DataObject

amount_of_money

Object containing amount and ISO currency code attributes

Type: ingenico.connect.sdk.domain.definitions.amount_of_money.AmountOfMoney

from_dictionary(dictionary)

references

Object that holds all reference properties that are linked to this transaction

Type: ingenico.connect.sdk.domain.payment.definitions.payment_references.PaymentReferences

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.order_references.OrderReferences

Bases: ingenico.connect.sdk.data_object.DataObject

descriptor

Descriptive text that is used towards to customer, either during an online checkout at a third party and/or on the statement of the customer. For card transactions this is usually referred to as a Soft Descriptor. The maximum allowed length varies per card acquirer:

• AIB - 22 characters
• American Express - 25 characters
• Atos Origin BNP - 15 characters
• Barclays - 25 characters
• Catella - 22 characters
• CBA - 20 characters
• Elavon - 25 characters
• First Data - 25 characters
• INICIS (INIPAY) - 22-30 characters
• JCB - 25 characters
• Merchant Solutions - 22-25 characters
• Payvision (EU & HK) - 25 characters
• SEB Euroline - 22 characters
• Sub1 Argentina - 15 characters
• Wells Fargo - 25 characters

Note that we advise you to use 22 characters as the max length as beyond this our experience is that issuers will start to truncate. We currently also only allow per API call overrides for AIB and Barclays

For alternative payment products the maximum allowed length varies per payment product:

• 402 e-Przelewy - 30 characters
• 404 INICIS - 80 characters
• 802 Nordea ePayment Finland - 234 characters
• 809 iDeal - 32 characters
• 836 SOFORT - 42 characters
• 840 PayPal - 127 characters
• 841 WebMoney - 175 characters
• 849 Yandex - 64 characters
• 861 Alipay - 256 characters
• 863 WeChat Pay - 32 characters
• 880 BOKU - 20 characters
• 8580 Qiwi - 255 characters
• 1504 Konbini - 80 characters

All other payment products don’t support a descriptor.

Type: str

from_dictionary(dictionary)

invoice_data

Object containing additional invoice data

Type: ingenico.connect.sdk.domain.payment.definitions.order_invoice_data.OrderInvoiceData

merchant_order_id

Your order identifier

Note: This does not need to have a unique value for each transaction. This allows your to link multiple transactions to the same logical order in your system.

Type: long

merchant_reference

Note that the maximum length of this field for transactions processed on the GlobalCollect platform is 30. Note that the maximum length of this field for transactions processed on the WL Online Payment Acceptance Platform platform is 50. Your unique reference of the transaction that is also returned in our report files. This is almost always used for your reconciliation of our report files.

Type: str

provider_id

Provides an additional means of reconciliation for Gateway merchants

Type: str

provider_merchant_id

Provides an additional means of reconciliation, this is the MerchantId used at the provider

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.order_references_approve_payment.OrderReferencesApprovePayment

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

merchant_reference

Your (unique) reference for the transaction that you can use to reconcile our report files

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.order_type_information.OrderTypeInformation

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

funding_type

Identifies the funding type being authenticated. Possible values are:

• personToPerson = When it is person to person funding (P2P)
• agentCashOut = When fund is being paid out to final recipient in Cash by company’s agent.
• businessToConsumer = When fund is being transferred from business to consumer (B2C)
• businessToBusiness = When fund is being transferred from business to business (B2B)
• prefundingStagedWallet = When funding is being used to load the funds into the wallet account.
• storedValueDigitalWallet = When funding is being used to load the funds into a stored value digital wallet.
• fundingGiftCardForPersonalUse = When funding a gift card for personal use.
• fundingGiftCardForSomeoneElse = When funding a gift card for someone else.

Type: str

purchase_type

Possible values are:

• physical
• digital

Type: str

to_dictionary()

transaction_type

Identifies the type of transaction being authenticated.Possible values are:

• purchase = The purpose of the transaction is to purchase goods or services (Default)
• check-acceptance = The purpose of the transaction is to accept a ‘check’/’cheque’
• account-funding = The purpose of the transaction is to fund an account
• quasi-cash = The purpose of the transaction is to buy a quasi cash type product that is representative of actual cash such as money orders, traveler’s checks, foreign currency, lottery tickets or casino gaming chips
• prepaid-activation-or-load = The purpose of the transaction is to activate or load a prepaid card

Type: str

usage_type

Possible values are:

• private
• commercial

Type: str

class ingenico.connect.sdk.domain.payment.definitions.payment.Payment

Bases: ingenico.connect.sdk.domain.definitions.abstract_order_status.AbstractOrderStatus

from_dictionary(dictionary)

hosted_checkout_specific_output

Hosted Checkout specific information. Populated if the payment was created on the GlobalCollect platform through a Hosted Checkout.

Type: ingenico.connect.sdk.domain.payment.definitions.hosted_checkout_specific_output.HostedCheckoutSpecificOutput

payment_output

Object containing payment details

Type: ingenico.connect.sdk.domain.payment.definitions.payment_output.PaymentOutput

status

Current high-level status of the payment in a human-readable form. Possible values are :

• ACCOUNT_VERIFIED - The account has been verified using a validation services like 0$ auth
• CREATED - The transaction has been created. This is the initial state once a new payment is created.
• REDIRECTED - The customer has been redirected to a 3rd party to complete the authentication/payment
• PENDING_PAYMENT - Instructions have been provided and we are now waiting for the money to come in
• PENDING_FRAUD_APPROVAL - The transaction has been marked for manual review after an automatic fraud screening
• PENDING_APPROVAL - The transaction is awaiting approval from you to proceed with the capturing of the funds
• PENDING_COMPLETION - The transaction needs to be completed.
• PENDING_CAPTURE - The transaction is waiting for you to request one or more captures of the funds.
• REJECTED - The transaction has been rejected
• AUTHORIZATION_REQUESTED - we have requested an authorization against an asynchronous system and is awaiting its response
• CAPTURE_REQUESTED - The transaction is in the queue to be captured
• CAPTURED - The transaction has been captured and we have received online confirmation
• PAID - We have matched the incoming funds to the transaction
• CANCELLED - You have cancelled the transaction
• REJECTED_CAPTURE - We or one of our downstream acquirers/providers have rejected the capture request
• REVERSED - The transaction has been reversed
• CHARGEBACK_NOTIFICATION - We have received a notification of chargeback and this status informs you that your account will be debited for a particular transaction
• CHARGEBACKED - The transaction has been chargebacked
• REFUNDED - The transaction has been refunded

Please see Statuses <https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/statuses.html> for a full overview of possible values.

Type: str

status_output

This object has the numeric representation of the current payment status, timestamp of last status change and performable action on the current payment resource.

In case of failed payments and negative scenarios, detailed error information is listed.

Type: ingenico.connect.sdk.domain.payment.definitions.payment_status_output.PaymentStatusOutput

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.payment_account_on_file.PaymentAccountOnFile

Bases: ingenico.connect.sdk.data_object.DataObject

Object containing information on the payment account data on file (tokens)

create_date

The date (YYYYMMDD) when the payment account on file was first created.

In case a token is used for the transaction we will use the creation date of the token in our system in case you leave this property empty.

Type: str

from_dictionary(dictionary)

number_of_card_on_file_creation_attempts_last24_hours

Number of attempts made to add new card to the customer account in the last 24 hours

Type: int

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.payment_creation_output.PaymentCreationOutput

Bases: ingenico.connect.sdk.domain.payment.definitions.payment_creation_references.PaymentCreationReferences

from_dictionary(dictionary)

is_checked_remember_me

Indicates whether the customer ticked the “Remember my details for future purchases” checkbox on the MyCheckout hosted payment pages

Type: bool

is_new_token

Indicates if a new token was created

• true - A new token was created
• false - A token with the same card number already exists and is returned. Please note that the existing token has not been updated. When you want to update other data then the card number, you need to update data stored in the token explicitly, as data is never updated during the creation of a token.

Type: bool

to_dictionary()

token

ID of the token

Type: str

tokenization_succeeded

Indicates if tokenization was successful or not. If this value is false, then the token and isNewToken properties will not be set.

Type: bool

class ingenico.connect.sdk.domain.payment.definitions.payment_creation_references.PaymentCreationReferences

Bases: ingenico.connect.sdk.data_object.DataObject

additional_reference

The additional reference identifier for this transaction. Data in this property will also be returned in our report files, allowing you to reconcile them.

Type: str

external_reference

The external reference identifier for this transaction. Data in this property will also be returned in our report files, allowing you to reconcile them.

Type: str

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.payment_output.PaymentOutput

Bases: ingenico.connect.sdk.domain.payment.definitions.order_output.OrderOutput

amount_paid

Amount that has been paid

Type: long

amount_reversed

Amount that has been reversed

Type: long

bank_transfer_payment_method_specific_output

Object containing the bank transfer payment method details

Type: ingenico.connect.sdk.domain.payment.definitions.bank_transfer_payment_method_specific_output.BankTransferPaymentMethodSpecificOutput

card_payment_method_specific_output

Object containing the card payment method details

Type: ingenico.connect.sdk.domain.payment.definitions.card_payment_method_specific_output.CardPaymentMethodSpecificOutput

cash_payment_method_specific_output

Object containing the cash payment method details

Type: ingenico.connect.sdk.domain.payment.definitions.cash_payment_method_specific_output.CashPaymentMethodSpecificOutput

direct_debit_payment_method_specific_output

Object containing the non SEPA direct debit payment method details

Type: ingenico.connect.sdk.domain.payment.definitions.non_sepa_direct_debit_payment_method_specific_output.NonSepaDirectDebitPaymentMethodSpecificOutput

e_invoice_payment_method_specific_output

Object containing the e-invoice payment method details

Type: ingenico.connect.sdk.domain.payment.definitions.e_invoice_payment_method_specific_output.EInvoicePaymentMethodSpecificOutput

from_dictionary(dictionary)

invoice_payment_method_specific_output

Object containing the invoice payment method details

Type: ingenico.connect.sdk.domain.payment.definitions.invoice_payment_method_specific_output.InvoicePaymentMethodSpecificOutput

mobile_payment_method_specific_output

Object containing the mobile payment method details

Type: ingenico.connect.sdk.domain.payment.definitions.mobile_payment_method_specific_output.MobilePaymentMethodSpecificOutput

payment_method

Payment method identifier used by the our payment engine with the following possible values:

• bankRefund
• bankTransfer
• card
• cash
• directDebit
• eInvoice
• invoice
• redirect

Type: str

redirect_payment_method_specific_output

Object containing the redirect payment product details

Type: ingenico.connect.sdk.domain.payment.definitions.redirect_payment_method_specific_output.RedirectPaymentMethodSpecificOutput

reversal_reason

The reason description given for the reversedAmount property.

Type: str

sepa_direct_debit_payment_method_specific_output

Object containing the SEPA direct debit details

Type: ingenico.connect.sdk.domain.payment.definitions.sepa_direct_debit_payment_method_specific_output.SepaDirectDebitPaymentMethodSpecificOutput

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.payment_product3201_specific_output.PaymentProduct3201SpecificOutput

Bases: ingenico.connect.sdk.data_object.DataObject

card

Object containing card details

Type: ingenico.connect.sdk.domain.definitions.card_essentials.CardEssentials

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.payment_product771_specific_output.PaymentProduct771SpecificOutput

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

mandate_reference

Unique reference to a Mandate

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.payment_product806_specific_output.PaymentProduct806SpecificOutput

Bases: ingenico.connect.sdk.data_object.DataObject

billing_address

Object containing the billing address details of the customer

Type: ingenico.connect.sdk.domain.definitions.address.Address

customer_account

Object containing the account details

Type: ingenico.connect.sdk.domain.payment.definitions.trustly_bank_account.TrustlyBankAccount

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.payment_product836_specific_output.PaymentProduct836SpecificOutput

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

security_indicator

Indicates if SofortBank could estabilish if the transaction could successfully be processed.

• 0 - You should wait for the transaction to be reported as paid before shipping any goods.
• 1 - You can ship the goods. In case the transaction is not reported as paid you can initiate a claims process with SofortBank.

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.payment_product840_customer_account.PaymentProduct840CustomerAccount

Bases: ingenico.connect.sdk.data_object.DataObject

PayPal account details as returned by PayPal

account_id

Username with which the PayPal account holder has registered at PayPal

Type: str

billing_agreement_id

Identification of the PayPal recurring billing agreement

Type: str

company_name

Name of the company in case the PayPal account is owned by a business

Type: str

contact_phone

The phone number of the PayPal account holder

Type: str

country_code

Country where the PayPal account is located

Type: str

customer_account_status

Status of the PayPal account.

Possible values are:

• verified - PayPal has verified the funding means for this account
• unverified - PayPal has not verified the funding means for this account

Type: str

customer_address_status

Status of the customer’s shipping address as registered by PayPal

Possible values are:

• none - Status is unknown at PayPal
• confirmed - The address has been confirmed
• unconfirmed - The address has not been confirmed

Type: str

first_name

First name of the PayPal account holder

Type: str

from_dictionary(dictionary)

payer_id

The unique identifier of a PayPal account and will never change in the life cycle of a PayPal account

Type: str

surname

Surname of the PayPal account holder

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.payment_product840_specific_output.PaymentProduct840SpecificOutput

Bases: ingenico.connect.sdk.data_object.DataObject

billing_address

Object containing the billing address details of the customer

Type: ingenico.connect.sdk.domain.definitions.address.Address

customer_account

Object containing the details of the PayPal account

Type: ingenico.connect.sdk.domain.payment.definitions.payment_product840_customer_account.PaymentProduct840CustomerAccount

customer_address

Object containing the address details of the customer

Type: ingenico.connect.sdk.domain.definitions.address.Address

from_dictionary(dictionary)

protection_eligibility

Protection Eligibility data of the PayPal customer

Type: ingenico.connect.sdk.domain.payment.definitions.protection_eligibility.ProtectionEligibility

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.payment_product863_third_party_data.PaymentProduct863ThirdPartyData

Bases: ingenico.connect.sdk.data_object.DataObject

app_id

The appId to use in third party calls to WeChat.

Type: str

from_dictionary(dictionary)

nonce_str

The nonceStr to use in third party calls to WeChat

Type: str

package_sign

The packageSign to use in third party calls to WeChat

Type: str

pay_sign

The paySign to use in third party calls to WeChat

Type: str

prepay_id

The prepayId to use in third party calls to WeChat.

Type: str

sign_type

The signType to use in third party calls to WeChat

Type: str

time_stamp

The timeStamp to use in third party calls to WeChat

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.payment_references.PaymentReferences

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

merchant_order_id

Your order ID for this transaction that is also returned in our report files

Type: long

merchant_reference

Your unique reference of the transaction that is also returned in our report files. This is almost always used for your reconciliation of our report files.

Type: str

payment_reference

Payment Reference generated by WebCollect

Type: str

provider_id

Provides an additional means of reconciliation for Gateway merchants

Type: str

provider_merchant_id

Provides an additional means of reconciliation, this is the MerchantId used at the provider

Type: str

provider_reference

Provides an additional means of reconciliation for Gateway merchants

Type: str

reference_orig_payment

When you did not supply a merchantReference for your payment, you need to fill this property with the reference of the original payment when you want to refund it

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.payment_status_output.PaymentStatusOutput

Bases: ingenico.connect.sdk.domain.definitions.order_status_output.OrderStatusOutput

from_dictionary(dictionary)

is_authorized

Indicates if the transaction has been authorized

• true
• false

Type: bool

is_refundable

Flag indicating if the payment can be refunded

• true
• false

Type: bool

three_d_secure_status

The 3D Secure status, with the following possible values:

• ENROLLED: the card is enrolled for 3D Secure authentication. The customer can be redirected to a 3D Secure access control server (ACS)
• NOT_ENROLLED: the card is not enrolled for 3D Secure authentication
• INVALID_PARES_OR_NOT_COMPLETED: the PARes is invalid, or the customer did not complete the 3D Secure authentication
• AUTHENTICATED: the customer has passed the 3D Secure authentication
• NOT_AUTHENTICATED: the customer failed the 3D Secure authentication
• NOT_PARTICIPATING: the cardholder has not set up their card for 2-step 3D Secure.

Note that this status will only be set for payments that make use of 2-step 3D Secure.

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.personal_identification.PersonalIdentification

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

id_issuing_country_code

ISO 3166-1 alpha-2 country code of the country that issued the identification document

Type: str

id_type

Indicates the type of identification

• nationalIdentification = The provided idValue is a national identification number.
• passportNumber = The provided idValue is a passport number.
• driverLicense = The provided idValue is driving License of the individual.
• companyRegistrationNumber = The provided idValue is a company identifier. It verifies its legal existence as an incorporated entity.
• socialSecurityNumber =n The provided idValue is a social security number, issued to an individual by the individual’s government.
• alienRegistrationNumber = The provided idValue is an alien registration number, provided by immigration services of a country.
• lawEnforcementIdentification = The provided idValue is an alien registration number, provided by immigration services of a country.
• militaryIdentification = The provided idValue is an identification issued to military personnel of a country.

Type: str

id_value

The value of the identification

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.personal_information.PersonalInformation

Bases: ingenico.connect.sdk.data_object.DataObject

date_of_birth

The date of birth of the customer

Format: YYYYMMDD

Type: str

from_dictionary(dictionary)

gender

The gender of the customer, possible values are:

• male
• female
• unknown or empty

Type: str

identification

Object containing identification documents information

Type: ingenico.connect.sdk.domain.payment.definitions.personal_identification.PersonalIdentification

name

Object containing the name details of the customer

Type: ingenico.connect.sdk.domain.payment.definitions.personal_name.PersonalName

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.personal_name.PersonalName

Bases: ingenico.connect.sdk.domain.definitions.personal_name_base.PersonalNameBase

from_dictionary(dictionary)

title

Title of customer

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.protection_eligibility.ProtectionEligibility

Bases: ingenico.connect.sdk.data_object.DataObject

eligibility

Possible values:

• Eligible
• PartiallyEligible
• Ineligible

Type: str

from_dictionary(dictionary)

to_dictionary()

type

Possible values:

• ItemNotReceivedEligible
• UnauthorizedPaymentEligible
• Ineligible

Type: str

class ingenico.connect.sdk.domain.payment.definitions.redirect_data.RedirectData

Bases: ingenico.connect.sdk.domain.definitions.redirect_data_base.RedirectDataBase

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.redirect_payment_method_specific_input.RedirectPaymentMethodSpecificInput

Bases: ingenico.connect.sdk.domain.payment.definitions.abstract_redirect_payment_method_specific_input.AbstractRedirectPaymentMethodSpecificInput

from_dictionary(dictionary)

is_recurring

• true
• false

Type: bool

payment_product4101_specific_input

Object containing specific input required for UPI (Payment product ID 4101)

Type: ingenico.connect.sdk.domain.payment.definitions.redirect_payment_product4101_specific_input.RedirectPaymentProduct4101SpecificInput

payment_product809_specific_input

Object containing specific input required for Dutch iDeal payments (Payment product ID 809)

Type: ingenico.connect.sdk.domain.payment.definitions.redirect_payment_product809_specific_input.RedirectPaymentProduct809SpecificInput

payment_product816_specific_input

Object containing specific input required for German giropay payments (Payment product ID 816)

Type: ingenico.connect.sdk.domain.payment.definitions.redirect_payment_product816_specific_input.RedirectPaymentProduct816SpecificInput

payment_product840_specific_input

Object containing specific input required for PayPal payments (Payment product ID 840)

Type: ingenico.connect.sdk.domain.payment.definitions.redirect_payment_product840_specific_input.RedirectPaymentProduct840SpecificInput

payment_product861_specific_input

Object containing specific input required for AliPay payments (Payment product ID 861)

Type: ingenico.connect.sdk.domain.payment.definitions.redirect_payment_product861_specific_input.RedirectPaymentProduct861SpecificInput

payment_product863_specific_input

Object containing specific input required for We Chat Pay payments (Payment product ID 863)

Type: ingenico.connect.sdk.domain.payment.definitions.redirect_payment_product863_specific_input.RedirectPaymentProduct863SpecificInput

payment_product869_specific_input

Object containing specific input required for China UnionPay payments (Payment product ID 869)

Type: ingenico.connect.sdk.domain.payment.definitions.redirect_payment_product869_specific_input.RedirectPaymentProduct869SpecificInput

payment_product882_specific_input

Object containing specific input required for Indian Net Banking payments (Payment product ID 882)

Type: ingenico.connect.sdk.domain.payment.definitions.redirect_payment_product882_specific_input.RedirectPaymentProduct882SpecificInput

redirection_data

Object containing browser specific redirection related data

Type: ingenico.connect.sdk.domain.payment.definitions.redirection_data.RedirectionData

return_url

The URL that the customer is redirect to after the payment flow has finished. You can add any number of key value pairs in the query string that, for instance help you to identify the customer when they return to your site. Please note that we will also append some additional key value pairs that will also help you with this identification process.

Note: The provided URL should be absolute and contain the protocol to use, e.g. http:// or https://. For use on mobile devices a custom protocol can be used in the form of protocol://. This protocol must be registered on the device first.

URLs without a protocol will be rejected.

Type: str

Deprecated; Use redirectionData.returnUrl instead

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.redirect_payment_method_specific_input_base.RedirectPaymentMethodSpecificInputBase

Bases: ingenico.connect.sdk.domain.payment.definitions.abstract_redirect_payment_method_specific_input.AbstractRedirectPaymentMethodSpecificInput

from_dictionary(dictionary)

payment_product4101_specific_input

Object containing specific input required for payment product 4101 (UPI)

Type: ingenico.connect.sdk.domain.payment.definitions.redirect_payment_product4101_specific_input_base.RedirectPaymentProduct4101SpecificInputBase

payment_product840_specific_input

Object containing specific input required for PayPal payments (Payment product ID 840)

Type: ingenico.connect.sdk.domain.payment.definitions.redirect_payment_product840_specific_input_base.RedirectPaymentProduct840SpecificInputBase

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.redirect_payment_method_specific_output.RedirectPaymentMethodSpecificOutput

Bases: ingenico.connect.sdk.domain.payment.definitions.abstract_payment_method_specific_output.AbstractPaymentMethodSpecificOutput

bank_account_bban

Object that holds the Basic Bank Account Number (BBAN) data

Type: ingenico.connect.sdk.domain.definitions.bank_account_bban.BankAccountBban

bank_account_iban

Object containing account holder name and IBAN information

Type: ingenico.connect.sdk.domain.definitions.bank_account_iban.BankAccountIban

bic

The BIC is the Business Identifier Code, also known as SWIFT or Bank Identifier code. It is a code with an internationally agreed format to Identify a specific bank or even branch. The BIC contains 8 or 11 positions: the first 4 contain the bank code, followed by the country code and location code.

Type: str

fraud_results

Object containing the results of the fraud screening

Type: ingenico.connect.sdk.domain.definitions.fraud_results.FraudResults

from_dictionary(dictionary)

payment_product3201_specific_output

PostFinance Card (payment product 3201) specific details

Type: ingenico.connect.sdk.domain.payment.definitions.payment_product3201_specific_output.PaymentProduct3201SpecificOutput

payment_product806_specific_output

Trustly (payment product 806) specific details

Type: ingenico.connect.sdk.domain.payment.definitions.payment_product806_specific_output.PaymentProduct806SpecificOutput

payment_product836_specific_output

Sofort (payment product 836) specific details

Type: ingenico.connect.sdk.domain.payment.definitions.payment_product836_specific_output.PaymentProduct836SpecificOutput

payment_product840_specific_output

PayPal (payment product 840) specific details

Type: ingenico.connect.sdk.domain.payment.definitions.payment_product840_specific_output.PaymentProduct840SpecificOutput

to_dictionary()

token

ID of the token. This property is populated when the payment was done with a token or when the payment was tokenized.

Type: str

class ingenico.connect.sdk.domain.payment.definitions.redirect_payment_product4101_specific_input.RedirectPaymentProduct4101SpecificInput

Bases: ingenico.connect.sdk.data_object.DataObject

Please find below specific input fields for payment product 4101 (UPI)

display_name

The merchant name as shown to the customer in some payment applications.

Type: str

from_dictionary(dictionary)

integration_type

The value of this property must be ‘vpa’, ‘desktopQRCode’, or ‘urlIntent’.

Type: str

to_dictionary()

virtual_payment_address

The Virtual Payment Address (VPA) of the customer. The ‘+’ character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.

Type: str

class ingenico.connect.sdk.domain.payment.definitions.redirect_payment_product4101_specific_input_base.RedirectPaymentProduct4101SpecificInputBase

Bases: ingenico.connect.sdk.domain.payment.definitions.abstract_redirect_payment_product4101_specific_input.AbstractRedirectPaymentProduct4101SpecificInput

Please find below specific input fields for payment product 4101 (UPI)

display_name

The merchant name as shown to the customer in some payment applications.

Type: str

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.redirect_payment_product809_specific_input.RedirectPaymentProduct809SpecificInput

Bases: ingenico.connect.sdk.data_object.DataObject

Please find below specific input fields for payment product 809 (iDeal)

expiration_period

This sets the maximum amount of minutes a customer has to complete the payment at the bank. After this period has expired it is impossible for the customer to make a payment and in case no payment has been made the transaction will be marked as unsuccessful and expired by the bank. Setting the expirationPeriod is convenient if you want to maximise the time a customer has to complete the payment. Please note that it is normal for a customer to take up to 5 minutes to complete a payment. Setting this value below 10 minutes is not advised.

You can set this value in minutes with a maximum value of 60 minutes. If no input is provided the default value of 60 is used for the transaction.

Type: str

Deprecated; Use RedirectPaymentMethodSpecificInput.expirationPeriod instead

from_dictionary(dictionary)

issuer_id

ID of the issuing bank of the customer. A list of available issuerIDs can be obtained by using the retrieve payment product directory API.

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.redirect_payment_product816_specific_input.RedirectPaymentProduct816SpecificInput

Bases: ingenico.connect.sdk.data_object.DataObject

Please find below specific input fields for payment product 816 (giropay)

bank_account_iban

Object containing the bank account details of the customer

Type: ingenico.connect.sdk.domain.definitions.bank_account_iban.BankAccountIban

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.redirect_payment_product840_specific_input.RedirectPaymentProduct840SpecificInput

Bases: ingenico.connect.sdk.domain.payment.definitions.abstract_redirect_payment_product840_specific_input.AbstractRedirectPaymentProduct840SpecificInput

Please find below specific input fields for payment product 840 (PayPal)

custom

A free text string that you can send to PayPal. With a special agreement between PayPal and you, PayPal uses the data in that property, for custom services they offer to you.

Type: str

Deprecated; Use Order.references.descriptor instead

from_dictionary(dictionary)

is_shortcut

Deprecated: If your PayPal payments are processed by Worldline’s Ogone Payment Platform, please use the property addressSelectionAtPayPal instead.

Indicates whether to use PayPal Express Checkout for payments processed by Worldline’s GlobalCollect Payment Platform.

• true = PayPal Express Checkout
• false = Regular PayPal payment

For payments processed by Worldline’s Ogone Payment Platform, please see the addressSelectionAtPayPal property for more information.

Type: bool

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.redirect_payment_product840_specific_input_base.RedirectPaymentProduct840SpecificInputBase

Bases: ingenico.connect.sdk.domain.payment.definitions.abstract_redirect_payment_product840_specific_input.AbstractRedirectPaymentProduct840SpecificInput

Please find below the specific input field for payment product 840 (PayPal)

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.redirect_payment_product861_specific_input.RedirectPaymentProduct861SpecificInput

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

mobile_device

This indicates that a customer is on a mobile device and it is used to distinguish whether a customer should be redirected to AliPay Desktop or Mobile. Alternatively, if you cannot determine whether a customer is on a mobile device or not, a customer can be redirected to AliPay Mobile if the property CreatePaymentRequest.order.customer.device.userAgent is supplied.

Type: bool

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.redirect_payment_product863_specific_input.RedirectPaymentProduct863SpecificInput

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

integration_type

The type of integration with WeChat. Possible values:

• desktopQRCode - used on desktops, the customer opens the WeChat app by scanning a QR code.
• urlIntent - used in mobile apps or on mobile web pages, the customer opens the WeChat app using a URL intent.
• nativeInApp - used in mobile apps that use the WeChat Pay SDK.
• javaScriptAPI - used for WeChat official accounts. Requires the QQ browser to function.
• miniProgram - used for Mini Programs.

Type: str

open_id

An openId of a customer.

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.redirect_payment_product869_specific_input.RedirectPaymentProduct869SpecificInput

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

issuer_id

ID of the issuing bank of the customer. A list of available issuerIDs can be obtained by using the retrieve payment product directory API.

Type: str

resident_id_name

The name as described on the Resident Identity Card of the People’s Republic of China.

Type: str

resident_id_number

The identification number as described on the Resident Identity Card of the People’s Republic of China.

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.redirect_payment_product882_specific_input.RedirectPaymentProduct882SpecificInput

Bases: ingenico.connect.sdk.data_object.DataObject

Please find below specific input fields for payment product 882 (Net Banking)

from_dictionary(dictionary)

issuer_id

ID of the issuing bank of the customer. A list of available issuerIDs can be obtained by using the retrieve payment product directory API.

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.redirection_data.RedirectionData

Bases: ingenico.connect.sdk.data_object.DataObject

Object containing browser specific redirection related data

from_dictionary(dictionary)

return_url

The URL that the customer is redirect to after the payment flow has finished. You can add any number of key value pairs in the query string that, for instance help you to identify the customer when they return to your site. Please note that we will also append some additional key value pairs that will also help you with this identification process.

Note: The provided URL should be absolute and contain the protocol to use, e.g. http:// or https://. For use on mobile devices a custom protocol can be used in the form of protocol://. This protocol must be registered on the device first.

URLs without a protocol will be rejected.

Type: str

to_dictionary()

variant

Using the Configuration Center it is possible to create multiple variations of your MyCheckout payment pages. The redirection flow for 3-D Secure uses the MyCheckout payment pages to display the following types of pages:

• Redirection page - All redirection using a POST method will load a page in the browser of the customer that performs the actual redirection. This page contains a message to the customer explaining what is happening.
• MethodURL page - Certain Issuers will use a specific flow in case of 3-D Secure version 2 to directly collect information from the customer browser. This page contains a spinner indicating that this process is going on in.

By specifying a specific variant you can force the use of another variant than the default. This allows you to test out the effect of certain changes to your MyCheckout payment pages in a controlled manner. Please note that you need to specify the ID instead of the name of the variant.

Note: In case you have defined a Dynamic 3D Secure rule that takes the variant into account this will only work if you explicitly specify the ID using this property.

Type: str

class ingenico.connect.sdk.domain.payment.definitions.refund_bank_method_specific_output.RefundBankMethodSpecificOutput

Bases: ingenico.connect.sdk.domain.payment.definitions.refund_method_specific_output.RefundMethodSpecificOutput

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.refund_card_method_specific_output.RefundCardMethodSpecificOutput

Bases: ingenico.connect.sdk.domain.payment.definitions.refund_method_specific_output.RefundMethodSpecificOutput

authorisation_code

Card Authorization code as returned by the acquirer

Type: str

card

Object containing card details

Type: ingenico.connect.sdk.domain.definitions.card_essentials.CardEssentials

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.refund_cash_method_specific_output.RefundCashMethodSpecificOutput

Bases: ingenico.connect.sdk.domain.payment.definitions.refund_method_specific_output.RefundMethodSpecificOutput

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.refund_e_invoice_method_specific_output.RefundEInvoiceMethodSpecificOutput

Bases: ingenico.connect.sdk.domain.payment.definitions.refund_method_specific_output.RefundMethodSpecificOutput

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.refund_e_wallet_method_specific_output.RefundEWalletMethodSpecificOutput

Bases: ingenico.connect.sdk.domain.payment.definitions.refund_method_specific_output.RefundMethodSpecificOutput

from_dictionary(dictionary)

payment_product840_specific_output

PayPal (payment product 840) specific details

Type: ingenico.connect.sdk.domain.payment.definitions.refund_payment_product840_specific_output.RefundPaymentProduct840SpecificOutput

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.refund_method_specific_output.RefundMethodSpecificOutput

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

refund_product_id

Refund product identifier

Please see refund products <https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/refundproducts.html> for a full overview of possible values.

Type: int

to_dictionary()

total_amount_paid

Total paid amount (in cents and always with 2 decimals)

Type: long

total_amount_refunded

Type: long

class ingenico.connect.sdk.domain.payment.definitions.refund_mobile_method_specific_output.RefundMobileMethodSpecificOutput

Bases: ingenico.connect.sdk.domain.payment.definitions.refund_method_specific_output.RefundMethodSpecificOutput

from_dictionary(dictionary)

network

The network that was used for the refund. The string that represents the network is identical to the strings that the payment product vendors use in their documentation.For instance: “Visa” for Google Pay <https://developer.apple.com/reference/passkit/pkpaymentnetwork>.

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.refund_output.RefundOutput

Bases: ingenico.connect.sdk.domain.payment.definitions.order_output.OrderOutput

amount_paid

Amount paid

Type: long

bank_refund_method_specific_output

Object containing specific bank refund details

Type: ingenico.connect.sdk.domain.payment.definitions.refund_bank_method_specific_output.RefundBankMethodSpecificOutput

card_refund_method_specific_output

Object containing specific card refund details

Type: ingenico.connect.sdk.domain.payment.definitions.refund_card_method_specific_output.RefundCardMethodSpecificOutput

cash_refund_method_specific_output

Object containing specific cash refund details

Type: ingenico.connect.sdk.domain.payment.definitions.refund_cash_method_specific_output.RefundCashMethodSpecificOutput

e_invoice_refund_method_specific_output

Object containing specific e-invoice refund details

Type: ingenico.connect.sdk.domain.payment.definitions.refund_e_invoice_method_specific_output.RefundEInvoiceMethodSpecificOutput

e_wallet_refund_method_specific_output

Object containing specific eWallet refund details

Type: ingenico.connect.sdk.domain.payment.definitions.refund_e_wallet_method_specific_output.RefundEWalletMethodSpecificOutput

from_dictionary(dictionary)

mobile_refund_method_specific_output

Object containing specific mobile refund details

Type: ingenico.connect.sdk.domain.payment.definitions.refund_mobile_method_specific_output.RefundMobileMethodSpecificOutput

payment_method

Payment method identifier used by the our payment engine with the following possible values:

• bankRefund
• bankTransfer
• card
• cash
• directDebit
• eInvoice
• invoice
• redirect

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.refund_payment_product840_customer_account.RefundPaymentProduct840CustomerAccount

Bases: ingenico.connect.sdk.data_object.DataObject

PayPal account details

customer_account_status

Status of the PayPal account.

Possible values are:

• verified - PayPal has verified the funding means for this account
• unverified - PayPal has not verified the funding means for this account

Type: str

customer_address_status

Status of the customer’s shipping address as registered by PayPal

Possible values are:

• none - Status is unknown at PayPal
• confirmed - The address has been confirmed
• unconfirmed - The address has not been confirmed

Type: str

from_dictionary(dictionary)

payer_id

The unique identifier of a PayPal account and will never change in the life cycle of a PayPal account

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.refund_payment_product840_specific_output.RefundPaymentProduct840SpecificOutput

Bases: ingenico.connect.sdk.data_object.DataObject

PayPal refund details

customer_account

Object containing the PayPal account details

Type: ingenico.connect.sdk.domain.payment.definitions.refund_payment_product840_customer_account.RefundPaymentProduct840CustomerAccount

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.scheme_token_data.SchemeTokenData

Bases: ingenico.connect.sdk.data_object.DataObject

cardholder_name

The cardholder’s name on the card

Type: str

cryptogram

The Token Cryptogram is a dynamic one-time use value that is used to verify the authenticity of the transaction and the integrity of the data used in the generation of the Token Cryptogram. Visa calls this the Token Authentication Verification Value (TAVV) cryptogram.

Type: str

eci

The Electronic Commerce Indicator you got with the Token Cryptogram

Type: str

from_dictionary(dictionary)

network_token

The network token. Note: This is called Payment Token in the EMVCo documentation

Type: str

to_dictionary()

token_expiry_date

The expiry date of the network token

Type: str

class ingenico.connect.sdk.domain.payment.definitions.sdk_data_input.SdkDataInput

Bases: ingenico.connect.sdk.data_object.DataObject

device_render_options

Object containing rendering options of the device.

Type: ingenico.connect.sdk.domain.payment.definitions.device_render_options.DeviceRenderOptions

from_dictionary(dictionary)

sdk_app_id

Universally unique ID created upon all installations and updates of your app on a c Device. This will be newly generated and stored by the 3DS SDK for each installation or update

Type: str

sdk_encrypted_data

JWE Object containing data encrypted by the 3-D Secure SDK

Type: str

sdk_ephemeral_public_key

Public key component of the ephemeral key pair generated by the 3-D Secure SDK and used to establish session keys between the 3-D Secure SDK and ACS.

Type: str

sdk_max_timeout

Indicates maximum amount of time (in minutes) for all exchanges. Minimum amount of minutes is 5.

Type: str

sdk_reference_number

Identifies the vendor and version for the 3-D Secure SDK that is integrated in your app, assigned by EMVCo when the 3-D Secure SDK is approved.

Type: str

sdk_transaction_id

Universally unique transaction identifier assigned by the 3-D Secure SDK to identify a single transaction.

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.sdk_data_output.SdkDataOutput

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

sdk_transaction_id

Universally unique transaction identifier assigned by the 3-D Secure SDK to identify this transaction.

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.seller.Seller

Bases: ingenico.connect.sdk.data_object.DataObject

address

Object containing the seller address details

Type: ingenico.connect.sdk.domain.definitions.address.Address

channel_code

This property is specific to Visa Argentina. Channelcode according to Prisma. Please contact the acquirer to get the full list you need to use.

Type: str

description

Description of the seller

Type: str

external_reference_id

Seller ID assigned by the Merchant Aggregator

Type: str

from_dictionary(dictionary)

geocode

The sellers geocode

Type: str

id

The sellers identifier

Type: str

invoice_number

Invoice number of the payment

Type: str

is_foreign_retailer

Indicates if the retailer is considered foreign or domestic when compared to the location of the marketplace. Possible values:

• true - The retailer is considered foreign because they are located in a different country than the marketplace. For marketplaces located in the European Economic Area (EEA) and UK (and Gibraltar), this includes transactions where the marketplace is within the EEA and UK (and Gibraltar), but the retailer is located outside of the EEA and UK (and Gibraltar)
• false - The retailer is considered domestic because they are located in the same country as the marketplace. For marketplaces located in the European Economic Area (EEA) and UK (and Gibraltar), this includes transactions where the retailer is also located within the EEA and UK (and Gibraltar).

Type: bool

mcc

Merchant category code

Type: str

name

Name of the seller

Type: str

phone_number

Main Phone Number

Type: str

to_dictionary()

type

Seller type. Possible values:

• passport
• dni
• arg-identity-card
• civic-notebook
• enrollment-book
• cuil
• cuit
• general-register
• election-title
• cpf
• cnpj
• ssn
• citizen-ship
• col-identity-card
• alien-registration

Type: str

class ingenico.connect.sdk.domain.payment.definitions.sepa_direct_debit_payment_method_specific_input.SepaDirectDebitPaymentMethodSpecificInput

Bases: ingenico.connect.sdk.domain.payment.definitions.abstract_sepa_direct_debit_payment_method_specific_input.AbstractSepaDirectDebitPaymentMethodSpecificInput

date_collect

Changed date for direct debit collection. Only relevant for legacy SEPA Direct Debit.

Format: YYYYMMDD

Type: str

direct_debit_text

Description of the transaction that will appear on the customer bank statement to aid the customer in recognizing the transaction. Only relevant for legacy SEPA Direct Debit.

Type: str

from_dictionary(dictionary)

is_recurring

Indicates if this transaction is of a one-off or a recurring type. Only relevant for legacy SEPA Direct Debit.

• true - This is recurring
• false - This is one-off

Type: bool

payment_product771_specific_input

Object containing information specific to SEPA Direct Debit

Type: ingenico.connect.sdk.domain.payment.definitions.sepa_direct_debit_payment_product771_specific_input.SepaDirectDebitPaymentProduct771SpecificInput

recurring_payment_sequence_indicator

Only relevant for legacy SEPA Direct Debit.

• first = This transaction is the first of a series of recurring transactions
• recurring = This transaction is a subsequent transaction in a series of recurring transactions
• last = This transaction is the last transaction of a series of recurring transactions

Type: str

requires_approval

• true - The payment requires approval before the funds will be captured using the Approve payment or Capture payment API.
• false - The payment does not require approval, and the funds will be captured automatically.

Type: bool

to_dictionary()

token

ID of the token that holds previously stored SEPA Direct Debit account and mandate data. Only relevant for legacy SEPA Direct Debit.

Type: str

tokenize

Indicates if this transaction should be tokenized. Only relevant for legacy SEPA Direct Debit.

• true - Tokenize the transaction
• false - Do not tokenize the transaction, unless it would be tokenized by other means such as auto-tokenization of recurring payments.

Type: bool

class ingenico.connect.sdk.domain.payment.definitions.sepa_direct_debit_payment_method_specific_input_base.SepaDirectDebitPaymentMethodSpecificInputBase

Bases: ingenico.connect.sdk.domain.payment.definitions.abstract_sepa_direct_debit_payment_method_specific_input.AbstractSepaDirectDebitPaymentMethodSpecificInput

from_dictionary(dictionary)

payment_product771_specific_input

Object containing information specific to SEPA Direct Debit

Type: ingenico.connect.sdk.domain.payment.definitions.sepa_direct_debit_payment_product771_specific_input_base.SepaDirectDebitPaymentProduct771SpecificInputBase

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.sepa_direct_debit_payment_method_specific_output.SepaDirectDebitPaymentMethodSpecificOutput

Bases: ingenico.connect.sdk.domain.payment.definitions.abstract_payment_method_specific_output.AbstractPaymentMethodSpecificOutput

fraud_results

Object containing the results of the fraud screening

Type: ingenico.connect.sdk.domain.definitions.fraud_results.FraudResults

from_dictionary(dictionary)

payment_product771_specific_output

Output that is SEPA Direct Debit specific (i.e. the used mandate)

Type: ingenico.connect.sdk.domain.payment.definitions.payment_product771_specific_output.PaymentProduct771SpecificOutput

to_dictionary()

token

ID of the token. This property is populated for the GlobalCollect payment platform when the payment was done with a token or when the payment was tokenized.

Type: str

class ingenico.connect.sdk.domain.payment.definitions.sepa_direct_debit_payment_product771_specific_input.SepaDirectDebitPaymentProduct771SpecificInput

Bases: ingenico.connect.sdk.domain.payment.definitions.abstract_sepa_direct_debit_payment_product771_specific_input.AbstractSepaDirectDebitPaymentProduct771SpecificInput

Object containing information specific to SEPA Direct Debit for Create Payments.

existing_unique_mandate_reference

The unique reference of the existing mandate to use in this payment.

Type: str

from_dictionary(dictionary)

mandate

Object containing information to create a SEPA Direct Debit mandate.

Type: ingenico.connect.sdk.domain.mandates.definitions.create_mandate_with_return_url.CreateMandateWithReturnUrl

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.sepa_direct_debit_payment_product771_specific_input_base.SepaDirectDebitPaymentProduct771SpecificInputBase

Bases: ingenico.connect.sdk.domain.payment.definitions.abstract_sepa_direct_debit_payment_product771_specific_input.AbstractSepaDirectDebitPaymentProduct771SpecificInput

Object containing information specific to SEPA Direct Debit for Hosted Checkouts.

existing_unique_mandate_reference

The unique reference of the existing mandate to use in this payment.

Type: str

from_dictionary(dictionary)

mandate

Object containing information to create a SEPA Direct Debit mandate.

Type: ingenico.connect.sdk.domain.mandates.definitions.create_mandate_base.CreateMandateBase

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.shipping.Shipping

Bases: ingenico.connect.sdk.data_object.DataObject

Object containing information regarding shipping / delivery

address

Object containing address information

Type: ingenico.connect.sdk.domain.payment.definitions.address_personal.AddressPersonal

address_indicator

Indicates shipping method chosen for the transaction. Possible values:

• same-as-billing = the shipping address is the same as the billing address
• another-verified-address-on-file-with-merchant = the address used for shipping is another verified address of the customer that is on file with you
• different-than-billing = shipping address is different from the billing address
• ship-to-store = goods are shipped to a store (shipping address = store address)
• digital-goods = electronic delivery of digital goods
• travel-and-event-tickets-not-shipped = travel and/or event tickets that are not shipped
• other = other means of delivery

Type: str

comments

Comments included during shipping

Type: str

email_address

Email address linked to the shipping

Type: str

first_usage_date

Date (YYYYMMDD) when the shipping details for this transaction were first used.

Type: str

from_dictionary(dictionary)

is_first_usage

Indicator if this shipping address is used for the first time to ship an order

true = the shipping details are used for the first time with this transaction

false = the shipping details have been used for other transactions in the past

Type: bool

to_dictionary()

tracking_number

Shipment tracking number

Type: str

type

Indicates the merchandise delivery timeframe. Possible values:

• electronic = For electronic delivery (services or digital goods)
• same-day = For same day deliveries
• overnight = For overnight deliveries
• 2-day-or-more = For two day or more delivery time for payments that are processed by the GlobalCollect platform
• 2-day-or-more = For two day or more delivery time for payments that are processed by the Ogone platform
• priority = For prioritized deliveries for payments that are processed by the WL Online Payment Acceptance platform
• ground = For deliveries via ground for payments that are processed by the WL Online Payment Acceptance platform
• to-store = For deliveries to a store for payments that are processed by the WL Online Payment Acceptance platform

Type: str

class ingenico.connect.sdk.domain.payment.definitions.shopping_cart.ShoppingCart

Bases: ingenico.connect.sdk.data_object.DataObject

amount_breakdown

Determines the type of the amount.

Type: list[ingenico.connect.sdk.domain.payment.definitions.amount_breakdown.AmountBreakdown]

from_dictionary(dictionary)

gift_card_purchase

Object containing information on purchased gift card(s)

Type: ingenico.connect.sdk.domain.payment.definitions.gift_card_purchase.GiftCardPurchase

is_pre_order

The customer is pre-ordering one or more items

Type: bool

items

Shopping cart data

Type: list[ingenico.connect.sdk.domain.payment.definitions.line_item.LineItem]

pre_order_item_availability_date

Date (YYYYMMDD) when the preordered item becomes available

Type: str

re_order_indicator

Indicates whether the cardholder is reordering previously purchased item(s)

true = the customer is re-ordering at least one of the items again

false = this is the first time the customer is ordering these items

Type: bool

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.third_party_data.ThirdPartyData

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

payment_product863

Contains the third party data for payment product 863 (WeChat Pay).

Type: ingenico.connect.sdk.domain.payment.definitions.payment_product863_third_party_data.PaymentProduct863ThirdPartyData

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.three_d_secure.ThreeDSecure

Bases: ingenico.connect.sdk.domain.payment.definitions.abstract_three_d_secure.AbstractThreeDSecure

Object containing specific data regarding 3-D Secure

external_cardholder_authentication_data

Object containing 3D secure details.

Type: ingenico.connect.sdk.domain.payment.definitions.external_cardholder_authentication_data.ExternalCardholderAuthenticationData

from_dictionary(dictionary)

redirection_data

Object containing browser specific redirection related data

Type: ingenico.connect.sdk.domain.payment.definitions.redirection_data.RedirectionData

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.three_d_secure_base.ThreeDSecureBase

Bases: ingenico.connect.sdk.domain.payment.definitions.abstract_three_d_secure.AbstractThreeDSecure

Object containing specific data regarding 3-D Secure

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.payment.definitions.three_d_secure_data.ThreeDSecureData

Bases: ingenico.connect.sdk.data_object.DataObject

Object containing data regarding the 3D Secure authentication

acs_transaction_id

The ACS Transaction ID for a prior 3-D Secure authenticated transaction (for example, the first recurring transaction that was authenticated with the customer)

Type: str

from_dictionary(dictionary)

method

Method of authentication used for this transaction.Possible values:

• frictionless = The authentication went without a challenge
• challenged = Cardholder was challenged
• avs-verified = The authentication was verified by AVS
• other = Another issuer method was used to authenticate this transaction

Type: str

to_dictionary()

utc_timestamp

Timestamp in UTC (YYYYMMDDHHmm) of the 3-D Secure authentication of this transaction

Type: str

class ingenico.connect.sdk.domain.payment.definitions.three_d_secure_results.ThreeDSecureResults

Bases: ingenico.connect.sdk.data_object.DataObject

Object containing the 3-D Secure specific results

acs_transaction_id

Identifier of the authenticated transaction at the ACS/Issuer

Type: str

applied_exemption

Exemption code from Carte Bancaire (130) (unknown possible values so far -free format)

Type: str

authentication_amount

The amount for which this transaction has been authenticated.

Type: ingenico.connect.sdk.domain.definitions.amount_of_money.AmountOfMoney

cavv

CAVV or AVV result indicating authentication validation value

Type: str

directory_server_transaction_id

The 3-D Secure Directory Server transaction ID that is used for the 3D Authentication

Type: str

eci

Indicates Authentication validation results returned after AuthenticationValidation

Type: str

exemption_output

Object containing exemption output

Type: ingenico.connect.sdk.domain.payment.definitions.exemption_output.ExemptionOutput

from_dictionary(dictionary)

scheme_risk_score

Global score calculated by the Carte Bancaire (130) Scoring platform. Possible values from 0 to 99

Type: int

sdk_data

Object containing 3-D Secure in-app SDK data

Type: ingenico.connect.sdk.domain.payment.definitions.sdk_data_output.SdkDataOutput

three_d_secure_data

Object containing data regarding the 3-D Secure authentication

Type: ingenico.connect.sdk.domain.payment.definitions.three_d_secure_data.ThreeDSecureData

three_d_secure_version

The 3-D Secure version used for the authentication.

This property is used in the communication with the acquirer

Type: str

three_d_server_transaction_id

The 3-D Secure Server transaction ID that is used for the 3-D Secure version 2 Authentication.

Type: str

to_dictionary()

xid

Transaction ID for the Authentication

Type: str

class ingenico.connect.sdk.domain.payment.definitions.trustly_bank_account.TrustlyBankAccount

Bases: ingenico.connect.sdk.data_object.DataObject

account_last_digits

The last digits of the account number

Type: str

bank_name

The name of the bank

Type: str

clearinghouse

The country of the clearing house

Type: str

from_dictionary(dictionary)

person_identification_number

The ID number of the account holder

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.payout.approve_payout_request.ApprovePayoutRequest

Bases: ingenico.connect.sdk.data_object.DataObject

date_payout

The desired date for the payout

Format: YYYYMMDD

Type: str

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.payout.create_payout_request.CreatePayoutRequest

Bases: ingenico.connect.sdk.data_object.DataObject

amount_of_money

Object containing amount and ISO currency code attributes

Type: ingenico.connect.sdk.domain.definitions.amount_of_money.AmountOfMoney

Deprecated; Moved to PayoutDetails

bank_account_bban

Object containing account holder name and bank account information. This property can only be used for payouts in the UK.

Type: ingenico.connect.sdk.domain.definitions.bank_account_bban.BankAccountBban

Deprecated; Moved to BankTransferPayoutMethodSpecificInput

bank_account_iban

Object containing account holder and IBAN information.

Type: ingenico.connect.sdk.domain.definitions.bank_account_iban.BankAccountIban

Deprecated; Moved to BankTransferPayoutMethodSpecificInput

bank_transfer_payout_method_specific_input

Object containing the specific input details for bank transfer payouts.

Type: ingenico.connect.sdk.domain.payout.definitions.bank_transfer_payout_method_specific_input.BankTransferPayoutMethodSpecificInput

card_payout_method_specific_input

Object containing the specific input details for card payouts.

Type: ingenico.connect.sdk.domain.payout.definitions.card_payout_method_specific_input.CardPayoutMethodSpecificInput

customer

Object containing the details of the customer.

Type: ingenico.connect.sdk.domain.payout.definitions.payout_customer.PayoutCustomer

Deprecated; Moved to PayoutDetails

from_dictionary(dictionary)

merchant

Object containing information on you, the merchant

Type: ingenico.connect.sdk.domain.payout.definitions.payout_merchant.PayoutMerchant

payout_date

Date of the payout sent to the bank by us

Format: YYYYMMDD

Type: str

Deprecated; Moved to BankTransferPayoutMethodSpecificInput

payout_details

Object containing the details for Create Payout Request

Type: ingenico.connect.sdk.domain.payout.definitions.payout_details.PayoutDetails

payout_text

Text to be printed on the bank account statement of the beneficiary. The maximum allowed length might differ per country. The data will be automatically truncated to the maximum allowed length.

Type: str

Deprecated; Moved to BankTransferPayoutMethodSpecificInput

references

Object that holds all reference properties that are linked to this transaction

Type: ingenico.connect.sdk.domain.payout.definitions.payout_references.PayoutReferences

Deprecated; Moved to PayoutDetails

swift_code

The BIC is the Business Identifier Code, also known as SWIFT or Bank Identifier code. It is a code with an internationally agreed format to Identify a specific bank. The BIC contains 8 or 11 positions: the first 4 contain the bank code, followed by the country code and location code.

Type: str

Deprecated; Moved to BankTransferPayoutMethodSpecificInput

to_dictionary()

class ingenico.connect.sdk.domain.payout.find_payouts_response.FindPayoutsResponse

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

limit

The limit you used in the request.

Type: int

offset

The offset you used in the request.

Type: int

payouts

A list of payouts that matched your filter, starting at the given offset and limited to the given limit.

Type: list[ingenico.connect.sdk.domain.payout.definitions.payout_result.PayoutResult]

to_dictionary()

total_count

The total number of payouts that matched your filter.

Type: int

class ingenico.connect.sdk.domain.payout.payout_error_response.PayoutErrorResponse

Bases: ingenico.connect.sdk.data_object.DataObject

error_id

Unique reference, for debugging purposes, of this error response

Type: str

errors

List of one or more errors

Type: list[ingenico.connect.sdk.domain.errors.definitions.api_error.APIError]

from_dictionary(dictionary)

payout_result

Object that contains details on the created payout in case one has been created

Type: ingenico.connect.sdk.domain.payout.definitions.payout_result.PayoutResult

to_dictionary()

class ingenico.connect.sdk.domain.payout.payout_response.PayoutResponse

Bases: ingenico.connect.sdk.domain.payout.definitions.payout_result.PayoutResult

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.payout.definitions.abstract_payout_method_specific_input.AbstractPayoutMethodSpecificInput

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.payout.definitions.bank_transfer_payout_method_specific_input.BankTransferPayoutMethodSpecificInput

Bases: ingenico.connect.sdk.domain.payout.definitions.abstract_payout_method_specific_input.AbstractPayoutMethodSpecificInput

bank_account_bban

Object containing account holder name and bank account information. This property can only be used for payouts in the UK.

Type: ingenico.connect.sdk.domain.definitions.bank_account_bban.BankAccountBban

bank_account_iban

Object containing account holder and IBAN information.

Type: ingenico.connect.sdk.domain.definitions.bank_account_iban.BankAccountIban

customer

Object containing the details of the customer.

Type: ingenico.connect.sdk.domain.payout.definitions.payout_customer.PayoutCustomer

Deprecated; Moved to PayoutDetails

from_dictionary(dictionary)

payout_date

Date of the payout sent to the bank by us.

Format: YYYYMMDD

Type: str

payout_text

Text to be printed on the bank account statement of the beneficiary. The maximum allowed length might differ per country. The data will be automatically truncated to the maximum allowed length.

Type: str

swift_code

The BIC is the Business Identifier Code, also known as SWIFT or Bank Identifier code. It is a code with an internationally agreed format to Identify a specific bank. The BIC contains 8 or 11 positions: the first 4 contain the bank code, followed by the country code and location code.

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.payout.definitions.card_payout_method_specific_input.CardPayoutMethodSpecificInput

Bases: ingenico.connect.sdk.domain.payout.definitions.abstract_payout_method_specific_input.AbstractPayoutMethodSpecificInput

card

Object containing the card details.

Type: ingenico.connect.sdk.domain.definitions.card.Card

from_dictionary(dictionary)

payment_product_id

Payment product identifier

Please see payment products <https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/paymentproducts.html> for a full overview of possible values.

Type: int

recipient

Object containing the details of the recipient of the payout

Type: ingenico.connect.sdk.domain.payout.definitions.payout_recipient.PayoutRecipient

to_dictionary()

token

ID of the token that holds previously stored card data.

If both the token and card are provided, then the card takes precedence over the token.

Type: str

class ingenico.connect.sdk.domain.payout.definitions.payout_customer.PayoutCustomer

Bases: ingenico.connect.sdk.data_object.DataObject

address

Object containing address details

Type: ingenico.connect.sdk.domain.definitions.address.Address

company_information

Object containing company information

Type: ingenico.connect.sdk.domain.definitions.company_information.CompanyInformation

contact_details

Object containing contact details like email address and phone number

Type: ingenico.connect.sdk.domain.definitions.contact_details_base.ContactDetailsBase

from_dictionary(dictionary)

merchant_customer_id

Your identifier for the customer. It can be used as a search criteria in the GlobalCollect Payment Console and is also included in the GlobalCollect report files. It is used in the fraud-screening process for payments on the Ogone Payment Platform.

Type: str

name

Object containing PersonalName object

Type: ingenico.connect.sdk.domain.payment.definitions.personal_name.PersonalName

to_dictionary()

class ingenico.connect.sdk.domain.payout.definitions.payout_details.PayoutDetails

Bases: ingenico.connect.sdk.data_object.DataObject

amount_of_money

Object containing amount and ISO currency code attributes

Type: ingenico.connect.sdk.domain.definitions.amount_of_money.AmountOfMoney

customer

Object containing the details of the customer.

Type: ingenico.connect.sdk.domain.payout.definitions.payout_customer.PayoutCustomer

from_dictionary(dictionary)

references

Object that holds all reference properties that are linked to this transaction

Type: ingenico.connect.sdk.domain.payout.definitions.payout_references.PayoutReferences

to_dictionary()

class ingenico.connect.sdk.domain.payout.definitions.payout_merchant.PayoutMerchant

Bases: ingenico.connect.sdk.data_object.DataObject

configuration_id

In case your account has been setup with multiple configurations you can use this property to identify the one you would like to use for the transaction. Note that you can only submit preconfigured values in combination with the Worldline Online Payments Acceptance platform. In case no value is supplied a default value of 0 will be submitted to the Worldline Online Payments Acceptance platform. The Worldline Online Payments Acceptance platform internally refers to this as a PosId.

Type: str

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.payout.definitions.payout_recipient.PayoutRecipient

Bases: ingenico.connect.sdk.data_object.DataObject

Object containing the details of the recipient of the payout

first_name

Given name(s) or first name(s) of the customer

Type: str

from_dictionary(dictionary)

surname

Surname(s) or last name(s) of the customer

Type: str

surname_prefix

Middle name - In between first name and surname - of the customer

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.payout.definitions.payout_references.PayoutReferences

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

invoice_number

Your invoice number (on printed invoice) that is also returned in our report files

Type: str

merchant_order_id

Order Identifier generated by the merchant

Note: This does not need to have a unique value for each transaction

Type: long

merchant_reference

Note that the maximum length of this field for transactions processed on the GlobalCollect platform is 30. Your unique reference of the transaction that is also returned in our report files. This is almost always used for your reconciliation of our report files.

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.payout.definitions.payout_result.PayoutResult

Bases: ingenico.connect.sdk.domain.definitions.abstract_order_status.AbstractOrderStatus

from_dictionary(dictionary)

payout_output

Object containing payout details

Type: ingenico.connect.sdk.domain.payment.definitions.order_output.OrderOutput

status

Current high-level status of the payouts in a human-readable form. Possible values are :

• CREATED - The transaction has been created. This is the initial state once a new payout is created.
• PENDING_APPROVAL - The transaction is awaiting approval from you to proceed with the paying out of the funds
• REJECTED - The transaction has been rejected
• PAYOUT_REQUESTED - The transaction is in the queue to be payed out to the customer
• ACCOUNT_CREDITED - We have successfully credited the customer
• REJECTED_CREDIT - The credit to the account of the customer was rejected by the bank
• CANCELLED - You have cancelled the transaction
• REVERSED - The payout has been reversed and the money is returned to your balance

Please see Statuses <https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/statuses.html> for a full overview of possible values.

Type: str

status_output

This object has the numeric representation of the current payout status, timestamp of last status change and performable action on the current payout resource.

In case of a rejected payout, detailed error information is listed.

Type: ingenico.connect.sdk.domain.definitions.order_status_output.OrderStatusOutput

to_dictionary()

class ingenico.connect.sdk.domain.product.create_payment_product_session_request.CreatePaymentProductSessionRequest

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

payment_product_session302_specific_input

Object containing details for creating an Apple Pay session.

Type: ingenico.connect.sdk.domain.product.definitions.mobile_payment_product_session302_specific_input.MobilePaymentProductSession302SpecificInput

to_dictionary()

class ingenico.connect.sdk.domain.product.create_payment_product_session_response.CreatePaymentProductSessionResponse

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

payment_product_session302_specific_output

Object containing the Apple Pay session object.

Type: ingenico.connect.sdk.domain.product.definitions.mobile_payment_product_session302_specific_output.MobilePaymentProductSession302SpecificOutput

to_dictionary()

class ingenico.connect.sdk.domain.product.device_fingerprint_request.DeviceFingerprintRequest

Bases: ingenico.connect.sdk.data_object.DataObject

collector_callback

You can supply a JavaScript function call that will be called after the device fingerprint data collecting using the provided JavaScript snippet is finished. This will then be added to the snippet that is returned in the property html.

Type: str

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.product.device_fingerprint_response.DeviceFingerprintResponse

Bases: ingenico.connect.sdk.data_object.DataObject

device_fingerprint_transaction_id

Contains the unique id which is used by the device fingerprint collector script. This must be used to set the property fraudFields.deviceFingerprintTransactionId in either in the CreatePayment.order.customer.device.deviceFingerprintTransactionId, the CreateRiskAssessmentCards.order.customer.device.deviceFingerprintTransactionId or the CreateRiskAssessmentBankaccounts.order.customer.device.deviceFingerprintTransactionId.

Type: str

from_dictionary(dictionary)

html

Contains the ready-to-use device fingerprint collector script. You have to inject it into your page and call it when the customer presses the final payment submit button. You should only call it once per payment request.

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.product.directory.Directory

Bases: ingenico.connect.sdk.data_object.DataObject

entries

List of entries in the directory

Type: list[ingenico.connect.sdk.domain.product.definitions.directory_entry.DirectoryEntry]

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.product.get_customer_details_request.GetCustomerDetailsRequest

Bases: ingenico.connect.sdk.data_object.DataObject

Input for the retrieval of a customer’s details.

country_code

The code of the country where the customer should reside.

Type: str

from_dictionary(dictionary)

to_dictionary()

values

A list of keys with a value used to retrieve the details of a customer. Depending on the country code, different keys are required. These can be determined with a getPaymentProduct call and using payment product properties with the property usedForLookup set to true.

Type: list[ingenico.connect.sdk.domain.definitions.key_value_pair.KeyValuePair]

class ingenico.connect.sdk.domain.product.get_customer_details_response.GetCustomerDetailsResponse

Bases: ingenico.connect.sdk.data_object.DataObject

Output for the retrieval of a customer’s details.

city

The city in which the customer resides.

Type: str

country

The country in which the customer resides.

Type: str

email_address

The email address registered to the customer.

Type: str

first_name

The first name of the customer

Type: str

fiscal_number

The fiscal number (SSN) for the customer.

Type: str

from_dictionary(dictionary)

language_code

The code of the language used by the customer.

Type: str

phone_number

The phone number registered to the customer.

Type: str

street

The street on which the customer resides.

Type: str

surname

The surname or family name of the customer.

Type: str

to_dictionary()

zip

The ZIP or postal code for the area in which the customer resides.

Type: str

class ingenico.connect.sdk.domain.product.payment_product_group_response.PaymentProductGroupResponse

Bases: ingenico.connect.sdk.domain.product.definitions.payment_product_group.PaymentProductGroup

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.product.payment_product_groups.PaymentProductGroups

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

payment_product_groups

Array containing payment product groups and their characteristics

Type: list[ingenico.connect.sdk.domain.product.definitions.payment_product_group.PaymentProductGroup]

to_dictionary()

class ingenico.connect.sdk.domain.product.payment_product_networks_response.PaymentProductNetworksResponse

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

networks

Array containing network entries for a payment product. The strings that represent the networks in the array are identical to the strings that the payment product vendors use in their documentation.For instance: “Visa” for Google Pay <https://developer.apple.com/reference/passkit/pkpaymentnetwork>.

Type: list[str]

to_dictionary()

class ingenico.connect.sdk.domain.product.payment_product_response.PaymentProductResponse

Bases: ingenico.connect.sdk.domain.product.definitions.payment_product.PaymentProduct

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.product.payment_products.PaymentProducts

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

payment_products

Array containing payment products and their characteristics

Type: list[ingenico.connect.sdk.domain.product.definitions.payment_product.PaymentProduct]

to_dictionary()

class ingenico.connect.sdk.domain.product.definitions.abstract_indicator.AbstractIndicator

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

name

Type: str

to_dictionary()

value

Type: str

class ingenico.connect.sdk.domain.product.definitions.account_on_file.AccountOnFile

Bases: ingenico.connect.sdk.data_object.DataObject

Elements from the AccountsOnFile array

attributes

Array containing the details of the stored token

Type: list[ingenico.connect.sdk.domain.product.definitions.account_on_file_attribute.AccountOnFileAttribute]

display_hints

Object containing information for the client on how best to display this field

Type: ingenico.connect.sdk.domain.product.definitions.account_on_file_display_hints.AccountOnFileDisplayHints

from_dictionary(dictionary)

id

ID of the account on file record

Type: int

payment_product_id

Payment product identifier

Please see payment products <https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/paymentproducts.html> for a full overview of possible values.

Type: int

to_dictionary()

class ingenico.connect.sdk.domain.product.definitions.account_on_file_attribute.AccountOnFileAttribute

Bases: ingenico.connect.sdk.domain.definitions.key_value_pair.KeyValuePair

from_dictionary(dictionary)

must_write_reason

The reason why the status is MUST_WRITE. Currently only “IN_THE_PAST” is possible as value (for expiry date), but this can be extended with new values in the future.

Type: str

status

Possible values:

• READ_ONLY - attribute cannot be updated and should be presented in that way to the user
• CAN_WRITE - attribute can be updated and should be presented as an editable field, for example an expiration date that will expire very soon
• MUST_WRITE - attribute should be updated and must be presented as an editable field, for example an expiration date that has already expired

Any updated values that are entered for CAN_WRITE or MUST_WRITE will be used to update the values stored in the token.

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.product.definitions.account_on_file_display_hints.AccountOnFileDisplayHints

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

label_template

Array of attribute keys and their mask

Type: list[ingenico.connect.sdk.domain.product.definitions.label_template_element.LabelTemplateElement]

logo

Partial URL that you can reference for the image of this payment product. You can use our server-side resize functionality by appending ‘?size={{width}}x{{height}}’ to the full URL, where width and height are specified in pixels. The resized image will always keep its correct aspect ratio.

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.product.definitions.authentication_indicator.AuthenticationIndicator

Bases: ingenico.connect.sdk.domain.product.definitions.abstract_indicator.AbstractIndicator

Indicates if the payment product supports 3D Security (mandatory, optional or not needed).

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.product.definitions.boleto_bancario_requiredness_validator.BoletoBancarioRequirednessValidator

Bases: ingenico.connect.sdk.data_object.DataObject

fiscal_number_length

When performing a payment with Boleto Bancario, some values are only required when the fiscalnumber has a specific length. The length the fiscalnumber has to have to make the field required is defined here.

For example the CompanyName is required when the fiscalnumber is a CNPJ. The firstname and surname are required when the fiscalnumber is a CPF.

Type: int

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.product.definitions.directory_entry.DirectoryEntry

Bases: ingenico.connect.sdk.data_object.DataObject

country_names

Country name of the issuer, used to group issuers per country

Note: this is only filled if supported by the payment product.

Type: list[str]

from_dictionary(dictionary)

issuer_id

Unique ID of the issuing bank of the customer

Type: str

issuer_list

To be used to sort the issuers.

• short - These issuers should be presented at the top of the list
• long - These issuers should be presented after the issuers marked as short

Note: this is only filled if supported by the payment product. Currently only iDeal (809) support this. Sorting within the groups should be done alphabetically.

Type: str

issuer_name

Name of the issuing bank, as it should be presented to the customer

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.product.definitions.empty_validator.EmptyValidator

Bases: ingenico.connect.sdk.data_object.DataObject

A validator object that contains no additional properties.

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.product.definitions.fixed_list_validator.FixedListValidator

Bases: ingenico.connect.sdk.data_object.DataObject

allowed_values

List of the allowed values that the field will be validated against

Type: list[str]

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.product.definitions.label_template_element.LabelTemplateElement

Bases: ingenico.connect.sdk.data_object.DataObject

attribute_key

Name of the attribute that is shown to the customer on selection pages or screens

Type: str

from_dictionary(dictionary)

mask

Regular mask for the attributeKey

Note: The mask is optional as not every field has a mask

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.product.definitions.length_validator.LengthValidator

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

max_length

The maximum allowed length

Type: int

min_length

The minimum allowed length

Type: int

to_dictionary()

class ingenico.connect.sdk.domain.product.definitions.mobile_payment_product_session302_specific_input.MobilePaymentProductSession302SpecificInput

Bases: ingenico.connect.sdk.data_object.DataObject

display_name

Used as an input for the Apple Pay payment button. Provide your company name in a human readable form.

Type: str

domain_name

Provide a fully qualified domain name of your own payment page that will be showing an Apple Pay button.

Type: str

from_dictionary(dictionary)

to_dictionary()

validation_url

Provide the validation URL that has been provided by Apple once you have started an Apple Pay session.

Type: str

class ingenico.connect.sdk.domain.product.definitions.mobile_payment_product_session302_specific_output.MobilePaymentProductSession302SpecificOutput

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

session_object

Object containing an opaque merchant session object.

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.product.definitions.payment_product.PaymentProduct

Bases: ingenico.connect.sdk.data_object.DataObject

accounts_on_file

List of tokens for that payment product

Type: list[ingenico.connect.sdk.domain.product.definitions.account_on_file.AccountOnFile]

acquirer_country

ISO 3166-1 alpha-2 country code which indicates the most likely country code of the acquirer that will process the transaction. For Google Pay (paymentProductId 320) transactions this acquirerCountry is should be provided in the https://developers.google.com/pay/api/web/guides/resources/sca <https://developers.google.com/pay/api/web/reference/request-objects#TransactionInfo>

Type: str

allows_installments

Indicates if the product supports installments

• true - This payment supports installments
• false - This payment does not support installments

Type: bool

allows_recurring

Indicates if the product supports recurring payments

• true - This payment product supports recurring payments
• false - This payment product does not support recurring transactions and can only be used for one-off payments

Type: bool

allows_tokenization

Indicates if the payment details can be tokenized for future re-use

• true - Payment details from payments done with this payment product can be tokenized for future re-use
• false - Payment details from payments done with this payment product can not be tokenized

Type: bool

authentication_indicator

Indicates if the payment product supports 3D Security (mandatory, optional or not needed).

Type: ingenico.connect.sdk.domain.product.definitions.authentication_indicator.AuthenticationIndicator

auto_tokenized

Indicates if the payment details can be automatically tokenized for future re-use

• true - Payment details from payments done with this payment product can be automatically tokenized for future re-use
• false - Payment details from payments done with this payment product can not be automatically tokenized

Type: bool

can_be_iframed

This property is only relevant for payment products that use third party redirects. This property indicates if the third party disallows their payment pages to be embedded in an iframe using the X-Frame-Options header.

• true - the third party allows their payment pages to be embedded in an iframe.
• false - the third party disallows their payment pages to be embedded in an iframe.

Type: bool

device_fingerprint_enabled

Indicates if device fingerprint is enabled for the product

• true
• false

Type: bool

display_hints

Object containing display hints like the order in which the product should be shown, the name of the product and the logo

Type: ingenico.connect.sdk.domain.product.definitions.payment_product_display_hints.PaymentProductDisplayHints

fields

Object containing all the fields and their details that are associated with this payment product. If you are not interested in the data in the fields you should have us filter them out (using filter=fields in the query-string)

Type: list[ingenico.connect.sdk.domain.product.definitions.payment_product_field.PaymentProductField]

fields_warning

If one or more of the payment product fields could not be constructed, no payment product fields will be returned and a message will be present in this property stating why.

Type: str

from_dictionary(dictionary)

id

The ID of the payment product in our system

Type: int

is_authentication_supported

Indicates if the payment product supports 3D-Secure.

Type: bool

is_java_script_required

This property indicates if the payment product requires JavaScript to be enabled on the customer’s browser. This is usually only true if the payment product depends on a third party JavaScript integration.

• true - the payment product requires JavaScript to be enabled.
• false - the payment product does not require JavaScript to be enabled. This is the default value if the property is not present.

Type: bool

max_amount

Maximum amount in cents (using 2 decimals, so 1 EUR becomes 100 cents) for transactions done with this payment product

Type: long

min_amount

Minimum amount in cents (using 2 decimals, so 1 EUR becomes 100 cents) for transactions done with this payment product

Type: long

mobile_integration_level

This provides insight into the level of support for payments using a device with a smaller screen size. You can for instance use this to rank payment products differently on devices with a smaller screen. Possible values are:

• NO_SUPPORT - The payment product does not work at all on a mobile device
• BASIC_SUPPORT - The payment product has not optimized its user experience for devices with smaller screens
• OPTIMISED_SUPPORT - The payment product offers a user experience that has been optimized for devices with smaller screens

Type: str

payment_method

Indicates which payment method will be used for this payment product. Payment method is one of:

• bankTransfer
• card
• cash
• directDebit
• eInvoice
• invoice
• redirect

Type: str

payment_product302_specific_data

Apple Pay (payment product 302) specific details.

Type: ingenico.connect.sdk.domain.product.definitions.payment_product302_specific_data.PaymentProduct302SpecificData

payment_product320_specific_data

Google Pay (payment product 320) specific details.

Type: ingenico.connect.sdk.domain.product.definitions.payment_product320_specific_data.PaymentProduct320SpecificData

payment_product863_specific_data

WeChat Pay (payment product 863) specific details.

Type: ingenico.connect.sdk.domain.product.definitions.payment_product863_specific_data.PaymentProduct863SpecificData

payment_product_group

The payment product group that has this payment product, if there is any. Not populated otherwise. Currently only one payment product group is supported:

• cards

Type: str

supports_mandates

Indicates whether the payment product supports mandates.

Type: bool

to_dictionary()

uses_redirection_to3rd_party

Indicates whether the payment product requires redirection to a third party to complete the payment. You can use this to filter out products that require a redirect if you don’t want to support that.

• true - Redirection is required
• false - No redirection is required

Type: bool

class ingenico.connect.sdk.domain.product.definitions.payment_product302_specific_data.PaymentProduct302SpecificData

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

networks

The networks that can be used in the current payment context. The strings that represent the networks in the array are identical to the strings that Apple uses in their documentation <https://developer.apple.com/reference/passkit/pkpaymentnetwork>.For instance: “Visa”.

Type: list[str]

to_dictionary()

class ingenico.connect.sdk.domain.product.definitions.payment_product320_specific_data.PaymentProduct320SpecificData

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

gateway

The GlobalCollect gateway identifier. You should use this when creating a tokenization specification <https://developers.google.com/pay/api/android/reference/object#Gateway>.

Type: str

networks

The networks that can be used in the current payment context. The strings that represent the networks in the array are identical to the strings that Google uses in their documentation <https://developers.google.com/pay/api/android/reference/object#CardParameters>.For instance: “VISA”.

Type: list[str]

to_dictionary()

class ingenico.connect.sdk.domain.product.definitions.payment_product863_specific_data.PaymentProduct863SpecificData

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

integration_types

The WeChat Pay integration types that can be used in the current payment context. Possible values:

• desktopQRCode - used on desktops, the customer opens the WeChat app by scanning a QR code.
• urlIntent - used in mobile apps or on mobile web pages, the customer opens the WeChat app using a URL intent.
• nativeInApp - used in mobile apps that use the WeChat Pay SDK.

Type: list[str]

to_dictionary()

class ingenico.connect.sdk.domain.product.definitions.payment_product_display_hints.PaymentProductDisplayHints

Bases: ingenico.connect.sdk.data_object.DataObject

display_order

Determines the order in which the payment products and groups should be shown (sorted ascending)

Type: int

from_dictionary(dictionary)

label

Name of the field based on the locale that was included in the request

Type: str

logo

Partial URL that you can reference for the image of this payment product. You can use our server-side resize functionality by appending ‘?size={{width}}x{{height}}’ to the full URL, where width and height are specified in pixels. The resized image will always keep its correct aspect ratio.

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.product.definitions.payment_product_field.PaymentProductField

Bases: ingenico.connect.sdk.data_object.DataObject

data_restrictions

Object containing data restrictions that apply to this field, like minimum and/or maximum length

Type: ingenico.connect.sdk.domain.product.definitions.payment_product_field_data_restrictions.PaymentProductFieldDataRestrictions

display_hints

Object containing display hints for this field, like the order, mask, preferred keyboard

Type: ingenico.connect.sdk.domain.product.definitions.payment_product_field_display_hints.PaymentProductFieldDisplayHints

from_dictionary(dictionary)

id

The ID of the field

Type: str

to_dictionary()

type

The type of field, possible values are:

• string - Any UTF-8 chracters
• numericstring - A string that consisting only of numbers. Note that you should strip out anything that is not a digit, but leading zeros are allowed
• date - Date in the format DDMMYYYY
• expirydate - Expiration date in the format MMYY
• integer - An integer
• boolean - A boolean

Type: str

used_for_lookup

Indicates that the product can be used in a get customer details <https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/products/customerDetails.html> call and that when that call is done the field should be supplied as (one of the) key(s) with a valid value.

Type: bool

class ingenico.connect.sdk.domain.product.definitions.payment_product_field_data_restrictions.PaymentProductFieldDataRestrictions

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

is_required

• true - Indicates that this field is required
• false - Indicates that this field is optional

Type: bool

to_dictionary()

validators

Object containing the details of the validations on the field

Type: ingenico.connect.sdk.domain.product.definitions.payment_product_field_validators.PaymentProductFieldValidators

class ingenico.connect.sdk.domain.product.definitions.payment_product_field_display_element.PaymentProductFieldDisplayElement

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

id

The ID of the display element.

Type: str

label

The label of the display element.

Type: str

to_dictionary()

type

The type of the display element. Indicates how the value should be presented. Possible values are:

• STRING - as plain text
• CURRENCY - as an amount in cents displayed with a decimal separator and the currency of the payment
• PERCENTAGE - as a number with a percentage sign
• INTEGER - as an integer
• URI - as a link

Type: str

value

the value of the display element.

Type: str

class ingenico.connect.sdk.domain.product.definitions.payment_product_field_display_hints.PaymentProductFieldDisplayHints

Bases: ingenico.connect.sdk.data_object.DataObject

always_show

• true - Indicates that this field is advised to be captured to increase the success rates even though it isn’t marked as required. Please note that making the field required could hurt the success rates negatively. This boolean only indicates our advise to always show this field to the customer.
• false - Indicates that this field is not to be shown unless it is a required field.

Type: bool

display_order

The order in which the fields should be shown (ascending)

Type: int

form_element

Object detailing the type of form element that should be used to present the field

Type: ingenico.connect.sdk.domain.product.definitions.payment_product_field_form_element.PaymentProductFieldFormElement

from_dictionary(dictionary)

label

Label/Name of the field to be used in the user interface

Type: str

link

Link that should be used to replace the ‘{link}’ variable in the label.

Type: str

mask

A mask that can be used in the input field. You can use it to inject additional characters to provide a better user experience and to restrict the accepted character set (illegal characters to be ignored during typing).

* is used for wildcards (and also chars)

9 is used for numbers

Everything outside {{ and }} is used as-is.

Type: str

obfuscate

• true - The data in this field should be obfuscated as it is entered, just like a password field
• false - The data in this field does not need to be obfuscated

Type: bool

placeholder_label

A placeholder value for the form element

Type: str

preferred_input_type

The type of keyboard that can best be used to fill out the value of this field. Possible values are:

• PhoneNumberKeyboard - Keyboard that is normally used to enter phone numbers
• StringKeyboard - Keyboard that is used to enter strings
• IntegerKeyboard - Keyboard that is used to enter only numerical values
• EmailAddressKeyboard - Keyboard that allows easier entry of email addresses

Type: str

to_dictionary()

tooltip

Object that contains an optional tooltip to assist the customer

Type: ingenico.connect.sdk.domain.product.definitions.payment_product_field_tooltip.PaymentProductFieldTooltip

class ingenico.connect.sdk.domain.product.definitions.payment_product_field_form_element.PaymentProductFieldFormElement

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

to_dictionary()

type

Type of form element to be used. The following types can be returned:

• text - A normal text input field
• list - A list of values that the customer needs to choose from, is detailed in the valueMapping array
• currency - Currency fields should be split into two fields, with the second one being specifically for the cents
• boolean - Boolean fields should offer the customer a choice, like accepting the terms and conditions of a product.
• date - let the customer pick a date.

Type: str

value_mapping

An array of values and displayNames that should be used to populate the list object in the GUI

Type: list[ingenico.connect.sdk.domain.product.definitions.value_mapping_element.ValueMappingElement]

class ingenico.connect.sdk.domain.product.definitions.payment_product_field_tooltip.PaymentProductFieldTooltip

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

image

Relative URL that can be used to retrieve an image for the tooltip image. You can use our server-side resize functionality by appending ‘?size={{width}}x{{height}}’ to the full URL, where width and height are specified in pixels. The resized image will always keep its correct aspect ratio.

Type: str

label

A text explaining the field in more detail. This is meant to be used for displaying to the customer.

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.product.definitions.payment_product_field_validators.PaymentProductFieldValidators

Bases: ingenico.connect.sdk.data_object.DataObject

boleto_bancario_requiredness

Indicates the requiredness of the field based on the fiscalnumber for Boleto Bancario

Type: ingenico.connect.sdk.domain.product.definitions.boleto_bancario_requiredness_validator.BoletoBancarioRequirednessValidator

email_address

Indicates that the content should be validated against the rules for an email address

Type: ingenico.connect.sdk.domain.product.definitions.empty_validator.EmptyValidator

expiration_date

Indicates that the content should be validated against the rules for an expiration date (it should be in the future)

Type: ingenico.connect.sdk.domain.product.definitions.empty_validator.EmptyValidator

fixed_list

Indicates that content should be one of the, in this object, listed items

Type: ingenico.connect.sdk.domain.product.definitions.fixed_list_validator.FixedListValidator

from_dictionary(dictionary)

iban

Indicates that the content of this (iban) field needs to validated against format checks and modulo check (as described in ISO 7064)

Type: ingenico.connect.sdk.domain.product.definitions.empty_validator.EmptyValidator

length

Indicates that the content needs to be validated against length criteria defined in this object

Type: ingenico.connect.sdk.domain.product.definitions.length_validator.LengthValidator

luhn

Indicates that the content needs to be validated using a LUHN check

Type: ingenico.connect.sdk.domain.product.definitions.empty_validator.EmptyValidator

range

Indicates that the content needs to be validated against a, in this object, defined range

Type: ingenico.connect.sdk.domain.product.definitions.range_validator.RangeValidator

regular_expression

A string representing the regular expression to check

Type: ingenico.connect.sdk.domain.product.definitions.regular_expression_validator.RegularExpressionValidator

resident_id_number

Indicates that the content needs to be validated as per the Chinese resident identity number format

Type: ingenico.connect.sdk.domain.product.definitions.empty_validator.EmptyValidator

terms_and_conditions

Indicates that the content should be validated as such that the customer has accepted the field as if they were terms and conditions of a service

Type: ingenico.connect.sdk.domain.product.definitions.empty_validator.EmptyValidator

to_dictionary()

class ingenico.connect.sdk.domain.product.definitions.payment_product_group.PaymentProductGroup

Bases: ingenico.connect.sdk.data_object.DataObject

Definition of the details of a single payment product group

accounts_on_file

Only populated in the Client API

Type: list[ingenico.connect.sdk.domain.product.definitions.account_on_file.AccountOnFile]

allows_installments

Indicates if the product supports installments

• true - This payment supports installments
• false - This payment does not support installments

Type: bool

device_fingerprint_enabled

Indicates if device fingerprint is enabled for the product group

• true
• false

Type: bool

display_hints

Object containing display hints like the order of the group when shown in a list, the name of the group and the logo. Note that the order of the group is the lowest order among the payment products that belong to the group.

Type: ingenico.connect.sdk.domain.product.definitions.payment_product_display_hints.PaymentProductDisplayHints

fields

Object containing all the fields and their details that are associated with this payment product group. If you are not interested in the these fields you can have us filter them out (using hide=fields in the query-string)

Type: list[ingenico.connect.sdk.domain.product.definitions.payment_product_field.PaymentProductField]

from_dictionary(dictionary)

id

The ID of the payment product group in our system

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.product.definitions.range_validator.RangeValidator

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

max_value

Upper value of the range that is still valid

Type: int

min_value

Lower value of the range that is still valid

Type: int

to_dictionary()

class ingenico.connect.sdk.domain.product.definitions.regular_expression_validator.RegularExpressionValidator

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

regular_expression

Contains the regular expression that the value of the field needs to be validated against

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.product.definitions.value_mapping_element.ValueMappingElement

Bases: ingenico.connect.sdk.data_object.DataObject

display_elements

List of extra data of the value.

Type: list[ingenico.connect.sdk.domain.product.definitions.payment_product_field_display_element.PaymentProductFieldDisplayElement]

display_name

Key name

Type: str

Deprecated; Use displayElements instead with ID ‘displayName’

from_dictionary(dictionary)

to_dictionary()

value

Value corresponding to the key

Type: str

class ingenico.connect.sdk.domain.refund.approve_refund_request.ApproveRefundRequest

Bases: ingenico.connect.sdk.data_object.DataObject

amount

Refund amount to be approved

Type: long

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.refund.find_refunds_response.FindRefundsResponse

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

limit

The limit you used in the request.

Type: int

offset

The offset you used in the request.

Type: int

refunds

A list of refunds that matched your filter, starting at the given offset and limited to the given limit.

Type: list[ingenico.connect.sdk.domain.refund.definitions.refund_result.RefundResult]

to_dictionary()

total_count

The total number of refunds that matched your filter.

Type: int

class ingenico.connect.sdk.domain.refund.refund_error_response.RefundErrorResponse

Bases: ingenico.connect.sdk.data_object.DataObject

error_id

Unique reference, for debugging purposes, of this error response

Type: str

errors

List of one or more errors

Type: list[ingenico.connect.sdk.domain.errors.definitions.api_error.APIError]

from_dictionary(dictionary)

refund_result

Object that contains details on the created refund in case one has been created

Type: ingenico.connect.sdk.domain.refund.definitions.refund_result.RefundResult

to_dictionary()

class ingenico.connect.sdk.domain.refund.refund_request.RefundRequest

Bases: ingenico.connect.sdk.data_object.DataObject

amount_of_money

Object containing amount and ISO currency code attributes

Type: ingenico.connect.sdk.domain.definitions.amount_of_money.AmountOfMoney

bank_refund_method_specific_input

Object containing the specific input details for a bank refund

Type: ingenico.connect.sdk.domain.refund.definitions.bank_refund_method_specific_input.BankRefundMethodSpecificInput

customer

Object containing the details of the customer

Type: ingenico.connect.sdk.domain.refund.definitions.refund_customer.RefundCustomer

from_dictionary(dictionary)

refund_date

Refund date

Format: YYYYMMDD

Type: str

refund_references

Object that holds all reference properties that are linked to this refund

Type: ingenico.connect.sdk.domain.refund.definitions.refund_references.RefundReferences

to_dictionary()

class ingenico.connect.sdk.domain.refund.refund_response.RefundResponse

Bases: ingenico.connect.sdk.domain.refund.definitions.refund_result.RefundResult

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.refund.refunds_response.RefundsResponse

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

refunds

The list of all refunds performed on the requested payment.

Type: list[ingenico.connect.sdk.domain.refund.definitions.refund_result.RefundResult]

to_dictionary()

class ingenico.connect.sdk.domain.refund.definitions.bank_account_bban_refund.BankAccountBbanRefund

Bases: ingenico.connect.sdk.domain.definitions.bank_account_bban.BankAccountBban

bank_city

City of the bank to refund to

Type: str

from_dictionary(dictionary)

patronymic_name

Every Russian has three names: a first name, a patronymic, and a surname. The second name is a patronymic. Russian patronymic is a name derived from the father’s first name by adding -ович/-евич (son of) for male, or -овна/-евна (daughter of) for females.

Type: str

swift_code

The BIC is the Business Identifier Code, also known as SWIFT or Bank Identifier code. It is a code with an internationally agreed format to Identify a specific bank. The BIC contains 8 or 11 positions: the first 4 contain the bank code, followed by the country code and location code.

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.refund.definitions.bank_refund_method_specific_input.BankRefundMethodSpecificInput

Bases: ingenico.connect.sdk.data_object.DataObject

bank_account_bban

Object that holds the Basic Bank Account Number (BBAN) data

Type: ingenico.connect.sdk.domain.refund.definitions.bank_account_bban_refund.BankAccountBbanRefund

bank_account_iban

Object that holds the International Bank Account Number (IBAN) data

Type: ingenico.connect.sdk.domain.definitions.bank_account_iban.BankAccountIban

country_code

ISO 3166-1 alpha-2 country code of the country where money will be refunded to

Type: str

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.refund.definitions.refund_customer.RefundCustomer

Bases: ingenico.connect.sdk.data_object.DataObject

address

Object containing address details

Type: ingenico.connect.sdk.domain.payment.definitions.address_personal.AddressPersonal

company_information

Object containing company information

Type: ingenico.connect.sdk.domain.definitions.company_information.CompanyInformation

contact_details

Object containing contact details like email address and phone number

Type: ingenico.connect.sdk.domain.definitions.contact_details_base.ContactDetailsBase

fiscal_number

The fiscal registration number of the customer or the tax registration number of the company in case of a business customer. Please find below specifics per country:

• Argentina - Consumer (DNI) with a length of 7 or 8 digits
• Argentina - Company (CUIT) with a length of 11 digits
• Brazil - Consumer (CPF) with a length of 11 digits
• Brazil - Company (CNPJ) with a length of 14 digits
• Chile - Consumer (RUT) with a length of 9 digits
• Colombia - Consumer (NIT) with a length of 8, 9 or 10 digits
• Denmark - Consumer (CPR-nummer or personnummer) with a length of 10 digits
• Dominican Republic - Consumer (RNC) with a length of 11 digits
• Finland - Consumer (Finnish: henkilötunnus (abbreviated as HETU)) with a length of 11 characters
• India - Consumer (PAN) with a length of 10 characters
• Mexico - Consumer (RFC) with a length of 13 digits
• Mexico - Company (RFC) with a length of 12 digits
• Norway - Consumer (fødselsnummer) with a length of 11 digits
• Peru - Consumer (RUC) with a length of 11 digits
• Sweden - Consumer (personnummer) with a length of 10 or 12 digits
• Uruguay - Consumer (CI) with a length of 8 digits
• Uruguay - Consumer (NIE) with a length of 9 digits
• Uruguay - Company (RUT) with a length of 12 digits

Type: str

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.refund.definitions.refund_references.RefundReferences

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

merchant_reference

Note that the maximum length of this field for transactions processed on the GlobalCollect platform is 30. Your unique reference of the transaction that is also returned in our report files. This is almost always used for your reconciliation of our report files.

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.refund.definitions.refund_result.RefundResult

Bases: ingenico.connect.sdk.domain.definitions.abstract_order_status.AbstractOrderStatus

from_dictionary(dictionary)

refund_output

Object containing refund details

Type: ingenico.connect.sdk.domain.payment.definitions.refund_output.RefundOutput

status

Current high-level status of the refund in a human-readable form. Possible values are:

• CREATED - The transaction has been created. This is the initial state once a new refund is created.
• PENDING_APPROVAL - The transaction is awaiting approval from you to proceed with the processing of the refund
• REJECTED - The refund has been rejected
• REFUND_REQUESTED - The transaction is in the queue to be refunded
• REFUNDED - We have successfully refunded the customer
• REJECTED_CAPTURE - The refund was rejected by the bank or us during processing
• CANCELLED - You have cancelled the transaction

Please see Statuses <https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/statuses.html> for a full overview of possible values.

Type: str

status_output

This object has the numeric representation of the current refund status, timestamp of last status change and performable action on the current refund resource.

In case of a rejected refund, detailed error information is listed.

Type: ingenico.connect.sdk.domain.definitions.order_status_output.OrderStatusOutput

to_dictionary()

class ingenico.connect.sdk.domain.riskassessments.risk_assessment_bank_account.RiskAssessmentBankAccount

Bases: ingenico.connect.sdk.domain.riskassessments.definitions.risk_assessment.RiskAssessment

bank_account_bban

Object containing account holder name and bank account information

Type: ingenico.connect.sdk.domain.definitions.bank_account_bban.BankAccountBban

bank_account_iban

Object containing account holder name and IBAN information

Type: ingenico.connect.sdk.domain.definitions.bank_account_iban.BankAccountIban

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.riskassessments.risk_assessment_card.RiskAssessmentCard

Bases: ingenico.connect.sdk.domain.riskassessments.definitions.risk_assessment.RiskAssessment

card

Object containing Card object

Type: ingenico.connect.sdk.domain.definitions.card.Card

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.riskassessments.risk_assessment_response.RiskAssessmentResponse

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

results

Object that contains the results of the performed fraudchecks

Type: list[ingenico.connect.sdk.domain.definitions.result_do_risk_assessment.ResultDoRiskAssessment]

to_dictionary()

class ingenico.connect.sdk.domain.riskassessments.definitions.contact_details_risk_assessment.ContactDetailsRiskAssessment

Bases: ingenico.connect.sdk.data_object.DataObject

email_address

Email address of the customer

Type: str

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.riskassessments.definitions.customer_account_risk_assessment.CustomerAccountRiskAssessment

Bases: ingenico.connect.sdk.data_object.DataObject

Object containing data related to the account the customer has with you

from_dictionary(dictionary)

has_forgotten_password

Specifies if the customer (initially) had forgotten their password

• true - The customer has forgotten their password
• false - The customer has not forgotten their password

Type: bool

has_password

Specifies if the customer entered a password to gain access to an account registered with the you

• true - The customer has used a password to gain access
• false - The customer has not used a password to gain access

Type: bool

to_dictionary()

class ingenico.connect.sdk.domain.riskassessments.definitions.customer_device_risk_assessment.CustomerDeviceRiskAssessment

Bases: ingenico.connect.sdk.data_object.DataObject

Object containing information on the device and browser of the customer

default_form_fill

Degree of default form fill, with the following possible values:

• automatically - All fields filled automatically
• automatically-but-modified - All fields filled automatically, but some fields were modified manually
• manually - All fields were entered manually

Type: str

device_fingerprint_transaction_id

One must set the deviceFingerprintTransactionId received by the response of the endpoint /{merchant}/products/{paymentProductId}/deviceFingerprint

Type: str

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.riskassessments.definitions.customer_risk_assessment.CustomerRiskAssessment

Bases: ingenico.connect.sdk.data_object.DataObject

Object containing data related to the customer

account

Object containing data related to the account the customer has with you

Type: ingenico.connect.sdk.domain.riskassessments.definitions.customer_account_risk_assessment.CustomerAccountRiskAssessment

account_type

Type of the customer account that is used to place this order. Can have one of the following values:

• none - The account that was used to place the order is a guest account or no account was used at all
• created - The customer account was created during this transaction
• existing - The customer account was an already existing account prior to this transaction

Type: str

billing_address

Object containing billing address details

Type: ingenico.connect.sdk.domain.definitions.address.Address

contact_details

Object containing contact details like email address

Type: ingenico.connect.sdk.domain.riskassessments.definitions.contact_details_risk_assessment.ContactDetailsRiskAssessment

device

Object containing information on the device and browser of the customer

Type: ingenico.connect.sdk.domain.riskassessments.definitions.customer_device_risk_assessment.CustomerDeviceRiskAssessment

from_dictionary(dictionary)

is_previous_customer

Specifies if the customer has a history of online shopping with the merchant

• true - The customer is a known returning customer
• false - The customer is new/unknown customer

Type: bool

locale

The locale that the customer should be addressed in (for 3rd parties). Note that some 3rd party providers only support the languageCode part of the locale, in those cases we will only use part of the locale provided.

Type: str

personal_information

Object containing personal information like name, date of birth and gender

Type: ingenico.connect.sdk.domain.riskassessments.definitions.personal_information_risk_assessment.PersonalInformationRiskAssessment

shipping_address

Object containing shipping address details

Type: ingenico.connect.sdk.domain.payment.definitions.address_personal.AddressPersonal

Deprecated; Use Order.shipping.address instead

to_dictionary()

class ingenico.connect.sdk.domain.riskassessments.definitions.merchant_risk_assessment.MerchantRiskAssessment

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

to_dictionary()

website_url

The website from which the purchase was made

Type: str

class ingenico.connect.sdk.domain.riskassessments.definitions.order_risk_assessment.OrderRiskAssessment

Bases: ingenico.connect.sdk.data_object.DataObject

additional_input

Object containing additional input on the order

Type: ingenico.connect.sdk.domain.definitions.additional_order_input_airline_data.AdditionalOrderInputAirlineData

amount_of_money

Object containing amount and ISO currency code attributes

Type: ingenico.connect.sdk.domain.definitions.amount_of_money.AmountOfMoney

customer

Object containing the details of the customer

Type: ingenico.connect.sdk.domain.riskassessments.definitions.customer_risk_assessment.CustomerRiskAssessment

from_dictionary(dictionary)

shipping

Object containing information regarding shipping / delivery

Type: ingenico.connect.sdk.domain.riskassessments.definitions.shipping_risk_assessment.ShippingRiskAssessment

to_dictionary()

class ingenico.connect.sdk.domain.riskassessments.definitions.personal_information_risk_assessment.PersonalInformationRiskAssessment

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

name

Object containing the name details of the customer

Type: ingenico.connect.sdk.domain.riskassessments.definitions.personal_name_risk_assessment.PersonalNameRiskAssessment

to_dictionary()

class ingenico.connect.sdk.domain.riskassessments.definitions.personal_name_risk_assessment.PersonalNameRiskAssessment

Bases: ingenico.connect.sdk.domain.definitions.personal_name_base.PersonalNameBase

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.riskassessments.definitions.risk_assessment.RiskAssessment

Bases: ingenico.connect.sdk.data_object.DataObject

fraud_fields

Object containing additional data that will be used to assess the risk of fraud

Type: ingenico.connect.sdk.domain.definitions.fraud_fields.FraudFields

from_dictionary(dictionary)

merchant

Type: ingenico.connect.sdk.domain.riskassessments.definitions.merchant_risk_assessment.MerchantRiskAssessment

order

Type: ingenico.connect.sdk.domain.riskassessments.definitions.order_risk_assessment.OrderRiskAssessment

payment_product_id

Payment product identifier

Please see payment products <https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/paymentproducts.html> for a full overview of possible values.

Type: int

to_dictionary()

class ingenico.connect.sdk.domain.riskassessments.definitions.shipping_risk_assessment.ShippingRiskAssessment

Bases: ingenico.connect.sdk.data_object.DataObject

Object containing information regarding shipping / delivery

address

Object containing address information

Type: ingenico.connect.sdk.domain.payment.definitions.address_personal.AddressPersonal

comments

Comments included during shipping

Type: str

from_dictionary(dictionary)

to_dictionary()

tracking_number

Shipment tracking number

Type: str

class ingenico.connect.sdk.domain.services.bank_details_request.BankDetailsRequest

Bases: ingenico.connect.sdk.domain.services.definitions.bank_details.BankDetails

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.services.bank_details_response.BankDetailsResponse

Bases: ingenico.connect.sdk.data_object.DataObject

bank_account_bban

Object that holds the Basic Bank Account Number (BBAN) data

Type: ingenico.connect.sdk.domain.definitions.bank_account_bban.BankAccountBban

bank_account_iban

Object that holds the International Bank Account Number (IBAN) data

Type: ingenico.connect.sdk.domain.definitions.bank_account_iban.BankAccountIban

bank_data

Object that holds the reformatted bank account data

Type: ingenico.connect.sdk.domain.services.definitions.bank_data.BankData

from_dictionary(dictionary)

swift

Object that holds all the SWIFT routing information

Type: ingenico.connect.sdk.domain.services.definitions.swift.Swift

to_dictionary()

class ingenico.connect.sdk.domain.services.convert_amount.ConvertAmount

Bases: ingenico.connect.sdk.data_object.DataObject

converted_amount

Converted amount in cents and having 2 decimal

Type: long

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.services.get_iin_details_request.GetIINDetailsRequest

Bases: ingenico.connect.sdk.data_object.DataObject

Input for the retrieval of the IIN details request.

bin

The first digits of the credit card number from left to right with a minimum of 6 digits. Providing additional digits can result in more co-brands being returned.

Type: str

from_dictionary(dictionary)

payment_context

Optional payment context to refine the IIN lookup to filter out payment products not applicable to your payment.

Type: ingenico.connect.sdk.domain.services.definitions.payment_context.PaymentContext

to_dictionary()

class ingenico.connect.sdk.domain.services.get_iin_details_response.GetIINDetailsResponse

Bases: ingenico.connect.sdk.data_object.DataObject

Output of the retrieval of the IIN details request

co_brands

Populated only if the card has multiple brands.

A list with for every brand of the card, the payment product identifier associated with that brand, and if you submitted a payment context, whether that payment product is allowed in the context.

Type: list[ingenico.connect.sdk.domain.services.definitions.iin_detail.IINDetail]

country_code

The ISO 3166-1 alpha-2 country code of the country where the card was issued. If we don’t know where the card was issued, then the countryCode will return the value ‘99’.

Type: str

from_dictionary(dictionary)

is_allowed_in_context

Populated only if you submitted a payment context.

• true - The payment product is allowed in the submitted context.
• false - The payment product is not allowed in the submitted context. Note that in this case, none of the brands of the card will be allowed in the submitted context.

Type: bool

payment_product_id

The payment product identifier associated with the card. If the card has multiple brands, then we select the most appropriate payment product based on your configuration and the payment context, if you submitted one.

Please see payment products <https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/paymentproducts.html> for a full overview of possible values

Type: int

to_dictionary()

class ingenico.connect.sdk.domain.services.get_privacy_policy_response.GetPrivacyPolicyResponse

Bases: ingenico.connect.sdk.data_object.DataObject

Output of the retrieval of the privacy policy

from_dictionary(dictionary)

html_content

HTML content to be displayed to the user

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.services.test_connection.TestConnection

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

result

OK result on the connection to the payment engine.

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.services.definitions.bank_data.BankData

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

new_bank_name

Bank name, matching the bank code of the request

Type: str

reformatted_account_number

Reformatted account number according to local clearing rules

Type: str

reformatted_bank_code

Reformatted bank code according to local clearing rules

Type: str

reformatted_branch_code

Reformatted branch code according to local clearing rules

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.services.definitions.bank_details.BankDetails

Bases: ingenico.connect.sdk.data_object.DataObject

bank_account_bban

Object that holds the Basic Bank Account Number (BBAN) data

Type: ingenico.connect.sdk.domain.definitions.bank_account_bban.BankAccountBban

bank_account_iban

Object that holds the International Bank Account Number (IBAN) data

Type: ingenico.connect.sdk.domain.definitions.bank_account_iban.BankAccountIban

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.services.definitions.iin_detail.IINDetail

Bases: ingenico.connect.sdk.data_object.DataObject

Output of the retrieval of the IIN details request

from_dictionary(dictionary)

is_allowed_in_context

Populated only if you submitted a payment context.

• true - The payment product is allowed in the submitted context.
• false - The payment product is not allowed in the submitted context. Note that in this case, none of the brands of the card will be allowed in the submitted context.

Type: bool

payment_product_id

Payment product identifier

Please see payment products <https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/paymentproducts.html> for a full overview of possible values.

Type: int

to_dictionary()

class ingenico.connect.sdk.domain.services.definitions.payment_context.PaymentContext

Bases: ingenico.connect.sdk.data_object.DataObject

Values that can optionally be set to refine an IIN Lookup

amount_of_money

The payment amount

Type: ingenico.connect.sdk.domain.definitions.amount_of_money.AmountOfMoney

country_code

The country the payment takes place in

Type: str

from_dictionary(dictionary)

is_installments

True if the payment is to be paid in multiple installments (numberOfInstallments &gt; 1 for the payment). When true only payment products that support installments will be allowed in context.

Type: bool

is_recurring

True if the payment is recurring

Type: bool

to_dictionary()

class ingenico.connect.sdk.domain.services.definitions.swift.Swift

Bases: ingenico.connect.sdk.data_object.DataObject

bic

The BIC is the Business Identifier Code, also known as SWIFT or Bank Identifier code. It is a code with an internationally agreed format to Identify a specific bank or even branch. The BIC contains 8 or 11 positions: the first 4 contain the bank code, followed by the country code and location code.

Type: str

category

SWIFT category

Type: str

chips_uid

Clearing House Interbank Payments System (CHIPS) UID

CHIPS is one half of the primary US network of large-value domestic and international payments.

Type: str

extra_info

SWIFT extra information

Type: str

from_dictionary(dictionary)

po_box_country

Institution PO Box country

Type: str

po_box_location

Institution PO Box location

Type: str

po_box_number

Institution PO Box number

Type: str

po_box_zip

Institution PO Box ZIP

Type: str

routing_bic

Payment routing BIC

Type: str

services

SWIFT services

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.sessions.session_request.SessionRequest

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

payment_product_filters

Restrict the payment products available for payment completion by restricting to and excluding certain payment products and payment product groups.

Type: ingenico.connect.sdk.domain.sessions.definitions.payment_product_filters_client_session.PaymentProductFiltersClientSession

to_dictionary()

tokens

List of previously stored tokens linked to the customer that wants to checkout.

Type: list[str]

class ingenico.connect.sdk.domain.sessions.session_response.SessionResponse

Bases: ingenico.connect.sdk.data_object.DataObject

asset_url

The datacenter-specific base url for assets. This value needs to be passed to the Client SDK to make sure that the client software connects to the right datacenter.

Type: str

client_api_url

The datacenter-specific base url for client requests. This value needs to be passed to the Client SDK to make sure that the client software connects to the right datacenter.

Type: str

client_session_id

The identifier of the session that has been created.

Type: str

customer_id

The session is build up around the customer in the form of the customerId. All of the Client APIs use this customerId in the URI to identify the customer.

Type: str

from_dictionary(dictionary)

invalid_tokens

Tokens that are submitted in the request are validated. In case any of the tokens can’t be used anymore they are returned in this array. You should most likely remove those tokens from your system.

Type: list[str]

region

Possible values:

• EU - datacenter located in Amsterdam
• US - datacenter located in Miami
• AMS - datacenter located in Amsterdam
• PAR - datacenter located in Paris

When a session is created it is created in a specific datacenter. Any subsequent calls using the Client API need to be datacenter specific. The datacenters are identified by this region value. This value needs to be passed to the Client SDK to make sure that the client software connects to the right datacenter. This only applies if your clients use a version older than the ones listed below:

• JavaScript Client SDK v3.6.0
• iOS ObjectiveC Client SDK v3.10.0
• iOS Swift Client SDK v2.2.0
• Android Client SDK v3.10.0

In case of the iOS and Android SDKs the version of the SDK used will be tightly coupled with the versions of your app that is still in active use. You are advised to pass this value to your clients in case you are unsure of the version used in your clients.

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.sessions.definitions.payment_product_filters_client_session.PaymentProductFiltersClientSession

Bases: ingenico.connect.sdk.data_object.DataObject

exclude

Contains the payment product ids and payment product groups that should be excluded from the payment products available for the payment. Note that excluding a payment product will ensure exclusion, even if the payment product is also present in the restrictTo filter, and that excluding a payment product group will exclude all payment products that are a part of that group, even if one or more of them are present in the restrictTo filters.

Type: ingenico.connect.sdk.domain.definitions.payment_product_filter.PaymentProductFilter

from_dictionary(dictionary)

restrict_to

Contains the payment product ids and payment product groups that should be at most contained in the payment products available for completing the payment. Note that the list of payment products available for completing the payment will only contain payment products present in these filters, but not all payment products in these filters might be present in the list. Some of them might not be allowed in context or they might be present in the exclude filters.

Type: ingenico.connect.sdk.domain.definitions.payment_product_filter.PaymentProductFilter

to_dictionary()

class ingenico.connect.sdk.domain.token.approve_token_request.ApproveTokenRequest

Bases: ingenico.connect.sdk.domain.token.definitions.mandate_approval.MandateApproval

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.token.create_token_request.CreateTokenRequest

Bases: ingenico.connect.sdk.data_object.DataObject

card

Object containing card details

Type: ingenico.connect.sdk.domain.token.definitions.token_card.TokenCard

e_wallet

Object containing eWallet details

Type: ingenico.connect.sdk.domain.token.definitions.token_e_wallet.TokenEWallet

encrypted_customer_input

Data that was encrypted client side containing all customer entered data elements like card data.

Note: Because this data can only be submitted once to our system and contains encrypted card data you should not store it. As the data was captured within the context of a client session you also need to submit it to us before the session has expired.

Type: str

from_dictionary(dictionary)

non_sepa_direct_debit

Object containing non SEPA Direct Debit details

Type: ingenico.connect.sdk.domain.token.definitions.token_non_sepa_direct_debit.TokenNonSepaDirectDebit

payment_product_id

Payment product identifier

Please see payment products <https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/paymentproducts.html> for a full overview of possible values.

Type: int

sepa_direct_debit

Object containing SEPA Direct Debit details

Type: ingenico.connect.sdk.domain.token.definitions.token_sepa_direct_debit_without_creditor.TokenSepaDirectDebitWithoutCreditor

to_dictionary()

class ingenico.connect.sdk.domain.token.create_token_response.CreateTokenResponse

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

is_new_token

Indicates if a new token was created

• true - A new token was created
• false - A token with the same card number already exists and is returned. Please note that the existing token has not been updated. When you want to update other data then the card number, you need to use the update API call, as data is never updated during the creation of a token.

Type: bool

original_payment_id

The initial Payment ID of the transaction from which the token has been created

Type: str

to_dictionary()

token

ID of the token

Type: str

class ingenico.connect.sdk.domain.token.token_response.TokenResponse

Bases: ingenico.connect.sdk.data_object.DataObject

card

Object containing card details

Type: ingenico.connect.sdk.domain.token.definitions.token_card.TokenCard

e_wallet

Object containing eWallet details

Type: ingenico.connect.sdk.domain.token.definitions.token_e_wallet.TokenEWallet

from_dictionary(dictionary)

id

ID of the token

Type: str

non_sepa_direct_debit

Object containing the non SEPA Direct Debit details

Type: ingenico.connect.sdk.domain.token.definitions.token_non_sepa_direct_debit.TokenNonSepaDirectDebit

original_payment_id

The initial Payment ID of the transaction from which the token has been created

Type: str

payment_product_id

Payment product identifier

Please see payment products <https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/paymentproducts.html> for a full overview of possible values.

Type: int

sepa_direct_debit

Object containing the SEPA Direct Debit details

Type: ingenico.connect.sdk.domain.token.definitions.token_sepa_direct_debit.TokenSepaDirectDebit

to_dictionary()

class ingenico.connect.sdk.domain.token.update_token_request.UpdateTokenRequest

Bases: ingenico.connect.sdk.data_object.DataObject

card

Object containing card details

Type: ingenico.connect.sdk.domain.token.definitions.token_card.TokenCard

e_wallet

Object containing eWallet details

Type: ingenico.connect.sdk.domain.token.definitions.token_e_wallet.TokenEWallet

from_dictionary(dictionary)

non_sepa_direct_debit

Object containing the non SEPA Direct Debit details

Type: ingenico.connect.sdk.domain.token.definitions.token_non_sepa_direct_debit.TokenNonSepaDirectDebit

payment_product_id

Payment product identifier

Please see payment products <https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/paymentproducts.html> for a full overview of possible values.

Type: int

sepa_direct_debit

Object containing the SEPA Direct Debit details

Type: ingenico.connect.sdk.domain.token.definitions.token_sepa_direct_debit_without_creditor.TokenSepaDirectDebitWithoutCreditor

to_dictionary()

class ingenico.connect.sdk.domain.token.definitions.abstract_token.AbstractToken

Bases: ingenico.connect.sdk.data_object.DataObject

alias

An alias for the token. This can be used to visually represent the token.

If no alias is given in Create token calls, a payment product specific default is used, e.g. the obfuscated card number for card payment products.

Do not include any unobfuscated sensitive data in the alias.

Type: str

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.token.definitions.contact_details_token.ContactDetailsToken

Bases: ingenico.connect.sdk.domain.definitions.contact_details_base.ContactDetailsBase

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.token.definitions.creditor.Creditor

Bases: ingenico.connect.sdk.data_object.DataObject

additional_address_info

Additional information about the creditor’s address, like Suite II, Apartment 2a

Type: str

city

City of the creditor address

Type: str

country_code

ISO 3166-1 alpha-2 country code

Type: str

from_dictionary(dictionary)

house_number

House number of the creditor address

Type: str

iban

Creditor IBAN number

The IBAN is the International Bank Account Number. It is an internationally agreed format for the bank account number and includes the ISO country code and two check digits.

Type: str

id

Creditor identifier

Type: str

name

Name of the collecting creditor

Type: str

reference_party

Creditor type of the legal reference of the collecting entity

Type: str

reference_party_id

Legal reference of the collecting creditor

Type: str

street

Street of the creditor address

Type: str

to_dictionary()

zip

ZIP code of the creditor address

Type: str

class ingenico.connect.sdk.domain.token.definitions.customer_token.CustomerToken

Bases: ingenico.connect.sdk.domain.definitions.customer_base.CustomerBase

billing_address

Object containing the billing address details

Type: ingenico.connect.sdk.domain.definitions.address.Address

from_dictionary(dictionary)

personal_information

Object containing personal information of the customer

Type: ingenico.connect.sdk.domain.token.definitions.personal_information_token.PersonalInformationToken

to_dictionary()

class ingenico.connect.sdk.domain.token.definitions.customer_token_with_contact_details.CustomerTokenWithContactDetails

Bases: ingenico.connect.sdk.domain.token.definitions.customer_token.CustomerToken

contact_details

Object containing contact details like email address and phone number

Type: ingenico.connect.sdk.domain.token.definitions.contact_details_token.ContactDetailsToken

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.token.definitions.debtor.Debtor

Bases: ingenico.connect.sdk.data_object.DataObject

This object describes the the consumer (or company) that will be debited and it is part of a SEPA Direct Debit Mandate

additional_address_info

Additional information about the debtor’s address, like Suite II, Apartment 2a

Type: str

city

City of the debtor’s address

Type: str

country_code

ISO 3166-1 alpha-2 country code of the debtor’s address

Type: str

first_name

Debtor first name

Type: str

from_dictionary(dictionary)

house_number

House number of the debtor’s address

Type: str

state

State of debtor address

Type: str

state_code

ISO 3166-2 alpha-3 state code

Notes:

• The maximum length for 3-D Secure version 2 is AN3.
• The maximum length for paymentProductId 1503 (Boleto) is AN2.

Type: str

street

Street of debtor’s address

Type: str

surname

Debtor’s last name

Type: str

surname_prefix

Prefix of the debtor’s last name

Type: str

to_dictionary()

zip

ZIP code of the debtor’s address

Type: str

class ingenico.connect.sdk.domain.token.definitions.mandate_approval.MandateApproval

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

mandate_signature_date

The date when the mandate was signed

Format: YYYYMMDD

Type: str

mandate_signature_place

The city where the mandate was signed

Type: str

mandate_signed

• true = Mandate is signed
• false = Mandate is not signed

Type: bool

to_dictionary()

class ingenico.connect.sdk.domain.token.definitions.mandate_non_sepa_direct_debit.MandateNonSepaDirectDebit

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

payment_product705_specific_data

Object containing specific data for Direct Debit UK

Type: ingenico.connect.sdk.domain.token.definitions.token_non_sepa_direct_debit_payment_product705_specific_data.TokenNonSepaDirectDebitPaymentProduct705SpecificData

payment_product730_specific_data

Object containing specific data for ACH

Type: ingenico.connect.sdk.domain.token.definitions.token_non_sepa_direct_debit_payment_product730_specific_data.TokenNonSepaDirectDebitPaymentProduct730SpecificData

to_dictionary()

class ingenico.connect.sdk.domain.token.definitions.mandate_sepa_direct_debit.MandateSepaDirectDebit

Bases: ingenico.connect.sdk.domain.token.definitions.mandate_sepa_direct_debit_with_mandate_id.MandateSepaDirectDebitWithMandateId

creditor

Object containing information on the creditor

Type: ingenico.connect.sdk.domain.token.definitions.creditor.Creditor

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.token.definitions.mandate_sepa_direct_debit_with_mandate_id.MandateSepaDirectDebitWithMandateId

Bases: ingenico.connect.sdk.domain.token.definitions.mandate_sepa_direct_debit_without_creditor.MandateSepaDirectDebitWithoutCreditor

from_dictionary(dictionary)

mandate_id

Unique mandate identifier

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.token.definitions.mandate_sepa_direct_debit_without_creditor.MandateSepaDirectDebitWithoutCreditor

Bases: ingenico.connect.sdk.data_object.DataObject

bank_account_iban

Object containing Account holder and IBAN information

Type: ingenico.connect.sdk.domain.definitions.bank_account_iban.BankAccountIban

customer_contract_identifier

Identifies the contract between customer and merchant

Type: str

debtor

Object containing information on the debtor

Type: ingenico.connect.sdk.domain.token.definitions.debtor.Debtor

from_dictionary(dictionary)

is_recurring

• true
• false

Type: bool

mandate_approval

Object containing the details of the mandate approval

Type: ingenico.connect.sdk.domain.token.definitions.mandate_approval.MandateApproval

pre_notification

Indicates whether a pre-notification should be sent to the customer.

• do-not-send - Do not send a pre-notification
• send-on-first-collection - Send a pre-notification

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.token.definitions.personal_information_token.PersonalInformationToken

Bases: ingenico.connect.sdk.data_object.DataObject

from_dictionary(dictionary)

name

Given name(s) or first name(s) of the customer

Type: ingenico.connect.sdk.domain.token.definitions.personal_name_token.PersonalNameToken

to_dictionary()

class ingenico.connect.sdk.domain.token.definitions.personal_name_token.PersonalNameToken

Bases: ingenico.connect.sdk.domain.definitions.personal_name_base.PersonalNameBase

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.token.definitions.token_card.TokenCard

Bases: ingenico.connect.sdk.domain.token.definitions.abstract_token.AbstractToken

customer

Object containing the details of the customer

Type: ingenico.connect.sdk.domain.token.definitions.customer_token.CustomerToken

data

Object containing the card tokenizable details

Type: ingenico.connect.sdk.domain.token.definitions.token_card_data.TokenCardData

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.token.definitions.token_card_data.TokenCardData

Bases: ingenico.connect.sdk.data_object.DataObject

card_without_cvv

Object containing the card details (without CVV)

Type: ingenico.connect.sdk.domain.definitions.card_without_cvv.CardWithoutCvv

first_transaction_date

Date of the first transaction (for ATOS)

Format: YYYYMMDD

Type: str

from_dictionary(dictionary)

provider_reference

Reference of the provider (of the first transaction) - used to store the ATOS Transaction Certificate

Type: str

to_dictionary()

class ingenico.connect.sdk.domain.token.definitions.token_e_wallet.TokenEWallet

Bases: ingenico.connect.sdk.domain.token.definitions.abstract_token.AbstractToken

customer

Object containing the details of the customer

Type: ingenico.connect.sdk.domain.token.definitions.customer_token.CustomerToken

data

Object containing the eWallet tokenizable data

Type: ingenico.connect.sdk.domain.token.definitions.token_e_wallet_data.TokenEWalletData

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.token.definitions.token_e_wallet_data.TokenEWalletData

Bases: ingenico.connect.sdk.data_object.DataObject

billing_agreement_id

Identification of the PayPal recurring billing agreement

Type: str

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.token.definitions.token_non_sepa_direct_debit.TokenNonSepaDirectDebit

Bases: ingenico.connect.sdk.domain.token.definitions.abstract_token.AbstractToken

customer

Object containing the details of the customer

Type: ingenico.connect.sdk.domain.token.definitions.customer_token.CustomerToken

from_dictionary(dictionary)

mandate

Object containing the mandate details

Type: ingenico.connect.sdk.domain.token.definitions.mandate_non_sepa_direct_debit.MandateNonSepaDirectDebit

to_dictionary()

class ingenico.connect.sdk.domain.token.definitions.token_non_sepa_direct_debit_payment_product705_specific_data.TokenNonSepaDirectDebitPaymentProduct705SpecificData

Bases: ingenico.connect.sdk.data_object.DataObject

authorisation_id

Core reference number for the direct debit instruction in UK

Type: str

bank_account_bban

Object containing account holder name and bank account information

Type: ingenico.connect.sdk.domain.definitions.bank_account_bban.BankAccountBban

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.token.definitions.token_non_sepa_direct_debit_payment_product730_specific_data.TokenNonSepaDirectDebitPaymentProduct730SpecificData

Bases: ingenico.connect.sdk.data_object.DataObject

bank_account_bban

Object containing account holder name and bank account information

Type: ingenico.connect.sdk.domain.definitions.bank_account_bban.BankAccountBban

from_dictionary(dictionary)

to_dictionary()

class ingenico.connect.sdk.domain.token.definitions.token_sepa_direct_debit.TokenSepaDirectDebit

Bases: ingenico.connect.sdk.domain.token.definitions.abstract_token.AbstractToken

customer

Object containing the details of the customer

Type: ingenico.connect.sdk.domain.token.definitions.customer_token_with_contact_details.CustomerTokenWithContactDetails

from_dictionary(dictionary)

mandate

Object containing the mandate details

Type: ingenico.connect.sdk.domain.token.definitions.mandate_sepa_direct_debit.MandateSepaDirectDebit

to_dictionary()

class ingenico.connect.sdk.domain.token.definitions.token_sepa_direct_debit_without_creditor.TokenSepaDirectDebitWithoutCreditor

Bases: ingenico.connect.sdk.domain.token.definitions.abstract_token.AbstractToken

customer

Object containing the details of the customer

Type: ingenico.connect.sdk.domain.token.definitions.customer_token_with_contact_details.CustomerTokenWithContactDetails

from_dictionary(dictionary)

mandate

Object containing the mandate details

Type: ingenico.connect.sdk.domain.token.definitions.mandate_sepa_direct_debit_without_creditor.MandateSepaDirectDebitWithoutCreditor

to_dictionary()

class ingenico.connect.sdk.domain.webhooks.web_hooks_event.WebhooksEvent

Bases: ingenico.connect.sdk.data_object.DataObject

api_version

created

dispute

from_dictionary(dictionary)

id

merchant_id

payment

payout

refund

to_dictionary()

token

type

class ingenico.connect.sdk.log.body_obfuscator.BodyObfuscator(additional_rules=None)

Bases: object

A class that can be used to obfuscate properties in JSON bodies.

__init__(additional_rules=None)

Creates a new body obfuscator. This will contain some pre-defined obfuscation rules, as well as any provided custom rules

Parameters:additional_rules – An optional mapping from property names to obfuscation rules, where an obfuscation rule is a function that obfuscates a single string,

static default_body_obfuscator()

obfuscate_body(body, charset=None)

Obfuscates the body from the given stream as necessary. :param body: The body to obfuscate, as string or bytes. :param charset: The charset to use to read the body bytes.

class ingenico.connect.sdk.log.communicator_logger.CommunicatorLogger

Used to log messages from communicators.

log(message, thrown=None)

Logs a throwable with an accompanying message.

Parameters:

• message – The message accompanying the throwable.
• thrown – The throwable to log.

log_request(request_log_message)

Logs a request message object

log_response(response_log_message)

Logs a response message object

class ingenico.connect.sdk.log.header_obfuscator.HeaderObfuscator(additional_rules=None)

A class that can be used to obfuscate headers.

__init__(additional_rules=None)

Creates a new header obfuscator. This will contain some pre-defined obfuscation rules, as well as any provided custom rules

Parameters:additional_rules – An optional mapping from property names to obfuscation rules, where an obfuscation rule is a function that obfuscates a single string,

static default_header_obfuscator()

obfuscate_header(header_name, value)

Obfuscates the value for the given header as necessary.

class ingenico.connect.sdk.log.log_message.LogMessage(request_id, body_obfuscator=<ingenico.connect.sdk.log.body_obfuscator.BodyObfuscator object>, header_obfuscator=<ingenico.connect.sdk.log.header_obfuscator.HeaderObfuscator instance>)

Bases: object

A utility class to build log messages.

add_header(name, value)

body

content_type

empty_if_none(value)

get_header_list()

get_message()

headers

request_id

set_binary_body(content_type)

set_body(body, content_type, charset=None)

class ingenico.connect.sdk.log.logging_capable.LoggingCapable

Bases: object

Classes that extend this class have support for log messages from communicators.

disable_logging()

Turns off logging.

enable_logging(communicator_logger)

Turns on logging using the given communicator logger.

Raise:ValueError If the given communicator logger is None.

class ingenico.connect.sdk.log.logging_util.LoggingUtil

A utility class to support logging.

static obfuscate_body(body, charset=None)

Obfuscates the body from the given stream as necessary.

Deprecated; Use BodyObfuscator instead

Parameters:

• body – The body to obfuscate, as string or bytes
• charset – The charset to use to read the body input stream.

static obfuscate_header(name, value)

Obfuscates the value for the given header as necessary.

Deprecated; Use HeaderObfuscator instead

class ingenico.connect.sdk.log.obfuscation_capable.ObfuscationCapable

Bases: object

Classes that extend this class support obfuscating bodies and headers.

__abstractmethods__ = frozenset(['set_header_obfuscator', 'set_body_obfuscator'])

set_body_obfuscator(body_obfuscator)

Sets the current body obfuscator to use.

set_header_obfuscator(header_obfuscator)

Sets the current header obfuscator to use.

ingenico.connect.sdk.log.obfuscation_rule.obfuscate_all()

Returns an obfuscation rule (function) that will replace all characters with *

ingenico.connect.sdk.log.obfuscation_rule.obfuscate_all_but_first(count)

Returns an obfuscation rule (function) that will keep a fixed number of characters at the start, then replaces all other characters with *

ingenico.connect.sdk.log.obfuscation_rule.obfuscate_all_but_last(count)

Returns an obfuscation rule that will keep a fixed number of characters at the end, then replaces all other characters with *

ingenico.connect.sdk.log.obfuscation_rule.obfuscate_with_fixed_length(fixed_length)

Returns an obfuscation rule (function) that will replace values with a fixed length string containing only *

class ingenico.connect.sdk.log.python_communicator_logger.PythonCommunicatorLogger(logger, log_level, error_log_level=False)

Bases: ingenico.connect.sdk.log.communicator_logger.CommunicatorLogger

A communicator logger that is backed by the log library.

__init__(logger, log_level, error_log_level=False)

Logs messages to the argument logger using the argument log_level. If absent, the error_log_level will be equal to the log_level. Note that if the CommunicatorLogger’s log level is lower than the argument logger’s log level (e.g. the CommunicatorLogger is given log.INFO as level and the argument logger has a level of log.WARNING), then nothing will be logged to the logger.

Parameters:

• logger – the logger to log to
• log_level – the log level that will be used for non-error messages logged via the CommunicatorLogger
• error_log_level – the log level that will be used for error messages logged via the CommunicatorLogger.

log(message, thrown=None)

Log a message to the underlying logger. If thrown is absent, the message will be logged with the CommunicatorLogger’s log_level, if a thrown object is provided, the message and exception will be logged with the CommunicatorLogger’s error_log_level.

Parameters:

• message – the message to be logged
• thrown – an optional throwable object

class ingenico.connect.sdk.log.request_log_message.RequestLogMessage(request_id, method, uri, body_obfuscator=<ingenico.connect.sdk.log.body_obfuscator.BodyObfuscator object>, header_obfuscator=<ingenico.connect.sdk.log.header_obfuscator.HeaderObfuscator instance>)

Bases: ingenico.connect.sdk.log.log_message.LogMessage

A utility class to build request log messages.

get_message()

class ingenico.connect.sdk.log.response_log_message.ResponseLogMessage(request_id, status_code, duration=-1, body_obfuscator=<ingenico.connect.sdk.log.body_obfuscator.BodyObfuscator object>, header_obfuscator=<ingenico.connect.sdk.log.header_obfuscator.HeaderObfuscator instance>)

Bases: ingenico.connect.sdk.log.log_message.LogMessage

A utility class to build request log messages.

get_duration()

get_message()

get_status_code()

class ingenico.connect.sdk.log.sys_out_communicator_logger.SysOutCommunicatorLogger

Bases: ingenico.connect.sdk.log.communicator_logger.CommunicatorLogger

A communicator logger that prints its message to sys.stdout It includes a timestamp in yyyy-MM-ddTHH:mm:ss format in the system time zone.

static INSTANCE()

log(message, thrown=None)

class ingenico.connect.sdk.merchant.merchant_client.MerchantClient(parent, path_context)

Bases: ingenico.connect.sdk.api_resource.ApiResource

Merchant client. Thread-safe.

__init__(parent, path_context)

Parameters:

• parent – ingenico.connect.sdk.api_resource.ApiResource
• path_context – dict[str, str]

captures()

Resource /{merchantId}/captures

Returns:ingenico.connect.sdk.merchant.captures.captures_client.CapturesClient

disputes()

Resource /{merchantId}/disputes

Returns:ingenico.connect.sdk.merchant.disputes.disputes_client.DisputesClient

files()

Resource /{merchantId}/files

Returns:ingenico.connect.sdk.merchant.files.files_client.FilesClient

hostedcheckouts()

Resource /{merchantId}/hostedcheckouts

Returns:ingenico.connect.sdk.merchant.hostedcheckouts.hostedcheckouts_client.HostedcheckoutsClient

hostedmandatemanagements()

Resource /{merchantId}/hostedmandatemanagements

Returns:ingenico.connect.sdk.merchant.hostedmandatemanagements.hostedmandatemanagements_client.HostedmandatemanagementsClient

installments()

Resource /{merchantId}/installments

Returns:ingenico.connect.sdk.merchant.installments.installments_client.InstallmentsClient

mandates()

Resource /{merchantId}/mandates

Returns:ingenico.connect.sdk.merchant.mandates.mandates_client.MandatesClient

payments()

Resource /{merchantId}/payments

Returns:ingenico.connect.sdk.merchant.payments.payments_client.PaymentsClient

payouts()

Resource /{merchantId}/payouts

Returns:ingenico.connect.sdk.merchant.payouts.payouts_client.PayoutsClient

productgroups()

Resource /{merchantId}/productgroups

Returns:ingenico.connect.sdk.merchant.productgroups.productgroups_client.ProductgroupsClient

products()

Resource /{merchantId}/products

Returns:ingenico.connect.sdk.merchant.products.products_client.ProductsClient

refunds()

Resource /{merchantId}/refunds

Returns:ingenico.connect.sdk.merchant.refunds.refunds_client.RefundsClient

riskassessments()

Resource /{merchantId}/riskassessments

Returns:ingenico.connect.sdk.merchant.riskassessments.riskassessments_client.RiskassessmentsClient

services()

Resource /{merchantId}/services

Returns:ingenico.connect.sdk.merchant.services.services_client.ServicesClient

sessions()

Resource /{merchantId}/sessions

Returns:ingenico.connect.sdk.merchant.sessions.sessions_client.SessionsClient

tokens()

Resource /{merchantId}/tokens

Returns:ingenico.connect.sdk.merchant.tokens.tokens_client.TokensClient

class ingenico.connect.sdk.merchant.captures.captures_client.CapturesClient(parent, path_context)

Bases: ingenico.connect.sdk.api_resource.ApiResource

Captures client. Thread-safe.

__init__(parent, path_context)

Parameters:

• parent – ingenico.connect.sdk.api_resource.ApiResource
• path_context – dict[str, str]

get(capture_id, context=None)

Resource /{merchantId}/captures/{captureId} - Get capture

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/captures/get.html

Parameters:

• capture_id – str
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.capture.capture_response.CaptureResponse

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

refund(capture_id, body, context=None)

Resource /{merchantId}/captures/{captureId}/refund - Create Refund

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/captures/refund.html

Parameters:

• capture_id – str
• body – ingenico.connect.sdk.domain.refund.refund_request.RefundRequest
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.refund.refund_response.RefundResponse

Raise:

DeclinedRefundException if the Ingenico ePayments platform declined / rejected the refund. The refund result will be available from the exception.

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

class ingenico.connect.sdk.merchant.disputes.disputes_client.DisputesClient(parent, path_context)

Bases: ingenico.connect.sdk.api_resource.ApiResource

Disputes client. Thread-safe.

__init__(parent, path_context)

Parameters:

• parent – ingenico.connect.sdk.api_resource.ApiResource
• path_context – dict[str, str]

cancel(dispute_id, context=None)

Resource /{merchantId}/disputes/{disputeId}/cancel - Cancel dispute

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/disputes/cancel.html

Parameters:

• dispute_id – str
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.dispute.dispute_response.DisputeResponse

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

get(dispute_id, context=None)

Resource /{merchantId}/disputes/{disputeId} - Get dispute

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/disputes/get.html

Parameters:

• dispute_id – str
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.dispute.dispute_response.DisputeResponse

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

submit(dispute_id, context=None)

Resource /{merchantId}/disputes/{disputeId}/submit - Submit dispute

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/disputes/submit.html

Parameters:

• dispute_id – str
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.dispute.dispute_response.DisputeResponse

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

upload_file(dispute_id, body, context=None)

Resource /{merchantId}/disputes/{disputeId} - Upload File

See also https://epayments-api.developer-ingenico.com/fileserviceapi/v1/en_US/python/disputes/uploadFile.html

Parameters:

• dispute_id – str
• body – ingenico.connect.sdk.merchant.disputes.upload_file_request.UploadFileRequest
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.dispute.upload_dispute_file_response.UploadDisputeFileResponse

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

class ingenico.connect.sdk.merchant.disputes.upload_file_request.UploadFileRequest

Bases: ingenico.connect.sdk.multipart_form_data_request.MultipartFormDataRequest

Multipart/form-data parameters for Upload File

See also https://epayments-api.developer-ingenico.com/fileserviceapi/v1/en_US/python/disputes/uploadFile.html

file

The file that you will upload as evidence to support a dispute.

Type: ingenico.connect.sdk.UploadableFile

to_multipart_form_data_object()

Returns:ingenico.connect.sdk.MultipartFormDataObject

class ingenico.connect.sdk.merchant.files.files_client.FilesClient(parent, path_context)

Bases: ingenico.connect.sdk.api_resource.ApiResource

Files client. Thread-safe.

__init__(parent, path_context)

Parameters:

• parent – ingenico.connect.sdk.api_resource.ApiResource
• path_context – dict[str, str]

get_file(file_id, context=None)

Resource /{merchantId}/files/{fileId} - Retrieve File

See also https://epayments-api.developer-ingenico.com/fileserviceapi/v1/en_US/python/files/getFile.html

Parameters:

• file_id – str
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

a tuple with the headers and a generator of body chunks

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

class ingenico.connect.sdk.merchant.hostedcheckouts.hostedcheckouts_client.HostedcheckoutsClient(parent, path_context)

Bases: ingenico.connect.sdk.api_resource.ApiResource

Hostedcheckouts client. Thread-safe.

__init__(parent, path_context)

Parameters:

• parent – ingenico.connect.sdk.api_resource.ApiResource
• path_context – dict[str, str]

create(body, context=None)

Resource /{merchantId}/hostedcheckouts - Create hosted checkout

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/hostedcheckouts/create.html

Parameters:

• body – ingenico.connect.sdk.domain.hostedcheckout.create_hosted_checkout_request.CreateHostedCheckoutRequest
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.hostedcheckout.create_hosted_checkout_response.CreateHostedCheckoutResponse

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

delete(hosted_checkout_id, context=None)

Resource /{merchantId}/hostedcheckouts/{hostedCheckoutId} - Delete hosted checkout

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/hostedcheckouts/delete.html

Parameters:

• hosted_checkout_id – str
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

None

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

get(hosted_checkout_id, context=None)

Resource /{merchantId}/hostedcheckouts/{hostedCheckoutId} - Get hosted checkout status

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/hostedcheckouts/get.html

Parameters:

• hosted_checkout_id – str
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.hostedcheckout.get_hosted_checkout_response.GetHostedCheckoutResponse

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

class ingenico.connect.sdk.merchant.hostedmandatemanagements.hostedmandatemanagements_client.HostedmandatemanagementsClient(parent, path_context)

Bases: ingenico.connect.sdk.api_resource.ApiResource

Hostedmandatemanagements client. Thread-safe.

__init__(parent, path_context)

Parameters:

• parent – ingenico.connect.sdk.api_resource.ApiResource
• path_context – dict[str, str]

create(body, context=None)

Resource /{merchantId}/hostedmandatemanagements - Create hosted mandate management

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/hostedmandatemanagements/create.html

Parameters:

• body – ingenico.connect.sdk.domain.hostedmandatemanagement.create_hosted_mandate_management_request.CreateHostedMandateManagementRequest
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.hostedmandatemanagement.create_hosted_mandate_management_response.CreateHostedMandateManagementResponse

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

get(hosted_mandate_management_id, context=None)

Resource /{merchantId}/hostedmandatemanagements/{hostedMandateManagementId} - Get hosted mandate management status

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/hostedmandatemanagements/get.html

Parameters:

• hosted_mandate_management_id – str
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.hostedmandatemanagement.get_hosted_mandate_management_response.GetHostedMandateManagementResponse

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

class ingenico.connect.sdk.merchant.installments.installments_client.InstallmentsClient(parent, path_context)

Bases: ingenico.connect.sdk.api_resource.ApiResource

Installments client. Thread-safe.

__init__(parent, path_context)

Parameters:

• parent – ingenico.connect.sdk.api_resource.ApiResource
• path_context – dict[str, str]

get_installments_info(body, context=None)

Resource /{merchantId}/installments/getInstallmentsInfo - Get installment information

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/installments/getInstallmentsInfo.html

Parameters:

• body – ingenico.connect.sdk.domain.installments.get_installment_request.GetInstallmentRequest
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.installments.installment_options_response.InstallmentOptionsResponse

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

class ingenico.connect.sdk.merchant.mandates.mandates_client.MandatesClient(parent, path_context)

Bases: ingenico.connect.sdk.api_resource.ApiResource

Mandates client. Thread-safe.

__init__(parent, path_context)

Parameters:

• parent – ingenico.connect.sdk.api_resource.ApiResource
• path_context – dict[str, str]

block(unique_mandate_reference, context=None)

Resource /{merchantId}/mandates/{uniqueMandateReference}/block - Block mandate

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/mandates/block.html

Parameters:

• unique_mandate_reference – str
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.mandates.get_mandate_response.GetMandateResponse

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

create(body, context=None)

Resource /{merchantId}/mandates - Create mandate

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/mandates/create.html

Parameters:

• body – ingenico.connect.sdk.domain.mandates.create_mandate_request.CreateMandateRequest
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.mandates.create_mandate_response.CreateMandateResponse

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

create_with_mandate_reference(unique_mandate_reference, body, context=None)

Resource /{merchantId}/mandates/{uniqueMandateReference} - Create mandate with mandatereference

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/mandates/createWithMandateReference.html

Parameters:

• unique_mandate_reference – str
• body – ingenico.connect.sdk.domain.mandates.create_mandate_request.CreateMandateRequest
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.mandates.create_mandate_response.CreateMandateResponse

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

get(unique_mandate_reference, context=None)

Resource /{merchantId}/mandates/{uniqueMandateReference} - Get mandate

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/mandates/get.html

Parameters:

• unique_mandate_reference – str
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.mandates.get_mandate_response.GetMandateResponse

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

revoke(unique_mandate_reference, context=None)

Resource /{merchantId}/mandates/{uniqueMandateReference}/revoke - Revoke mandate

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/mandates/revoke.html

Parameters:

• unique_mandate_reference – str
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.mandates.get_mandate_response.GetMandateResponse

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

unblock(unique_mandate_reference, context=None)

Resource /{merchantId}/mandates/{uniqueMandateReference}/unblock - Unblock mandate

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/mandates/unblock.html

Parameters:

• unique_mandate_reference – str
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.mandates.get_mandate_response.GetMandateResponse

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

class ingenico.connect.sdk.merchant.payments.find_payments_params.FindPaymentsParams

Bases: ingenico.connect.sdk.param_request.ParamRequest

Query parameters for Find payments

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/payments/find.html

hosted_checkout_id

Your hosted checkout identifier to filter on.

Type: str

limit

The maximum number of payments to return, with a maximum of 100. If omitted, the limit will be 10.

Type: int

merchant_order_id

Your order identifier to filter on.

Type: long

merchant_reference

Your unique transaction reference to filter on. The maximum length is 52 characters for payments that are processed by WL Online Payment Acceptance platform.

Type: str

offset

The zero-based index of the first payment in the result. If omitted, the offset will be 0.

Type: int

to_request_parameters()

Returns:list[RequestParam]

class ingenico.connect.sdk.merchant.payments.payments_client.PaymentsClient(parent, path_context)

Bases: ingenico.connect.sdk.api_resource.ApiResource

Payments client. Thread-safe.

__init__(parent, path_context)

Parameters:

• parent – ingenico.connect.sdk.api_resource.ApiResource
• path_context – dict[str, str]

approve(payment_id, body, context=None)

Resource /{merchantId}/payments/{paymentId}/approve - Approve payment

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/payments/approve.html

Parameters:

• payment_id – str
• body – ingenico.connect.sdk.domain.payment.approve_payment_request.ApprovePaymentRequest
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.payment.payment_approval_response.PaymentApprovalResponse

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

cancel(payment_id, context=None)

Resource /{merchantId}/payments/{paymentId}/cancel - Cancel payment

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/payments/cancel.html

Parameters:

• payment_id – str
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.payment.cancel_payment_response.CancelPaymentResponse

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

cancelapproval(payment_id, context=None)

Resource /{merchantId}/payments/{paymentId}/cancelapproval - Undo capture payment

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/payments/cancelapproval.html

Parameters:

• payment_id – str
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.payment.cancel_approval_payment_response.CancelApprovalPaymentResponse

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

capture(payment_id, body, context=None)

Resource /{merchantId}/payments/{paymentId}/capture - Capture payment

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/payments/capture.html

Parameters:

• payment_id – str
• body – ingenico.connect.sdk.domain.payment.capture_payment_request.CapturePaymentRequest
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.capture.capture_response.CaptureResponse

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

captures(payment_id, context=None)

Resource /{merchantId}/payments/{paymentId}/captures - Get captures of payment

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/payments/captures.html

Parameters:

• payment_id – str
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.capture.captures_response.CapturesResponse

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

complete(payment_id, body, context=None)

Resource /{merchantId}/payments/{paymentId}/complete - Complete payment

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/payments/complete.html

Parameters:

• payment_id – str
• body – ingenico.connect.sdk.domain.payment.complete_payment_request.CompletePaymentRequest
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.payment.complete_payment_response.CompletePaymentResponse

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

create(body, context=None)

Resource /{merchantId}/payments - Create payment

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/payments/create.html

Parameters:

• body – ingenico.connect.sdk.domain.payment.create_payment_request.CreatePaymentRequest
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.payment.create_payment_response.CreatePaymentResponse

Raise:

DeclinedPaymentException if the Ingenico ePayments platform declined / rejected the payment. The payment result will be available from the exception.

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

devicefingerprint(payment_id, context=None)

Resource /{merchantId}/payments/{paymentId}/devicefingerprint - Get Device Fingerprint details

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/payments/devicefingerprint.html

Parameters:

• payment_id – str
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.payment.device_fingerprint_details.DeviceFingerprintDetails

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

dispute(payment_id, body, context=None)

Resource /{merchantId}/payments/{paymentId}/dispute - Create dispute

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/payments/dispute.html

Parameters:

• payment_id – str
• body – ingenico.connect.sdk.domain.dispute.create_dispute_request.CreateDisputeRequest
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.dispute.dispute_response.DisputeResponse

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

disputes(payment_id, context=None)

Resource /{merchantId}/payments/{paymentId}/disputes - Get disputes

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/payments/disputes.html

Parameters:

• payment_id – str
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.dispute.disputes_response.DisputesResponse

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

find(query, context=None)

Resource /{merchantId}/payments - Find payments

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/payments/find.html

Parameters:

• query – ingenico.connect.sdk.merchant.payments.find_payments_params.FindPaymentsParams
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.payment.find_payments_response.FindPaymentsResponse

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

get(payment_id, context=None)

Resource /{merchantId}/payments/{paymentId} - Get payment

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/payments/get.html

Parameters:

• payment_id – str
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.payment.payment_response.PaymentResponse

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

processchallenged(payment_id, context=None)

Resource /{merchantId}/payments/{paymentId}/processchallenged - Approves challenged payment

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/payments/processchallenged.html

Parameters:

• payment_id – str
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.payment.payment_response.PaymentResponse

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

refund(payment_id, body, context=None)

Resource /{merchantId}/payments/{paymentId}/refund - Create refund

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/payments/refund.html

Parameters:

• payment_id – str
• body – ingenico.connect.sdk.domain.refund.refund_request.RefundRequest
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.refund.refund_response.RefundResponse

Raise:

DeclinedRefundException if the Ingenico ePayments platform declined / rejected the refund. The refund result will be available from the exception.

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

refunds(payment_id, context=None)

Resource /{merchantId}/payments/{paymentId}/refunds - Get refunds of payment

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/payments/refunds.html

Parameters:

• payment_id – str
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.refund.refunds_response.RefundsResponse

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

third_party_status(payment_id, context=None)

Resource /{merchantId}/payments/{paymentId}/thirdpartystatus - Third party status poll

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/payments/thirdPartyStatus.html

Parameters:

• payment_id – str
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.payment.third_party_status_response.ThirdPartyStatusResponse

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

tokenize(payment_id, body, context=None)

Resource /{merchantId}/payments/{paymentId}/tokenize - Create a token from payment

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/payments/tokenize.html

Parameters:

• payment_id – str
• body – ingenico.connect.sdk.domain.payment.tokenize_payment_request.TokenizePaymentRequest
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.token.create_token_response.CreateTokenResponse

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

class ingenico.connect.sdk.merchant.payouts.find_payouts_params.FindPayoutsParams

Bases: ingenico.connect.sdk.param_request.ParamRequest

Query parameters for Find payouts

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/payouts/find.html

limit

The maximum number of payouts to return, with a maximum of 100. If omitted, the limit will be 10.

Type: int

merchant_order_id

Your order identifier to filter on.

Type: long

merchant_reference

Your unique transaction reference to filter on.

Type: str

offset

The zero-based index of the first payout in the result. If omitted, the offset will be 0.

Type: int

to_request_parameters()

Returns:list[RequestParam]

class ingenico.connect.sdk.merchant.payouts.payouts_client.PayoutsClient(parent, path_context)

Bases: ingenico.connect.sdk.api_resource.ApiResource

Payouts client. Thread-safe.

__init__(parent, path_context)

Parameters:

• parent – ingenico.connect.sdk.api_resource.ApiResource
• path_context – dict[str, str]

approve(payout_id, body, context=None)

Resource /{merchantId}/payouts/{payoutId}/approve - Approve payout

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/payouts/approve.html

Parameters:

• payout_id – str
• body – ingenico.connect.sdk.domain.payout.approve_payout_request.ApprovePayoutRequest
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.payout.payout_response.PayoutResponse

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

cancel(payout_id, context=None)

Resource /{merchantId}/payouts/{payoutId}/cancel - Cancel payout

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/payouts/cancel.html

Parameters:

• payout_id – str
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

None

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

cancelapproval(payout_id, context=None)

Resource /{merchantId}/payouts/{payoutId}/cancelapproval - Undo approve payout

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/payouts/cancelapproval.html

Parameters:

• payout_id – str
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

None

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

create(body, context=None)

Resource /{merchantId}/payouts - Create payout

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/payouts/create.html

Parameters:

• body – ingenico.connect.sdk.domain.payout.create_payout_request.CreatePayoutRequest
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.payout.payout_response.PayoutResponse

Raise:

DeclinedPayoutException if the Ingenico ePayments platform declined / rejected the payout. The payout result will be available from the exception.

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

find(query, context=None)

Resource /{merchantId}/payouts - Find payouts

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/payouts/find.html

Parameters:

• query – ingenico.connect.sdk.merchant.payouts.find_payouts_params.FindPayoutsParams
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.payout.find_payouts_response.FindPayoutsResponse

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

get(payout_id, context=None)

Resource /{merchantId}/payouts/{payoutId} - Get payout

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/payouts/get.html

Parameters:

• payout_id – str
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.payout.payout_response.PayoutResponse

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

class ingenico.connect.sdk.merchant.productgroups.find_productgroups_params.FindProductgroupsParams

Bases: ingenico.connect.sdk.param_request.ParamRequest

Query parameters for Get payment product groups

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/productgroups/find.html

add_hide(value)

Parameters:value – str

amount

Amount of the transaction in cents and always having 2 decimals

Type: long

country_code

ISO 3166-1 alpha-2 country code of the transaction

Type: str

currency_code

Three-letter ISO currency code representing the currency for the amount

Type: str

hide

Allows you to hide elements from the response, reducing the amount of data that needs to be returned to your client. Possible options are:

• fields - Don’t return any data on fields of the payment product
• accountsOnFile - Don’t return any accounts on file data
• translations - Don’t return any label texts associated with the payment products

Type: list[str]

is_installments

This allows you to filter payment products based on their support for installments or not

• true
• false

If this is omitted all payment products are returned.

Type: bool

is_recurring

This allows you to filter groups based on their support for recurring, where a group supports recurring if it has at least one payment product that supports recurring

• true
• false

Type: bool

locale

Locale used in the GUI towards the consumer. Please make sure that a language pack is configured for the locale you are submitting. If you submit a locale that is not set up on your account, we will use the default language pack for your account. You can easily upload additional language packs and set the default language pack in the Configuration Center.

Type: str

to_request_parameters()

Returns:list[RequestParam]

class ingenico.connect.sdk.merchant.productgroups.get_productgroup_params.GetProductgroupParams

Bases: ingenico.connect.sdk.param_request.ParamRequest

Query parameters for Get payment product group

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/productgroups/get.html

add_hide(value)

Parameters:value – str

amount

Amount of the transaction in cents and always having 2 decimals.

Type: long

country_code

ISO 3166-1 alpha-2 country code of the transaction

Type: str

currency_code

Three-letter ISO currency code representing the currency for the amount

Type: str

hide

Allows you to hide elements from the response, reducing the amount of data that needs to be returned to your client. Possible options are:

• fields - Don’t return any data on fields of the payment product
• accountsOnFile - Don’t return any accounts on file data
• translations - Don’t return any label texts associated with the payment products

Type: list[str]

is_installments

This allows you to filter payment products based on their support for installments or not

• true
• false

If this is omitted all payment products are returned.

Type: bool

is_recurring

Toggles filtering on support for recurring payments. Default value is false.

• true - filter out groups that do not support recurring payments, where a group supports recurring payments if it has at least one payment product that supports recurring.
• false - do not filter

Type: bool

locale

Locale used in the GUI towards the consumer. Please make sure that a language pack is configured for the locale you are submitting. If you submit a locale that is not setup on your account we will use the default language pack for your account. You can easily upload additional language packs and set the default language pack in the Configuration Center.

Type: str

to_request_parameters()

Returns:list[RequestParam]

class ingenico.connect.sdk.merchant.productgroups.productgroups_client.ProductgroupsClient(parent, path_context)

Bases: ingenico.connect.sdk.api_resource.ApiResource

Productgroups client. Thread-safe.

__init__(parent, path_context)

Parameters:

• parent – ingenico.connect.sdk.api_resource.ApiResource
• path_context – dict[str, str]

device_fingerprint(payment_product_group_id, body, context=None)

Resource /{merchantId}/productgroups/{paymentProductGroupId}/deviceFingerprint - Get device fingerprint

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/productgroups/deviceFingerprint.html

Parameters:

• payment_product_group_id – str
• body – ingenico.connect.sdk.domain.product.device_fingerprint_request.DeviceFingerprintRequest
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.product.device_fingerprint_response.DeviceFingerprintResponse

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

find(query, context=None)

Resource /{merchantId}/productgroups - Get payment product groups

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/productgroups/find.html

Parameters:

• query – ingenico.connect.sdk.merchant.productgroups.find_productgroups_params.FindProductgroupsParams
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.product.payment_product_groups.PaymentProductGroups

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

get(payment_product_group_id, query, context=None)

Resource /{merchantId}/productgroups/{paymentProductGroupId} - Get payment product group

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/productgroups/get.html

Parameters:

• payment_product_group_id – str
• query – ingenico.connect.sdk.merchant.productgroups.get_productgroup_params.GetProductgroupParams
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.product.payment_product_group_response.PaymentProductGroupResponse

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

class ingenico.connect.sdk.merchant.products.directory_params.DirectoryParams

Bases: ingenico.connect.sdk.param_request.ParamRequest

Query parameters for Get payment product directory

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/products/directory.html

country_code

ISO 3166-1 alpha-2 country code

Type: str

currency_code

Three-letter ISO currency code representing the currency of the transaction

Type: str

to_request_parameters()

Returns:list[RequestParam]

class ingenico.connect.sdk.merchant.products.find_products_params.FindProductsParams

Bases: ingenico.connect.sdk.param_request.ParamRequest

Query parameters for Get payment products

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/products/find.html

add_hide(value)

Parameters:value – str

amount

Amount in cents and always having 2 decimals

Type: long

country_code

ISO 3166-1 alpha-2 country code

Type: str

currency_code

Three-letter ISO currency code representing the currency for the amount

Type: str

hide

Allows you to hide elements from the response, reducing the amount of data that needs to be returned to your client. Possible options are:

• fields - Don’t return any data on fields of the payment product
• accountsOnFile - Don’t return any accounts on file data
• translations - Don’t return any label texts associated with the payment products
• productsWithoutFields - Don’t return products that require any additional data to be captured
• productsWithoutInstructions - Don’t return products that show instructions
• productsWithRedirects - Don’t return products that require a redirect to a 3rd party. Note that products that involve potential redirects related to 3D Secure authentication are not hidden

Type: list[str]

is_installments

This allows you to filter payment products based on their support for installments or not

• true
• false

If this is omitted all payment products are returned.

Type: bool

is_recurring

This allows you to filter payment products based on their support for recurring or not

• true
• false

If this is omitted all payment products are returned.

Type: bool

locale

Locale used in the GUI towards the consumer. Please make sure that a language pack is configured for the locale you are submitting. If you submit a locale that is not setup on your account we will use the default language pack for your account. You can easily upload additional language packs and set the default language pack in the Configuration Center.

Type: str

to_request_parameters()

Returns:list[RequestParam]

class ingenico.connect.sdk.merchant.products.get_product_params.GetProductParams

Bases: ingenico.connect.sdk.param_request.ParamRequest

Query parameters for Get payment product

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/products/get.html

add_hide(value)

Parameters:value – str

amount

Amount in cents and always having 2 decimals

Type: long

country_code

ISO 3166-1 alpha-2 country code

Type: str

currency_code

Three-letter ISO currency code representing the currency for the amount

Type: str

force_basic_flow

Relevant only for payment product 3012 (Bancontact). A boolean that indicates if you want to force the response to return the fields of the basic flow. This can be useful in corner cases where you have enabled the enhanced flow which supports payment with the Bancontact app, but need access to the product fields without creating a payment first.

Type: bool

hide

Allows you to hide elements from the response, reducing the amount of data that needs to be returned to your client. Possible options are:

• fields - Don’t return any data on fields of the payment product
• accountsOnFile - Don’t return any accounts on file data
• translations - Don’t return any label texts associated with the payment products

Type: list[str]

is_installments

This allows you to filter payment products based on their support for installments or not

• true
• false

If this is omitted all payment products are returned.

Type: bool

is_recurring

This allows you to filter payment products based on their support for recurring or not

• true
• false

If this is omitted all payment products are returned.

Type: bool

locale

Locale used in the GUI towards the consumer. Please make sure that a language pack is configured for the locale you are submitting. If you submit a locale that is not setup on your account we will use the default language pack for your account. You can easily upload additional language packs and set the default language pack in the Configuration Center.

Type: str

to_request_parameters()

Returns:list[RequestParam]

class ingenico.connect.sdk.merchant.products.networks_params.NetworksParams

Bases: ingenico.connect.sdk.param_request.ParamRequest

Query parameters for Get payment product networks

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/products/networks.html

amount

Amount in cents and always having 2 decimals

Type: long

country_code

ISO 3166-1 alpha-2 country code

Type: str

currency_code

Three-letter ISO currency code representing the currency for the amount

Type: str

is_recurring

This allows you to filter networks based on their support for recurring or not

• true
• false

Type: bool

to_request_parameters()

Returns:list[RequestParam]

class ingenico.connect.sdk.merchant.products.products_client.ProductsClient(parent, path_context)

Bases: ingenico.connect.sdk.api_resource.ApiResource

Products client. Thread-safe.

__init__(parent, path_context)

Parameters:

• parent – ingenico.connect.sdk.api_resource.ApiResource
• path_context – dict[str, str]

customer_details(payment_product_id, body, context=None)

Resource /{merchantId}/products/{paymentProductId}/customerDetails - Get customer details

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/products/customerDetails.html

Parameters:

• payment_product_id – int
• body – ingenico.connect.sdk.domain.product.get_customer_details_request.GetCustomerDetailsRequest
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.product.get_customer_details_response.GetCustomerDetailsResponse

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

device_fingerprint(payment_product_id, body, context=None)

Resource /{merchantId}/products/{paymentProductId}/deviceFingerprint - Get device fingerprint

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/products/deviceFingerprint.html

Parameters:

• payment_product_id – int
• body – ingenico.connect.sdk.domain.product.device_fingerprint_request.DeviceFingerprintRequest
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.product.device_fingerprint_response.DeviceFingerprintResponse

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

directory(payment_product_id, query, context=None)

Resource /{merchantId}/products/{paymentProductId}/directory - Get payment product directory

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/products/directory.html

Parameters:

• payment_product_id – int
• query – ingenico.connect.sdk.merchant.products.directory_params.DirectoryParams
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.product.directory.Directory

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

find(query, context=None)

Resource /{merchantId}/products - Get payment products

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/products/find.html

Parameters:

• query – ingenico.connect.sdk.merchant.products.find_products_params.FindProductsParams
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.product.payment_products.PaymentProducts

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

get(payment_product_id, query, context=None)

Resource /{merchantId}/products/{paymentProductId} - Get payment product

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/products/get.html

Parameters:

• payment_product_id – int
• query – ingenico.connect.sdk.merchant.products.get_product_params.GetProductParams
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.product.payment_product_response.PaymentProductResponse

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

networks(payment_product_id, query, context=None)

Resource /{merchantId}/products/{paymentProductId}/networks - Get payment product networks

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/products/networks.html

Parameters:

• payment_product_id – int
• query – ingenico.connect.sdk.merchant.products.networks_params.NetworksParams
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.product.payment_product_networks_response.PaymentProductNetworksResponse

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

sessions(payment_product_id, body, context=None)

Resource /{merchantId}/products/{paymentProductId}/sessions - Create session for payment product

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/products/sessions.html

Parameters:

• payment_product_id – int
• body – ingenico.connect.sdk.domain.product.create_payment_product_session_request.CreatePaymentProductSessionRequest
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.product.create_payment_product_session_response.CreatePaymentProductSessionResponse

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

class ingenico.connect.sdk.merchant.refunds.find_refunds_params.FindRefundsParams

Bases: ingenico.connect.sdk.param_request.ParamRequest

Query parameters for Find refunds

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/refunds/find.html

hosted_checkout_id

Your hosted checkout identifier to filter on.

Type: str

limit

The maximum number of refunds to return, with a maximum of 100. If omitted, the limit will be 10.

Type: int

merchant_order_id

Your order identifier to filter on.

Type: long

merchant_reference

Your unique transaction reference to filter on.

Type: str

offset

The zero-based index of the first refund in the result. If omitted, the offset will be 0.

Type: int

to_request_parameters()

Returns:list[RequestParam]

class ingenico.connect.sdk.merchant.refunds.refunds_client.RefundsClient(parent, path_context)

Bases: ingenico.connect.sdk.api_resource.ApiResource

Refunds client. Thread-safe.

__init__(parent, path_context)

Parameters:

• parent – ingenico.connect.sdk.api_resource.ApiResource
• path_context – dict[str, str]

approve(refund_id, body, context=None)

Resource /{merchantId}/refunds/{refundId}/approve - Approve refund

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/refunds/approve.html

Parameters:

• refund_id – str
• body – ingenico.connect.sdk.domain.refund.approve_refund_request.ApproveRefundRequest
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

None

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

cancel(refund_id, context=None)

Resource /{merchantId}/refunds/{refundId}/cancel - Cancel refund

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/refunds/cancel.html

Parameters:

• refund_id – str
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

None

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

cancelapproval(refund_id, context=None)

Resource /{merchantId}/refunds/{refundId}/cancelapproval - Undo approve refund

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/refunds/cancelapproval.html

Parameters:

• refund_id – str
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

None

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

find(query, context=None)

Resource /{merchantId}/refunds - Find refunds

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/refunds/find.html

Parameters:

• query – ingenico.connect.sdk.merchant.refunds.find_refunds_params.FindRefundsParams
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.refund.find_refunds_response.FindRefundsResponse

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

get(refund_id, context=None)

Resource /{merchantId}/refunds/{refundId} - Get refund

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/refunds/get.html

Parameters:

• refund_id – str
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.refund.refund_response.RefundResponse

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

class ingenico.connect.sdk.merchant.riskassessments.riskassessments_client.RiskassessmentsClient(parent, path_context)

Bases: ingenico.connect.sdk.api_resource.ApiResource

Riskassessments client. Thread-safe.

__init__(parent, path_context)

Parameters:

• parent – ingenico.connect.sdk.api_resource.ApiResource
• path_context – dict[str, str]

bankaccounts(body, context=None)

Resource /{merchantId}/riskassessments/bankaccounts - Risk-assess bankaccount

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/riskassessments/bankaccounts.html

Parameters:

• body – ingenico.connect.sdk.domain.riskassessments.risk_assessment_bank_account.RiskAssessmentBankAccount
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.riskassessments.risk_assessment_response.RiskAssessmentResponse

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

cards(body, context=None)

Resource /{merchantId}/riskassessments/cards - Risk-assess card

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/riskassessments/cards.html

Parameters:

• body – ingenico.connect.sdk.domain.riskassessments.risk_assessment_card.RiskAssessmentCard
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.riskassessments.risk_assessment_response.RiskAssessmentResponse

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

class ingenico.connect.sdk.merchant.services.convert_amount_params.ConvertAmountParams

Bases: ingenico.connect.sdk.param_request.ParamRequest

Query parameters for Convert amount

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/services/convertAmount.html

amount

Amount to be converted in cents and always having 2 decimals

Type: long

source

Three-letter ISO currency code representing the source currency

Type: str

target

Three-letter ISO currency code representing the target currency

Type: str

to_request_parameters()

Returns:list[RequestParam]

class ingenico.connect.sdk.merchant.services.privacypolicy_params.PrivacypolicyParams

Bases: ingenico.connect.sdk.param_request.ParamRequest

Query parameters for Get privacy policy

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/services/privacypolicy.html

locale

Locale in which the privacy policy should be returned. Uses your default locale when none is provided.

Type: str

payment_product_id

ID of the payment product for which you wish to retrieve the privacy policy. When no ID is provided you will receive all privacy policies for your payment products.

Type: int

to_request_parameters()

Returns:list[RequestParam]

class ingenico.connect.sdk.merchant.services.services_client.ServicesClient(parent, path_context)

Bases: ingenico.connect.sdk.api_resource.ApiResource

Services client. Thread-safe.

__init__(parent, path_context)

Parameters:

• parent – ingenico.connect.sdk.api_resource.ApiResource
• path_context – dict[str, str]

bankaccount(body, context=None)

Resource /{merchantId}/services/convert/bankaccount - Convert bankaccount

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/services/bankaccount.html

Parameters:

• body – ingenico.connect.sdk.domain.services.bank_details_request.BankDetailsRequest
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.services.bank_details_response.BankDetailsResponse

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

convert_amount(query, context=None)

Resource /{merchantId}/services/convert/amount - Convert amount

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/services/convertAmount.html

Parameters:

• query – ingenico.connect.sdk.merchant.services.convert_amount_params.ConvertAmountParams
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.services.convert_amount.ConvertAmount

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

get_iin_details(body, context=None)

Resource /{merchantId}/services/getIINdetails - Get IIN details

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/services/getIINdetails.html

Parameters:

• body – ingenico.connect.sdk.domain.services.get_iin_details_request.GetIINDetailsRequest
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.services.get_iin_details_response.GetIINDetailsResponse

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

privacypolicy(query, context=None)

Resource /{merchantId}/services/privacypolicy - Get privacy policy

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/services/privacypolicy.html

Parameters:

• query – ingenico.connect.sdk.merchant.services.privacypolicy_params.PrivacypolicyParams
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.services.get_privacy_policy_response.GetPrivacyPolicyResponse

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

testconnection(context=None)

Resource /{merchantId}/services/testconnection - Test connection

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/services/testconnection.html

Parameters:context – ingenico.connect.sdk.call_context.CallContext Returns:ingenico.connect.sdk.domain.services.test_connection.TestConnection Raise:ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400) Raise:AuthorizationException if the request was not allowed (HTTP status code 403) Raise:ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410) Raise:GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503) Raise:ApiException if the Ingenico ePayments platform returned any other error

class ingenico.connect.sdk.merchant.sessions.sessions_client.SessionsClient(parent, path_context)

Bases: ingenico.connect.sdk.api_resource.ApiResource

Sessions client. Thread-safe.

__init__(parent, path_context)

Parameters:

• parent – ingenico.connect.sdk.api_resource.ApiResource
• path_context – dict[str, str]

create(body, context=None)

Resource /{merchantId}/sessions - Create session

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/sessions/create.html

Parameters:

• body – ingenico.connect.sdk.domain.sessions.session_request.SessionRequest
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.sessions.session_response.SessionResponse

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

class ingenico.connect.sdk.merchant.tokens.delete_token_params.DeleteTokenParams

Bases: ingenico.connect.sdk.param_request.ParamRequest

Query parameters for Delete token

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/tokens/delete.html

mandate_cancel_date

Date of the mandate cancellation

Format: YYYYMMDD

Type: str

to_request_parameters()

Returns:list[RequestParam]

class ingenico.connect.sdk.merchant.tokens.tokens_client.TokensClient(parent, path_context)

Bases: ingenico.connect.sdk.api_resource.ApiResource

Tokens client. Thread-safe.

__init__(parent, path_context)

Parameters:

• parent – ingenico.connect.sdk.api_resource.ApiResource
• path_context – dict[str, str]

approvesepadirectdebit(token_id, body, context=None)

Resource /{merchantId}/tokens/{tokenId}/approvesepadirectdebit - Approve SEPA DD mandate

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/tokens/approvesepadirectdebit.html

Parameters:

• token_id – str
• body – ingenico.connect.sdk.domain.token.approve_token_request.ApproveTokenRequest
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

None

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

create(body, context=None)

Resource /{merchantId}/tokens - Create token

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/tokens/create.html

Parameters:

• body – ingenico.connect.sdk.domain.token.create_token_request.CreateTokenRequest
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.token.create_token_response.CreateTokenResponse

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

delete(token_id, query, context=None)

Resource /{merchantId}/tokens/{tokenId} - Delete token

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/tokens/delete.html

Parameters:

• token_id – str
• query – ingenico.connect.sdk.merchant.tokens.delete_token_params.DeleteTokenParams
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

None

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

get(token_id, context=None)

Resource /{merchantId}/tokens/{tokenId} - Get token

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/tokens/get.html

Parameters:

• token_id – str
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

ingenico.connect.sdk.domain.token.token_response.TokenResponse

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

update(token_id, body, context=None)

Resource /{merchantId}/tokens/{tokenId} - Update token

See also https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/python/tokens/update.html

Parameters:

• token_id – str
• body – ingenico.connect.sdk.domain.token.update_token_request.UpdateTokenRequest
• context – ingenico.connect.sdk.call_context.CallContext

Returns:

None

Raise:

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raise:

AuthorizationException if the request was not allowed (HTTP status code 403)

Raise:

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

Raise:

GlobalCollectException if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raise:

ApiException if the Ingenico ePayments platform returned any other error

exception ingenico.connect.sdk.webhooks.api_version_mismatch_exception.ApiVersionMismatchException(event_api_version, sdk_api_version)

Bases: exceptions.RuntimeError

Represents an error because a webhooks event has an API version that this version of the SDK does not support.

event_api_version

Returns:The API version from the webhooks event.

sdk_api_version

Returns:The API version that this version of the SDK supports.

class ingenico.connect.sdk.webhooks.in_memory_secret_key_store.InMemorySecretKeyStore

Bases: ingenico.connect.sdk.webhooks.secret_key_store.SecretKeyStore

An in-memory secret key store. This implementation can be used in applications where secret keys can be specified at application startup.

static INSTANCE()

clear()

Removes all stored secret keys.

get_secret_key(key_id)

Returns:The secret key for the given key ID. Never None. Raise:SecretKeyNotAvailableException: If the secret key for the given key ID is not available.

remove_secret_key(key_id)

Removes the secret key for the given key ID.

store_secret_key(key_id, secret_key)

Stores the given secret key for the given key ID.

exception ingenico.connect.sdk.webhooks.secret_key_not_available_exception.SecretKeyNotAvailableException(param1, param2, cause=False)

Bases: ingenico.connect.sdk.webhooks.signature_validation_exception.SignatureValidationException

Represents an error that causes a secret key to not be available.

key_id

class ingenico.connect.sdk.webhooks.secret_key_store.SecretKeyStore

Bases: object

A store of secret keys. Implementations could store secret keys in a database, on disk, etc.

get_secret_key(key_id)

Returns:The secret key for the given key ID. Never None. Raise:SecretKeyNotAvailableException: If the secret key for the given key ID is not available.

exception ingenico.connect.sdk.webhooks.signature_validation_exception.SignatureValidationException(param, cause=False)

Bases: exceptions.RuntimeError

Represents an error while validating webhooks signatures.

class ingenico.connect.sdk.webhooks.signature_validator.SignatureValidator(secret_key_store)

Validator for webhooks signatures.

secret_key_store

validate(body, request_headers)

Validates the given body using the given request headers.

Raise:SignatureValidationException: If the body could not be validated successfully.

class ingenico.connect.sdk.webhooks.web_hooks.Webhooks

Ingenico ePayments platform factory for several webhooks components.

static create_helper(secret_key_store)

static create_helper_builder(secret_key_store)

Creates a WebhooksHelperBuilder that will use the given SecretKeyStore.

class ingenico.connect.sdk.webhooks.web_hooks_helper.WebhooksHelper(marshaller, secret_key_store)

Ingenico ePayments platform webhooks helper.

static are_equal_signatures(signature, expected_signature)

Deprecated; use hmac.compare_digest instead

marshaller

secret_key_store

unmarshal(body, request_headers)

Unmarshals the given body, while also validating it using the given request headers.

Raise:SignatureValidationException: If the body could not be validated successfully. Raise:ApiVersionMismatchException: If the resulting event has an API version that this version of the SDK does not support. Returns:The body unmarshalled as a WebhooksEvent.

class ingenico.connect.sdk.webhooks.web_hooks_helper_builder.WebhooksHelperBuilder

Builder for a WebhooksHelper object.

build()

Creates a fully initialized WebhooksHelper object.

Raise:ValueError: if not all required components are set

with_marshaller(marshaller)

Sets the Marshaller to use.

with_secret_key_store(secret_key_store)

Sets the SecretKeyStore to use.

Indices and tables

• Index
• Module Index
• Search Page