Orbipay.PaymentsApi.Client.Api.ICustomerApi Interface Reference

More...

Inheritance diagram for Orbipay.PaymentsApi.Client.Api.ICustomerApi:

Public Member Functions
ApiResponse< CustomerResponse >	CreateCustomer (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, CreateCustomerRequest createCustomerRequest, string requestor=null, string xOPAYHeaders=null)
	Create Customer More...
ApiResponse< CustomerResponse >	CreateCustomerWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, CreateCustomerRequest createCustomerRequest, string requestor=null, string xOPAYHeaders=null)
	Create Customer More...
ApiResponse< CustomerResponse >	GetCustomer (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER, string requestor=null, string xOPAYHeaders=null)
	Get Customer More...
ApiResponse< CustomerResponse >	GetCustomerWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER, string requestor=null, string xOPAYHeaders=null)
	Get Customer More...
ApiResponse< CustomersResponse >	RetrieveCustomers (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string requestor=null, string xOPAYHeaders=null, string pageSize=null, string customerReference=null, string ssn=null, string email=null, string accountNumber=null)
	Retrieve Customers More...
ApiResponse< CustomersResponse >	RetrieveCustomersWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string requestor=null, string xOPAYHeaders=null, string pageSize=null, string customerReference=null, string ssn=null, string email=null, string accountNumber=null)
	Retrieve Customers More...
ApiResponse< CustomersResponse >	RetrieveCustomersPage (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string queryId, string requestor=null, string xOPAYHeaders=null, string pageSize=null, string fromIndex=null, string toIndex=null)
	Retrieve Customers Pagination More...
ApiResponse< CustomersResponse >	RetrieveCustomersPageWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string queryId, string requestor=null, string xOPAYHeaders=null, string pageSize=null, string fromIndex=null, string toIndex=null)
	Retrieve Customers Pagination More...
ApiResponse< CustomerResponse >	UpdateCustomer (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER, UpdateCustomerRequest updateCustomerRequest, string requestor=null, string xOPAYHeaders=null)
	Update Customer More...
ApiResponse< CustomerResponse >	UpdateCustomerWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER, UpdateCustomerRequest updateCustomerRequest, string requestor=null, string xOPAYHeaders=null)
	Update Customer More...
System.Threading.Tasks.Task < CustomerResponse >	CreateCustomerAsync (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, CreateCustomerRequest createCustomerRequest, string requestor=null, string xOPAYHeaders=null)
	Create Customer More...
System.Threading.Tasks.Task < ApiResponse < CustomerResponse > >	CreateCustomerAsyncWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, CreateCustomerRequest createCustomerRequest, string requestor=null, string xOPAYHeaders=null)
	Create Customer More...
System.Threading.Tasks.Task < CustomerResponse >	GetCustomerAsync (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER, string requestor=null, string xOPAYHeaders=null)
	Get Customer More...
System.Threading.Tasks.Task < ApiResponse < CustomerResponse > >	GetCustomerAsyncWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER, string requestor=null, string xOPAYHeaders=null)
	Get Customer More...
System.Threading.Tasks.Task < CustomersResponse >	RetrieveCustomersAsync (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string requestor=null, string xOPAYHeaders=null, string pageSize=null, string customerReference=null, string ssn=null, string email=null, string accountNumber=null)
	Retrieve Customers More...
System.Threading.Tasks.Task < ApiResponse < CustomersResponse > >	RetrieveCustomersAsyncWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string requestor=null, string xOPAYHeaders=null, string pageSize=null, string customerReference=null, string ssn=null, string email=null, string accountNumber=null)
	Retrieve Customers More...
System.Threading.Tasks.Task < CustomersResponse >	RetrieveCustomersPageAsync (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string queryId, string requestor=null, string xOPAYHeaders=null, string pageSize=null, string fromIndex=null, string toIndex=null)
	Retrieve Customers Pagination More...
System.Threading.Tasks.Task < ApiResponse < CustomersResponse > >	RetrieveCustomersPageAsyncWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string queryId, string requestor=null, string xOPAYHeaders=null, string pageSize=null, string fromIndex=null, string toIndex=null)
	Retrieve Customers Pagination More...
System.Threading.Tasks.Task < CustomerResponse >	UpdateCustomerAsync (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER, UpdateCustomerRequest updateCustomerRequest, string requestor=null, string xOPAYHeaders=null)
	Update Customer More...
System.Threading.Tasks.Task < ApiResponse < CustomerResponse > >	UpdateCustomerAsyncWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER, UpdateCustomerRequest updateCustomerRequest, string requestor=null, string xOPAYHeaders=null)
	Update Customer More...
Public Member Functions inherited from Orbipay.PaymentsApi.Client.Client.IApiAccessor
String	GetBasePath ()
	Gets the base path of the API client. More...

