new module:models/RefundResponse()
This class subject to change without prior notice, Please dont use this class directly.
Constructs a newRefundResponse.
Members
-
static, readonly RefundTypeEnum :String
-
Allowed values for the
refund_typeproperty.Properties:
Name Type Description payment_and_feeString value: "payment_and_fee"
payment_onlyString value: "payment_only"
fee_onlyString value: "fee_only"
otherString value: "other"
-
static, readonly StatusEnum :String
-
Allowed values for the
statusproperty.Properties:
Name Type Description scheduledString value: "scheduled"
cancelledString value: "cancelled"
processingString value: "processing"
processedString value: "processed"
declinedString value: "declined"
returnedString value: "returned"
disputedString value: "disputed"
errorString value: "error"
-
inner audit_info :module:models/AuditInfoVo
-
-
inner comments :String
-
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
-
The confirmation number or reference provided to the customer for the refund.
-
inner custom_fields :Object.<String, String>
-
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
-
The date by which the credits would be posted to the original funding account. ISO8601 full-date format, YYYY-MM-DD
-
inner fee_refund :module:models/FeeRefundResponse
-
-
inner id :String
-
The unique identifier assigned by EBPP to the refund.
-
inner payment_network_response :module:models/PaymentNetworkResponseVo
-
-
inner refund_amount :String
-
The refund amount upto 2 decimal places.
-
inner refund_date :String
-
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
-
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
-
The unique identifier in the client system for the refund.
-
inner refund_type :module:models/RefundResponse.RefundTypeEnum
-
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 :module:models/SourcePayment
-
-
inner status :module:models/RefundResponse.StatusEnum
-
The status of the refund.
-
inner url :String
-
This URL fetches the details of refund.
Methods
-
static constructFromObject(data, obj) → {module:models/RefundResponse}
-
Constructs a
RefundResponsefrom a plain JavaScript object, optionally creating a new instance. Copies all relevant properties fromdatatoobjif supplied or a new instance if not.Parameters:
Name Type Description dataObject The plain JavaScript object bearing properties of interest.
objmodule:models/RefundResponse Optional instance to populate.