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

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

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< CustomerResponse >	CreateCustomer (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string requestor, CreateCustomerRequest createCustomerRequest, 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< CustomerResponse >	CreateCustomerWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string requestor, CreateCustomerRequest createCustomerRequest, 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, string requestor, CreateCustomerRequest createCustomerRequest, 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, string requestor, CreateCustomerRequest createCustomerRequest, 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< CustomerResponse >	GetCustomer (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string requestor, string ID_CUSTOMER, 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< CustomerResponse >	GetCustomerWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string requestor, string ID_CUSTOMER, 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 requestor, string ID_CUSTOMER, 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 requestor, string ID_CUSTOMER, 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< Object >	InitiateContactVerification (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string requestor, InitiateContactVerificationRequest initiateContactVerificationRequest, string xOPAYHeaders=null, string traceId=null)
	Initiate Contact Verification This API generates a verification code for the specified phone number of a given customer. More...

ApiResponse< Object >	InitiateContactVerificationWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string requestor, InitiateContactVerificationRequest initiateContactVerificationRequest, string xOPAYHeaders=null, string traceId=null)
	Initiate Contact Verification This API generates a verification code for the specified phone number of a given customer. More...

async System.Threading.Tasks.Task	InitiateContactVerificationAsync (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string requestor, InitiateContactVerificationRequest initiateContactVerificationRequest, string xOPAYHeaders=null, string traceId=null)
	Initiate Contact Verification This API generates a verification code for the specified phone number of a given customer. More...

async System.Threading.Tasks.Task < ApiResponse< Object > >	InitiateContactVerificationAsyncWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string requestor, InitiateContactVerificationRequest initiateContactVerificationRequest, string xOPAYHeaders=null, string traceId=null)
	Initiate Contact Verification This API generates a verification code for the specified phone number of a given customer. More...

ApiResponse < CustomerContactResponse >	LinkCustomerContact (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string requestor, LinkCustomerContactRequest linkCustomerContactRequest, string xOPAYHeaders=null, string traceId=null)
	Link Customer Contact This API is used to link a customer's contact information to their existing account. The API takes a request body containing the customer's unique identifier and the contact information to be linked. It should be noted that for a specific contact type, such as email or sms, only one contact can be linked per customer. More...

ApiResponse < CustomerContactResponse >	LinkCustomerContactWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string requestor, LinkCustomerContactRequest linkCustomerContactRequest, string xOPAYHeaders=null, string traceId=null)
	Link Customer Contact This API is used to link a customer's contact information to their existing account. The API takes a request body containing the customer's unique identifier and the contact information to be linked. It should be noted that for a specific contact type, such as email or sms, only one contact can be linked per customer. More...

async System.Threading.Tasks.Task < CustomerContactResponse >	LinkCustomerContactAsync (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string requestor, LinkCustomerContactRequest linkCustomerContactRequest, string xOPAYHeaders=null, string traceId=null)
	Link Customer Contact This API is used to link a customer's contact information to their existing account. The API takes a request body containing the customer's unique identifier and the contact information to be linked. It should be noted that for a specific contact type, such as email or sms, only one contact can be linked per customer. More...

async System.Threading.Tasks.Task < ApiResponse < CustomerContactResponse > >	LinkCustomerContactAsyncWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string requestor, LinkCustomerContactRequest linkCustomerContactRequest, string xOPAYHeaders=null, string traceId=null)
	Link Customer Contact This API is used to link a customer's contact information to their existing account. The API takes a request body containing the customer's unique identifier and the contact information to be linked. It should be noted that for a specific contact type, such as email or sms, only one contact can be linked per customer. More...

ApiResponse< CustomersResponse >	RetrieveCustomers (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string requestor, string xOPAYHeaders=null, string traceId=null, string pageSize=null, string customerReference=null, string ssn=null, string email=null, string accountNumber=null)
	Retrieve Customer 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 Customer API will return an error if it cannot retrieve a unique customer. More...