Additional Inherited Members
Properties inherited from Orbipay.PaymentsApi.Client.Client.IApiAccessor
Configuration	Configuration [get, set]
	Gets or sets the configuration object More...
ExceptionFactory	ExceptionFactory [get, set]
	Provides a factory method hook for the creation of exceptions. More...

Detailed Description

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

Member Function Documentation

ApiResponse<CustomerResponse> Orbipay.PaymentsApi.Client.Api.ICustomerApi.CreateCustomer	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		CreateCustomerRequest	createCustomerRequest,
		string	requestor = null,
		string	xOPAYHeaders = null
	)

Create Customer

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.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException

Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
createCustomerRequest	The JSON that contains all the attributes of customer to be created.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)

Returns

ApiResponse<CustomerResponse>

Implemented in Orbipay.PaymentsApi.Client.Api.CustomerApi.

System.Threading.Tasks.Task<CustomerResponse> Orbipay.PaymentsApi.Client.Api.ICustomerApi.CreateCustomerAsync	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		CreateCustomerRequest	createCustomerRequest,
		string	requestor = null,
		string	xOPAYHeaders = null
	)

Create Customer

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.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException

Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
createCustomerRequest	The JSON that contains all the attributes of customer to be created.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)

Returns

Task of CustomerResponse

Implemented in Orbipay.PaymentsApi.Client.Api.CustomerApi.

System.Threading.Tasks.Task<ApiResponse<CustomerResponse> > Orbipay.PaymentsApi.Client.Api.ICustomerApi.CreateCustomerAsyncWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		CreateCustomerRequest	createCustomerRequest,
		string	requestor = null,
		string	xOPAYHeaders = null
	)

Create Customer

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.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException

Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
createCustomerRequest	The JSON that contains all the attributes of customer to be created.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)

Returns

Task of ApiResponse (CustomerResponse)

Implemented in Orbipay.PaymentsApi.Client.Api.CustomerApi.

ApiResponse<CustomerResponse> Orbipay.PaymentsApi.Client.Api.ICustomerApi.CreateCustomerWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		CreateCustomerRequest	createCustomerRequest,
		string	requestor = null,
		string	xOPAYHeaders = null
	)

Create Customer

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.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException

Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
createCustomerRequest	The JSON that contains all the attributes of customer to be created.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)

Returns

ApiResponse of CustomerResponse

Implemented in Orbipay.PaymentsApi.Client.Api.CustomerApi.

ApiResponse<CustomerResponse> Orbipay.PaymentsApi.Client.Api.ICustomerApi.GetCustomer	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_CUSTOMER,
		string	requestor = null,
		string	xOPAYHeaders = null
	)

Get Customer

The Get Customer API is used to retrieve the details of the customer based on the id.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException

Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)

Returns

ApiResponse<CustomerResponse>

Implemented in Orbipay.PaymentsApi.Client.Api.CustomerApi.

System.Threading.Tasks.Task<CustomerResponse> Orbipay.PaymentsApi.Client.Api.ICustomerApi.GetCustomerAsync	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_CUSTOMER,
		string	requestor = null,
		string	xOPAYHeaders = null
	)

Get Customer

The Get Customer API is used to retrieve the details of the customer based on the id.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException

Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)

Returns

Task of CustomerResponse

Implemented in Orbipay.PaymentsApi.Client.Api.CustomerApi.

System.Threading.Tasks.Task<ApiResponse<CustomerResponse> > Orbipay.PaymentsApi.Client.Api.ICustomerApi.GetCustomerAsyncWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_CUSTOMER,
		string	requestor = null,
		string	xOPAYHeaders = null
	)

Get Customer

The Get Customer API is used to retrieve the details of the customer based on the id.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException

Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)

Returns

Task of ApiResponse (CustomerResponse)

Implemented in Orbipay.PaymentsApi.Client.Api.CustomerApi.

ApiResponse<CustomerResponse> Orbipay.PaymentsApi.Client.Api.ICustomerApi.GetCustomerWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_CUSTOMER,
		string	requestor = null,
		string	xOPAYHeaders = null
	)

Get Customer

The Get Customer API is used to retrieve the details of the customer based on the id.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException

Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)

Returns

ApiResponse of CustomerResponse

Implemented in Orbipay.PaymentsApi.Client.Api.CustomerApi.

ApiResponse<CustomersResponse> Orbipay.PaymentsApi.Client.Api.ICustomerApi.RetrieveCustomers	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	requestor = null,
		string	xOPAYHeaders = null,
		string	pageSize = null,
		string	customerReference = null,
		string	ssn = null,
		string	email = null,
		string	accountNumber = null
	)

