Represents a collection of functions to interact with the API endpoints More...

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

Public Member Functions
	CustomerAccountApi (String basePath)
	Initializes a new instance of the CustomerAccountApi class. More...

	CustomerAccountApi (Orbipay.PaymentsApi.Client.Client.Configuration configuration=null)
	Initializes a new instance of the CustomerAccountApi class using Configuration object More...

String	GetBasePath ()
	Gets the base path of the API client. More...

void	SetBasePath (String basePath)
	Sets the base path of the API client. More...

IDictionary< String, String >	DefaultHeader ()
	Gets the default header. More...

void	AddDefaultHeader (string key, string value)
	Add default header. More...

ApiResponse < CustomerAccountResponse >	GetCustomerAccount (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER_ACCOUNT, string ID_CUSTOMER, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Get Customer Account The Get Customer Account API is used to retrieve the details of a customer account based on the id. More...

ApiResponse < CustomerAccountResponse >	GetCustomerAccountWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER_ACCOUNT, string ID_CUSTOMER, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Get Customer Account The Get Customer Account API is used to retrieve the details of a customer account based on the id. More...

async System.Threading.Tasks.Task < CustomerAccountResponse >	GetCustomerAccountAsync (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER_ACCOUNT, string ID_CUSTOMER, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Get Customer Account The Get Customer Account API is used to retrieve the details of a customer account based on the id. More...

async System.Threading.Tasks.Task < ApiResponse < CustomerAccountResponse > >	GetCustomerAccountAsyncWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER_ACCOUNT, string ID_CUSTOMER, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Get Customer Account The Get Customer Account API is used to retrieve the details of a customer account based on the id. More...

ApiResponse < CustomerAccountResponse >	RenewCustomerAccount (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER_ACCOUNT, string ID_CUSTOMER, RenewCustomerAccountRequest renewCustomerAccountRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Renew Customer Account 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. More...

ApiResponse < CustomerAccountResponse >	RenewCustomerAccountWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER_ACCOUNT, string ID_CUSTOMER, RenewCustomerAccountRequest renewCustomerAccountRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Renew Customer Account 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. More...

async System.Threading.Tasks.Task < CustomerAccountResponse >	RenewCustomerAccountAsync (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER_ACCOUNT, string ID_CUSTOMER, RenewCustomerAccountRequest renewCustomerAccountRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Renew Customer Account 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. More...

async System.Threading.Tasks.Task < ApiResponse < CustomerAccountResponse > >	RenewCustomerAccountAsyncWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER_ACCOUNT, string ID_CUSTOMER, RenewCustomerAccountRequest renewCustomerAccountRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Renew Customer Account 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. More...

ApiResponse < CustomerAccountsResponse >	RetrieveCustomerAccounts (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER, string requestor=null, string xOPAYHeaders=null, string traceId=null, string pageSize=null, string accountNumber=null, List< string > status=null)
	Retrieve Customer Accounts 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. More...

ApiResponse < CustomerAccountsResponse >	RetrieveCustomerAccountsWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER, string requestor=null, string xOPAYHeaders=null, string traceId=null, string pageSize=null, string accountNumber=null, List< string > status=null)
	Retrieve Customer Accounts 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. More...

async System.Threading.Tasks.Task < CustomerAccountsResponse >	RetrieveCustomerAccountsAsync (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER, string requestor=null, string xOPAYHeaders=null, string traceId=null, string pageSize=null, string accountNumber=null, List< string > status=null)
	Retrieve Customer Accounts 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. More...

async System.Threading.Tasks.Task < ApiResponse < CustomerAccountsResponse > >	RetrieveCustomerAccountsAsyncWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER, string requestor=null, string xOPAYHeaders=null, string traceId=null, string pageSize=null, string accountNumber=null, List< string > status=null)
	Retrieve Customer Accounts 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. More...

ApiResponse < CustomerAccountsResponse >	RetrieveCustomerAccountsPage (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER, string queryId, string requestor=null, string xOPAYHeaders=null, string traceId=null, string pageSize=null, string fromIndex=null, string toIndex=null)
	Retrieve Customer Accounts Pagination This API is used to paginate through the list of customer Accounts returned in the Retrieve Customer Accounts API. More...

ApiResponse < CustomerAccountsResponse >	RetrieveCustomerAccountsPageWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER, string queryId, string requestor=null, string xOPAYHeaders=null, string traceId=null, string pageSize=null, string fromIndex=null, string toIndex=null)
	Retrieve Customer Accounts Pagination This API is used to paginate through the list of customer Accounts returned in the Retrieve Customer Accounts API. More...

async System.Threading.Tasks.Task < CustomerAccountsResponse >	RetrieveCustomerAccountsPageAsync (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER, string queryId, string requestor=null, string xOPAYHeaders=null, string traceId=null, string pageSize=null, string fromIndex=null, string toIndex=null)
	Retrieve Customer Accounts Pagination This API is used to paginate through the list of customer Accounts returned in the Retrieve Customer Accounts API. More...

async System.Threading.Tasks.Task < ApiResponse < CustomerAccountsResponse > >	RetrieveCustomerAccountsPageAsyncWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER, string queryId, string requestor=null, string xOPAYHeaders=null, string traceId=null, string pageSize=null, string fromIndex=null, string toIndex=null)
	Retrieve Customer Accounts Pagination This API is used to paginate through the list of customer Accounts returned in the Retrieve Customer Accounts API. More...