ApiResponse< CustomersResponse >	RetrieveCustomersWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string requestor, string xOPAYHeaders=null, string traceId=null, string pageSize=null, string customerReference=null, string ssn=null, string email=null, string accountNumber=null)
	Retrieve Customer 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 Customer 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, string xOPAYHeaders=null, string traceId=null, string pageSize=null, string customerReference=null, string ssn=null, string email=null, string accountNumber=null)
	Retrieve Customer 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 Customer 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, string xOPAYHeaders=null, string traceId=null, string pageSize=null, string customerReference=null, string ssn=null, string email=null, string accountNumber=null)
	Retrieve Customer 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 Customer API will return an error if it cannot retrieve a unique customer. More...

ApiResponse< Object >	UnlinkCustomerContact (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string requestor, UnlinkCustomerContactRequest unlinkCustomerContactRequest, string xOPAYHeaders=null, string traceId=null)
	Unlink Customer Contact This API is used to unlink a customer's contact information from their account. The API takes a request body containing the customer's unique identifier and the contact information to be unlinked. More...

ApiResponse< Object >	UnlinkCustomerContactWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string requestor, UnlinkCustomerContactRequest unlinkCustomerContactRequest, string xOPAYHeaders=null, string traceId=null)
	Unlink Customer Contact This API is used to unlink a customer's contact information from their account. The API takes a request body containing the customer's unique identifier and the contact information to be unlinked. More...

async System.Threading.Tasks.Task	UnlinkCustomerContactAsync (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string requestor, UnlinkCustomerContactRequest unlinkCustomerContactRequest, string xOPAYHeaders=null, string traceId=null)
	Unlink Customer Contact This API is used to unlink a customer's contact information from their account. The API takes a request body containing the customer's unique identifier and the contact information to be unlinked. More...

async System.Threading.Tasks.Task < ApiResponse< Object > >	UnlinkCustomerContactAsyncWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string requestor, UnlinkCustomerContactRequest unlinkCustomerContactRequest, string xOPAYHeaders=null, string traceId=null)
	Unlink Customer Contact This API is used to unlink a customer's contact information from their account. The API takes a request body containing the customer's unique identifier and the contact information to be unlinked. More...

ApiResponse< CustomerResponse >	UpdateCustomer (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string requestor, string ID_CUSTOMER, UpdateCustomerRequest updateCustomerRequest, string xOPAYHeaders=null, string traceId=null)
	Update Customer The Update Customer API is used to edit the customer''s personal details, accounts or the customer''s status. Only the information being updated needs to be sent in the request, along with the id of the customer being updated. A customer can also be associated with new customer accounts using the API. <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> </ul> \| \| active \| revoked \| <ul> <li>external_user</li> </ul> </ul> \| \| suspended \| active \| <ul> <li>external_user</li> </ul> </ul> \| \| suspended \| revoked \| <ul> <li>external_user</li> </ul> </ul> \| \| revoked \| active \| <ul> <li>external_user</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> </ul> \| \| inactive \| active \| <ul> <li>external_user</li> </ul> </ul> \| \| active \| incollections \| <ul> <li>external_user</li> </ul> </ul> \| \| incollections \| active \| <ul> <li>external_user</li> </ul> </ul> \| \| inactive \| incollections \| <ul> <li>external_user</li> </ul> </ul> \| \| incollections \| inactive \| <ul> <li>external_user</li> </ul> </ul> \| \| active \| inbankruptcy \| <ul> <li>external_user</li> </ul> </ul> \| \| incollections \| inbankruptcy \| <ul> <li>external_user</li> </ul> </ul> \| \| inbankruptcy \| active \| <ul> <li>external_user</li> </ul> </ul> \| \| inbankruptcy \| inactive \| <ul> <li>external_user</li> </ul> </ul> \| More...

