orbipay_paymentsapi_client.api package¶

Submodules¶

orbipay_paymentsapi_client.api.customer_account_api module¶

## This class subject to change without prior notice, Please dont use this class directly.##¶

class orbipay_paymentsapi_client.api.customer_account_api.CustomerAccountApi(api_client=None)¶

Bases: object

get_customer_account(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer_account, id_customer, x_opay_headers, **kwargs)¶

Get Customer Account # noqa: E501

The Get Customer Account API is used to retrieve the details of a customer account based on the id. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = CustomerAccountApi(api_client=api_client) >>> thread = api.get_customer_account(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer_account, id_customer, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str id_customer_account: The unique identifier assigned by EBPP to the Customer Account. (required) :param str id_customer: The unique identifier assigned by EBPP to the customer. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :return: CustomerAccountResponse

get_customer_account_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer_account, id_customer, x_opay_headers, **kwargs)¶

Get Customer Account # noqa: E501

The Get Customer Account API is used to retrieve the details of a customer account based on the id. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = CustomerAccountApi(api_client=api_client) >>> thread = api.get_customer_account_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer_account, id_customer, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str id_customer_account: The unique identifier assigned by EBPP to the Customer Account. (required) :param str id_customer: The unique identifier assigned by EBPP to the customer. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :return: CustomerAccountResponse

renew_customer_account(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer_account, id_customer, renew_customer_account_request, x_opay_headers, **kwargs)¶

Renew Customer Account # noqa: E501

This API is used to renew a customer account. The API migrates all the pending payments and active payment setups from the original customer account to the new one. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = CustomerAccountApi(api_client=api_client) >>> thread = api.renew_customer_account(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer_account, id_customer, renew_customer_account_request, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str id_customer_account: The unique identifier assigned by EBPP to the Customer Account. (required) :param str id_customer: The unique identifier assigned by EBPP to the customer. (required) :param RenewCustomerAccountRequest renew_customer_account_request: JSON containing all the attributes of the Customer account to be renewed. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :return: CustomerAccountResponse

renew_customer_account_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer_account, id_customer, renew_customer_account_request, x_opay_headers, **kwargs)¶

Renew Customer Account # noqa: E501

This API is used to renew a customer account. The API migrates all the pending payments and active payment setups from the original customer account to the new one. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = CustomerAccountApi(api_client=api_client) >>> thread = api.renew_customer_account_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer_account, id_customer, renew_customer_account_request, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str id_customer_account: The unique identifier assigned by EBPP to the Customer Account. (required) :param str id_customer: The unique identifier assigned by EBPP to the customer. (required) :param RenewCustomerAccountRequest renew_customer_account_request: JSON containing all the attributes of the Customer account to be renewed. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :return: CustomerAccountResponse

retrieve_customer_accounts(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, x_opay_headers, **kwargs)¶

Retrieve Customer Accounts # noqa: E501

The API is used to retrieve all the customer accounts associated with a customer. The accounts can be filtered using the account number, status. The API responds with the first page of the list of customerAccounts matching the criteria. The results are sorted in descending order of the last_modified_time. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = CustomerAccountApi(api_client=api_client) >>> thread = api.retrieve_customer_accounts(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str id_customer: The unique identifier assigned by EBPP to the customer. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :param str page_size: The maximum number of objects returned in the query. :param str account_number: The Account Number to get details of. :param list[str] status: The status of the customer’s account in EBPP. This can take multiple values in the format key=value1&key=value2…. :return: CustomerAccountsResponse

retrieve_customer_accounts_page(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, query_id, x_opay_headers, **kwargs)¶

Retrieve Customer Accounts Pagination # noqa: E501

This API is used to paginate through the list of customer Accounts returned in the Retrieve Customer Accounts API. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = CustomerAccountApi(api_client=api_client) >>> thread = api.retrieve_customer_accounts_page(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, query_id, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str id_customer: The unique identifier assigned by EBPP to the customer. (required) :param str query_id: query id of the Retrieve/Search Accounts lookup. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :param str page_size: The maximum number of objects returned in the query. :param str from_index: To fetch the next set of objects that start after this object :param str to_index: To fetch the previous set of objects that end at this object :return: CustomerAccountsResponse

retrieve_customer_accounts_page_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, query_id, x_opay_headers, **kwargs)¶

Retrieve Customer Accounts Pagination # noqa: E501

This API is used to paginate through the list of customer Accounts returned in the Retrieve Customer Accounts API. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = CustomerAccountApi(api_client=api_client) >>> thread = api.retrieve_customer_accounts_page_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, query_id, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str id_customer: The unique identifier assigned by EBPP to the customer. (required) :param str query_id: query id of the Retrieve/Search Accounts lookup. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :param str page_size: The maximum number of objects returned in the query. :param str from_index: To fetch the next set of objects that start after this object :param str to_index: To fetch the previous set of objects that end at this object :return: CustomerAccountsResponse

retrieve_customer_accounts_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, x_opay_headers, **kwargs)¶

Retrieve Customer Accounts # noqa: E501

The API is used to retrieve all the customer accounts associated with a customer. The accounts can be filtered using the account number, status. The API responds with the first page of the list of customerAccounts matching the criteria. The results are sorted in descending order of the last_modified_time. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = CustomerAccountApi(api_client=api_client) >>> thread = api.retrieve_customer_accounts_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str id_customer: The unique identifier assigned by EBPP to the customer. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :param str page_size: The maximum number of objects returned in the query. :param str account_number: The Account Number to get details of. :param list[str] status: The status of the customer’s account in EBPP. This can take multiple values in the format key=value1&key=value2…. :return: CustomerAccountsResponse

orbipay_paymentsapi_client.api.customer_api module¶

## This class subject to change without prior notice, Please dont use this class directly.##¶

class orbipay_paymentsapi_client.api.customer_api.CustomerApi(api_client=None)¶

Bases: object

create_customer(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, create_customer_request, x_opay_headers, **kwargs)¶

Create Customer # noqa: E501

The Create Customer API is used to register a customer with a biller in EBPP. It is also mandatory to create a customer account for the customer. So, at least one customer account should be provided in order to register a customer. There is no limit on the number of accounts that can be associated with the customer. Either first_name or last_name is required to create a customer. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = CustomerApi(api_client=api_client) >>> thread = api.create_customer(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, create_customer_request, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param CreateCustomerRequest create_customer_request: The JSON that contains all the attributes of customer to be created. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :return: CustomerResponse

create_customer_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, create_customer_request, x_opay_headers, **kwargs)¶

Create Customer # noqa: E501

The Create Customer API is used to register a customer with a biller in EBPP. It is also mandatory to create a customer account for the customer. So, at least one customer account should be provided in order to register a customer. There is no limit on the number of accounts that can be associated with the customer. Either first_name or last_name is required to create a customer. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = CustomerApi(api_client=api_client) >>> thread = api.create_customer_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, create_customer_request, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param CreateCustomerRequest create_customer_request: The JSON that contains all the attributes of customer to be created. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :return: CustomerResponse

get_customer(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, x_opay_headers, **kwargs)¶

Get Customer # noqa: E501