Properties
Orbipay.PaymentsApi.Client.Client.Configuration	Configuration `[get, set]`
	Gets or sets the configuration object More...

Orbipay.PaymentsApi.Client.Client.ExceptionFactory	ExceptionFactory `[get, set]`
	Provides a factory method hook for the creation of exceptions. More...

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

Represents a collection of functions to interact with the API endpoints

Constructor & Destructor Documentation

Orbipay.PaymentsApi.Client.Api.CustomerAccountApi.CustomerAccountApi ( String basePath )

Initializes a new instance of the CustomerAccountApi class.

Returns

Orbipay.PaymentsApi.Client.Api.CustomerAccountApi.CustomerAccountApi ( Orbipay.PaymentsApi.Client.Client.Configuration configuration = null )

Initializes a new instance of the CustomerAccountApi class using Configuration object

Parameters

configuration An instance of Configuration

Returns

Member Function Documentation

void Orbipay.PaymentsApi.Client.Api.CustomerAccountApi.AddDefaultHeader	(	string	key,
		string	value
	)

Add default header.

Parameters

key	Header field name.
value	Header field value.

Returns

IDictionary<String, String> Orbipay.PaymentsApi.Client.Api.CustomerAccountApi.DefaultHeader ( )

Gets the default header.

Returns: Dictionary of HTTP header

String Orbipay.PaymentsApi.Client.Api.CustomerAccountApi.GetBasePath ( )

Gets the base path of the API client.

The base path

Implements Orbipay.PaymentsApi.Client.Client.IApiAccessor.

ApiResponse<CustomerAccountResponse> Orbipay.PaymentsApi.Client.Api.CustomerAccountApi.GetCustomerAccount	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_CUSTOMER_ACCOUNT,
		string	ID_CUSTOMER,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Get Customer Account The Get Customer Account API is used to retrieve the details of a customer account 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_ACCOUNT	The unique identifier assigned by EBPP to the Customer Account.
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)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns: CustomerAccountResponse

Implements Orbipay.PaymentsApi.Client.Api.ICustomerAccountApi.

async System.Threading.Tasks.Task<CustomerAccountResponse> Orbipay.PaymentsApi.Client.Api.CustomerAccountApi.GetCustomerAccountAsync	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_CUSTOMER_ACCOUNT,
		string	ID_CUSTOMER,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Get Customer Account The Get Customer Account API is used to retrieve the details of a customer account 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_ACCOUNT	The unique identifier assigned by EBPP to the Customer Account.
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)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns: Task of CustomerAccountResponse

Implements Orbipay.PaymentsApi.Client.Api.ICustomerAccountApi.

async System.Threading.Tasks.Task<ApiResponse<CustomerAccountResponse> > Orbipay.PaymentsApi.Client.Api.CustomerAccountApi.GetCustomerAccountAsyncWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_CUSTOMER_ACCOUNT,
		string	ID_CUSTOMER,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Get Customer Account The Get Customer Account API is used to retrieve the details of a customer account 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_ACCOUNT	The unique identifier assigned by EBPP to the Customer Account.
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)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns: Task of ApiResponse (CustomerAccountResponse)

Implements Orbipay.PaymentsApi.Client.Api.ICustomerAccountApi.

ApiResponse< CustomerAccountResponse > Orbipay.PaymentsApi.Client.Api.CustomerAccountApi.GetCustomerAccountWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_CUSTOMER_ACCOUNT,
		string	ID_CUSTOMER,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Get Customer Account The Get Customer Account API is used to retrieve the details of a customer account 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_ACCOUNT	The unique identifier assigned by EBPP to the Customer Account.
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)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns: ApiResponse of CustomerAccountResponse

Implements Orbipay.PaymentsApi.Client.Api.ICustomerAccountApi.