ApiResponse< CustomerResponse >	UpdateCustomerWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string requestor, string ID_CUSTOMER, UpdateCustomerRequest updateCustomerRequest, string xOPAYHeaders=null, string traceId=null)
	Update Customer The Update Customer API is used to edit the customer''s personal details, accounts or the customer''s status. Only the information being updated needs to be sent in the request, along with the id of the customer being updated. A customer can also be associated with new customer accounts using the API. <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> </ul> \| \| active \| revoked \| <ul> <li>external_user</li> </ul> </ul> \| \| suspended \| active \| <ul> <li>external_user</li> </ul> </ul> \| \| suspended \| revoked \| <ul> <li>external_user</li> </ul> </ul> \| \| revoked \| active \| <ul> <li>external_user</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> </ul> \| \| inactive \| active \| <ul> <li>external_user</li> </ul> </ul> \| \| active \| incollections \| <ul> <li>external_user</li> </ul> </ul> \| \| incollections \| active \| <ul> <li>external_user</li> </ul> </ul> \| \| inactive \| incollections \| <ul> <li>external_user</li> </ul> </ul> \| \| incollections \| inactive \| <ul> <li>external_user</li> </ul> </ul> \| \| active \| inbankruptcy \| <ul> <li>external_user</li> </ul> </ul> \| \| incollections \| inbankruptcy \| <ul> <li>external_user</li> </ul> </ul> \| \| inbankruptcy \| active \| <ul> <li>external_user</li> </ul> </ul> \| \| inbankruptcy \| inactive \| <ul> <li>external_user</li> </ul> </ul> \| More...

async System.Threading.Tasks.Task < CustomerResponse >	UpdateCustomerAsync (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string requestor, string ID_CUSTOMER, UpdateCustomerRequest updateCustomerRequest, string xOPAYHeaders=null, string traceId=null)
	Update Customer The Update Customer API is used to edit the customer''s personal details, accounts or the customer''s status. Only the information being updated needs to be sent in the request, along with the id of the customer being updated. A customer can also be associated with new customer accounts using the API. <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> </ul> \| \| active \| revoked \| <ul> <li>external_user</li> </ul> </ul> \| \| suspended \| active \| <ul> <li>external_user</li> </ul> </ul> \| \| suspended \| revoked \| <ul> <li>external_user</li> </ul> </ul> \| \| revoked \| active \| <ul> <li>external_user</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> </ul> \| \| inactive \| active \| <ul> <li>external_user</li> </ul> </ul> \| \| active \| incollections \| <ul> <li>external_user</li> </ul> </ul> \| \| incollections \| active \| <ul> <li>external_user</li> </ul> </ul> \| \| inactive \| incollections \| <ul> <li>external_user</li> </ul> </ul> \| \| incollections \| inactive \| <ul> <li>external_user</li> </ul> </ul> \| \| active \| inbankruptcy \| <ul> <li>external_user</li> </ul> </ul> \| \| incollections \| inbankruptcy \| <ul> <li>external_user</li> </ul> </ul> \| \| inbankruptcy \| active \| <ul> <li>external_user</li> </ul> </ul> \| \| inbankruptcy \| inactive \| <ul> <li>external_user</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 requestor, string ID_CUSTOMER, UpdateCustomerRequest updateCustomerRequest, string xOPAYHeaders=null, string traceId=null)
	Update Customer The Update Customer API is used to edit the customer''s personal details, accounts or the customer''s status. Only the information being updated needs to be sent in the request, along with the id of the customer being updated. A customer can also be associated with new customer accounts using the API. <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> </ul> \| \| active \| revoked \| <ul> <li>external_user</li> </ul> </ul> \| \| suspended \| active \| <ul> <li>external_user</li> </ul> </ul> \| \| suspended \| revoked \| <ul> <li>external_user</li> </ul> </ul> \| \| revoked \| active \| <ul> <li>external_user</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> </ul> \| \| inactive \| active \| <ul> <li>external_user</li> </ul> </ul> \| \| active \| incollections \| <ul> <li>external_user</li> </ul> </ul> \| \| incollections \| active \| <ul> <li>external_user</li> </ul> </ul> \| \| inactive \| incollections \| <ul> <li>external_user</li> </ul> </ul> \| \| incollections \| inactive \| <ul> <li>external_user</li> </ul> </ul> \| \| active \| inbankruptcy \| <ul> <li>external_user</li> </ul> </ul> \| \| incollections \| inbankruptcy \| <ul> <li>external_user</li> </ul> </ul> \| \| inbankruptcy \| active \| <ul> <li>external_user</li> </ul> </ul> \| \| inbankruptcy \| inactive \| <ul> <li>external_user</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

