Members

static, readonly PaymentAmountTypeEnum :String

models/CreatePaymentRequest.js, line 176

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"
discounted_amount	String	value: "discounted_amount"
penalty_amount	String	value: "penalty_amount"
other	String	value: "other"

inner amount :String

models/CreatePaymentRequest.js, line 108

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

inner card_cvv_number :String

models/CreatePaymentRequest.js, line 113

This is never returned by EBPP. This needs to be passed to EBPP when making or editing a payment with a card funding account.

inner comments :String

models/CreatePaymentRequest.js, line 159

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 custom_fields :Object.<String, String>

models/CreatePaymentRequest.js, line 164

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. Only the custom fields enabled for the client, in EBPP, would be accepted in the requests.

inner customer :module:models/CustomerMinimalRequest

models/CreatePaymentRequest.js, line 137

inner customer_account :module:models/CustomerAccountMinimalRequest

models/CreatePaymentRequest.js, line 145

inner fee :module:models/FeeRequest

models/CreatePaymentRequest.js, line 133

inner funding_account :module:models/FundingAccountMinimalRequest

models/CreatePaymentRequest.js, line 141

inner payment_amount_type :module:models/CreatePaymentRequest.PaymentAmountTypeEnum

models/CreatePaymentRequest.js, line 128

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/CreatePaymentRequest.js, line 118

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

models/CreatePaymentRequest.js, line 154

The email address to which notifications for the payment will be sent. The notifications will be sent to the customer's email in case this is not provided.

inner payment_reference :String

models/CreatePaymentRequest.js, line 149

The unique identifier in the client system for the payment.

inner payment_request_date :String

models/CreatePaymentRequest.js, line 123

The date on which the biller wants the payment to be settled. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. This is applicable only if the client has opted for it.

Methods

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

models/CreatePaymentRequest.js, line 61

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

Returns:

module:models/CreatePaymentRequest -

The populated CreatePaymentRequest instance.