The Get Customer API is used to retrieve the details of the customer based on the id. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = CustomerApi(api_client=api_client) >>> thread = api.get_customer(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str id_customer: The unique identifier assigned by EBPP to the customer. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :return: CustomerResponse

get_customer_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, x_opay_headers, **kwargs)¶

Get Customer # noqa: E501

The Get Customer API is used to retrieve the details of the customer based on the id. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = CustomerApi(api_client=api_client) >>> thread = api.get_customer_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str id_customer: The unique identifier assigned by EBPP to the customer. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :return: CustomerResponse

retrieve_customers(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, x_opay_headers, **kwargs)¶

Retrieve Customers # noqa: E501

This API is used to retrieve/lookup customers from EBPP. Customers can be retrieved matching criteria that includes the customer_reference, the ssn, the email or the customer account number. A unique customer can be retrieved by using search criteria as per the customer uniqueness parameters opted by the client/biller. If the requestor_type is customer, the Retrieve Customers API will return an error if it cannot retrieve a unique customer. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = CustomerApi(api_client=api_client) >>> thread = api.retrieve_customers(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :param str page_size: The maximum number of objects returned in the query. :param str customer_reference: Unique ID assigned by the biller/client system for a given customer. :param str ssn: The SSN of the customer if the account holder is an individual or the tax ID, if the customer is a business. :param str email: This field contains the customer’s email address within EBPP. :param str account_number: Customer Account Number of the customer to get details of. :return: CustomersResponse

retrieve_customers_page(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, query_id, x_opay_headers, **kwargs)¶

Retrieve Customers Pagination # noqa: E501

This API is used to paginate through the list of customers returned in the Retrieve Customers API. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = CustomerApi(api_client=api_client) >>> thread = api.retrieve_customers_page(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, query_id, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str query_id: query id of the Retrieve/Search Customers lookup. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :param str page_size: The maximum number of objects returned in the query. :param str from_index: To fetch the next set of objects that start after this object :param str to_index: To fetch the previous set of objects that end at this object :return: CustomersResponse

retrieve_customers_page_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, query_id, x_opay_headers, **kwargs)¶

Retrieve Customers Pagination # noqa: E501

This API is used to paginate through the list of customers returned in the Retrieve Customers API. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = CustomerApi(api_client=api_client) >>> thread = api.retrieve_customers_page_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, query_id, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str query_id: query id of the Retrieve/Search Customers lookup. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :param str page_size: The maximum number of objects returned in the query. :param str from_index: To fetch the next set of objects that start after this object :param str to_index: To fetch the previous set of objects that end at this object :return: CustomersResponse

retrieve_customers_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, x_opay_headers, **kwargs)¶

Retrieve Customers # noqa: E501

This API is used to retrieve/lookup customers from EBPP. Customers can be retrieved matching criteria that includes the customer_reference, the ssn, the email or the customer account number. A unique customer can be retrieved by using search criteria as per the customer uniqueness parameters opted by the client/biller. If the requestor_type is customer, the Retrieve Customers API will return an error if it cannot retrieve a unique customer. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = CustomerApi(api_client=api_client) >>> thread = api.retrieve_customers_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :param str page_size: The maximum number of objects returned in the query. :param str customer_reference: Unique ID assigned by the biller/client system for a given customer. :param str ssn: The SSN of the customer if the account holder is an individual or the tax ID, if the customer is a business. :param str email: This field contains the customer’s email address within EBPP. :param str account_number: Customer Account Number of the customer to get details of. :return: CustomersResponse

update_customer(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, update_customer_request, x_opay_headers, **kwargs)¶

Update Customer # noqa: E501

The Update Customer API is used to edit the customer’’s personal details, accounts or the customer’’s status. Only the information being updated needs to be sent in the request, along with the id of the customer being updated. A customer can also be associated with new customer accounts using the API. Along with Customer details , Customer and Customer Account statuses also can be updated using the Update Customer API. Below are the possible customer state transformations. | from_status | to_status | allowed requestor_type | | ———— | ———— | ———— | | active | suspended| <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> | | active | revoked | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | suspended | active | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | suspended | revoked | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | revoked | active | <ul> <li>external_user</li> <li> client_agent</li></ul> </ul> | Below are the possible customer account state transformation. | from_status | to_status | allowed requestor_type | | ———— | ———— | ———— | | active | inactive| <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> | | inactive | active | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | active | incollections | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | incollections | active | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | inactive | incollections | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | incollections | inactive | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | active | inbankruptcy | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | incollections | inbankruptcy | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | inbankruptcy | active | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | inbankruptcy | closed | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = CustomerApi(api_client=api_client) >>> thread = api.update_customer(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, update_customer_request, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str id_customer: The unique identifier assigned by EBPP to the customer. (required) :param UpdateCustomerRequest update_customer_request: JSON containing all the attributes of the customer to be updated. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :return: CustomerResponse

update_customer_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, update_customer_request, x_opay_headers, **kwargs)¶

Update Customer # noqa: E501

The Update Customer API is used to edit the customer’’s personal details, accounts or the customer’’s status. Only the information being updated needs to be sent in the request, along with the id of the customer being updated. A customer can also be associated with new customer accounts using the API. Along with Customer details , Customer and Customer Account statuses also can be updated using the Update Customer API. Below are the possible customer state transformations. | from_status | to_status | allowed requestor_type | | ———— | ———— | ———— | | active | suspended| <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> | | active | revoked | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | suspended | active | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | suspended | revoked | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | revoked | active | <ul> <li>external_user</li> <li> client_agent</li></ul> </ul> | Below are the possible customer account state transformation. | from_status | to_status | allowed requestor_type | | ———— | ———— | ———— | | active | inactive| <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> | | inactive | active | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | active | incollections | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | incollections | active | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | inactive | incollections | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | incollections | inactive | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | active | inbankruptcy | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | incollections | inbankruptcy | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | inbankruptcy | active | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | inbankruptcy | closed | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = CustomerApi(api_client=api_client) >>> thread = api.update_customer_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, update_customer_request, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str id_customer: The unique identifier assigned by EBPP to the customer. (required) :param UpdateCustomerRequest update_customer_request: JSON containing all the attributes of the customer to be updated. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :return: CustomerResponse

orbipay_paymentsapi_client.api.funding_account_api module¶

## This class subject to change without prior notice, Please dont use this class directly.##¶

class orbipay_paymentsapi_client.api.funding_account_api.FundingAccountApi(api_client=None)¶

Bases: object

add_funding_account(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, add_funding_account_request, x_opay_headers, **kwargs)¶

Add Funding Account # noqa: E501

This API is used to add a funding account for the customer. The funding account is available for servicing all the customer accounts the customer holds. An exhaustive set of account types are supported as funding accounts as indicated in the field account_subtype. ABA routing number and account sub-type are mandatory for bank accounts. Expiry date, address fields and Card CVV are required for card accounts. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = FundingAccountApi(api_client=api_client) >>> thread = api.add_funding_account(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, add_funding_account_request, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str id_customer: The unique identifier assigned by EBPP to the customer. (required) :param AddFundingAccountRequest add_funding_account_request: JSON containing all the attributes of the Funding account to be added to customer. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :return: FundingAccountResponse

add_funding_account_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, add_funding_account_request, x_opay_headers, **kwargs)¶

