Methods

createRefund(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_payment, id_customer, create_refund_request, opts, callback)

api/RefundApi.js, line 64

Create Refund This API is used to initiate a refund. Any payment made using EBPP can be refunded. Customer cannot initiate a refund request. In other words, the Create Refund request will fail if the associated requestor_type is 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.
id_payment	String	The unique identifier assigned by EBPP to the payment.
id_customer	String	The unique identifier assigned by EBPP to the customer.
create_refund_request	module:models/CreateRefundRequest	JSON containing all the fields required to refund 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. trace_id String The unique reference that can be used for tracing and debugging an API call.
callback	module:api/RefundApi~createRefundCallback	The callback function, accepting three arguments: error, data, response data is of type: module:models/RefundResponse

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

api/RefundApi.js, line 126

Get Refund The API is used to retrieve the details of a refund 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_refund	String	The unique identifier assigned by EBPP to the refund.
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. trace_id String The unique reference that can be used for tracing and debugging an API call.
callback	module:api/RefundApi~getRefundCallback	The callback function, accepting three arguments: error, data, response data is of type: module:models/RefundResponse

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

api/RefundApi.js, line 195

Retrieve Refunds The API is used to retrieve the refunds made to a customer against payments processed through EBPP. Refunds can be filtered using the customer id, confirmation number of the payment being refunded or of the refund, status of the refund and others mentioned below. Scheduled refunds that are yet to be processed and all the refunds processed in the last six months are returned if date criteria is not specified. If the requestor_type is customer then the id_customer request parameter is mandatory. The results are sorted in descending order of the refund_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. If the requestor_type is <b>system</b>, requestor is optional. 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. confirmation_number String The confirmation number provided to the customer for the refund or for the corresponding successful payment. status Array.<module:models/String> The status of the refund. This can take multiple values in the format key=value1&key=value2.... from_date String The date from which refunds, matching the criteria specified, need to be retrieved. to_date String The date upto which refunds, 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/RefundApi~retrieveRefundsCallback	The callback function, accepting three arguments: error, data, response data is of type: module:models/RefundsResponse

Type Definitions

createRefundCallback(error, data, response)

api/RefundApi.js, line 37

Callback function to receive the result of the createRefund operation.

Parameters:

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

getRefundCallback(error, data, response)

api/RefundApi.js, line 100

Callback function to receive the result of the getRefund operation.

Parameters:

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

retrieveRefundsCallback(error, data, response)

api/RefundApi.js, line 162

Callback function to receive the result of the retrieveRefunds operation.

Parameters:

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