Retrieve Customers

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.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException

Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)
pageSize	The maximum number of objects returned in the query. (optional)
customerReference	Unique ID assigned by the biller/client system for a given customer. (optional)
ssn	The SSN of the customer if the account holder is an individual or the tax ID, if the customer is a business. (optional)
email	This field contains the customer’s email address within EBPP. (optional)
accountNumber	Customer Account Number of the customer to get details of. (optional)

Returns

ApiResponse<CustomersResponse>

Implemented in Orbipay.PaymentsApi.Client.Api.CustomerApi.

System.Threading.Tasks.Task<CustomersResponse> Orbipay.PaymentsApi.Client.Api.ICustomerApi.RetrieveCustomersAsync	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	requestor = null,
		string	xOPAYHeaders = null,
		string	pageSize = null,
		string	customerReference = null,
		string	ssn = null,
		string	email = null,
		string	accountNumber = null
	)

Retrieve Customers

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.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException

Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)
pageSize	The maximum number of objects returned in the query. (optional)
customerReference	Unique ID assigned by the biller/client system for a given customer. (optional)
ssn	The SSN of the customer if the account holder is an individual or the tax ID, if the customer is a business. (optional)
email	This field contains the customer’s email address within EBPP. (optional)
accountNumber	Customer Account Number of the customer to get details of. (optional)

Returns

Task of CustomersResponse

Implemented in Orbipay.PaymentsApi.Client.Api.CustomerApi.

System.Threading.Tasks.Task<ApiResponse<CustomersResponse> > Orbipay.PaymentsApi.Client.Api.ICustomerApi.RetrieveCustomersAsyncWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	requestor = null,
		string	xOPAYHeaders = null,
		string	pageSize = null,
		string	customerReference = null,
		string	ssn = null,
		string	email = null,
		string	accountNumber = null
	)

Retrieve Customers

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.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException

Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)
pageSize	The maximum number of objects returned in the query. (optional)
customerReference	Unique ID assigned by the biller/client system for a given customer. (optional)
ssn	The SSN of the customer if the account holder is an individual or the tax ID, if the customer is a business. (optional)
email	This field contains the customer’s email address within EBPP. (optional)
accountNumber	Customer Account Number of the customer to get details of. (optional)

Returns

Task of ApiResponse (CustomersResponse)

Implemented in Orbipay.PaymentsApi.Client.Api.CustomerApi.

ApiResponse<CustomersResponse> Orbipay.PaymentsApi.Client.Api.ICustomerApi.RetrieveCustomersPage	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	queryId,
		string	requestor = null,
		string	xOPAYHeaders = null,
		string	pageSize = null,
		string	fromIndex = null,
		string	toIndex = null
	)

Retrieve Customers Pagination

This API is used to paginate through the list of customers returned in the Retrieve Customers API.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException

Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
queryId	query id of the Retrieve/Search Customers lookup.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)
pageSize	The maximum number of objects returned in the query. (optional)
fromIndex	To fetch the next set of objects that start after this object (optional)
toIndex	To fetch the previous set of objects that end at this object (optional)

Returns

ApiResponse<CustomersResponse>

Implemented in Orbipay.PaymentsApi.Client.Api.CustomerApi.

System.Threading.Tasks.Task<CustomersResponse> Orbipay.PaymentsApi.Client.Api.ICustomerApi.RetrieveCustomersPageAsync	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	queryId,
		string	requestor = null,
		string	xOPAYHeaders = null,
		string	pageSize = null,
		string	fromIndex = null,
		string	toIndex = null
	)

Retrieve Customers Pagination

This API is used to paginate through the list of customers returned in the Retrieve Customers API.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException

Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
queryId	query id of the Retrieve/Search Customers lookup.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)
pageSize	The maximum number of objects returned in the query. (optional)
fromIndex	To fetch the next set of objects that start after this object (optional)
toIndex	To fetch the previous set of objects that end at this object (optional)

Returns

Task of CustomersResponse

Implemented in Orbipay.PaymentsApi.Client.Api.CustomerApi.

System.Threading.Tasks.Task<ApiResponse<CustomersResponse> > Orbipay.PaymentsApi.Client.Api.ICustomerApi.RetrieveCustomersPageAsyncWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	queryId,
		string	requestor = null,
		string	xOPAYHeaders = null,
		string	pageSize = null,
		string	fromIndex = null,
		string	toIndex = null
	)

Retrieve Customers Pagination

This API is used to paginate through the list of customers returned in the Retrieve Customers API.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException

Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
queryId	query id of the Retrieve/Search Customers lookup.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)
pageSize	The maximum number of objects returned in the query. (optional)
fromIndex	To fetch the next set of objects that start after this object (optional)
toIndex	To fetch the previous set of objects that end at this object (optional)