Add Funding Account # noqa: E501

This API is used to add a funding account for the customer. The funding account is available for servicing all the customer accounts the customer holds. An exhaustive set of account types are supported as funding accounts as indicated in the field account_subtype. ABA routing number and account sub-type are mandatory for bank accounts. Expiry date, address fields and Card CVV are required for card accounts. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = FundingAccountApi(api_client=api_client) >>> thread = api.add_funding_account_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, add_funding_account_request, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str id_customer: The unique identifier assigned by EBPP to the customer. (required) :param AddFundingAccountRequest add_funding_account_request: JSON containing all the attributes of the Funding account to be added to customer. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :return: FundingAccountResponse

delete_funding_account(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_funding_account, id_customer, delete_funding_account_request, x_opay_headers, **kwargs)¶

Delete Funding Account # noqa: E501

The Delete Funding Account API is used to delete the funding account of a customer. All pending payments made with that account are cancelled upon deletion of the funding account. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = FundingAccountApi(api_client=api_client) >>> thread = api.delete_funding_account(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_funding_account, id_customer, delete_funding_account_request, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str id_funding_account: The unique identifier assigned by EBPP to the Funding Account. (required) :param str id_customer: The unique identifier assigned by EBPP to the customer. (required) :param DeleteFundingAccountRequest delete_funding_account_request: Details of account to be deleted. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :return: DeleteResponse

delete_funding_account_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_funding_account, id_customer, delete_funding_account_request, x_opay_headers, **kwargs)¶

Delete Funding Account # noqa: E501

The Delete Funding Account API is used to delete the funding account of a customer. All pending payments made with that account are cancelled upon deletion of the funding account. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = FundingAccountApi(api_client=api_client) >>> thread = api.delete_funding_account_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_funding_account, id_customer, delete_funding_account_request, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str id_funding_account: The unique identifier assigned by EBPP to the Funding Account. (required) :param str id_customer: The unique identifier assigned by EBPP to the customer. (required) :param DeleteFundingAccountRequest delete_funding_account_request: Details of account to be deleted. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :return: DeleteResponse

get_funding_account(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_funding_account, id_customer, x_opay_headers, **kwargs)¶

Get Funding Account # noqa: E501

The Get Funding Account API is used to retrieve the details of the funding account based on the id. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = FundingAccountApi(api_client=api_client) >>> thread = api.get_funding_account(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_funding_account, id_customer, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str id_funding_account: The unique identifier assigned by EBPP to the Funding Account. (required) :param str id_customer: The unique identifier assigned by EBPP to the customer. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :return: FundingAccountResponse

get_funding_account_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_funding_account, id_customer, x_opay_headers, **kwargs)¶

Get Funding Account # noqa: E501

The Get Funding Account API is used to retrieve the details of the funding account based on the id. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = FundingAccountApi(api_client=api_client) >>> thread = api.get_funding_account_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_funding_account, id_customer, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str id_funding_account: The unique identifier assigned by EBPP to the Funding Account. (required) :param str id_customer: The unique identifier assigned by EBPP to the customer. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :return: FundingAccountResponse

replace_funding_account(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_funding_account, id_customer, replace_funding_account_request, x_opay_headers, **kwargs)¶

Replace Funding Account # noqa: E501

The API is used to replace the funding account details. The type of the funding account cannot be replaced. In other words, a card account cannot be replaced to a bank account and vice versa. CVV is mandatory to make any change to a card account.Replacing a funding account updates the account information on all pending payments made using that account but does not change the details on payments that have been completed. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = FundingAccountApi(api_client=api_client) >>> thread = api.replace_funding_account(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_funding_account, id_customer, replace_funding_account_request, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str id_funding_account: The unique identifier assigned by EBPP to the Funding Account. (required) :param str id_customer: The unique identifier assigned by EBPP to the customer. (required) :param ReplaceFundingAccountRequest replace_funding_account_request: JSON containing all the attributes of the Funding account to be replaced. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :return: FundingAccountResponse

replace_funding_account_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_funding_account, id_customer, replace_funding_account_request, x_opay_headers, **kwargs)¶

Replace Funding Account # noqa: E501

The API is used to replace the funding account details. The type of the funding account cannot be replaced. In other words, a card account cannot be replaced to a bank account and vice versa. CVV is mandatory to make any change to a card account.Replacing a funding account updates the account information on all pending payments made using that account but does not change the details on payments that have been completed. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = FundingAccountApi(api_client=api_client) >>> thread = api.replace_funding_account_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_funding_account, id_customer, replace_funding_account_request, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str id_funding_account: The unique identifier assigned by EBPP to the Funding Account. (required) :param str id_customer: The unique identifier assigned by EBPP to the customer. (required) :param ReplaceFundingAccountRequest replace_funding_account_request: JSON containing all the attributes of the Funding account to be replaced. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :return: FundingAccountResponse

retrieve_funding_accounts(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, x_opay_headers, **kwargs)¶

Retrieve Funding Accounts # noqa: E501

This API is used to retrieve all the funding accounts associated with a customer. Accounts can be filtered using the account number, the ABA routing number (for bank accounts), the account status, account type, account sub-type and others mentioned below. The results are sorted based on their last_modified_time in descending order. The API responds with the first page of the list of funding accounts matching the criteria. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = FundingAccountApi(api_client=api_client) >>> thread = api.retrieve_funding_accounts(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str id_customer: The unique identifier assigned by EBPP to the customer. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :param str page_size: The maximum number of objects returned in the query. :param str account_number: The Account Number to get details of. :param list[str] status: The status of the funding account in EBPP. This can take multiple values in the format key=value1&key=value2…. :param str aba_routing_number: The ABA/Routing number for the bank account. :param list[str] account_type: The type of the funding account. This can take multiple values in the format key=value1&key=value2…. :param str account_subtype: The sub type of the funding account. This is derived by EBPP in the case of card funding accounts. :return: FundingAccountsResponse

retrieve_funding_accounts_page(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, query_id, x_opay_headers, **kwargs)¶

Retrieve Funding Accounts Pagination # noqa: E501

This API is used to paginate through the list of funding accounts returned in the Retrieve Funding Accounts API. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = FundingAccountApi(api_client=api_client) >>> thread = api.retrieve_funding_accounts_page(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, query_id, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str id_customer: The unique identifier assigned by EBPP to the customer. (required) :param str query_id: query id of the Retrieve/Search Accounts lookup. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :param str page_size: The maximum number of objects returned in the query. :param str from_index: To fetch the next set of objects that start after this object :param str to_index: To fetch the previous set of objects that end at this object :return: FundingAccountsResponse

retrieve_funding_accounts_page_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, query_id, x_opay_headers, **kwargs)¶

Retrieve Funding Accounts Pagination # noqa: E501

This API is used to paginate through the list of funding accounts returned in the Retrieve Funding Accounts API. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = FundingAccountApi(api_client=api_client) >>> thread = api.retrieve_funding_accounts_page_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, query_id, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str id_customer: The unique identifier assigned by EBPP to the customer. (required) :param str query_id: query id of the Retrieve/Search Accounts lookup. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :param str page_size: The maximum number of objects returned in the query. :param str from_index: To fetch the next set of objects that start after this object :param str to_index: To fetch the previous set of objects that end at this object :return: FundingAccountsResponse

retrieve_funding_accounts_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, x_opay_headers, **kwargs)¶