configuration An instance of Configuration

Returns

Member Function Documentation

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

Add default header.

Parameters

key	Header field name.
value	Header field value.

Returns

ApiResponse<CustomerResponse> Orbipay.PaymentsApi.Client.Api.CustomerApi.CreateCustomer	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	requestor,
		CreateCustomerRequest	createCustomerRequest,
		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.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
requestor	The identifier for the requestor of the API, in EBPP. The value to be passed in the requestor field would depend on the requestor_type. If the requestor_type is "customer", the requestor should be “guest”. This is typically used in the case of self registration, where there is no EBPP generated customer id yet. If the requestor_type is "external_user", the requestor can be any unique identifier that the client may have for the external agent.
createCustomerRequest	The JSON that contains all the attributes of customer to be created.
xOPAYHeaders	Intended for the future use. (optional)
traceId	The 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,
		string	requestor,
		CreateCustomerRequest	createCustomerRequest,
		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.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
requestor	The identifier for the requestor of the API, in EBPP. The value to be passed in the requestor field would depend on the requestor_type. If the requestor_type is "customer", the requestor should be “guest”. This is typically used in the case of self registration, where there is no EBPP generated customer id yet. If the requestor_type is "external_user", the requestor can be any unique identifier that the client may have for the external agent.
createCustomerRequest	The JSON that contains all the attributes of customer to be created.
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns: Task of 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,
		string	requestor,
		CreateCustomerRequest	createCustomerRequest,
		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.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
