Members

inner audit_info :AuditInfo

wrappers/Refund.js, line 175

inner comments :String

wrappers/Refund.js, line 162

Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.

inner confirmation_number :String

wrappers/Refund.js, line 137

The confirmation number or reference provided to the customer for the refund.

inner custom_fields :Object

wrappers/Refund.js, line 157

The additional information or meta-information that EBPP can accept, maintain and transmit back to the client. The custom fields need to be configured with EBPP before they can be accepted. EBPP would reject custom fields that are not pre-configured. Please contact <a href = "mailto: support@billerpayments.com">support@billerpayments.com for more information on configuring and using custom fields.

inner expected_refund_settlement_date :String

wrappers/Refund.js, line 152

The date by which the credits would be posted to the original funding account. ISO8601 full-date format, YYYY-MM-DD

inner fee_refund :FeeRefund

wrappers/Refund.js, line 128

inner id :String

wrappers/Refund.js, line 108

The unique identifier assigned by EBPP to the refund.

inner ID_CUSTOMER :String

wrappers/Refund.js, line 184

The unique identifier assigned by EBPP to the customer.

inner ID_PAYMENT :String

wrappers/Refund.js, line 179

The unique identifier assigned by EBPP to the payment.

inner ID_REFUND :String

wrappers/Refund.js, line 189

The unique identifier assigned by EBPP to the refund.

inner payment_network_response :PaymentNetworkResponse

wrappers/Refund.js, line 171

inner refund_amount :String

wrappers/Refund.js, line 123

The refund amount upto 2 decimal places.

inner refund_date :String

wrappers/Refund.js, line 142

The date on which the refund is scheduled to be made. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

inner refund_entry_date :String

wrappers/Refund.js, line 147

The date on which the refund captured in EBPP. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

inner refund_reference :String

wrappers/Refund.js, line 103

The unique identifier in the client system for the refund.

inner refund_type :String

wrappers/Refund.js, line 118

The portion of the payment amount that is to be or has been refunded. The original payment can be refunded fully including the amount and the fee components, or partially, for just the amount or the fee component. Refund can also be initiated for an arbitrary amount limited by the original payment amount.

inner source_payment :SourcePayment

wrappers/Refund.js, line 167

inner status :String

wrappers/Refund.js, line 132

The status of the refund.

inner url :String

wrappers/Refund.js, line 113

This URL fetches the details of refund.

Methods

static constructFromObject(data, obj) → {module:wrappers/Refund}

wrappers/Refund.js, line 31

Constructs a Refund from a plain JavaScript object, optionally creating a new instance. Copies all relevant properties from data to obj if supplied or a new instance if not.

Parameters:

Name	Type	Description
data	Object	The plain JavaScript object bearing properties of interest.
obj	module:wrappers/Refund	Optional instance to populate.

Returns:

module:wrappers/Refund -

The populated Refund instance.

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

wrappers/Refund.js, line 199

Parameters:

Name	Type	Description
client_key	String	The client_key of Refund.

Returns:

module:wrappers/Refund -

The instance of Refund.

forCustomer(ID_CUSTOMER) → {module:wrappers/Refund}

wrappers/Refund.js, line 265

Parameters:

Name	Type	Description
ID_CUSTOMER	String	The ID_CUSTOMER of Refund.

Returns:

module:wrappers/Refund -

The instance of Refund.

forPayment(ID_PAYMENT) → {module:wrappers/Refund}

wrappers/Refund.js, line 277

Parameters:

Name	Type	Description
ID_PAYMENT	String	The ID_PAYMENT of Refund.

Returns:

module:wrappers/Refund -

The instance of Refund.

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

wrappers/Refund.js, line 208

Parameters:

Name	Type	Description
channel	String	The channel of Refund.

Returns:

module:wrappers/Refund -

The instance of Refund.

withCustomFields(custom_fields) → {module:wrappers/Refund}

wrappers/Refund.js, line 289

Parameters:

Name	Type	Description
custom_fields	Object	The custom_fields of Refund.

Returns:

module:wrappers/Refund -

The instance of Refund.

withDetails(refund_amount) → {module:wrappers/Refund}

wrappers/Refund.js, line 217

Parameters:

Name	Type	Description
refund_amount	String	The refund_amount of Refund.

Returns:

module:wrappers/Refund -

The instance of Refund.

withFeeRefund(fee_refund) → {module:wrappers/Refund}

wrappers/Refund.js, line 301

Parameters:

Name	Type	Description
fee_refund	FeeRefund	The fee_refund of Refund.

Returns:

module:wrappers/Refund -

The instance of Refund.

withMemo(comments) → {module:wrappers/Refund}

wrappers/Refund.js, line 241

Parameters:

Name	Type	Description
comments	String	The comments of Refund.

Returns:

module:wrappers/Refund -

The instance of Refund.

withReference(refund_reference) → {module:wrappers/Refund}

wrappers/Refund.js, line 229

Parameters:

Name	Type	Description
refund_reference	String	The refund_reference of Refund.

Returns:

module:wrappers/Refund -

The instance of Refund.

withStatus(status) → {module:wrappers/Refund}

wrappers/Refund.js, line 253

Parameters:

Name	Type	Description
status	String	The status of Refund.

Returns:

module:wrappers/Refund -

The instance of Refund.