Retrieve Funding Accounts # noqa: E501

This API is used to retrieve all the funding accounts associated with a customer. Accounts can be filtered using the account number, the ABA routing number (for bank accounts), the account status, account type, account sub-type and others mentioned below. The results are sorted based on their last_modified_time in descending order. The API responds with the first page of the list of funding accounts matching the criteria. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = FundingAccountApi(api_client=api_client) >>> thread = api.retrieve_funding_accounts_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str id_customer: The unique identifier assigned by EBPP to the customer. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :param str page_size: The maximum number of objects returned in the query. :param str account_number: The Account Number to get details of. :param list[str] status: The status of the funding account in EBPP. This can take multiple values in the format key=value1&key=value2…. :param str aba_routing_number: The ABA/Routing number for the bank account. :param list[str] account_type: The type of the funding account. This can take multiple values in the format key=value1&key=value2…. :param str account_subtype: The sub type of the funding account. This is derived by EBPP in the case of card funding accounts. :return: FundingAccountsResponse

update_funding_account(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_funding_account, id_customer, update_funding_account_request, x_opay_headers, **kwargs)¶

Update Funding Account # noqa: E501

The API is used to edit the funding account details. The type of the funding account cannot be changed. In other words, a card account cannot be changed to a bank account and vice versa. The sub-type of a bank account can be changed. For e.g., a saving account can be updated to a money market account. However, the sub-type cannot be updated for a card account. CVV is mandatory to make any change to a card account. The Id of the funding account gets updated to a new value if the account number is updated. Editing a funding account updates the account information on all pending payments made using that account but does not change the details on payments that have been completed. Below are the possible funding account state transformation. | from_status | to_status | allowed requestor_type | | ———— | ———— | ———— | | active | deleted| <ul> <li>external_user</li> <li> client_agent</li> <li> system</li> <li> customer</li></ul> | | active | frozen | <ul> <li>external_user </li> <li> client_agent </li> <li> system</li></ul> | | active | inactive | <ul> <li>external_user </li> <li> client_agent </li> <li> system</li></ul> | | active | unverified | <ul> <li>system</li></ul> | | frozen | active | <ul> <li>external_user </li> <li> client_agent</li></ul> | | inactive | active | <ul> <li>external_user </li> <li> client_agent </li> <li> system</li></ul> | # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = FundingAccountApi(api_client=api_client) >>> thread = api.update_funding_account(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_funding_account, id_customer, update_funding_account_request, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str id_funding_account: The unique identifier assigned by EBPP to the Funding Account. (required) :param str id_customer: The unique identifier assigned by EBPP to the customer. (required) :param UpdateFundingAccountRequest update_funding_account_request: JSON containing all the attributes of the Funding account to be updated. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :return: FundingAccountResponse

update_funding_account_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_funding_account, id_customer, update_funding_account_request, x_opay_headers, **kwargs)¶

Update Funding Account # noqa: E501

The API is used to edit the funding account details. The type of the funding account cannot be changed. In other words, a card account cannot be changed to a bank account and vice versa. The sub-type of a bank account can be changed. For e.g., a saving account can be updated to a money market account. However, the sub-type cannot be updated for a card account. CVV is mandatory to make any change to a card account. The Id of the funding account gets updated to a new value if the account number is updated. Editing a funding account updates the account information on all pending payments made using that account but does not change the details on payments that have been completed. Below are the possible funding account state transformation. | from_status | to_status | allowed requestor_type | | ———— | ———— | ———— | | active | deleted| <ul> <li>external_user</li> <li> client_agent</li> <li> system</li> <li> customer</li></ul> | | active | frozen | <ul> <li>external_user </li> <li> client_agent </li> <li> system</li></ul> | | active | inactive | <ul> <li>external_user </li> <li> client_agent </li> <li> system</li></ul> | | active | unverified | <ul> <li>system</li></ul> | | frozen | active | <ul> <li>external_user </li> <li> client_agent</li></ul> | | inactive | active | <ul> <li>external_user </li> <li> client_agent </li> <li> system</li></ul> | # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = FundingAccountApi(api_client=api_client) >>> thread = api.update_funding_account_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_funding_account, id_customer, update_funding_account_request, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str id_funding_account: The unique identifier assigned by EBPP to the Funding Account. (required) :param str id_customer: The unique identifier assigned by EBPP to the customer. (required) :param UpdateFundingAccountRequest update_funding_account_request: JSON containing all the attributes of the Funding account to be updated. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :return: FundingAccountResponse

orbipay_paymentsapi_client.api.payment_api module¶

## This class subject to change without prior notice, Please dont use this class directly.##¶

class orbipay_paymentsapi_client.api.payment_api.PaymentApi(api_client=None)¶

Bases: object

create_payment(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, create_payment_request, x_opay_headers, **kwargs)¶

Create Payment # noqa: E501

The API is used to make payments to service a customer account. Client systems can provide the unique identifier for the payment in their system as payment_reference.Fee amount and fee type are conditional and should be provided if the details of the fee to be charged are maintained in the client system. The fee types that are supported in EBPP are add_to_principal and bill_separately. Alternatively, the fee information can be setup in EBPP, in which case, these fields are ignored. If fee information is setup in the system, the details of the fee are returned in the response. if payment_authorization.id is passed then the payment is charged from the amount that is hold as part of the create payment authorization API # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = PaymentApi(api_client=api_client) >>> thread = api.create_payment(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, create_payment_request, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str id_customer: The unique identifier assigned by EBPP to the customer. (required) :param CreatePaymentRequest create_payment_request: JSON containing all the fields required to make a payment. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :return: PaymentResponse

create_payment_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, create_payment_request, x_opay_headers, **kwargs)¶

Create Payment # noqa: E501

The API is used to make payments to service a customer account. Client systems can provide the unique identifier for the payment in their system as payment_reference.Fee amount and fee type are conditional and should be provided if the details of the fee to be charged are maintained in the client system. The fee types that are supported in EBPP are add_to_principal and bill_separately. Alternatively, the fee information can be setup in EBPP, in which case, these fields are ignored. If fee information is setup in the system, the details of the fee are returned in the response. if payment_authorization.id is passed then the payment is charged from the amount that is hold as part of the create payment authorization API # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = PaymentApi(api_client=api_client) >>> thread = api.create_payment_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, create_payment_request, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str id_customer: The unique identifier assigned by EBPP to the customer. (required) :param CreatePaymentRequest create_payment_request: JSON containing all the fields required to make a payment. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :return: PaymentResponse

delete_payment(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_payment, id_customer, delete_payment_request, x_opay_headers, **kwargs)¶

Delete Payment # noqa: E501