requestor	The identifier for the requestor of the API, in EBPP. The value to be passed in the requestor field would depend on the requestor_type. If the requestor_type is "customer", the requestor should be “guest”. This is typically used in the case of self registration, where there is no EBPP generated customer id yet. If the requestor_type is "external_user", the requestor can be any unique identifier that the client may have for the external agent.
createCustomerRequest	The JSON that contains all the attributes of customer to be created.
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns: Task of ApiResponse (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,
		string	requestor,
		CreateCustomerRequest	createCustomerRequest,
		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.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
requestor	The identifier for the requestor of the API, in EBPP. The value to be passed in the requestor field would depend on the requestor_type. If the requestor_type is "customer", the requestor should be “guest”. This is typically used in the case of self registration, where there is no EBPP generated customer id yet. If the requestor_type is "external_user", the requestor can be any unique identifier that the client may have for the external agent.
createCustomerRequest	The JSON that contains all the attributes of customer to be created.
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns: ApiResponse of 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	requestor,
		string	ID_CUSTOMER,
		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.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
requestor	The identifier for the requestor of the API.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
xOPAYHeaders	Intended for the future use. (optional)
traceId	The 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	requestor,
		string	ID_CUSTOMER,
		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.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
requestor	The identifier for the requestor of the API.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns: Task of 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	requestor,
		string	ID_CUSTOMER,
		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.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
requestor	The identifier for the requestor of the API.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns: Task of ApiResponse (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	requestor,
		string	ID_CUSTOMER,
		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.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
requestor	The identifier for the requestor of the API.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns: ApiResponse of CustomerResponse

Implements Orbipay.PaymentsApi.Client.Api.ICustomerApi.

ApiResponse<Object> Orbipay.PaymentsApi.Client.Api.CustomerApi.InitiateContactVerification	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	requestor,
		InitiateContactVerificationRequest	initiateContactVerificationRequest,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Initiate Contact Verification This API generates a verification code for the specified phone number of a given customer.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
requestor	The identifier for the requestor of the API.
initiateContactVerificationRequest	JSON containing all the fields required to Initiate Contact Verification.
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns

Implements Orbipay.PaymentsApi.Client.Api.ICustomerApi.

async System.Threading.Tasks.Task Orbipay.PaymentsApi.Client.Api.CustomerApi.InitiateContactVerificationAsync	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	requestor,
		InitiateContactVerificationRequest	initiateContactVerificationRequest,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Initiate Contact Verification This API generates a verification code for the specified phone number of a given customer.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
requestor	The identifier for the requestor of the API.
initiateContactVerificationRequest	JSON containing all the fields required to Initiate Contact Verification.
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns: Task of void

Implements Orbipay.PaymentsApi.Client.Api.ICustomerApi.

async System.Threading.Tasks.Task<ApiResponse<Object> > Orbipay.PaymentsApi.Client.Api.CustomerApi.InitiateContactVerificationAsyncWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	requestor,
		InitiateContactVerificationRequest	initiateContactVerificationRequest,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Initiate Contact Verification This API generates a verification code for the specified phone number of a given customer.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
requestor	The identifier for the requestor of the API.
initiateContactVerificationRequest	JSON containing all the fields required to Initiate Contact Verification.
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns: Task of ApiResponse

Implements Orbipay.PaymentsApi.Client.Api.ICustomerApi.

ApiResponse<Object> Orbipay.PaymentsApi.Client.Api.CustomerApi.InitiateContactVerificationWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	requestor,
		InitiateContactVerificationRequest	initiateContactVerificationRequest,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Initiate Contact Verification This API generates a verification code for the specified phone number of a given customer.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
requestor	The identifier for the requestor of the API.
initiateContactVerificationRequest	JSON containing all the fields required to Initiate Contact Verification.
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns: ApiResponse of Object(void)

Implements Orbipay.PaymentsApi.Client.Api.ICustomerApi.

ApiResponse<CustomerContactResponse> Orbipay.PaymentsApi.Client.Api.CustomerApi.LinkCustomerContact	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	requestor,
		LinkCustomerContactRequest	linkCustomerContactRequest,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Link Customer Contact This API is used to link a customer's contact information to their existing account. The API takes a request body containing the customer's unique identifier and the contact information to be linked. It should be noted that for a specific contact type, such as email or sms, only one contact can be linked per customer.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
requestor	The identifier for the requestor of the API.
linkCustomerContactRequest	JSON containing all the fields required to link a contact to customer.
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns: CustomerContactResponse

Implements Orbipay.PaymentsApi.Client.Api.ICustomerApi.

async System.Threading.Tasks.Task<CustomerContactResponse> Orbipay.PaymentsApi.Client.Api.CustomerApi.LinkCustomerContactAsync	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	requestor,
		LinkCustomerContactRequest	linkCustomerContactRequest,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Link Customer Contact This API is used to link a customer's contact information to their existing account. The API takes a request body containing the customer's unique identifier and the contact information to be linked. It should be noted that for a specific contact type, such as email or sms, only one contact can be linked per customer.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
requestor	The identifier for the requestor of the API.
linkCustomerContactRequest	JSON containing all the fields required to link a contact to customer.
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns: Task of CustomerContactResponse

Implements Orbipay.PaymentsApi.Client.Api.ICustomerApi.

async System.Threading.Tasks.Task<ApiResponse<CustomerContactResponse> > Orbipay.PaymentsApi.Client.Api.CustomerApi.LinkCustomerContactAsyncWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	requestor,
		LinkCustomerContactRequest	linkCustomerContactRequest,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Link Customer Contact This API is used to link a customer's contact information to their existing account. The API takes a request body containing the customer's unique identifier and the contact information to be linked. It should be noted that for a specific contact type, such as email or sms, only one contact can be linked per customer.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
requestor	The identifier for the requestor of the API.
linkCustomerContactRequest	JSON containing all the fields required to link a contact to customer.
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns: Task of ApiResponse (CustomerContactResponse)

Implements Orbipay.PaymentsApi.Client.Api.ICustomerApi.

ApiResponse< CustomerContactResponse > Orbipay.PaymentsApi.Client.Api.CustomerApi.LinkCustomerContactWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	requestor,
		LinkCustomerContactRequest	linkCustomerContactRequest,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Link Customer Contact This API is used to link a customer's contact information to their existing account. The API takes a request body containing the customer's unique identifier and the contact information to be linked. It should be noted that for a specific contact type, such as email or sms, only one contact can be linked per customer.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
requestor	The identifier for the requestor of the API.
linkCustomerContactRequest	JSON containing all the fields required to link a contact to customer.
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns: ApiResponse of CustomerContactResponse

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,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`,
		string	pageSize = `null`,
		string	customerReference = `null`,
		string	ssn = `null`,
		string	email = `null`,
		string	accountNumber = `null`
	)

Retrieve Customer 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 Customer API will return an error if it cannot retrieve a unique customer.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
requestor	The identifier for the requestor of the API, in EBPP. The value to be passed in the requestor field would depend on the requestor_type. If the requestor_type is "customer", the requestor should be set to ''guest''. If the requestor_type is "external_user", the requestor can be any unique identifier that the client may have for the external agent.
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)
pageSize	The maximum number of objects returned in the query. (optional)
customerReference	Unique ID assigned by the biller/client system for a given customer. (optional)
ssn	The SSN of the customer if the account holder is an individual or the tax ID, if the customer is a business. (optional)
email	This field contains the customer’s email address within EBPP. (optional)
accountNumber	Customer Account Number of the customer to get details of. (optional)

Returns: 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,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`,
		string	pageSize = `null`,
		string	customerReference = `null`,
		string	ssn = `null`,
		string	email = `null`,
		string	accountNumber = `null`
	)

Retrieve Customer 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 Customer API will return an error if it cannot retrieve a unique customer.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
requestor	The identifier for the requestor of the API, in EBPP. The value to be passed in the requestor field would depend on the requestor_type. If the requestor_type is "customer", the requestor should be set to ''guest''. If the requestor_type is "external_user", the requestor can be any unique identifier that the client may have for the external agent.
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)
pageSize	The maximum number of objects returned in the query. (optional)
customerReference	Unique ID assigned by the biller/client system for a given customer. (optional)
ssn	The SSN of the customer if the account holder is an individual or the tax ID, if the customer is a business. (optional)
email	This field contains the customer’s email address within EBPP. (optional)
accountNumber	Customer Account Number of the customer to get details of. (optional)

