My Project
 All Classes Namespaces Files Functions Variables Typedefs Properties Pages
Orbipay.PaymentsApi.Client.Api.ICustomerAccountApi Interface Reference

More...

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

Public Member Functions

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 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 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 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 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 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 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 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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 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<CustomerAccountResponse> Orbipay.PaymentsApi.Client.Api.ICustomerAccountApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
ID_CUSTOMER_ACCOUNTThe unique identifier assigned by EBPP to the Customer Account.
ID_CUSTOMERThe unique identifier assigned by EBPP to the customer.
requestorThe identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
Returns
ApiResponse<CustomerAccountResponse>

Implemented in Orbipay.PaymentsApi.Client.Api.CustomerAccountApi.

System.Threading.Tasks.Task<CustomerAccountResponse> Orbipay.PaymentsApi.Client.Api.ICustomerAccountApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
ID_CUSTOMER_ACCOUNTThe unique identifier assigned by EBPP to the Customer Account.
ID_CUSTOMERThe unique identifier assigned by EBPP to the customer.
requestorThe identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
Returns
Task of CustomerAccountResponse

Implemented in Orbipay.PaymentsApi.Client.Api.CustomerAccountApi.

System.Threading.Tasks.Task<ApiResponse<CustomerAccountResponse> > Orbipay.PaymentsApi.Client.Api.ICustomerAccountApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
ID_CUSTOMER_ACCOUNTThe unique identifier assigned by EBPP to the Customer Account.
ID_CUSTOMERThe unique identifier assigned by EBPP to the customer.
requestorThe identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
Returns
Task of ApiResponse (CustomerAccountResponse)

Implemented in Orbipay.PaymentsApi.Client.Api.CustomerAccountApi.

ApiResponse<CustomerAccountResponse> Orbipay.PaymentsApi.Client.Api.ICustomerAccountApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
ID_CUSTOMER_ACCOUNTThe unique identifier assigned by EBPP to the Customer Account.
ID_CUSTOMERThe unique identifier assigned by EBPP to the customer.
requestorThe identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
Returns
ApiResponse of CustomerAccountResponse

Implemented in Orbipay.PaymentsApi.Client.Api.CustomerAccountApi.

ApiResponse<CustomerAccountResponse> Orbipay.PaymentsApi.Client.Api.ICustomerAccountApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
ID_CUSTOMER_ACCOUNTThe unique identifier assigned by EBPP to the Customer Account.
ID_CUSTOMERThe unique identifier assigned by EBPP to the customer.
renewCustomerAccountRequestJSON containing all the attributes of the Customer account to be renewed.
requestorThe identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
Returns
ApiResponse<CustomerAccountResponse>

Implemented in Orbipay.PaymentsApi.Client.Api.CustomerAccountApi.

System.Threading.Tasks.Task<CustomerAccountResponse> Orbipay.PaymentsApi.Client.Api.ICustomerAccountApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
ID_CUSTOMER_ACCOUNTThe unique identifier assigned by EBPP to the Customer Account.
ID_CUSTOMERThe unique identifier assigned by EBPP to the customer.
renewCustomerAccountRequestJSON containing all the attributes of the Customer account to be renewed.
requestorThe identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
Returns
Task of CustomerAccountResponse

Implemented in Orbipay.PaymentsApi.Client.Api.CustomerAccountApi.

System.Threading.Tasks.Task<ApiResponse<CustomerAccountResponse> > Orbipay.PaymentsApi.Client.Api.ICustomerAccountApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
ID_CUSTOMER_ACCOUNTThe unique identifier assigned by EBPP to the Customer Account.
ID_CUSTOMERThe unique identifier assigned by EBPP to the customer.
renewCustomerAccountRequestJSON containing all the attributes of the Customer account to be renewed.
requestorThe identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
Returns
Task of ApiResponse (CustomerAccountResponse)

Implemented in Orbipay.PaymentsApi.Client.Api.CustomerAccountApi.

ApiResponse<CustomerAccountResponse> Orbipay.PaymentsApi.Client.Api.ICustomerAccountApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
ID_CUSTOMER_ACCOUNTThe unique identifier assigned by EBPP to the Customer Account.
ID_CUSTOMERThe unique identifier assigned by EBPP to the customer.
renewCustomerAccountRequestJSON containing all the attributes of the Customer account to be renewed.
requestorThe identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
Returns
ApiResponse of CustomerAccountResponse

Implemented in Orbipay.PaymentsApi.Client.Api.CustomerAccountApi.

