wrappers/Payments

The Payments wrapper module.

Members

inner confirmation_number :String

The confirmation number or reference provided to the customer for the successful payment.

inner from_date :String

The date from which payments, matching the criteria specified, need to be retrieved.

inner from_index :String

The id of the object before which the previous set of objects are to be retrieved.

inner has_more_results :String

true if there are more results or pages

inner id_customer :String

The unique identifier assigned by EBPP to the customer.

inner id_customer_account :String

The unique identifier assigned by EBPP to the customer account

inner id_funding_account :String

The unique identifier assigned by EBPP to the funding account

inner page_size :String

The maximum number of objects returned in the query.

inner Payment

inner query_id :String

The query id of the object.

inner String

The status of the payment. This can take multiple values in the format key=value1&key=value2....

inner String

The schedule type for the payment setup. This can take multiple values in the format key=value1&key=value2....

inner to_date :String

The date upto which payments, matching the criteria specified, need to be retrieved.

inner to_index :String

The id of the object after which the next set of objects are to be retrieved.

inner total_results_count :String

total number of payments available with matching criteria

inner url :String

This URL fetches the next or previous set of payments, based on the presence of after_object or before_object parameter.

Methods

findBy(id_funding_account, id_customer_account, confirmation_number, Stringopt, from_date, to_date, Stringopt, page_size, query_id, from_index, to_index) → {module:wrappers/Payments}

Parameters:
Name Type Attributes Description
id_funding_account String

The id_funding_account of Payments.

id_customer_account String

The id_customer_account of Payments.

confirmation_number String

The confirmation_number of Payments.

String <optional>

payment_schedule_type - The payment_schedule_type of Payments.

from_date String

The from_date of Payments.

to_date String

The to_date of Payments.

String <optional>

status - The status of Payments.

page_size String

The page_size of Payments.

query_id String

The query_id of Payments.

from_index String

The from_index of Payments.

to_index String

The to_index of Payments.

Returns:
module:wrappers/Payments -

The instance of Payments.

forClient(client_key) → {module:wrappers/Payments}

Parameters:
Name Type Description
client_key String

The client_key of Payments.

Returns:
module:wrappers/Payments -

The instance of Payments.

forCustomer(id_customer) → {module:wrappers/Payments}

Parameters:
Name Type Description
id_customer String

The id_customer of Payments.

Returns:
module:wrappers/Payments -

The instance of Payments.

videChannel(channel) → {module:wrappers/Payments}

Parameters:
Name Type Description
channel String

The channel of Payments.

Returns:
module:wrappers/Payments -

The instance of Payments.