Members

static, readonly PaymentSetupScheduleTypeEnum :String

models/CreatePaymentSetupRequest.js, line 159

Allowed values for the payment_setup_schedule_type property.

Properties:

Name	Type	Description
variable_recurring_enrollment	String	value: "variable_recurring_enrollment"
autopay_enrollment	String	value: "autopay_enrollment"
payment_plan	String	value: "payment_plan"

inner amount :String

models/CreatePaymentSetupRequest.js, line 112

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/CreatePaymentSetupRequest.js, line 117

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/CreatePaymentSetupRequest.js, line 147

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/CreatePaymentSetupRequest.js, line 142

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/CreatePaymentSetupRequest.js, line 126

inner customer_account :module:models/CustomerAccountMinimalRequest

models/CreatePaymentSetupRequest.js, line 134

inner fee :module:models/FeeRequest

models/CreatePaymentSetupRequest.js, line 122

inner funding_account :module:models/FundingAccountMinimalRequest

models/CreatePaymentSetupRequest.js, line 130

inner payment_schedule :module:models/PaymentScheduleVo

models/CreatePaymentSetupRequest.js, line 138

inner payment_setup_reference :String

models/CreatePaymentSetupRequest.js, line 102

The unique identifier in the client system for the paymentSetup.

inner payment_setup_schedule_type :module:models/CreatePaymentSetupRequest.PaymentSetupScheduleTypeEnum

models/CreatePaymentSetupRequest.js, line 107

The schedule type for the payment setup.

Methods

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

models/CreatePaymentSetupRequest.js, line 61

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

Returns:

module:models/CreatePaymentSetupRequest -

The populated CreatePaymentSetupRequest instance.