ApiResponse<CustomerAccountsResponse> Orbipay.PaymentsApi.Client.Api.ICustomerAccountApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
ID_CUSTOMERThe unique identifier assigned by EBPP to the customer.
requestorThe identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
pageSizeThe maximum number of objects returned in the query. (optional)
accountNumberThe Account Number to get details of. (optional)
statusThe status of the customer&#39;s account in EBPP. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2.... (optional)
Returns
ApiResponse<CustomerAccountsResponse>

Implemented in Orbipay.PaymentsApi.Client.Api.CustomerAccountApi.

System.Threading.Tasks.Task<CustomerAccountsResponse> Orbipay.PaymentsApi.Client.Api.ICustomerAccountApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
ID_CUSTOMERThe unique identifier assigned by EBPP to the customer.
requestorThe identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
pageSizeThe maximum number of objects returned in the query. (optional)
accountNumberThe Account Number to get details of. (optional)
statusThe status of the customer&#39;s account in EBPP. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2.... (optional)
Returns
Task of CustomerAccountsResponse

Implemented in Orbipay.PaymentsApi.Client.Api.CustomerAccountApi.

System.Threading.Tasks.Task<ApiResponse<CustomerAccountsResponse> > Orbipay.PaymentsApi.Client.Api.ICustomerAccountApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
ID_CUSTOMERThe unique identifier assigned by EBPP to the customer.
requestorThe identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
pageSizeThe maximum number of objects returned in the query. (optional)
accountNumberThe Account Number to get details of. (optional)
statusThe status of the customer&#39;s account in EBPP. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2.... (optional)
Returns
Task of ApiResponse (CustomerAccountsResponse)

Implemented in Orbipay.PaymentsApi.Client.Api.CustomerAccountApi.

ApiResponse<CustomerAccountsResponse> Orbipay.PaymentsApi.Client.Api.ICustomerAccountApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
ID_CUSTOMERThe unique identifier assigned by EBPP to the customer.
queryIdquery id of the Retrieve/Search Accounts lookup.
requestorThe identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
pageSizeThe maximum number of objects returned in the query. (optional)
fromIndexTo fetch the next set of objects that start after this object (optional)
toIndexTo fetch the previous set of objects that end at this object (optional)
Returns
ApiResponse<CustomerAccountsResponse>

Implemented in Orbipay.PaymentsApi.Client.Api.CustomerAccountApi.

System.Threading.Tasks.Task<CustomerAccountsResponse> Orbipay.PaymentsApi.Client.Api.ICustomerAccountApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
ID_CUSTOMERThe unique identifier assigned by EBPP to the customer.
queryIdquery id of the Retrieve/Search Accounts lookup.
requestorThe identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
pageSizeThe maximum number of objects returned in the query. (optional)
fromIndexTo fetch the next set of objects that start after this object (optional)
toIndexTo fetch the previous set of objects that end at this object (optional)
Returns
Task of CustomerAccountsResponse

Implemented in Orbipay.PaymentsApi.Client.Api.CustomerAccountApi.

System.Threading.Tasks.Task<ApiResponse<CustomerAccountsResponse> > Orbipay.PaymentsApi.Client.Api.ICustomerAccountApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
ID_CUSTOMERThe unique identifier assigned by EBPP to the customer.
queryIdquery id of the Retrieve/Search Accounts lookup.
requestorThe identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
pageSizeThe maximum number of objects returned in the query. (optional)
fromIndexTo fetch the next set of objects that start after this object (optional)
toIndexTo fetch the previous set of objects that end at this object (optional)
Returns
Task of ApiResponse (CustomerAccountsResponse)

Implemented in Orbipay.PaymentsApi.Client.Api.CustomerAccountApi.

ApiResponse<CustomerAccountsResponse> Orbipay.PaymentsApi.Client.Api.ICustomerAccountApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
ID_CUSTOMERThe unique identifier assigned by EBPP to the customer.
queryIdquery id of the Retrieve/Search Accounts lookup.
requestorThe identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
pageSizeThe maximum number of objects returned in the query. (optional)
fromIndexTo fetch the next set of objects that start after this object (optional)
toIndexTo fetch the previous set of objects that end at this object (optional)
Returns
ApiResponse of CustomerAccountsResponse

Implemented in Orbipay.PaymentsApi.Client.Api.CustomerAccountApi.

ApiResponse<CustomerAccountsResponse> Orbipay.PaymentsApi.Client.Api.ICustomerAccountApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
ID_CUSTOMERThe unique identifier assigned by EBPP to the customer.
requestorThe identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
pageSizeThe maximum number of objects returned in the query. (optional)
accountNumberThe Account Number to get details of. (optional)
statusThe status of the customer&#39;s account in EBPP. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2.... (optional)
Returns
ApiResponse of CustomerAccountsResponse

Implemented in Orbipay.PaymentsApi.Client.Api.CustomerAccountApi.


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