Members

static, readonly PaymentAmountTypeEnum :String

models/RecordedPaymentResponse.js, line 304

Allowed values for the payment_amount_type property.

Properties:

Name	Type	Description
current_balance	String	value: "current_balance"
minimum_payment_due	String	value: "minimum_payment_due"
past_payment_due	String	value: "past_payment_due"
statement_balance	String	value: "statement_balance"
other	String	value: "other"

static, readonly PaymentMethodEnum :String

models/RecordedPaymentResponse.js, line 270

Allowed values for the payment_method property.

Properties:

Name	Type	Description
cash	String	value: "cash"
swiped_card	String	value: "swiped_card"
scanned_check	String	value: "scanned_check"

static, readonly PaymentScheduleTypeEnum :String

models/RecordedPaymentResponse.js, line 292

Allowed values for the payment_schedule_type property.

Properties:

Name	Type	Description
one_time_payment	String	value: "one_time_payment"

static, readonly StatusEnum :String

models/RecordedPaymentResponse.js, line 253

Allowed values for the status property.

Properties:

Name	Type	Description
processed	String	value: "processed"
cancelled	String	value: "cancelled"

inner amount :String

models/RecordedPaymentResponse.js, line 185

The amount being paid. In case the payment_amount_type is 'other', the amount needs to be specified. In other cases, this is derived from the payment_amount_type.

inner audit_info :module:models/AuditInfoVo

models/RecordedPaymentResponse.js, line 242

inner comments :String

models/RecordedPaymentResponse.js, line 220

Comments that can be used to recollect the operation performed on the resource object.

inner confirmation_number :String

models/RecordedPaymentResponse.js, line 170

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

inner currency_code3d :String

models/RecordedPaymentResponse.js, line 180

The three-letter currency code in the ISO4217 format, in uppercase, for the card account. It must be a currency supported by EBPP. This defaults to USD.

inner custom_fields :Object.<String, String>

models/RecordedPaymentResponse.js, line 175

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 customer :module:models/SimplePaymentCustomerResponse

models/RecordedPaymentResponse.js, line 230

inner customer_account :module:models/CustomerAccountResponse

models/RecordedPaymentResponse.js, line 238

inner fee :module:models/FeeResponse

models/RecordedPaymentResponse.js, line 151

inner funding_account :module:models/RecordedPaymentFundingAccount

models/RecordedPaymentResponse.js, line 234

inner id :String

models/RecordedPaymentResponse.js, line 141

The unique identifier assigned by EBPP to the payment.

inner payment_amount_type :module:models/RecordedPaymentResponse.PaymentAmountTypeEnum

models/RecordedPaymentResponse.js, line 200

The type of amount, as per the bill/statement, that is being paid. The payment amount is derived from the amount type selected for the payment. This defaults to other.

inner payment_date :String

models/RecordedPaymentResponse.js, line 190

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

inner payment_entry_date :String

models/RecordedPaymentResponse.js, line 210

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

inner payment_method :module:models/RecordedPaymentResponse.PaymentMethodEnum

models/RecordedPaymentResponse.js, line 160

The non fulfillment method for the payment.

inner payment_reference :String

models/RecordedPaymentResponse.js, line 205

The unique identifier in the client system for the payment.

inner payment_return_date :String

models/RecordedPaymentResponse.js, line 215

The date on which the ACH returns is received by EBPP.

inner payment_schedule_type :module:models/RecordedPaymentResponse.PaymentScheduleTypeEnum

models/RecordedPaymentResponse.js, line 195

The schedule type for the payment. This defaults to one_time_payment.

inner return_code :String

models/RecordedPaymentResponse.js, line 225

The ACH return code or the chargeback code received from Visa/Mastercard, in the event of returned payments.

inner status :module:models/RecordedPaymentResponse.StatusEnum

models/RecordedPaymentResponse.js, line 155

The status of the payment.

inner token :String

models/RecordedPaymentResponse.js, line 165

The token is used to uniquely identify the payment, such as the POS token.

inner url :String

models/RecordedPaymentResponse.js, line 146

This URL fetches the details of payment.

Methods

static constructFromObject(data, obj) → {module:models/RecordedPaymentResponse}

models/RecordedPaymentResponse.js, line 67

Constructs a RecordedPaymentResponse 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:models/RecordedPaymentResponse	Optional instance to populate.

Returns:

module:models/RecordedPaymentResponse -

The populated RecordedPaymentResponse instance.