Methods

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

api/PaymentSetupApi.js, line 63

Create Payment Setup The API is used to set up recurring payments to service a customer 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_customer	String	The unique identifier assigned by EBPP to the customer.
create_payment_setup_request	module:models/CreatePaymentSetupRequest	JSON containing all the fields required to create a recurring payment setup.
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/PaymentSetupApi~createRecurringPaymentSetupCallback	The callback function, accepting three arguments: error, data, response data is of type: module:models/PaymentSetupResponse

deletePaymentSetup(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_payment_setup, id_customer, delete_payment_setup_request, opts, callback)

api/PaymentSetupApi.js, line 125

Delete Payment Setup The API is used to delete or cancel a recurring payment setup. Cancelling a payment setup will also cancel all the pending and future payments under the setup.

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_payment_setup	String	The unique identifier assigned by EBPP to the payment setup.
id_customer	String	The unique identifier assigned by EBPP to the customer.
delete_payment_setup_request	module:models/DeletePaymentSetupRequest	JSON containing all the fields required to delete a payment. Setup.
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/PaymentSetupApi~deletePaymentSetupCallback	The callback function, accepting three arguments: error, data, response data is of type: module:models/DeleteResponse

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

api/PaymentSetupApi.js, line 187

Get Payment Setup The API is used to retrieve the details of a recurring payment setup by 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_payment_setup	String	The unique identifier assigned by EBPP to the payment setup.
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/PaymentSetupApi~getPaymentSetupCallback	The callback function, accepting three arguments: error, data, response data is of type: module:models/PaymentSetupResponse

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

api/PaymentSetupApi.js, line 259

Retrieve Payment Setups The API is used to retrieve the recurring and autopay payments setup made against a customer account. The setup can be filtered using the confirmation number, customer account, funding account, status and payment setup schedule type, by date range and others mentioned below. If no dates are provided for retrieval, recurring payments set up in the last six months and all the ones in future are returned. The results are sorted in descending order of the payment_start_date followed by 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.
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. id_customer String The unique identifier assigned by EBPP to the customer. id_funding_account String The unique identifier assigned by EBPP to the funding account id_customer_account String The unique identifier assigned by EBPP to the customer account confirmation_number String The confirmation number or reference provided to the customer for the successful payment. status Array.<module:models/String> The status of the payment. This can take multiple values in the format key=value1&key=value2.... payment_setup_schedule_type Array.<module:models/String> The schedule type for the payment setup. This can take multiple values in the format key=value1&key=value2.... from_date String The date from which recurring payments setup, matching the criteria specified, need to be retrieved. to_date String The date upto which recurring payments setup, matching the criteria specified, need to be retrieved. page_size String The maximum number of objects returned in the query. query_id String query id of the Retrieve/Search Customers lookup. 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/PaymentSetupApi~retrievePaymentSetupsCallback	The callback function, accepting three arguments: error, data, response data is of type: module:models/PaymentSetupsResponse

updatePaymentSetup(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_payment_setup, id_customer, update_payment_setup_request, opts, callback)

api/PaymentSetupApi.js, line 332

Update Payment Setup The API is used to edit a payment Setup. Only autopay payment setup is allowed to edit.

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_payment_setup	String	The unique identifier assigned by EBPP to the payment setup.
id_customer	String	The unique identifier assigned by EBPP to the customer.
update_payment_setup_request	module:models/UpdatePaymentSetupRequest	Details of the Payment Setup 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/PaymentSetupApi~updatePaymentSetupCallback	The callback function, accepting three arguments: error, data, response data is of type: module:models/PaymentSetupResponse

Type Definitions

createRecurringPaymentSetupCallback(error, data, response)

api/PaymentSetupApi.js, line 37

Callback function to receive the result of the createRecurringPaymentSetup operation.

Parameters:

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

deletePaymentSetupCallback(error, data, response)

api/PaymentSetupApi.js, line 98

Callback function to receive the result of the deletePaymentSetup 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.

getPaymentSetupCallback(error, data, response)

api/PaymentSetupApi.js, line 161

Callback function to receive the result of the getPaymentSetup operation.

Parameters:

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

retrievePaymentSetupsCallback(error, data, response)

api/PaymentSetupApi.js, line 223

Callback function to receive the result of the retrievePaymentSetups operation.

Parameters:

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

updatePaymentSetupCallback(error, data, response)

api/PaymentSetupApi.js, line 305

Callback function to receive the result of the updatePaymentSetup operation.

Parameters:

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