module:api/CustomerApi(apiClientopt)

new module:api/CustomerApi(apiClientopt)

This class subject to change without prior notice, Please dont use this class directly.

Constructs a new CustomerApi.
Parameters:
Name Type Attributes Description
apiClient module:ApiClient <optional>

Optional API client implementation to use, default to module:ApiClient#instance if unspecified.

Methods

createCustomer(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, create_customer_request, opts, callback)

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.

Parameters:
Name Type Description
channel String

The channel through which the API is invoked.

client_key String

The unique identifier assigned by EBPP to the client.

product module:models/String

The product identifier corresponding to the API.

timestamp String

The timestamp for the moment when the API request is created.

idempotent_request_key String

The unique token that clients can generate and maintain in order to identify an API request.

requestor_type module:models/String

Type of the requestor of the API.

create_customer_request module:models/CreateCustomerRequest

The JSON that contains all the attributes of customer to be created.

opts Object

Optional parameters

Properties
Name Type Description
requestor String

The identifier for the requestor of the API.

x_opay_headers String

Intended for the future use.

trace_id String

The unique reference that can be used for tracing and debugging an API call.

callback module:api/CustomerApi~createCustomerCallback

The callback function, accepting three arguments: error, data, response data is of type: module:models/CustomerResponse

getCustomer(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, opts, callback)

Get Customer The Get Customer API is used to retrieve the details of the customer based on the id.

Parameters:
Name Type Description
channel String

The channel through which the API is invoked.

client_key String

The unique identifier assigned by EBPP to the client.

product module:models/String

The product identifier corresponding to the API.

timestamp String

The timestamp for the moment when the API request is created.

idempotent_request_key String

The unique token that clients can generate and maintain in order to identify an API request.

requestor_type module:models/String

Type of the requestor of the API.

id_customer String

The unique identifier assigned by EBPP to the customer.

opts Object

Optional parameters

Properties
Name Type Description
requestor String

The identifier for the requestor of the API.

x_opay_headers String

Intended for the future use.

trace_id String

The unique reference that can be used for tracing and debugging an API call.

callback module:api/CustomerApi~getCustomerCallback

The callback function, accepting three arguments: error, data, response data is of type: module:models/CustomerResponse

retrieveCustomers(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, opts, callback)

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.

Parameters:
Name Type Description
channel String

The channel through which the API is invoked.

client_key String

The unique identifier assigned by EBPP to the client.

product module:models/String

The product identifier corresponding to the API.

timestamp String

The timestamp for the moment when the API request is created.

idempotent_request_key String

The unique token that clients can generate and maintain in order to identify an API request.

requestor_type module:models/String

Type of the requestor of the API.

opts Object

Optional parameters

Properties
Name Type Description
requestor String

The identifier for the requestor of the API.

x_opay_headers String

Intended for the future use.

trace_id String

The unique reference that can be used for tracing and debugging an API call.

page_size String

The maximum number of objects returned in the query.

customer_reference String

Unique ID assigned by the biller/client system for a given customer.

ssn String

The SSN of the customer if the account holder is an individual or the tax ID, if the customer is a business.

email String

This field contains the customer’s email address within EBPP.

account_number String

Customer Account Number of the customer to get details of.

callback module:api/CustomerApi~retrieveCustomersCallback

The callback function, accepting three arguments: error, data, response data is of type: module:models/CustomersResponse

retrieveCustomersPage(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, query_id, opts, callback)

Retrieve Customers Pagination This API is used to paginate through the list of customers returned in the Retrieve Customers API.

Parameters:
Name Type Description
channel String

The channel through which the API is invoked.

client_key String

The unique identifier assigned by EBPP to the client.

product module:models/String

The product identifier corresponding to the API.

timestamp String

The timestamp for the moment when the API request is created.

idempotent_request_key String

The unique token that clients can generate and maintain in order to identify an API request.

requestor_type module:models/String

Type of the requestor of the API.

query_id String

query id of the Retrieve/Search Customers lookup.

opts Object

Optional parameters

Properties
Name Type Description
requestor String

The identifier for the requestor of the API.

x_opay_headers String

Intended for the future use.

trace_id String

The unique reference that can be used for tracing and debugging an API call.

page_size String

The maximum number of objects returned in the query.

from_index String

To fetch the next set of objects that start after this object

to_index String

To fetch the previous set of objects that end at this object

callback module:api/CustomerApi~retrieveCustomersPageCallback

The callback function, accepting three arguments: error, data, response data is of type: module:models/CustomersResponse

updateCustomer(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, update_customer_request, opts, callback)

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> | | active | incollections | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | incollections | active | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | inactive | incollections | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | incollections | inactive | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | active | inbankruptcy | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | incollections | inbankruptcy | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | inbankruptcy | active | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> | | inbankruptcy | closed | <ul> <li>external_user</li> <li> client_agent</li> <li> system</li></ul> </ul> |

Parameters:
Name Type Description
channel String

The channel through which the API is invoked.

client_key String

The unique identifier assigned by EBPP to the client.

product module:models/String

The product identifier corresponding to the API.

timestamp String

The timestamp for the moment when the API request is created.

idempotent_request_key String

The unique token that clients can generate and maintain in order to identify an API request.

requestor_type module:models/String

Type of the requestor of the API.

id_customer String

The unique identifier assigned by EBPP to the customer.

update_customer_request module:models/UpdateCustomerRequest

JSON containing all the attributes of the customer to be updated.

opts Object

Optional parameters

Properties
Name Type Description
requestor String

The identifier for the requestor of the API.

x_opay_headers String

Intended for the future use.

trace_id String

The unique reference that can be used for tracing and debugging an API call.

callback module:api/CustomerApi~updateCustomerCallback

The callback function, accepting three arguments: error, data, response data is of type: module:models/CustomerResponse

Type Definitions

createCustomerCallback(error, data, response)

Callback function to receive the result of the createCustomer operation.

Parameters:
Name Type Description
error String

Error message, if any.

data module:models/CustomerResponse

The data returned by the service call.

response String

The complete HTTP response.

getCustomerCallback(error, data, response)

Callback function to receive the result of the getCustomer operation.

Parameters:
Name Type Description
error String

Error message, if any.

data module:models/CustomerResponse

The data returned by the service call.

response String

The complete HTTP response.

retrieveCustomersCallback(error, data, response)

Callback function to receive the result of the retrieveCustomers operation.

Parameters:
Name Type Description
error String

Error message, if any.

data module:models/CustomersResponse

The data returned by the service call.

response String

The complete HTTP response.

retrieveCustomersPageCallback(error, data, response)

Callback function to receive the result of the retrieveCustomersPage operation.

Parameters:
Name Type Description
error String

Error message, if any.

data module:models/CustomersResponse

The data returned by the service call.

response String

The complete HTTP response.

updateCustomerCallback(error, data, response)

Callback function to receive the result of the updateCustomer operation.

Parameters:
Name Type Description
error String

Error message, if any.

data module:models/CustomerResponse

The data returned by the service call.

response String

The complete HTTP response.