new module:models/PaymentResponse()
This class subject to change without prior notice, Please dont use this class directly.
Constructs a newPaymentResponse.
Members
-
static, readonly PaymentAmountTypeEnum :String
-
Allowed values for the
payment_amount_typeproperty.Properties:
Name Type Description current_balanceString value: "current_balance"
minimum_payment_dueString value: "minimum_payment_due"
past_payment_dueString value: "past_payment_due"
statement_balanceString value: "statement_balance"
discounted_amountString value: "discounted_amount"
penalty_amountString value: "penalty_amount"
otherString value: "other"
-
static, readonly PaymentMethodEnum :String
-
Allowed values for the
payment_methodproperty.Properties:
Name Type Description achString value: "ach"
checkString value: "check"
visa_debitString value: "visa_debit"
pinless_debitString value: "pinless_debit"
master_debitString value: "master_debit"
amex_creditString value: "amex_credit"
discover_creditString value: "discover_credit"
visa_creditString value: "visa_credit"
master_creditString value: "master_credit"
discover_debitString value: "discover_debit"
cashString value: "cash"
swiped_cardString value: "swiped_card"
scanned_checkString value: "scanned_check"
apple_payString value: "apple_pay"
-
static, readonly PaymentScheduleTypeEnum :String
-
Allowed values for the
payment_schedule_typeproperty.Properties:
Name Type Description one_time_paymentString value: "one_time_payment"
autopay_generated_paymentString value: "autopay_generated_payment"
variable_recurring_generated_paymentString value: "variable_recurring_generated_payment"
payment_plan_generatedString value: "payment_plan_generated"
-
static, readonly StatusEnum :String
-
Allowed values for the
statusproperty.Properties:
Name Type Description scheduledString value: "scheduled"
cancelledString value: "cancelled"
processingString value: "processing"
processedString value: "processed"
returnedString value: "returned"
declinedString value: "declined"
disputedString value: "disputed"
errorString value: "error"
-
inner amount :String
-
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
-
-
inner card_cvv_number :String
-
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
-
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 confirmation_number :String
-
The confirmation number or reference provided to the customer for the payment.
-
inner currency_code3d :String
-
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>
-
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
-
-
inner customer_account :module:models/CustomerAccountSnapshotResponse
-
-
inner expected_payment_settlement_date :String
-
The date on which the payment is expected to be settled with the biller. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.
-
inner fee :module:models/FeeResponse
-
-
inner funding_account :module:models/FundingAccountSnapshotResponse
-
-
inner id :String
-
The unique identifier assigned by EBPP to the payment.
-
inner payment_amount_type :module:models/PaymentResponse.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_entry_date :String
-
The date on which the payment is captured in EBPP. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.
-
inner payment_method :module:models/PaymentResponse.PaymentMethodEnum
-
The fulfillment method for the payment.
-
inner payment_network_response :module:models/PaymentNetworkResponseVo
-
-
inner payment_notification_email :String
-
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
-
The unique identifier in the client system for the payment.
-
inner payment_request_date :String
-
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.
-
inner payment_return_date :String
-
The date on which the ACH returns is received by EBPP.
-
inner payment_schedule_type :module:models/PaymentResponse.PaymentScheduleTypeEnum
-
The schedule type for the payment. This defaults to one_time_payment.
-
inner return_code :String
-
The ACH return code or the chargeback code received from Visa/Mastercard, in the event of returned payments.
-
inner status :module:models/PaymentResponse.StatusEnum
-
The status of the payment.
-
inner token :String
-
The token is used to uniquely identify the payment, such as the POS token.
-
inner url :String
-
This URL fetches the details of payment.
Methods
-
static constructFromObject(data, obj) → {module:models/PaymentResponse}
-
Constructs a
PaymentResponsefrom a plain JavaScript object, optionally creating a new instance. Copies all relevant properties fromdatatoobjif supplied or a new instance if not.Parameters:
Name Type Description dataObject The plain JavaScript object bearing properties of interest.
objmodule:models/PaymentResponse Optional instance to populate.