Returns: Task of CustomersResponse

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,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`,
		string	pageSize = `null`,
		string	customerReference = `null`,
		string	ssn = `null`,
		string	email = `null`,
		string	accountNumber = `null`
	)

Retrieve Customer 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 Customer API will return an error if it cannot retrieve a unique customer.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
requestor	The identifier for the requestor of the API, in EBPP. The value to be passed in the requestor field would depend on the requestor_type. If the requestor_type is "customer", the requestor should be set to ''guest''. If the requestor_type is "external_user", the requestor can be any unique identifier that the client may have for the external agent.
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)
pageSize	The maximum number of objects returned in the query. (optional)
customerReference	Unique ID assigned by the biller/client system for a given customer. (optional)
ssn	The SSN of the customer if the account holder is an individual or the tax ID, if the customer is a business. (optional)
email	This field contains the customer’s email address within EBPP. (optional)
accountNumber	Customer Account Number of the customer to get details of. (optional)

Returns: Task of ApiResponse (CustomersResponse)

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,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`,
		string	pageSize = `null`,
		string	customerReference = `null`,
		string	ssn = `null`,
		string	email = `null`,
		string	accountNumber = `null`
	)

Retrieve Customer 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 Customer API will return an error if it cannot retrieve a unique customer.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
requestor	The identifier for the requestor of the API, in EBPP. The value to be passed in the requestor field would depend on the requestor_type. If the requestor_type is "customer", the requestor should be set to ''guest''. If the requestor_type is "external_user", the requestor can be any unique identifier that the client may have for the external agent.
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)
pageSize	The maximum number of objects returned in the query. (optional)
customerReference	Unique ID assigned by the biller/client system for a given customer. (optional)
ssn	The SSN of the customer if the account holder is an individual or the tax ID, if the customer is a business. (optional)
email	This field contains the customer’s email address within EBPP. (optional)
accountNumber	Customer Account Number of the customer to get details of. (optional)

