module:models/RecordPaymentRequest(payment_date, payment_method, customer, customer_account)

new module:models/RecordPaymentRequest(payment_date, payment_method, customer, customer_account)

This class subject to change without prior notice, Please dont use this class directly.

Constructs a new RecordPaymentRequest.
Parameters:
Name Type Description
payment_date String

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

payment_method module:models/RecordPaymentRequest.PaymentMethodEnum

The non fulfillment method for the payment.

customer module:models/SimplePaymentCustomerRequest
customer_account module:models/CreateCustomerAccountRequest

Members

static, readonly PaymentAmountTypeEnum :String

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

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

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

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

inner customer_account :module:models/CreateCustomerAccountRequest

inner fee :module:models/FeeRequest

inner funding_account :module:models/RecordedPaymentFundingAccount

inner payment_amount_type :module:models/RecordPaymentRequest.PaymentAmountTypeEnum

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

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

The non fulfillment method for the payment.

inner payment_reference :String

The unique identifier in the client system for the payment.

inner token :String

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

Methods

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

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.