The API is used to delete or cancel a payment. Payments that are under processing or have already been processed cannot be deleted. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = PaymentApi(api_client=api_client) >>> thread = api.delete_payment(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_payment, id_customer, delete_payment_request, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str id_payment: The unique identifier assigned by EBPP to the payment. (required) :param str id_customer: The unique identifier assigned by EBPP to the customer. (required) :param DeletePaymentRequest delete_payment_request: Details of payment to be deleted/cancelled (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :return: DeleteResponse

delete_payment_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_payment, id_customer, delete_payment_request, x_opay_headers, **kwargs)¶

Delete Payment # noqa: E501

The API is used to delete or cancel a payment. Payments that are under processing or have already been processed cannot be deleted. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = PaymentApi(api_client=api_client) >>> thread = api.delete_payment_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_payment, id_customer, delete_payment_request, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str id_payment: The unique identifier assigned by EBPP to the payment. (required) :param str id_customer: The unique identifier assigned by EBPP to the customer. (required) :param DeletePaymentRequest delete_payment_request: Details of payment to be deleted/cancelled (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :return: DeleteResponse

delete_record_payment(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_payment, delete_recorded_payment_request, x_opay_headers, **kwargs)¶

Delete Recorded Payment # noqa: E501

The API is used to delete the recorded payment. It returns 204 http status code with empty body in successful case # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = PaymentApi(api_client=api_client) >>> thread = api.delete_record_payment(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_payment, delete_recorded_payment_request, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str id_payment: The unique identifier assigned by EBPP to the payment. (required) :param DeleteRecordedPaymentRequest delete_recorded_payment_request: Details of payment to be deleted/cancelled (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :return: None

delete_record_payment_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_payment, delete_recorded_payment_request, x_opay_headers, **kwargs)¶

Delete Recorded Payment # noqa: E501

The API is used to delete the recorded payment. It returns 204 http status code with empty body in successful case # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = PaymentApi(api_client=api_client) >>> thread = api.delete_record_payment_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_payment, delete_recorded_payment_request, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str id_payment: The unique identifier assigned by EBPP to the payment. (required) :param DeleteRecordedPaymentRequest delete_recorded_payment_request: Details of payment to be deleted/cancelled (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :return: None

get_payment(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_payment, id_customer, x_opay_headers, **kwargs)¶

Get Payment # noqa: E501

The API is used to retrieve the details of a payment or a recorded payment by id. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = PaymentApi(api_client=api_client) >>> thread = api.get_payment(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_payment, id_customer, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str id_payment: The unique identifier assigned by EBPP to the payment. (required) :param str id_customer: The unique identifier assigned by EBPP to the customer. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :return: PaymentResponse

get_payment_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_payment, id_customer, x_opay_headers, **kwargs)¶

Get Payment # noqa: E501

The API is used to retrieve the details of a payment or a recorded payment by id. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = PaymentApi(api_client=api_client) >>> thread = api.get_payment_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_payment, id_customer, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str id_payment: The unique identifier assigned by EBPP to the payment. (required) :param str id_customer: The unique identifier assigned by EBPP to the customer. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :return: PaymentResponse

record_payment(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, record_payment_request, x_opay_headers, **kwargs)¶

Record Payment # noqa: E501

The API is used to record payments in EBPP those are made and fulfilled outside EBPP. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = PaymentApi(api_client=api_client) >>> thread = api.record_payment(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, record_payment_request, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param RecordPaymentRequest record_payment_request: JSON containing all the fields required to record a payment. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :return: RecordedPaymentResponse

record_payment_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, record_payment_request, x_opay_headers, **kwargs)¶

Record Payment # noqa: E501

The API is used to record payments in EBPP those are made and fulfilled outside EBPP. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = PaymentApi(api_client=api_client) >>> thread = api.record_payment_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, record_payment_request, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param RecordPaymentRequest record_payment_request: JSON containing all the fields required to record a payment. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :return: RecordedPaymentResponse

retrieve_fee_payment(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_fee, id_customer, x_opay_headers, **kwargs)¶

Get Fee Payment # noqa: E501

The API is used to retrieve the details of a fee payment by id. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = PaymentApi(api_client=api_client) >>> thread = api.retrieve_fee_payment(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_fee, id_customer, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by OrbiPay to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str id_fee: The unique identifier assigned by OrbiPay to the FeePayment. (required) :param str id_customer: The unique identifier assigned by OrbiPay to the customer. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :return: PaymentResponse

retrieve_fee_payment_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_fee, id_customer, x_opay_headers, **kwargs)¶

Get Fee Payment # noqa: E501

The API is used to retrieve the details of a fee payment by id. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = PaymentApi(api_client=api_client) >>> thread = api.retrieve_fee_payment_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_fee, id_customer, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by OrbiPay to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str id_fee: The unique identifier assigned by OrbiPay to the FeePayment. (required) :param str id_customer: The unique identifier assigned by OrbiPay to the customer. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :return: PaymentResponse

retrieve_payments(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, x_opay_headers, **kwargs)¶

Retrieve Payments # noqa: E501

The API is used to retrieve the payments and recorded payments made by a customer. Payments can be filtered using the confirmation number, customer account, funding account, status and payment schedule type, payment method, by date range and others mentioned below. If no dates are provided for retrieval, payments in the last six months and all the payments scheduled for a future date are returned. In case a payment has failed due to ACH returns, then the payment return date and the return code will be available in the response. The results are sorted in descending order of the payment_date followed by the last_modified_time. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = PaymentApi(api_client=api_client) >>> thread = api.retrieve_payments(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :param str id_customer: The unique identifier assigned by EBPP to the customer. :param str id_funding_account: The unique identifier assigned by EBPP to the funding account :param str id_customer_account: The unique identifier assigned by EBPP to the customer account :param str confirmation_number: The confirmation number or reference provided to the customer for the successful payment. :param list[str] status: The status of the payment. This can take multiple values in the format key=value1&key=value2…. :param list[str] payment_schedule_type: The schedule type for the payment setup. This can take multiple values in the format key=value1&key=value2…. :param list[str] payment_method: The fulfillment method for the payment. :param str from_date: The date from which payments, matching the criteria specified, need to be retrieved. :param str to_date: The date upto which payments, matching the criteria specified, need to be retrieved. :param str page_size: The maximum number of objects returned in the query. :param str query_id: query id of the Retrieve/Search Customers lookup. :param str from_index: To fetch the next set of objects that start after this object :param str to_index: To fetch the previous set of objects that end at this object :return: PaymentsResponse

retrieve_payments_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, x_opay_headers, **kwargs)¶

Retrieve Payments # noqa: E501

The API is used to retrieve the payments and recorded payments made by a customer. Payments can be filtered using the confirmation number, customer account, funding account, status and payment schedule type, payment method, by date range and others mentioned below. If no dates are provided for retrieval, payments in the last six months and all the payments scheduled for a future date are returned. In case a payment has failed due to ACH returns, then the payment return date and the return code will be available in the response. The results are sorted in descending order of the payment_date followed by the last_modified_time. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = PaymentApi(api_client=api_client) >>> thread = api.retrieve_payments_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :param str id_customer: The unique identifier assigned by EBPP to the customer. :param str id_funding_account: The unique identifier assigned by EBPP to the funding account :param str id_customer_account: The unique identifier assigned by EBPP to the customer account :param str confirmation_number: The confirmation number or reference provided to the customer for the successful payment. :param list[str] status: The status of the payment. This can take multiple values in the format key=value1&key=value2…. :param list[str] payment_schedule_type: The schedule type for the payment setup. This can take multiple values in the format key=value1&key=value2…. :param list[str] payment_method: The fulfillment method for the payment. :param str from_date: The date from which payments, matching the criteria specified, need to be retrieved. :param str to_date: The date upto which payments, matching the criteria specified, need to be retrieved. :param str page_size: The maximum number of objects returned in the query. :param str query_id: query id of the Retrieve/Search Customers lookup. :param str from_index: To fetch the next set of objects that start after this object :param str to_index: To fetch the previous set of objects that end at this object :return: PaymentsResponse

simple_payment(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, simple_payment_request, x_opay_headers, **kwargs)¶

Simple Payment # noqa: E501

The API is used to make payments to service a customer account. Client systems can provide the unique identifier for the payment in their system as payment_reference. Fee amount and fee type are conditional and should be provided if the details of the fee to be charged are maintained in the client system. The fee types that are supported in EBPP are add_to_principal and bill_separately. Alternatively, the fee information can be setup in EBPP, in which case, these fields are ignored. If fee information is setup in the system, the details of the fee are returned in the response. This API updates the details of the customer, customer account and the funding account if those exist in EBPP or creates them otherwise. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = PaymentApi(api_client=api_client) >>> thread = api.simple_payment(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, simple_payment_request, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param SimplePaymentRequest simple_payment_request: JSON containing all the fields required to make a payment. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :param str save_funding_account: query param :return: SimplePaymentResponse

simple_payment_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, simple_payment_request, x_opay_headers, **kwargs)¶

Simple Payment # noqa: E501

The API is used to make payments to service a customer account. Client systems can provide the unique identifier for the payment in their system as payment_reference. Fee amount and fee type are conditional and should be provided if the details of the fee to be charged are maintained in the client system. The fee types that are supported in EBPP are add_to_principal and bill_separately. Alternatively, the fee information can be setup in EBPP, in which case, these fields are ignored. If fee information is setup in the system, the details of the fee are returned in the response. This API updates the details of the customer, customer account and the funding account if those exist in EBPP or creates them otherwise. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = PaymentApi(api_client=api_client) >>> thread = api.simple_payment_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, simple_payment_request, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param SimplePaymentRequest simple_payment_request: JSON containing all the fields required to make a payment. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :param str save_funding_account: query param :return: SimplePaymentResponse

update_payment(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_payment, id_customer, update_payment_request, x_opay_headers, **kwargs)¶

Update Payment # noqa: E501

The API is used to edit a payment. Only payments in scheduled status can be edited. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = PaymentApi(api_client=api_client) >>> thread = api.update_payment(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_payment, id_customer, update_payment_request, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str id_payment: The unique identifier assigned by EBPP to the payment. (required) :param str id_customer: The unique identifier assigned by EBPP to the customer. (required) :param UpdatePaymentRequest update_payment_request: Details of the Payment to be updated. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :return: PaymentResponse

update_payment_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_payment, id_customer, update_payment_request, x_opay_headers, **kwargs)¶

Update Payment # noqa: E501

The API is used to edit a payment. Only payments in scheduled status can be edited. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = PaymentApi(api_client=api_client) >>> thread = api.update_payment_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_payment, id_customer, update_payment_request, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str id_payment: The unique identifier assigned by EBPP to the payment. (required) :param str id_customer: The unique identifier assigned by EBPP to the customer. (required) :param UpdatePaymentRequest update_payment_request: Details of the Payment to be updated. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :return: PaymentResponse

orbipay_paymentsapi_client.api.payment_authorization_api module¶

## This class subject to change without prior notice, Please dont use this class directly.##¶

class orbipay_paymentsapi_client.api.payment_authorization_api.PaymentAuthorizationApi(api_client=None)¶

Bases: object

cancel_payment_authorization(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, id_authorization, cancel_payment_authorization_request, x_opay_headers, **kwargs)¶

Cancel Payment Authorization # noqa: E501

The API is used to cancel a payment authorization. Payment Authorizations that are already been processed into Payment cannot be cancelled. It returns 204 http status code with empty body in successful case. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = PaymentAuthorizationApi(api_client=api_client) >>> thread = api.cancel_payment_authorization(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, id_authorization, cancel_payment_authorization_request, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str id_customer: The unique identifier assigned by EBPP to the customer. (required) :param str id_authorization: The unique identifier assigned by EBPP to the payment authorization. (required) :param CancelPaymentAuthorizationRequest cancel_payment_authorization_request: Details of payment authorization to be cancelled (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :return: None

cancel_payment_authorization_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, id_authorization, cancel_payment_authorization_request, x_opay_headers, **kwargs)¶

Cancel Payment Authorization # noqa: E501

The API is used to cancel a payment authorization. Payment Authorizations that are already been processed into Payment cannot be cancelled. It returns 204 http status code with empty body in successful case. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = PaymentAuthorizationApi(api_client=api_client) >>> thread = api.cancel_payment_authorization_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, id_authorization, cancel_payment_authorization_request, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str id_customer: The unique identifier assigned by EBPP to the customer. (required) :param str id_authorization: The unique identifier assigned by EBPP to the payment authorization. (required) :param CancelPaymentAuthorizationRequest cancel_payment_authorization_request: Details of payment authorization to be cancelled (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :return: None

create_payment_authorization(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, create_payment_authorization_request, x_opay_headers, **kwargs)¶

Create Payment Authorization # noqa: E501

The API is used to create a payment authorization with certain amount on a given card account. Client systems can provide the unique identifier for the payment authorization in their system as payment_auth_reference. As of now this API is supported only for voyager fleet card payments # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = PaymentAuthorizationApi(api_client=api_client) >>> thread = api.create_payment_authorization(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, create_payment_authorization_request, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param CreatePaymentAuthorizationRequest create_payment_authorization_request: JSON containing all the fields required to make a payment. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :return: PaymentAuthorizationResponse

create_payment_authorization_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, create_payment_authorization_request, x_opay_headers, **kwargs)¶

Create Payment Authorization # noqa: E501

The API is used to create a payment authorization with certain amount on a given card account. Client systems can provide the unique identifier for the payment authorization in their system as payment_auth_reference. As of now this API is supported only for voyager fleet card payments # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = PaymentAuthorizationApi(api_client=api_client) >>> thread = api.create_payment_authorization_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, create_payment_authorization_request, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param CreatePaymentAuthorizationRequest create_payment_authorization_request: JSON containing all the fields required to make a payment. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :return: PaymentAuthorizationResponse

orbipay_paymentsapi_client.api.payment_setup_api module¶

## This class subject to change without prior notice, Please dont use this class directly.##¶

class orbipay_paymentsapi_client.api.payment_setup_api.PaymentSetupApi(api_client=None)¶

Bases: object

create_recurring_payment_setup(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, create_payment_setup_request, x_opay_headers, **kwargs)¶

Create Payment Setup # noqa: E501

The API is used to set up recurring payments to service a customer account. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = PaymentSetupApi(api_client=api_client) >>> thread = api.create_recurring_payment_setup(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, create_payment_setup_request, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str id_customer: The unique identifier assigned by EBPP to the customer. (required) :param CreatePaymentSetupRequest create_payment_setup_request: JSON containing all the fields required to create a recurring payment setup. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :return: PaymentSetupResponse

create_recurring_payment_setup_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, create_payment_setup_request, x_opay_headers, **kwargs)¶

Create Payment Setup # noqa: E501

The API is used to set up recurring payments to service a customer account. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = PaymentSetupApi(api_client=api_client) >>> thread = api.create_recurring_payment_setup_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, create_payment_setup_request, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str id_customer: The unique identifier assigned by EBPP to the customer. (required) :param CreatePaymentSetupRequest create_payment_setup_request: JSON containing all the fields required to create a recurring payment setup. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :return: PaymentSetupResponse

delete_payment_setup(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_payment_setup, id_customer, delete_payment_setup_request, x_opay_headers, **kwargs)¶

Delete Payment Setup # noqa: E501

The API is used to delete or cancel a recurring payment setup. Cancelling a payment setup will also cancel all the pending and future payments under the setup. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = PaymentSetupApi(api_client=api_client) >>> thread = api.delete_payment_setup(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_payment_setup, id_customer, delete_payment_setup_request, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str id_payment_setup: The unique identifier assigned by EBPP to the payment setup. (required) :param str id_customer: The unique identifier assigned by EBPP to the customer. (required) :param DeletePaymentSetupRequest delete_payment_setup_request: JSON containing all the fields required to delete a payment. Setup. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :return: DeleteResponse

delete_payment_setup_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_payment_setup, id_customer, delete_payment_setup_request, x_opay_headers, **kwargs)¶

Delete Payment Setup # noqa: E501

The API is used to delete or cancel a recurring payment setup. Cancelling a payment setup will also cancel all the pending and future payments under the setup. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = PaymentSetupApi(api_client=api_client) >>> thread = api.delete_payment_setup_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_payment_setup, id_customer, delete_payment_setup_request, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str id_payment_setup: The unique identifier assigned by EBPP to the payment setup. (required) :param str id_customer: The unique identifier assigned by EBPP to the customer. (required) :param DeletePaymentSetupRequest delete_payment_setup_request: JSON containing all the fields required to delete a payment. Setup. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :return: DeleteResponse

get_payment_setup(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_payment_setup, id_customer, x_opay_headers, **kwargs)¶

Get Payment Setup # noqa: E501

The API is used to retrieve the details of a recurring payment setup by id. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = PaymentSetupApi(api_client=api_client) >>> thread = api.get_payment_setup(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_payment_setup, id_customer, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str id_payment_setup: The unique identifier assigned by EBPP to the payment setup. (required) :param str id_customer: The unique identifier assigned by EBPP to the customer. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :return: PaymentSetupResponse

get_payment_setup_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_payment_setup, id_customer, x_opay_headers, **kwargs)¶

Get Payment Setup # noqa: E501

The API is used to retrieve the details of a recurring payment setup by id. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = PaymentSetupApi(api_client=api_client) >>> thread = api.get_payment_setup_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_payment_setup, id_customer, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str id_payment_setup: The unique identifier assigned by EBPP to the payment setup. (required) :param str id_customer: The unique identifier assigned by EBPP to the customer. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :return: PaymentSetupResponse

retrieve_payment_setups(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, x_opay_headers, **kwargs)¶

Retrieve Payment Setups # noqa: E501

The API is used to retrieve the recurring and autopay payments setup made against a customer account. The setup can be filtered using the confirmation number, customer account, funding account, status and payment setup schedule type, by date range and others mentioned below. If no dates are provided for retrieval, recurring payments set up in the last six months and all the ones in future are returned. The results are sorted in descending order of the payment_start_date followed by the last_modified_time. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = PaymentSetupApi(api_client=api_client) >>> thread = api.retrieve_payment_setups(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :param str id_customer: The unique identifier assigned by EBPP to the customer. :param str id_funding_account: The unique identifier assigned by EBPP to the funding account :param str id_customer_account: The unique identifier assigned by EBPP to the customer account :param str confirmation_number: The confirmation number or reference provided to the customer for the successful payment. :param list[str] status: The status of the payment. This can take multiple values in the format key=value1&key=value2…. :param list[str] payment_setup_schedule_type: The schedule type for the payment setup. This can take multiple values in the format key=value1&key=value2…. :param str from_date: The date from which recurring payments setup, matching the criteria specified, need to be retrieved. :param str to_date: The date upto which recurring payments setup, matching the criteria specified, need to be retrieved. :param str page_size: The maximum number of objects returned in the query. :param str query_id: query id of the Retrieve/Search Customers lookup. :param str from_index: To fetch the next set of objects that start after this object :param str to_index: To fetch the previous set of objects that end at this object :return: PaymentSetupsResponse

retrieve_payment_setups_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, x_opay_headers, **kwargs)¶

Retrieve Payment Setups # noqa: E501

The API is used to retrieve the recurring and autopay payments setup made against a customer account. The setup can be filtered using the confirmation number, customer account, funding account, status and payment setup schedule type, by date range and others mentioned below. If no dates are provided for retrieval, recurring payments set up in the last six months and all the ones in future are returned. The results are sorted in descending order of the payment_start_date followed by the last_modified_time. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = PaymentSetupApi(api_client=api_client) >>> thread = api.retrieve_payment_setups_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :param str id_customer: The unique identifier assigned by EBPP to the customer. :param str id_funding_account: The unique identifier assigned by EBPP to the funding account :param str id_customer_account: The unique identifier assigned by EBPP to the customer account :param str confirmation_number: The confirmation number or reference provided to the customer for the successful payment. :param list[str] status: The status of the payment. This can take multiple values in the format key=value1&key=value2…. :param list[str] payment_setup_schedule_type: The schedule type for the payment setup. This can take multiple values in the format key=value1&key=value2…. :param str from_date: The date from which recurring payments setup, matching the criteria specified, need to be retrieved. :param str to_date: The date upto which recurring payments setup, matching the criteria specified, need to be retrieved. :param str page_size: The maximum number of objects returned in the query. :param str query_id: query id of the Retrieve/Search Customers lookup. :param str from_index: To fetch the next set of objects that start after this object :param str to_index: To fetch the previous set of objects that end at this object :return: PaymentSetupsResponse

update_payment_setup(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_payment_setup, id_customer, update_payment_setup_request, x_opay_headers, **kwargs)¶

Update Payment Setup # noqa: E501

The API is used to edit a payment Setup. Only autopay payment setup is allowed to edit. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = PaymentSetupApi(api_client=api_client) >>> thread = api.update_payment_setup(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_payment_setup, id_customer, update_payment_setup_request, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str id_payment_setup: The unique identifier assigned by EBPP to the payment setup. (required) :param str id_customer: The unique identifier assigned by EBPP to the customer. (required) :param UpdatePaymentSetupRequest update_payment_setup_request: Details of the Payment Setup to be updated. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :return: PaymentSetupResponse

update_payment_setup_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_payment_setup, id_customer, update_payment_setup_request, x_opay_headers, **kwargs)¶

Update Payment Setup # noqa: E501

The API is used to edit a payment Setup. Only autopay payment setup is allowed to edit. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = PaymentSetupApi(api_client=api_client) >>> thread = api.update_payment_setup_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_payment_setup, id_customer, update_payment_setup_request, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str id_payment_setup: The unique identifier assigned by EBPP to the payment setup. (required) :param str id_customer: The unique identifier assigned by EBPP to the customer. (required) :param UpdatePaymentSetupRequest update_payment_setup_request: Details of the Payment Setup to be updated. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :return: PaymentSetupResponse

orbipay_paymentsapi_client.api.refund_api module¶

## This class subject to change without prior notice, Please dont use this class directly.##¶

class orbipay_paymentsapi_client.api.refund_api.RefundApi(api_client=None)¶

Bases: object

create_refund(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_payment, id_customer, create_refund_request, x_opay_headers, **kwargs)¶

Create Refund # noqa: E501

This API is used to initiate a refund. Any payment made using EBPP can be refunded. Customer cannot initiate a refund request. In other words, the Create Refund request will fail if the associated requestor_type is customer. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = RefundApi(api_client=api_client) >>> thread = api.create_refund(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_payment, id_customer, create_refund_request, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str id_payment: The unique identifier assigned by EBPP to the payment. (required) :param str id_customer: The unique identifier assigned by EBPP to the customer. (required) :param CreateRefundRequest create_refund_request: JSON containing all the fields required to refund a payment. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :return: RefundResponse

create_refund_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_payment, id_customer, create_refund_request, x_opay_headers, **kwargs)¶

Create Refund # noqa: E501

This API is used to initiate a refund. Any payment made using EBPP can be refunded. Customer cannot initiate a refund request. In other words, the Create Refund request will fail if the associated requestor_type is customer. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = RefundApi(api_client=api_client) >>> thread = api.create_refund_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_payment, id_customer, create_refund_request, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str id_payment: The unique identifier assigned by EBPP to the payment. (required) :param str id_customer: The unique identifier assigned by EBPP to the customer. (required) :param CreateRefundRequest create_refund_request: JSON containing all the fields required to refund a payment. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :return: RefundResponse

get_refund(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_refund, id_customer, x_opay_headers, **kwargs)¶

Get Refund # noqa: E501

The API is used to retrieve the details of a refund by id. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = RefundApi(api_client=api_client) >>> thread = api.get_refund(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_refund, id_customer, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str id_refund: The unique identifier assigned by EBPP to the refund. (required) :param str id_customer: The unique identifier assigned by EBPP to the customer. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :return: RefundResponse

get_refund_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_refund, id_customer, x_opay_headers, **kwargs)¶

Get Refund # noqa: E501

The API is used to retrieve the details of a refund by id. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = RefundApi(api_client=api_client) >>> thread = api.get_refund_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_refund, id_customer, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str id_refund: The unique identifier assigned by EBPP to the refund. (required) :param str id_customer: The unique identifier assigned by EBPP to the customer. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :return: RefundResponse

retrieve_refunds(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, x_opay_headers, **kwargs)¶

Retrieve Refunds # noqa: E501

The API is used to retrieve the refunds made to a customer against payments processed through EBPP. Refunds can be filtered using the customer id, confirmation number of the payment being refunded or of the refund, status of the refund and others mentioned below. Scheduled refunds that are yet to be processed and all the refunds processed in the last six months are returned if date criteria is not specified. The results are sorted in descending order of the refund_date followed by the last_modified_time. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = RefundApi(api_client=api_client) >>> thread = api.retrieve_refunds(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :param str id_customer: The unique identifier assigned by EBPP to the customer. :param str confirmation_number: The confirmation number provided to the customer for the refund or for the corresponding successful payment. :param list[str] status: The status of the refund. This can take multiple values in the format key=value1&key=value2…. :param str from_date: The date from which refunds, matching the criteria specified, need to be retrieved. :param str to_date: The date upto which refunds, matching the criteria specified, need to be retrieved. :param str page_size: The maximum number of objects returned in the query. :param str query_id: query id of the Retrieve/Search Customers lookup. :param str from_index: To fetch the next set of objects that start after this object :param str to_index: To fetch the previous set of objects that end at this object :return: RefundsResponse

retrieve_refunds_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, x_opay_headers, **kwargs)¶

Retrieve Refunds # noqa: E501

The API is used to retrieve the refunds made to a customer against payments processed through EBPP. Refunds can be filtered using the customer id, confirmation number of the payment being refunded or of the refund, status of the refund and others mentioned below. Scheduled refunds that are yet to be processed and all the refunds processed in the last six months are returned if date criteria is not specified. The results are sorted in descending order of the refund_date followed by the last_modified_time. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> configuration = Configuration() >>> # configuration.secret = secret >>> # configuration.host = host >>> api_client = ApiClient(configuration=configuration) >>> api = RefundApi(api_client=api_client) >>> thread = api.retrieve_refunds_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, async_req=True) >>> result = thread.get()

:param async_req bool :param str channel: The channel through which the API is invoked. (required) :param str client_key: The unique identifier assigned by EBPP to the client. (required) :param str product: The product identifier corresponding to the API. (required) :param str timestamp: The timestamp for the moment when the API request is created. (required) :param str idempotent_request_key: The unique token that clients can generate and maintain in order to identify an API request. (required) :param str requestor_type: Type of the requestor of the API. (required) :param str requestor: The identifier for the requestor of the API. :param str x_opay_headers: Intended for the future use. :param str trace_id: The unique reference that can be used for tracing and debugging an API call. :param str id_customer: The unique identifier assigned by EBPP to the customer. :param str confirmation_number: The confirmation number provided to the customer for the refund or for the corresponding successful payment. :param list[str] status: The status of the refund. This can take multiple values in the format key=value1&key=value2…. :param str from_date: The date from which refunds, matching the criteria specified, need to be retrieved. :param str to_date: The date upto which refunds, matching the criteria specified, need to be retrieved. :param str page_size: The maximum number of objects returned in the query. :param str query_id: query id of the Retrieve/Search Customers lookup. :param str from_index: To fetch the next set of objects that start after this object :param str to_index: To fetch the previous set of objects that end at this object :return: RefundsResponse

orbipay_paymentsapi_client.api package¶

Submodules¶

orbipay_paymentsapi_client.api.customer_account_api module¶

## This class subject to change without prior notice, Please dont use this class directly.##¶

orbipay_paymentsapi_client.api.customer_api module¶

## This class subject to change without prior notice, Please dont use this class directly.##¶

orbipay_paymentsapi_client.api.funding_account_api module¶

## This class subject to change without prior notice, Please dont use this class directly.##¶

orbipay_paymentsapi_client.api.payment_api module¶

## This class subject to change without prior notice, Please dont use this class directly.##¶

orbipay_paymentsapi_client.api.payment_authorization_api module¶

## This class subject to change without prior notice, Please dont use this class directly.##¶

orbipay_paymentsapi_client.api.payment_setup_api module¶

## This class subject to change without prior notice, Please dont use this class directly.##¶

orbipay_paymentsapi_client.api.refund_api module¶

## This class subject to change without prior notice, Please dont use this class directly.##¶

Module contents¶