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

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

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

Public Member Functions

 CustomerApi (String basePath)
 Initializes a new instance of the CustomerApi class. More...
 
 CustomerApi (Orbipay.PaymentsApi.Client.Client.Configuration configuration=null)
 Initializes a new instance of the CustomerApi 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< CustomerResponseCreateCustomer (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, CreateCustomerRequest createCustomerRequest, string requestor=null, string xOPAYHeaders=null, string traceId=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. More...
 
ApiResponse< CustomerResponseCreateCustomerWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, CreateCustomerRequest createCustomerRequest, string requestor=null, string xOPAYHeaders=null, string traceId=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. More...
 
async
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, string traceId=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. More...
 
async
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, string traceId=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. More...
 
ApiResponse< CustomerResponseGetCustomer (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER, string requestor=null, string xOPAYHeaders=null, string traceId=null)
 Get Customer The Get Customer API is used to retrieve the details of the customer based on the id. More...
 
ApiResponse< CustomerResponseGetCustomerWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER, string requestor=null, string xOPAYHeaders=null, string traceId=null)
 Get Customer The Get Customer API is used to retrieve the details of the customer based on the id. More...
 
async
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, string traceId=null)
 Get Customer The Get Customer API is used to retrieve the details of the customer based on the id. More...
 
async
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, string traceId=null)
 Get Customer The Get Customer API is used to retrieve the details of the customer based on the id. More...
 