Returns

Task of ApiResponse (CustomersResponse)

Implemented in Orbipay.PaymentsApi.Client.Api.CustomerApi.

ApiResponse<CustomersResponse> Orbipay.PaymentsApi.Client.Api.ICustomerApi.RetrieveCustomersPageWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	queryId,
		string	requestor = null,
		string	xOPAYHeaders = null,
		string	pageSize = null,
		string	fromIndex = null,
		string	toIndex = null
	)

Retrieve Customers Pagination

This API is used to paginate through the list of customers returned in the Retrieve Customers API.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException

Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
queryId	query id of the Retrieve/Search Customers lookup.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)
pageSize	The maximum number of objects returned in the query. (optional)
fromIndex	To fetch the next set of objects that start after this object (optional)
toIndex	To fetch the previous set of objects that end at this object (optional)

Returns

ApiResponse of CustomersResponse

Implemented in Orbipay.PaymentsApi.Client.Api.CustomerApi.

ApiResponse<CustomersResponse> Orbipay.PaymentsApi.Client.Api.ICustomerApi.RetrieveCustomersWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	requestor = null,
		string	xOPAYHeaders = null,
		string	pageSize = null,
		string	customerReference = null,
		string	ssn = null,
		string	email = null,
		string	accountNumber = null
	)

Retrieve Customers

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.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException

Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)
pageSize	The maximum number of objects returned in the query. (optional)
customerReference	Unique ID assigned by the biller/client system for a given customer. (optional)
ssn	The SSN of the customer if the account holder is an individual or the tax ID, if the customer is a business. (optional)
email	This field contains the customer’s email address within EBPP. (optional)
accountNumber	Customer Account Number of the customer to get details of. (optional)

Returns

ApiResponse of CustomersResponse

Implemented in Orbipay.PaymentsApi.Client.Api.CustomerApi.

ApiResponse<CustomerResponse> Orbipay.PaymentsApi.Client.Api.ICustomerApi.UpdateCustomer	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_CUSTOMER,
		UpdateCustomerRequest	updateCustomerRequest,
		string	requestor = null,
		string	xOPAYHeaders = null
	)

Update Customer

The Update Customer API is used to edit the customer&#39;&#39;s personal details, accounts or the customer&#39;&#39;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. <br><br> 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> |

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException

Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
updateCustomerRequest	JSON containing all the attributes of the customer to be updated.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)

Returns

ApiResponse<CustomerResponse>

Implemented in Orbipay.PaymentsApi.Client.Api.CustomerApi.

System.Threading.Tasks.Task<CustomerResponse> Orbipay.PaymentsApi.Client.Api.ICustomerApi.UpdateCustomerAsync	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_CUSTOMER,
		UpdateCustomerRequest	updateCustomerRequest,
		string	requestor = null,
		string	xOPAYHeaders = null
	)

Update Customer

The Update Customer API is used to edit the customer&#39;&#39;s personal details, accounts or the customer&#39;&#39;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. <br><br> 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> |

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException

Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
updateCustomerRequest	JSON containing all the attributes of the customer to be updated.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)

Returns

Task of CustomerResponse

Implemented in Orbipay.PaymentsApi.Client.Api.CustomerApi.

System.Threading.Tasks.Task<ApiResponse<CustomerResponse> > Orbipay.PaymentsApi.Client.Api.ICustomerApi.UpdateCustomerAsyncWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_CUSTOMER,
		UpdateCustomerRequest	updateCustomerRequest,
		string	requestor = null,
		string	xOPAYHeaders = null
	)

Update Customer

The Update Customer API is used to edit the customer&#39;&#39;s personal details, accounts or the customer&#39;&#39;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. <br><br> 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> |

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException

Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
updateCustomerRequest	JSON containing all the attributes of the customer to be updated.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)

Returns

Task of ApiResponse (CustomerResponse)

Implemented in Orbipay.PaymentsApi.Client.Api.CustomerApi.

ApiResponse<CustomerResponse> Orbipay.PaymentsApi.Client.Api.ICustomerApi.UpdateCustomerWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_CUSTOMER,
		UpdateCustomerRequest	updateCustomerRequest,
		string	requestor = null,
		string	xOPAYHeaders = null
	)

Update Customer

The Update Customer API is used to edit the customer&#39;&#39;s personal details, accounts or the customer&#39;&#39;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. <br><br> 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> |

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException

Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
updateCustomerRequest	JSON containing all the attributes of the customer to be updated.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)

Returns

ApiResponse of CustomerResponse

Implemented in Orbipay.PaymentsApi.Client.Api.CustomerApi.

---

The documentation for this interface was generated from the following file:

• src/Orbipay.PaymentsApi.Client/Api/CustomerApi.cs