My Project
|
Represents a collection of functions to interact with the API endpoints More...
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, 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< CustomerResponse > | 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. 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< CustomerResponse > | 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. More... | |
ApiResponse< CustomerResponse > | GetCustomerWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER, string requestor=null, string xOPAYHeaders=null, 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< CustomersResponse > | 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. More... | |
ApiResponse< CustomersResponse > | 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. 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< CustomersResponse > | 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. More... | |
ApiResponse< CustomersResponse > | RetrieveCustomersPageWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string queryId, string requestor=null, string xOPAYHeaders=null, string 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< CustomerResponse > | UpdateCustomer (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER, UpdateCustomerRequest updateCustomerRequest, string requestor=null, string xOPAYHeaders=null, 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> <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> | More... | |
ApiResponse< CustomerResponse > | UpdateCustomerWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER, UpdateCustomerRequest updateCustomerRequest, string requestor=null, string xOPAYHeaders=null, 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> <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> | 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''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> <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> | 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''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> <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> | 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... | |
Represents a collection of functions to interact with the API endpoints
Orbipay.PaymentsApi.Client.Api.CustomerApi.CustomerApi | ( | String | basePath | ) |
Initializes a new instance of the CustomerApi class.
Orbipay.PaymentsApi.Client.Api.CustomerApi.CustomerApi | ( | Orbipay.PaymentsApi.Client.Client.Configuration | configuration = null | ) |
Initializes a new instance of the CustomerApi class using Configuration object
configuration | An instance of Configuration |
void Orbipay.PaymentsApi.Client.Api.CustomerApi.AddDefaultHeader | ( | string | key, |
string | value | ||
) |
Add default header.
key | Header field name. |
value | Header field value. |
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.
Orbipay.PaymentsApi.Client.Client.ApiException | Thrown when fails to make API call |
channel | The channel through which the API is invoked. |
clientKey | The unique identifier assigned by EBPP to the client. |
product | The product identifier corresponding to the API. |
timestamp | The timestamp for the moment when the API request is created. |
idempotentRequestKey | The unique token that clients can generate and maintain in order to identify an API request. |
requestorType | Type of the requestor of the API. |
createCustomerRequest | The JSON that contains all the attributes of customer to be created. |
requestor | The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional) |
xOPAYHeaders | Intended for the future use. (optional) |
traceId | The unique reference that can be used for tracing and debugging an API call. (optional) |
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.
Orbipay.PaymentsApi.Client.Client.ApiException | Thrown when fails to make API call |
channel | The channel through which the API is invoked. |
clientKey | The unique identifier assigned by EBPP to the client. |
product | The product identifier corresponding to the API. |
timestamp | The timestamp for the moment when the API request is created. |
idempotentRequestKey | The unique token that clients can generate and maintain in order to identify an API request. |
requestorType | Type of the requestor of the API. |
createCustomerRequest | The JSON that contains all the attributes of customer to be created. |
requestor | The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional) |
xOPAYHeaders | Intended for the future use. (optional) |
traceId | The unique reference that can be used for tracing and debugging an API call. (optional) |
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.
Orbipay.PaymentsApi.Client.Client.ApiException | Thrown when fails to make API call |
channel | The channel through which the API is invoked. |
clientKey | The unique identifier assigned by EBPP to the client. |
product | The product identifier corresponding to the API. |
timestamp | The timestamp for the moment when the API request is created. |
idempotentRequestKey | The unique token that clients can generate and maintain in order to identify an API request. |
requestorType | Type of the requestor of the API. |
createCustomerRequest | The JSON that contains all the attributes of customer to be created. |
requestor | The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional) |
xOPAYHeaders | Intended for the future use. (optional) |
traceId | The unique reference that can be used for tracing and debugging an API call. (optional) |
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.
Orbipay.PaymentsApi.Client.Client.ApiException | Thrown when fails to make API call |
channel | The channel through which the API is invoked. |
clientKey | The unique identifier assigned by EBPP to the client. |
product | The product identifier corresponding to the API. |
timestamp | The timestamp for the moment when the API request is created. |
idempotentRequestKey | The unique token that clients can generate and maintain in order to identify an API request. |
requestorType | Type of the requestor of the API. |
createCustomerRequest | The JSON that contains all the attributes of customer to be created. |
requestor | The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional) |
xOPAYHeaders | Intended for the future use. (optional) |
traceId | The unique reference that can be used for tracing and debugging an API call. (optional) |
Implements Orbipay.PaymentsApi.Client.Api.ICustomerApi.
IDictionary<String, String> Orbipay.PaymentsApi.Client.Api.CustomerApi.DefaultHeader | ( | ) |
Gets the default 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.
Orbipay.PaymentsApi.Client.Client.ApiException | Thrown when fails to make API call |
channel | The channel through which the API is invoked. |
clientKey | The unique identifier assigned by EBPP to the client. |
product | The product identifier corresponding to the API. |
timestamp | The timestamp for the moment when the API request is created. |
idempotentRequestKey | The unique token that clients can generate and maintain in order to identify an API request. |
requestorType | Type of the requestor of the API. |
ID_CUSTOMER | The unique identifier assigned by EBPP to the customer. |
requestor | The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional) |
xOPAYHeaders | Intended for the future use. (optional) |
traceId | The unique reference that can be used for tracing and debugging an API call. (optional) |
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.
Orbipay.PaymentsApi.Client.Client.ApiException | Thrown when fails to make API call |
channel | The channel through which the API is invoked. |
clientKey | The unique identifier assigned by EBPP to the client. |
product | The product identifier corresponding to the API. |
timestamp | The timestamp for the moment when the API request is created. |
idempotentRequestKey | The unique token that clients can generate and maintain in order to identify an API request. |
requestorType | Type of the requestor of the API. |
ID_CUSTOMER | The unique identifier assigned by EBPP to the customer. |
requestor | The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional) |
xOPAYHeaders | Intended for the future use. (optional) |
traceId | The unique reference that can be used for tracing and debugging an API call. (optional) |
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.
Orbipay.PaymentsApi.Client.Client.ApiException | Thrown when fails to make API call |
channel | The channel through which the API is invoked. |
clientKey | The unique identifier assigned by EBPP to the client. |
product | The product identifier corresponding to the API. |
timestamp | The timestamp for the moment when the API request is created. |
idempotentRequestKey | The unique token that clients can generate and maintain in order to identify an API request. |
requestorType | Type of the requestor of the API. |
ID_CUSTOMER | The unique identifier assigned by EBPP to the customer. |
requestor | The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional) |
xOPAYHeaders | Intended for the future use. (optional) |
traceId | The unique reference that can be used for tracing and debugging an API call. (optional) |
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.
Orbipay.PaymentsApi.Client.Client.ApiException | Thrown when fails to make API call |
channel | The channel through which the API is invoked. |
clientKey | The unique identifier assigned by EBPP to the client. |
product | The product identifier corresponding to the API. |
timestamp | The timestamp for the moment when the API request is created. |
idempotentRequestKey | The unique token that clients can generate and maintain in order to identify an API request. |
requestorType | Type of the requestor of the API. |
ID_CUSTOMER | The unique identifier assigned by EBPP to the customer. |
requestor | The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional) |
xOPAYHeaders | Intended for the future use. (optional) |
traceId | The unique reference that can be used for tracing and debugging an API call. (optional) |
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.
Orbipay.PaymentsApi.Client.Client.ApiException | Thrown when fails to make API call |
channel | The channel through which the API is invoked. |
clientKey | The unique identifier assigned by EBPP to the client. |
product | The product identifier corresponding to the API. |
timestamp | The timestamp for the moment when the API request is created. |
idempotentRequestKey | The unique token that clients can generate and maintain in order to identify an API request. |
requestorType | Type of the requestor of the API. |
requestor | The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional) |
xOPAYHeaders | Intended for the future use. (optional) |
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) |
This field contains the customer’s email address within EBPP. (optional) | |
accountNumber | Customer Account Number of the customer to get details of. (optional) |
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.
Orbipay.PaymentsApi.Client.Client.ApiException | Thrown when fails to make API call |
channel | The channel through which the API is invoked. |
clientKey | The unique identifier assigned by EBPP to the client. |
product | The product identifier corresponding to the API. |
timestamp | The timestamp for the moment when the API request is created. |
idempotentRequestKey | The unique token that clients can generate and maintain in order to identify an API request. |
requestorType | Type of the requestor of the API. |
requestor | The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional) |
xOPAYHeaders | Intended for the future use. (optional) |
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) |
This field contains the customer’s email address within EBPP. (optional) | |
accountNumber | Customer Account Number of the customer to get details of. (optional) |
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.
Orbipay.PaymentsApi.Client.Client.ApiException | Thrown when fails to make API call |
channel | The channel through which the API is invoked. |
clientKey | The unique identifier assigned by EBPP to the client. |
product | The product identifier corresponding to the API. |
timestamp | The timestamp for the moment when the API request is created. |
idempotentRequestKey | The unique token that clients can generate and maintain in order to identify an API request. |
requestorType | Type of the requestor of the API. |
requestor | The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional) |
xOPAYHeaders | Intended for the future use. (optional) |
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) |
This field contains the customer’s email address within EBPP. (optional) | |
accountNumber | Customer Account Number of the customer to get details of. (optional) |
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.
Orbipay.PaymentsApi.Client.Client.ApiException | Thrown when fails to make API call |
channel | The channel through which the API is invoked. |
clientKey | The unique identifier assigned by EBPP to the client. |
product | The product identifier corresponding to the API. |
timestamp | The timestamp for the moment when the API request is created. |
idempotentRequestKey | The unique token that clients can generate and maintain in order to identify an API request. |
requestorType | Type of the requestor of the API. |
queryId | query id of the Retrieve/Search Customers lookup. |
requestor | The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional) |
xOPAYHeaders | Intended for the future use. (optional) |
traceId | The unique reference that can be used for tracing and debugging an API call. (optional) |
pageSize | The maximum number of objects returned in the query. (optional) |
fromIndex | To fetch the next set of objects that start after this object (optional) |
toIndex | To fetch the previous set of objects that end at this object (optional) |
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.
Orbipay.PaymentsApi.Client.Client.ApiException | Thrown when fails to make API call |
channel | The channel through which the API is invoked. |
clientKey | The unique identifier assigned by EBPP to the client. |
product | The product identifier corresponding to the API. |
timestamp | The timestamp for the moment when the API request is created. |
idempotentRequestKey | The unique token that clients can generate and maintain in order to identify an API request. |
requestorType | Type of the requestor of the API. |
queryId | query id of the Retrieve/Search Customers lookup. |
requestor | The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional) |
xOPAYHeaders | Intended for the future use. (optional) |
traceId | The unique reference that can be used for tracing and debugging an API call. (optional) |
pageSize | The maximum number of objects returned in the query. (optional) |
fromIndex | To fetch the next set of objects that start after this object (optional) |
toIndex | To fetch the previous set of objects that end at this object (optional) |
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.
Orbipay.PaymentsApi.Client.Client.ApiException | Thrown when fails to make API call |
channel | The channel through which the API is invoked. |
clientKey | The unique identifier assigned by EBPP to the client. |
product | The product identifier corresponding to the API. |
timestamp | The timestamp for the moment when the API request is created. |
idempotentRequestKey | The unique token that clients can generate and maintain in order to identify an API request. |
requestorType | Type of the requestor of the API. |
queryId | query id of the Retrieve/Search Customers lookup. |
requestor | The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional) |
xOPAYHeaders | Intended for the future use. (optional) |
traceId | The unique reference that can be used for tracing and debugging an API call. (optional) |
pageSize | The maximum number of objects returned in the query. (optional) |
fromIndex | To fetch the next set of objects that start after this object (optional) |
toIndex | To fetch the previous set of objects that end at this object (optional) |
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.
Orbipay.PaymentsApi.Client.Client.ApiException | Thrown when fails to make API call |
channel | The channel through which the API is invoked. |
clientKey | The unique identifier assigned by EBPP to the client. |
product | The product identifier corresponding to the API. |
timestamp | The timestamp for the moment when the API request is created. |
idempotentRequestKey | The unique token that clients can generate and maintain in order to identify an API request. |
requestorType | Type of the requestor of the API. |
queryId | query id of the Retrieve/Search Customers lookup. |
requestor | The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional) |
xOPAYHeaders | Intended for the future use. (optional) |
traceId | The unique reference that can be used for tracing and debugging an API call. (optional) |
pageSize | The maximum number of objects returned in the query. (optional) |
fromIndex | To fetch the next set of objects that start after this object (optional) |
toIndex | To fetch the previous set of objects that end at this object (optional) |
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.
Orbipay.PaymentsApi.Client.Client.ApiException | Thrown when fails to make API call |
channel | The channel through which the API is invoked. |
clientKey | The unique identifier assigned by EBPP to the client. |
product | The product identifier corresponding to the API. |
timestamp | The timestamp for the moment when the API request is created. |
idempotentRequestKey | The unique token that clients can generate and maintain in order to identify an API request. |
requestorType | Type of the requestor of the API. |
requestor | The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional) |
xOPAYHeaders | Intended for the future use. (optional) |
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) |
This field contains the customer’s email address within EBPP. (optional) | |
accountNumber | Customer Account Number of the customer to get details of. (optional) |
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''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> <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> |
Orbipay.PaymentsApi.Client.Client.ApiException | Thrown when fails to make API call |
channel | The channel through which the API is invoked. |
clientKey | The unique identifier assigned by EBPP to the client. |
product | The product identifier corresponding to the API. |
timestamp | The timestamp for the moment when the API request is created. |
idempotentRequestKey | The unique token that clients can generate and maintain in order to identify an API request. |
requestorType | Type of the requestor of the API. |
ID_CUSTOMER | The unique identifier assigned by EBPP to the customer. |
updateCustomerRequest | JSON containing all the attributes of the customer to be updated. |
requestor | The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional) |
xOPAYHeaders | Intended for the future use. (optional) |
traceId | The unique reference that can be used for tracing and debugging an API call. (optional) |
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''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> <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> |
Orbipay.PaymentsApi.Client.Client.ApiException | Thrown when fails to make API call |
channel | The channel through which the API is invoked. |
clientKey | The unique identifier assigned by EBPP to the client. |
product | The product identifier corresponding to the API. |
timestamp | The timestamp for the moment when the API request is created. |
idempotentRequestKey | The unique token that clients can generate and maintain in order to identify an API request. |
requestorType | Type of the requestor of the API. |
ID_CUSTOMER | The unique identifier assigned by EBPP to the customer. |
updateCustomerRequest | JSON containing all the attributes of the customer to be updated. |
requestor | The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional) |
xOPAYHeaders | Intended for the future use. (optional) |
traceId | The unique reference that can be used for tracing and debugging an API call. (optional) |
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''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> <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> |
Orbipay.PaymentsApi.Client.Client.ApiException | Thrown when fails to make API call |
channel | The channel through which the API is invoked. |
clientKey | The unique identifier assigned by EBPP to the client. |
product | The product identifier corresponding to the API. |
timestamp | The timestamp for the moment when the API request is created. |
idempotentRequestKey | The unique token that clients can generate and maintain in order to identify an API request. |
requestorType | Type of the requestor of the API. |
ID_CUSTOMER | The unique identifier assigned by EBPP to the customer. |
updateCustomerRequest | JSON containing all the attributes of the customer to be updated. |
requestor | The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional) |
xOPAYHeaders | Intended for the future use. (optional) |
traceId | The unique reference that can be used for tracing and debugging an API call. (optional) |
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''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> <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> |
Orbipay.PaymentsApi.Client.Client.ApiException | Thrown when fails to make API call |
channel | The channel through which the API is invoked. |
clientKey | The unique identifier assigned by EBPP to the client. |
product | The product identifier corresponding to the API. |
timestamp | The timestamp for the moment when the API request is created. |
idempotentRequestKey | The unique token that clients can generate and maintain in order to identify an API request. |
requestorType | Type of the requestor of the API. |
ID_CUSTOMER | The unique identifier assigned by EBPP to the customer. |
updateCustomerRequest | JSON containing all the attributes of the customer to be updated. |
requestor | The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional) |
xOPAYHeaders | Intended for the future use. (optional) |
traceId | The unique reference that can be used for tracing and debugging an API call. (optional) |
Implements Orbipay.PaymentsApi.Client.Api.ICustomerApi.
|
getset |
Gets or sets the configuration object
An instance of the Configuration
|
getset |
Provides a factory method hook for the creation of exceptions.