module:api/CustomerAccountApi(apiClientopt)

new module:api/CustomerAccountApi(apiClientopt)

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

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

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

Methods

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

Get Customer Account The Get Customer Account API is used to retrieve the details of a customer account 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_account String

The unique identifier assigned by EBPP to the Customer Account.

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/CustomerAccountApi~getCustomerAccountCallback

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

renewCustomerAccount(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer_account, id_customer, renew_customer_account_request, opts, callback)

Renew Customer Account This API is used to renew a customer account. The API migrates all the pending payments and active payment setups from the original customer account to the new one.

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

The unique identifier assigned by EBPP to the Customer Account.

id_customer String

The unique identifier assigned by EBPP to the customer.

renew_customer_account_request module:models/RenewCustomerAccountRequest

JSON containing all the attributes of the Customer account to be renewed.

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/CustomerAccountApi~renewCustomerAccountCallback

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

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

Retrieve Customer Accounts The API is used to retrieve all the customer accounts associated with a customer. The accounts can be filtered using the account number, status. The API responds with the first page of the list of customerAccounts matching the criteria. The results are sorted in descending order of the last_modified_time.

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.

page_size String

The maximum number of objects returned in the query.

account_number String

The Account Number to get details of.

status Array.<module:models/String>

The status of the customer's account in EBPP. This can take multiple values in the format key=value1&key=value2....

callback module:api/CustomerAccountApi~retrieveCustomerAccountsCallback

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

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

Retrieve Customer Accounts Pagination This API is used to paginate through the list of customer Accounts returned in the Retrieve Customer Accounts 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.

id_customer String

The unique identifier assigned by EBPP to the customer.

query_id String

query id of the Retrieve/Search Accounts 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/CustomerAccountApi~retrieveCustomerAccountsPageCallback

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

Type Definitions

getCustomerAccountCallback(error, data, response)

Callback function to receive the result of the getCustomerAccount operation.

Parameters:
Name Type Description
error String

Error message, if any.

data module:models/CustomerAccountResponse

The data returned by the service call.

response String

The complete HTTP response.

renewCustomerAccountCallback(error, data, response)

Callback function to receive the result of the renewCustomerAccount operation.

Parameters:
Name Type Description
error String

Error message, if any.

data module:models/CustomerAccountResponse

The data returned by the service call.

response String

The complete HTTP response.

retrieveCustomerAccountsCallback(error, data, response)

Callback function to receive the result of the retrieveCustomerAccounts operation.

Parameters:
Name Type Description
error String

Error message, if any.

data module:models/CustomerAccountsResponse

The data returned by the service call.

response String

The complete HTTP response.

retrieveCustomerAccountsPageCallback(error, data, response)

Callback function to receive the result of the retrieveCustomerAccountsPage operation.

Parameters:
Name Type Description
error String

Error message, if any.

data module:models/CustomerAccountsResponse

The data returned by the service call.

response String

The complete HTTP response.