Returns: ApiResponse of CustomersResponse

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<Object> Orbipay.PaymentsApi.Client.Api.CustomerApi.UnlinkCustomerContact	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	requestor,
		UnlinkCustomerContactRequest	unlinkCustomerContactRequest,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Unlink Customer Contact This API is used to unlink a customer's contact information from their account. The API takes a request body containing the customer's unique identifier and the contact information to be unlinked.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
requestor	The identifier for the requestor of the API.
unlinkCustomerContactRequest	JSON containing all the fields required to unlink a contact from the customer.
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns

Implements Orbipay.PaymentsApi.Client.Api.ICustomerApi.

async System.Threading.Tasks.Task Orbipay.PaymentsApi.Client.Api.CustomerApi.UnlinkCustomerContactAsync	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	requestor,
		UnlinkCustomerContactRequest	unlinkCustomerContactRequest,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Unlink Customer Contact This API is used to unlink a customer's contact information from their account. The API takes a request body containing the customer's unique identifier and the contact information to be unlinked.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
requestor	The identifier for the requestor of the API.
unlinkCustomerContactRequest	JSON containing all the fields required to unlink a contact from the customer.
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns: Task of void

Implements Orbipay.PaymentsApi.Client.Api.ICustomerApi.

async System.Threading.Tasks.Task<ApiResponse<Object> > Orbipay.PaymentsApi.Client.Api.CustomerApi.UnlinkCustomerContactAsyncWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	requestor,
		UnlinkCustomerContactRequest	unlinkCustomerContactRequest,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Unlink Customer Contact This API is used to unlink a customer's contact information from their account. The API takes a request body containing the customer's unique identifier and the contact information to be unlinked.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
requestor	The identifier for the requestor of the API.
unlinkCustomerContactRequest	JSON containing all the fields required to unlink a contact from the customer.
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns: Task of ApiResponse

Implements Orbipay.PaymentsApi.Client.Api.ICustomerApi.

ApiResponse<Object> Orbipay.PaymentsApi.Client.Api.CustomerApi.UnlinkCustomerContactWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	requestor,
		UnlinkCustomerContactRequest	unlinkCustomerContactRequest,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Unlink Customer Contact This API is used to unlink a customer's contact information from their account. The API takes a request body containing the customer's unique identifier and the contact information to be unlinked.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
requestor	The identifier for the requestor of the API.
unlinkCustomerContactRequest	JSON containing all the fields required to unlink a contact from the customer.
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns: ApiResponse of Object(void)

Implements Orbipay.PaymentsApi.Client.Api.ICustomerApi.

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

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
requestor	The identifier for the requestor of the API.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
updateCustomerRequest	JSON containing all the attributes of the customer to be updated.
xOPAYHeaders	Intended for the future use. (optional)
traceId	The 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	requestor,
		string	ID_CUSTOMER,
		UpdateCustomerRequest	updateCustomerRequest,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

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

Returns: Task of 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	requestor,
		string	ID_CUSTOMER,
		UpdateCustomerRequest	updateCustomerRequest,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

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

Returns: Task of ApiResponse (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	requestor,
		string	ID_CUSTOMER,
		UpdateCustomerRequest	updateCustomerRequest,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

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

Returns: ApiResponse of 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:

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

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation