Members

static, readonly PaymentMethodEnum :String

models/PaymentSetupResponse.js, line 274

Allowed values for the payment_method property.

Properties:

Name	Type	Description
ach	String	value: "ach"
visa_debit	String	value: "visa_debit"
pinless_debit	String	value: "pinless_debit"
master_debit	String	value: "master_debit"
amex_credit	String	value: "amex_credit"
discover_credit	String	value: "discover_credit"
visa_credit	String	value: "visa_credit"
master_credit	String	value: "master_credit"
discover_debit	String	value: "discover_debit"

static, readonly PaymentSetupScheduleTypeEnum :String

models/PaymentSetupResponse.js, line 326

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"

static, readonly StatusEnum :String

models/PaymentSetupResponse.js, line 242

Allowed values for the status property.

Properties:

Name	Type	Description
scheduled	String	value: "scheduled"
cancelled	String	value: "cancelled"
declined	String	value: "declined"
error	String	value: "error"
completed	String	value: "completed"

inner amount :String

models/PaymentSetupResponse.js, line 181

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 audit_info :module:models/AuditInfoVo

models/PaymentSetupResponse.js, line 231

inner card_cvv_number :String

models/PaymentSetupResponse.js, line 186

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

inner comments :String

models/PaymentSetupResponse.js, line 210

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 (Orbipay) is not responsible for the security of any sensitive information that may be passed as part of the memo.

inner confirmation_number :String

models/PaymentSetupResponse.js, line 166

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

inner currency_code3d :String

models/PaymentSetupResponse.js, line 176

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/PaymentSetupResponse.js, line 171

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

models/PaymentSetupResponse.js, line 215

inner customer_account :module:models/CustomerAccountSnapshotResponse

models/PaymentSetupResponse.js, line 223

inner fee :module:models/FeeResponse

models/PaymentSetupResponse.js, line 147

inner funding_account :module:models/FundingAccountSnapshotResponse

models/PaymentSetupResponse.js, line 219

inner id :String

models/PaymentSetupResponse.js, line 137

The unique identifier assigned by EBPP to the payment setup.

inner next_payment_date :String

models/PaymentSetupResponse.js, line 191

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/PaymentSetupResponse.PaymentMethodEnum

models/PaymentSetupResponse.js, line 156

The fulfillment method for the payment.

inner payment_network_response :module:models/PaymentNetworkResponseVo

models/PaymentSetupResponse.js, line 227

inner payment_schedule :module:models/PaymentScheduleVo

models/PaymentSetupResponse.js, line 201

inner payment_setup_entry_date :String

models/PaymentSetupResponse.js, line 205

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

inner payment_setup_reference :String

models/PaymentSetupResponse.js, line 196

The unique identifier in the client system for the payment setup.

inner payment_setup_schedule_type :module:models/PaymentSetupResponse.PaymentSetupScheduleTypeEnum

models/PaymentSetupResponse.js, line 161

The schedule type for the payment setup.

inner status :module:models/PaymentSetupResponse.StatusEnum

models/PaymentSetupResponse.js, line 151

The status of the payment.

inner url :String

models/PaymentSetupResponse.js, line 142

This URL fetches the details of payment setup.

Methods

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

models/PaymentSetupResponse.js, line 66

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

Returns:

module:models/PaymentSetupResponse -

The populated PaymentSetupResponse instance.