Methods

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

api/CustomerApi.js, line 62

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.
requestor	String	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.
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 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, requestor, id_customer, opts, callback)

api/CustomerApi.js, line 121

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.
requestor	String	The identifier for 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 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

initiateContactVerification(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, requestor, initiate_contact_verification_request, opts, callback)

api/CustomerApi.js, line 180

Initiate Contact Verification This API generates a verification code for the specified phone number of a given 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.
requestor	String	The identifier for the requestor of the API.
initiate_contact_verification_request	module:models/InitiateContactVerificationRequest	JSON containing all the fields required to Initiate Contact Verification.
opts	Object	Optional parameters Properties Name Type Description 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~initiateContactVerificationCallback	The callback function, accepting three arguments: error, data, response

linkCustomerContact(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, requestor, link_customer_contact_request, opts, callback)

api/CustomerApi.js, line 239

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.

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.
requestor	String	The identifier for the requestor of the API.
link_customer_contact_request	module:models/LinkCustomerContactRequest	JSON containing all the fields required to link a contact to customer.
opts	Object	Optional parameters Properties Name Type Description 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~linkCustomerContactCallback	The callback function, accepting three arguments: error, data, response data is of type: module:models/CustomerContactResponse

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

api/CustomerApi.js, line 302

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.

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.
requestor	String	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.
opts	Object	Optional parameters Properties Name Type Description 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

unlinkCustomerContact(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, requestor, unlink_customer_contact_request, opts, callback)

api/CustomerApi.js, line 365

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.

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.
requestor	String	The identifier for the requestor of the API.
unlink_customer_contact_request	module:models/UnlinkCustomerContactRequest	JSON containing all the fields required to unlink a contact from the customer.
opts	Object	Optional parameters Properties Name Type Description 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~unlinkCustomerContactCallback	The callback function, accepting three arguments: error, data, response

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

api/CustomerApi.js, line 425

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> |

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.
requestor	String	The identifier for 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 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)

api/CustomerApi.js, line 37

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)

api/CustomerApi.js, line 96

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.

initiateContactVerificationCallback(error, data, response)

api/CustomerApi.js, line 156

Callback function to receive the result of the initiateContactVerification operation.

Parameters:

Name	Type	Description
error	String	Error message, if any.
data		This operation does not return a value.
response	String	The complete HTTP response.

linkCustomerContactCallback(error, data, response)

api/CustomerApi.js, line 214

Callback function to receive the result of the linkCustomerContact operation.

Parameters:

Name	Type	Description
error	String	Error message, if any.
data	module:models/CustomerContactResponse	The data returned by the service call.
response	String	The complete HTTP response.

retrieveCustomersCallback(error, data, response)

api/CustomerApi.js, line 273

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.

unlinkCustomerContactCallback(error, data, response)

api/CustomerApi.js, line 341

Callback function to receive the result of the unlinkCustomerContact operation.

Parameters:

Name	Type	Description
error	String	Error message, if any.
data		This operation does not return a value.
response	String	The complete HTTP response.

updateCustomerCallback(error, data, response)

api/CustomerApi.js, line 399

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.