ApiResponse<CustomerAccountResponse> Orbipay.PaymentsApi.Client.Api.CustomerAccountApi.RenewCustomerAccount	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_CUSTOMER_ACCOUNT,
		string	ID_CUSTOMER,
		RenewCustomerAccountRequest	renewCustomerAccountRequest,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Renew Customer Account 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.

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_ACCOUNT	The unique identifier assigned by EBPP to the Customer Account.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
renewCustomerAccountRequest	JSON containing all the attributes of the Customer account to be renewed.
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)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns: CustomerAccountResponse

Implements Orbipay.PaymentsApi.Client.Api.ICustomerAccountApi.

async System.Threading.Tasks.Task<CustomerAccountResponse> Orbipay.PaymentsApi.Client.Api.CustomerAccountApi.RenewCustomerAccountAsync	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_CUSTOMER_ACCOUNT,
		string	ID_CUSTOMER,
		RenewCustomerAccountRequest	renewCustomerAccountRequest,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Renew Customer Account 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.

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_ACCOUNT	The unique identifier assigned by EBPP to the Customer Account.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
renewCustomerAccountRequest	JSON containing all the attributes of the Customer account to be renewed.
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)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns: Task of CustomerAccountResponse

Implements Orbipay.PaymentsApi.Client.Api.ICustomerAccountApi.

async System.Threading.Tasks.Task<ApiResponse<CustomerAccountResponse> > Orbipay.PaymentsApi.Client.Api.CustomerAccountApi.RenewCustomerAccountAsyncWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_CUSTOMER_ACCOUNT,
		string	ID_CUSTOMER,
		RenewCustomerAccountRequest	renewCustomerAccountRequest,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Renew Customer Account 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.

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_ACCOUNT	The unique identifier assigned by EBPP to the Customer Account.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
renewCustomerAccountRequest	JSON containing all the attributes of the Customer account to be renewed.
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)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns: Task of ApiResponse (CustomerAccountResponse)

Implements Orbipay.PaymentsApi.Client.Api.ICustomerAccountApi.

ApiResponse< CustomerAccountResponse > Orbipay.PaymentsApi.Client.Api.CustomerAccountApi.RenewCustomerAccountWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_CUSTOMER_ACCOUNT,
		string	ID_CUSTOMER,
		RenewCustomerAccountRequest	renewCustomerAccountRequest,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Renew Customer Account 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.

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_ACCOUNT	The unique identifier assigned by EBPP to the Customer Account.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
renewCustomerAccountRequest	JSON containing all the attributes of the Customer account to be renewed.
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)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns: ApiResponse of CustomerAccountResponse

Implements Orbipay.PaymentsApi.Client.Api.ICustomerAccountApi.

ApiResponse<CustomerAccountsResponse> Orbipay.PaymentsApi.Client.Api.CustomerAccountApi.RetrieveCustomerAccounts	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_CUSTOMER,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`,
		string	pageSize = `null`,
		string	accountNumber = `null`,
		List< string >	status = `null`
	)

Retrieve Customer Accounts 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.

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)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)
pageSize	The maximum number of objects returned in the query. (optional)
accountNumber	The Account Number to get details of. (optional)
status	The status of the customer's account in EBPP. This can take multiple values in the format key=value1&key=value2.... (optional)

Returns: CustomerAccountsResponse

Implements Orbipay.PaymentsApi.Client.Api.ICustomerAccountApi.

async System.Threading.Tasks.Task<CustomerAccountsResponse> Orbipay.PaymentsApi.Client.Api.CustomerAccountApi.RetrieveCustomerAccountsAsync	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_CUSTOMER,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`,
		string	pageSize = `null`,
		string	accountNumber = `null`,
		List< string >	status = `null`
	)

Retrieve Customer Accounts 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.

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)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)
pageSize	The maximum number of objects returned in the query. (optional)
accountNumber	The Account Number to get details of. (optional)
status	The status of the customer's account in EBPP. This can take multiple values in the format key=value1&key=value2.... (optional)

Returns: Task of CustomerAccountsResponse

Implements Orbipay.PaymentsApi.Client.Api.ICustomerAccountApi.