ApiResponse< CustomersResponseRetrieveCustomers (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string requestor=null, string xOPAYHeaders=null, string traceId=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. More...
 
ApiResponse< CustomersResponseRetrieveCustomersWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string requestor=null, string xOPAYHeaders=null, string traceId=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. More...
 
async
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 traceId=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. More...
 
async
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 traceId=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. More...
 
ApiResponse< CustomersResponseRetrieveCustomersPage (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string queryId, string requestor=null, string xOPAYHeaders=null, string traceId=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. More...
 
ApiResponse< CustomersResponseRetrieveCustomersPageWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string queryId, string requestor=null, string xOPAYHeaders=null, string traceId=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. More...
 
async
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 traceId=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. More...
 
async
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 traceId=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. More...
 
ApiResponse< CustomerResponseUpdateCustomer (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER, UpdateCustomerRequest updateCustomerRequest, string requestor=null, string xOPAYHeaders=null, string traceId=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> | | active | incollections | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | incollections | active | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | inactive | incollections | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | incollections | inactive | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | active | inbankruptcy | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | incollections | inbankruptcy | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | inbankruptcy | active | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | inbankruptcy | closed | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | More...
 
ApiResponse< CustomerResponseUpdateCustomerWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER, UpdateCustomerRequest updateCustomerRequest, string requestor=null, string xOPAYHeaders=null, string traceId=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> | | active | incollections | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | incollections | active | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | inactive | incollections | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | incollections | inactive | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | active | inbankruptcy | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | incollections | inbankruptcy | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | inbankruptcy | active | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | inbankruptcy | closed | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | More...
 
async
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, string traceId=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> | | active | incollections | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | incollections | active | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | inactive | incollections | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | incollections | inactive | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | active | inbankruptcy | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | incollections | inbankruptcy | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | inbankruptcy | active | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | inbankruptcy | closed | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | More...
 
async
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, string traceId=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> | | active | incollections | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | incollections | active | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | inactive | incollections | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | incollections | inactive | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | active | inbankruptcy | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | incollections | inbankruptcy | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | inbankruptcy | active | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | inbankruptcy | closed | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | 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.CustomerApi.CustomerApi ( String  basePath)

Initializes a new instance of the CustomerApi class.

Returns
Orbipay.PaymentsApi.Client.Api.CustomerApi.CustomerApi ( Orbipay.PaymentsApi.Client.Client.Configuration  configuration = null)

Initializes a new instance of the CustomerApi class using Configuration object

Parameters
configurationAn instance of Configuration
Returns

Member Function Documentation

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

Add default header.

Parameters
keyHeader field name.
valueHeader field value.
Returns
ApiResponse<CustomerResponse> Orbipay.PaymentsApi.Client.Api.CustomerApi.CreateCustomer ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
CreateCustomerRequest  createCustomerRequest,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = 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.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.
createCustomerRequestThe JSON that contains all the attributes of customer to be created.
requestorThe identifier for the requestor of the API. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
Returns
CustomerResponse

Implements Orbipay.PaymentsApi.Client.Api.ICustomerApi.

async System.Threading.Tasks.Task<CustomerResponse> Orbipay.PaymentsApi.Client.Api.CustomerApi.CreateCustomerAsync ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
CreateCustomerRequest  createCustomerRequest,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = 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.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.
createCustomerRequestThe JSON that contains all the attributes of customer to be created.
requestorThe identifier for the requestor of the API. (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 CustomerResponse

Implements Orbipay.PaymentsApi.Client.Api.ICustomerApi.

async System.Threading.Tasks.Task<ApiResponse<CustomerResponse> > Orbipay.PaymentsApi.Client.Api.CustomerApi.CreateCustomerAsyncWithHttpInfo ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
CreateCustomerRequest  createCustomerRequest,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = 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.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.
createCustomerRequestThe JSON that contains all the attributes of customer to be created.
requestorThe identifier for the requestor of the API. (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 (CustomerResponse)

Implements Orbipay.PaymentsApi.Client.Api.ICustomerApi.

ApiResponse< CustomerResponse > Orbipay.PaymentsApi.Client.Api.CustomerApi.CreateCustomerWithHttpInfo ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
CreateCustomerRequest  createCustomerRequest,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = 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.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.
createCustomerRequestThe JSON that contains all the attributes of customer to be created.
requestorThe identifier for the requestor of the API. (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 CustomerResponse

Implements Orbipay.PaymentsApi.Client.Api.ICustomerApi.

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

Gets the default header.

Returns
Dictionary of HTTP header
String Orbipay.PaymentsApi.Client.Api.CustomerApi.GetBasePath ( )

Gets the base path of the API client.

The base path

Implements Orbipay.PaymentsApi.Client.Client.IApiAccessor.

ApiResponse<CustomerResponse> Orbipay.PaymentsApi.Client.Api.CustomerApi.GetCustomer ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
string  ID_CUSTOMER,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = 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.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. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
Returns
CustomerResponse

Implements Orbipay.PaymentsApi.Client.Api.ICustomerApi.

async System.Threading.Tasks.Task<CustomerResponse> Orbipay.PaymentsApi.Client.Api.CustomerApi.GetCustomerAsync ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
string  ID_CUSTOMER,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = 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.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. (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 CustomerResponse

Implements Orbipay.PaymentsApi.Client.Api.ICustomerApi.

async System.Threading.Tasks.Task<ApiResponse<CustomerResponse> > Orbipay.PaymentsApi.Client.Api.CustomerApi.GetCustomerAsyncWithHttpInfo ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
string  ID_CUSTOMER,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = 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.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. (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 (CustomerResponse)

Implements Orbipay.PaymentsApi.Client.Api.ICustomerApi.

ApiResponse< CustomerResponse > Orbipay.PaymentsApi.Client.Api.CustomerApi.GetCustomerWithHttpInfo ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
string  ID_CUSTOMER,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = 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.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. (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 CustomerResponse

Implements Orbipay.PaymentsApi.Client.Api.ICustomerApi.

ApiResponse<CustomersResponse> Orbipay.PaymentsApi.Client.Api.CustomerApi.RetrieveCustomers ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = 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.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.
requestorThe identifier for the requestor of the API. (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)
customerReferenceUnique ID assigned by the biller/client system for a given customer. (optional)
ssnThe SSN of the customer if the account holder is an individual or the tax ID, if the customer is a business. (optional)
emailThis field contains the customer’s email address within EBPP. (optional)
accountNumberCustomer Account Number of the customer to get details of. (optional)
Returns
CustomersResponse

Implements Orbipay.PaymentsApi.Client.Api.ICustomerApi.

async System.Threading.Tasks.Task<CustomersResponse> Orbipay.PaymentsApi.Client.Api.CustomerApi.RetrieveCustomersAsync ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = 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.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.
requestorThe identifier for the requestor of the API. (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)
customerReferenceUnique ID assigned by the biller/client system for a given customer. (optional)
ssnThe SSN of the customer if the account holder is an individual or the tax ID, if the customer is a business. (optional)
emailThis field contains the customer’s email address within EBPP. (optional)
accountNumberCustomer Account Number of the customer to get details of. (optional)
Returns
Task of CustomersResponse

Implements Orbipay.PaymentsApi.Client.Api.ICustomerApi.

async System.Threading.Tasks.Task<ApiResponse<CustomersResponse> > Orbipay.PaymentsApi.Client.Api.CustomerApi.RetrieveCustomersAsyncWithHttpInfo ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = 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.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.
requestorThe identifier for the requestor of the API. (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)
customerReferenceUnique ID assigned by the biller/client system for a given customer. (optional)
ssnThe SSN of the customer if the account holder is an individual or the tax ID, if the customer is a business. (optional)
emailThis field contains the customer’s email address within EBPP. (optional)
accountNumberCustomer Account Number of the customer to get details of. (optional)
Returns
Task of ApiResponse (CustomersResponse)

Implements Orbipay.PaymentsApi.Client.Api.ICustomerApi.

ApiResponse<CustomersResponse> Orbipay.PaymentsApi.Client.Api.CustomerApi.RetrieveCustomersPage ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
string  queryId,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = 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.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.
queryIdquery id of the Retrieve/Search Customers lookup.
requestorThe identifier for the requestor of the API. (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
CustomersResponse

Implements Orbipay.PaymentsApi.Client.Api.ICustomerApi.

async System.Threading.Tasks.Task<CustomersResponse> Orbipay.PaymentsApi.Client.Api.CustomerApi.RetrieveCustomersPageAsync ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
string  queryId,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = 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.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.
queryIdquery id of the Retrieve/Search Customers lookup.
requestorThe identifier for the requestor of the API. (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 CustomersResponse

Implements Orbipay.PaymentsApi.Client.Api.ICustomerApi.

async System.Threading.Tasks.Task<ApiResponse<CustomersResponse> > Orbipay.PaymentsApi.Client.Api.CustomerApi.RetrieveCustomersPageAsyncWithHttpInfo ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
string  queryId,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = 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.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.
queryIdquery id of the Retrieve/Search Customers lookup.
requestorThe identifier for the requestor of the API. (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 (CustomersResponse)

Implements Orbipay.PaymentsApi.Client.Api.ICustomerApi.

ApiResponse< CustomersResponse > Orbipay.PaymentsApi.Client.Api.CustomerApi.RetrieveCustomersPageWithHttpInfo ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
string  queryId,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = 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.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.
queryIdquery id of the Retrieve/Search Customers lookup.
requestorThe identifier for the requestor of the API. (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 CustomersResponse

Implements Orbipay.PaymentsApi.Client.Api.ICustomerApi.

ApiResponse< CustomersResponse > Orbipay.PaymentsApi.Client.Api.CustomerApi.RetrieveCustomersWithHttpInfo ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = 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.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.
requestorThe identifier for the requestor of the API. (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)
customerReferenceUnique ID assigned by the biller/client system for a given customer. (optional)
ssnThe SSN of the customer if the account holder is an individual or the tax ID, if the customer is a business. (optional)
emailThis field contains the customer’s email address within EBPP. (optional)
accountNumberCustomer Account Number of the customer to get details of. (optional)
Returns
ApiResponse of CustomersResponse

Implements Orbipay.PaymentsApi.Client.Api.ICustomerApi.

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

Sets the base path of the API client.

The base path

ApiResponse<CustomerResponse> Orbipay.PaymentsApi.Client.Api.CustomerApi.UpdateCustomer ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
string  ID_CUSTOMER,
UpdateCustomerRequest  updateCustomerRequest,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = 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> | | active | incollections | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | incollections | active | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | inactive | incollections | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | incollections | inactive | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | active | inbankruptcy | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | incollections | inbankruptcy | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | inbankruptcy | active | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | inbankruptcy | closed | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> |

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.
updateCustomerRequestJSON containing all the attributes of the customer to be updated.
requestorThe identifier for the requestor of the API. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
Returns
CustomerResponse

Implements Orbipay.PaymentsApi.Client.Api.ICustomerApi.

async System.Threading.Tasks.Task<CustomerResponse> Orbipay.PaymentsApi.Client.Api.CustomerApi.UpdateCustomerAsync ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
string  ID_CUSTOMER,
UpdateCustomerRequest  updateCustomerRequest,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = 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> | | active | incollections | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | incollections | active | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | inactive | incollections | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | incollections | inactive | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | active | inbankruptcy | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | incollections | inbankruptcy | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | inbankruptcy | active | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | inbankruptcy | closed | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> |

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.
updateCustomerRequestJSON containing all the attributes of the customer to be updated.
requestorThe identifier for the requestor of the API. (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 CustomerResponse

Implements Orbipay.PaymentsApi.Client.Api.ICustomerApi.

async System.Threading.Tasks.Task<ApiResponse<CustomerResponse> > Orbipay.PaymentsApi.Client.Api.CustomerApi.UpdateCustomerAsyncWithHttpInfo ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
string  ID_CUSTOMER,
UpdateCustomerRequest  updateCustomerRequest,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = 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> | | active | incollections | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | incollections | active | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | inactive | incollections | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | incollections | inactive | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | active | inbankruptcy | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | incollections | inbankruptcy | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | inbankruptcy | active | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | inbankruptcy | closed | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> |

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.
updateCustomerRequestJSON containing all the attributes of the customer to be updated.
requestorThe identifier for the requestor of the API. (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 (CustomerResponse)

Implements Orbipay.PaymentsApi.Client.Api.ICustomerApi.

ApiResponse< CustomerResponse > Orbipay.PaymentsApi.Client.Api.CustomerApi.UpdateCustomerWithHttpInfo ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
string  ID_CUSTOMER,
UpdateCustomerRequest  updateCustomerRequest,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = 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> | | active | incollections | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | incollections | active | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | inactive | incollections | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | incollections | inactive | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | active | inbankruptcy | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | incollections | inbankruptcy | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | inbankruptcy | active | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | inbankruptcy | closed | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> |

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.
updateCustomerRequestJSON containing all the attributes of the customer to be updated.
requestorThe identifier for the requestor of the API. (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 CustomerResponse

Implements Orbipay.PaymentsApi.Client.Api.ICustomerApi.

Property Documentation

Orbipay.PaymentsApi.Client.Client.Configuration Orbipay.PaymentsApi.Client.Api.CustomerApi.Configuration
getset

Gets or sets the configuration object

An instance of the Configuration

Orbipay.PaymentsApi.Client.Client.ExceptionFactory Orbipay.PaymentsApi.Client.Api.CustomerApi.ExceptionFactory
getset

Provides a factory method hook for the creation of exceptions.


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