Methods

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

api/FundingAccountApi.js, line 62

Add Funding Account This API is used to add a funding account for the customer. The funding account is available for servicing all the customer accounts the customer holds. An exhaustive set of account types are supported as funding accounts as indicated in the field account_subtype. ABA routing number and account sub-type are mandatory for bank accounts. Expiry date, address fields and Card CVV are required for card accounts.

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.
add_funding_account_request	module:models/AddFundingAccountRequest	JSON containing all the attributes of the Funding account to be added to customer.
opts	Object	Optional parameters Properties Name Type Description requestor String The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. x_opay_headers String Intended for the future use.
callback	module:api/FundingAccountApi~addFundingAccountCallback	The callback function, accepting three arguments: error, data, response data is of type: module:models/FundingAccountResponse

deleteFundingAccount(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_funding_account, id_customer, delete_funding_account_request, opts, callback)

api/FundingAccountApi.js, line 122

Delete Funding Account The Delete Funding Account API is used to delete the funding account of a customer. All pending payments made with that account are cancelled upon deletion of the funding account.

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_funding_account	String	The unique identifier assigned by EBPP to the Funding Account.
id_customer	String	The unique identifier assigned by EBPP to the customer.
delete_funding_account_request	module:models/DeleteFundingAccountRequest	Details of account to be deleted.
opts	Object	Optional parameters Properties Name Type Description requestor String The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. x_opay_headers String Intended for the future use.
callback	module:api/FundingAccountApi~deleteFundingAccountCallback	The callback function, accepting three arguments: error, data, response data is of type: module:models/DeleteResponse

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

api/FundingAccountApi.js, line 182

Get Funding Account The Get Funding Account API is used to retrieve the details of the funding 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_funding_account	String	The unique identifier assigned by EBPP to the Funding 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. If the requestor_type is <b>system</b>, requestor is optional. x_opay_headers String Intended for the future use.
callback	module:api/FundingAccountApi~getFundingAccountCallback	The callback function, accepting three arguments: error, data, response data is of type: module:models/FundingAccountResponse

replaceFundingAccount(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_funding_account, id_customer, replace_funding_account_request, opts, callback)

api/FundingAccountApi.js, line 243

Replace Funding Account The API is used to replace the funding account details. The type of the funding account cannot be replaced. In other words, a card account cannot be replaced to a bank account and vice versa. CVV is mandatory to make any change to a card account.Replacing a funding account updates the account information on all pending payments made using that account but does not change the details on payments that have been completed.

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_funding_account	String	The unique identifier assigned by EBPP to the Funding Account.
id_customer	String	The unique identifier assigned by EBPP to the customer.
replace_funding_account_request	module:models/ReplaceFundingAccountRequest	JSON containing all the attributes of the Funding account to be replaced.
opts	Object	Optional parameters Properties Name Type Description requestor String The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. x_opay_headers String Intended for the future use.
callback	module:api/FundingAccountApi~replaceFundingAccountCallback	The callback function, accepting three arguments: error, data, response data is of type: module:models/FundingAccountResponse

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

api/FundingAccountApi.js, line 308

Retrieve Funding Accounts This API is used to retrieve all the funding accounts associated with a customer. Accounts can be filtered using the account number, the ABA routing number (for bank accounts), the account status, account type, account sub-type and others mentioned below. The results are sorted based on their last_modified_time in descending order. The API responds with the first page of the list of funding accounts matching the criteria.

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. If the requestor_type is <b>system</b>, requestor is optional. x_opay_headers String Intended for the future use. 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 funding account in EBPP. This can take multiple values in the format key=value1&key=value2.... aba_routing_number String The ABA/Routing number for the bank account. account_type Array.<module:models/String> The type of the funding account. This can take multiple values in the format key=value1&key=value2.... account_subtype module:models/String The sub type of the funding account. This is derived by EBPP in the case of card funding accounts. It needs to be passed when adding or editing a DDA/bank account.
callback	module:api/FundingAccountApi~retrieveFundingAccountsCallback	The callback function, accepting three arguments: error, data, response data is of type: module:models/FundingAccountsResponse

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

api/FundingAccountApi.js, line 376

Retrieve Funding Accounts Pagination This API is used to paginate through the list of funding accounts returned in the Retrieve Funding 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. If the requestor_type is <b>system</b>, requestor is optional. x_opay_headers String Intended for the future use. 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/FundingAccountApi~retrieveFundingAccountsPageCallback	The callback function, accepting three arguments: error, data, response data is of type: module:models/FundingAccountsResponse

updateFundingAccount(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_funding_account, id_customer, update_funding_account_request, opts, callback)

api/FundingAccountApi.js, line 440

Update Funding Account The API is used to edit the funding account details. The type of the funding account cannot be changed. In other words, a card account cannot be changed to a bank account and vice versa. The sub-type of a bank account can be changed. For e.g., a saving account can be updated to a money market account. However, the sub-type cannot be updated for a card account. CVV is mandatory to make any change to a card account. The Id of the funding account gets updated to a new value if the account number is updated. Editing a funding account updates the account information on all pending payments made using that account but does not change the details on payments that have been completed. <br><br> Below are the possible funding account state transformation. | from_status | to_status | allowed requestor_type | | ------------ | ------------ | ------------ | | active | deleted| <ul> <li>external_user</li> <li> client_agent</li> <li> system</li> <li> customer</li></ul> | | active | frozen | <ul> <li>external_user </li> <li> client_agent </li> <li> system</li></ul> | | active | inactive | <ul> <li>external_user </li> <li> client_agent </li> <li> system</li></ul> | | active | unverified | <ul> <li>system</li></ul> | | frozen | active | <ul> <li>external_user </li> <li> client_agent</li></ul> | | inactive | active | <ul> <li>external_user </li> <li> client_agent </li> <li> system</li></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_funding_account	String	The unique identifier assigned by EBPP to the Funding Account.
id_customer	String	The unique identifier assigned by EBPP to the customer.
update_funding_account_request	module:models/UpdateFundingAccountRequest	JSON containing all the attributes of the Funding account to be updated.
opts	Object	Optional parameters Properties Name Type Description requestor String The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. x_opay_headers String Intended for the future use.
callback	module:api/FundingAccountApi~updateFundingAccountCallback	The callback function, accepting three arguments: error, data, response data is of type: module:models/FundingAccountResponse

Type Definitions

addFundingAccountCallback(error, data, response)

api/FundingAccountApi.js, line 37

Callback function to receive the result of the addFundingAccount operation.

Parameters:

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

deleteFundingAccountCallback(error, data, response)

api/FundingAccountApi.js, line 96

Callback function to receive the result of the deleteFundingAccount operation.

Parameters:

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

getFundingAccountCallback(error, data, response)

api/FundingAccountApi.js, line 157

Callback function to receive the result of the getFundingAccount operation.

Parameters:

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

replaceFundingAccountCallback(error, data, response)

api/FundingAccountApi.js, line 217

Callback function to receive the result of the replaceFundingAccount operation.

Parameters:

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

retrieveFundingAccountsCallback(error, data, response)

api/FundingAccountApi.js, line 278

Callback function to receive the result of the retrieveFundingAccounts operation.

Parameters:

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

retrieveFundingAccountsPageCallback(error, data, response)

api/FundingAccountApi.js, line 348

Callback function to receive the result of the retrieveFundingAccountsPage operation.

Parameters:

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

updateFundingAccountCallback(error, data, response)

api/FundingAccountApi.js, line 414

Callback function to receive the result of the updateFundingAccount operation.

Parameters:

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