async System.Threading.Tasks.Task<ApiResponse<CustomerAccountsResponse> > Orbipay.PaymentsApi.Client.Api.CustomerAccountApi.RetrieveCustomerAccountsAsyncWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_CUSTOMER,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`,
		string	pageSize = `null`,
		string	accountNumber = `null`,
		List< string >	status = `null`
	)

Retrieve Customer Accounts 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.

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)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)
pageSize	The maximum number of objects returned in the query. (optional)
accountNumber	The Account Number to get details of. (optional)
status	The status of the customer's account in EBPP. This can take multiple values in the format key=value1&key=value2.... (optional)

Returns: Task of ApiResponse (CustomerAccountsResponse)

Implements Orbipay.PaymentsApi.Client.Api.ICustomerAccountApi.

ApiResponse<CustomerAccountsResponse> Orbipay.PaymentsApi.Client.Api.CustomerAccountApi.RetrieveCustomerAccountsPage	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_CUSTOMER,
		string	queryId,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`,
		string	pageSize = `null`,
		string	fromIndex = `null`,
		string	toIndex = `null`
	)

Retrieve Customer Accounts Pagination This API is used to paginate through the list of customer Accounts returned in the Retrieve Customer Accounts 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.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
queryId	query id of the Retrieve/Search Accounts 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)
traceId	The unique reference that can be used for tracing and debugging an API call. (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: CustomerAccountsResponse

Implements Orbipay.PaymentsApi.Client.Api.ICustomerAccountApi.

async System.Threading.Tasks.Task<CustomerAccountsResponse> Orbipay.PaymentsApi.Client.Api.CustomerAccountApi.RetrieveCustomerAccountsPageAsync	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_CUSTOMER,
		string	queryId,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`,
		string	pageSize = `null`,
		string	fromIndex = `null`,
		string	toIndex = `null`
	)

Retrieve Customer Accounts Pagination This API is used to paginate through the list of customer Accounts returned in the Retrieve Customer Accounts 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.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
queryId	query id of the Retrieve/Search Accounts 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)
traceId	The unique reference that can be used for tracing and debugging an API call. (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 CustomerAccountsResponse

Implements Orbipay.PaymentsApi.Client.Api.ICustomerAccountApi.

async System.Threading.Tasks.Task<ApiResponse<CustomerAccountsResponse> > Orbipay.PaymentsApi.Client.Api.CustomerAccountApi.RetrieveCustomerAccountsPageAsyncWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_CUSTOMER,
		string	queryId,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`,
		string	pageSize = `null`,
		string	fromIndex = `null`,
		string	toIndex = `null`
	)

Retrieve Customer Accounts Pagination This API is used to paginate through the list of customer Accounts returned in the Retrieve Customer Accounts 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.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
queryId	query id of the Retrieve/Search Accounts 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)
traceId	The unique reference that can be used for tracing and debugging an API call. (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 (CustomerAccountsResponse)

Implements Orbipay.PaymentsApi.Client.Api.ICustomerAccountApi.

ApiResponse< CustomerAccountsResponse > Orbipay.PaymentsApi.Client.Api.CustomerAccountApi.RetrieveCustomerAccountsPageWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_CUSTOMER,
		string	queryId,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`,
		string	pageSize = `null`,
		string	fromIndex = `null`,
		string	toIndex = `null`
	)

Retrieve Customer Accounts Pagination This API is used to paginate through the list of customer Accounts returned in the Retrieve Customer Accounts 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.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
queryId	query id of the Retrieve/Search Accounts 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)
traceId	The unique reference that can be used for tracing and debugging an API call. (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 CustomerAccountsResponse

Implements Orbipay.PaymentsApi.Client.Api.ICustomerAccountApi.

ApiResponse< CustomerAccountsResponse > Orbipay.PaymentsApi.Client.Api.CustomerAccountApi.RetrieveCustomerAccountsWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_CUSTOMER,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`,
		string	pageSize = `null`,
		string	accountNumber = `null`,
		List< string >	status = `null`
	)

Retrieve Customer Accounts 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.

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)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)
pageSize	The maximum number of objects returned in the query. (optional)
accountNumber	The Account Number to get details of. (optional)
status	The status of the customer's account in EBPP. This can take multiple values in the format key=value1&key=value2.... (optional)

Returns: ApiResponse of CustomerAccountsResponse

Implements Orbipay.PaymentsApi.Client.Api.ICustomerAccountApi.

void Orbipay.PaymentsApi.Client.Api.CustomerAccountApi.SetBasePath ( String basePath )

Sets the base path of the API client.

The base path

Property Documentation

Orbipay.PaymentsApi.Client.Client.Configuration Orbipay.PaymentsApi.Client.Api.CustomerAccountApi.Configuration

getset

Gets or sets the configuration object

An instance of the Configuration

Orbipay.PaymentsApi.Client.Client.ExceptionFactory Orbipay.PaymentsApi.Client.Api.CustomerAccountApi.ExceptionFactory

getset

Provides a factory method hook for the creation of exceptions.

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

src/Orbipay.PaymentsApi.Client/Api/CustomerAccountApi.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation