Members

static, readonly PaymentAmountTypeEnum :String

models/RecordPaymentRequest.js, line 167

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/RecordPaymentRequest.js, line 199

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"

inner amount :String

models/RecordPaymentRequest.js, line 105

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 comments :String

models/RecordPaymentRequest.js, line 151

inner custom_fields :Object.<String, String>

models/RecordPaymentRequest.js, line 155

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/SimplePaymentCustomerRequest

models/RecordPaymentRequest.js, line 134

inner customer_account :module:models/CreateCustomerAccountRequest

models/RecordPaymentRequest.js, line 142

inner fee :module:models/FeeRequest

models/RecordPaymentRequest.js, line 130

inner funding_account :module:models/RecordedPaymentFundingAccount

models/RecordPaymentRequest.js, line 138

inner payment_amount_type :module:models/RecordPaymentRequest.PaymentAmountTypeEnum

models/RecordPaymentRequest.js, line 115

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/RecordPaymentRequest.js, line 110

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_method :module:models/RecordPaymentRequest.PaymentMethodEnum

models/RecordPaymentRequest.js, line 120

The non fulfillment method for the payment.

inner payment_reference :String

models/RecordPaymentRequest.js, line 146

The unique identifier in the client system for the payment.

inner token :String

models/RecordPaymentRequest.js, line 125

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

Methods

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

models/RecordPaymentRequest.js, line 61

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

Returns:

module:models/RecordPaymentRequest -

The populated RecordPaymentRequest instance.