Methods

deleteRecordPayment(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_payment, delete_recorded_payment_request, opts, callback)

api/RecordedPaymentApi.js, line 61

Delete Recorded Payment The API is used to delete the recorded payment. It returns 204 http status code with empty body in successful case

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	String	The unique identifier assigned by EBPP to the payment.
delete_recorded_payment_request	module:models/DeleteRecordedPaymentRequest	Details of payment to be deleted/cancelled
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/RecordedPaymentApi~deleteRecordPaymentCallback	The callback function, accepting three arguments: error, data, response

getRecordPayment(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_payment, opts, callback)

api/RecordedPaymentApi.js, line 119

Get Recorded Payment The API is used to retrieve the details of a payment 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	String	The unique identifier assigned by EBPP to the payment.
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/RecordedPaymentApi~getRecordPaymentCallback	The callback function, accepting three arguments: error, data, response data is of type: module:models/GetRecordedPaymentResponse

recordPayment(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, record_payment_request, opts, callback)

api/RecordedPaymentApi.js, line 177

Record Payment The API is used to record payments in EBPP those are made and fulfilled outside EBPP.

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.
record_payment_request	module:models/RecordPaymentRequest	JSON containing all the fields required to record a payment.
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/RecordedPaymentApi~recordPaymentCallback	The callback function, accepting three arguments: error, data, response data is of type: module:models/RecordedPaymentResponse

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

api/RecordedPaymentApi.js, line 244

Retrieve Recorded Payments The API is used to retrieve the payments made by a customer. Payments can be filtered using the confirmation number, customer account, status, by date range and others mentioned below. If no dates are provided for retrieval, payments in the last six months and all the payments scheduled for a future date are returned. In case a payment has failed due to ACH returns, then the payment return date and the return code will be available in the response.

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. 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. payment_method Array.<module:models/String> The non fulfillment method for the payment. This can take multiple values in the format key=value1&key=value2.... status Array.<module:models/String> The status of the payment. This can take multiple values in the format key=value1&key=value2.... from_date String The date from which payments, matching the criteria specified, need to be retrieved. to_date String The date upto which payments, 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 Payments 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/RecordedPaymentApi~retrieveRecordPaymentsCallback	The callback function, accepting three arguments: error, data, response data is of type: module:models/RecordedPaymentsResponse

Type Definitions

deleteRecordPaymentCallback(error, data, response)

api/RecordedPaymentApi.js, line 37

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

getRecordPaymentCallback(error, data, response)

api/RecordedPaymentApi.js, line 95

Callback function to receive the result of the getRecordPayment operation.

Parameters:

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

recordPaymentCallback(error, data, response)

api/RecordedPaymentApi.js, line 153

Callback function to receive the result of the recordPayment operation.

Parameters:

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

retrieveRecordPaymentsCallback(error, data, response)

api/RecordedPaymentApi.js, line 210

Callback function to receive the result of the retrieveRecordPayments operation.

Parameters:

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