The RecordedPayment wrapper module.
Members
-
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 audit_info :AuditInfo
-
-
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
-
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 :Customer
-
-
inner customer_account :CustomerAccount
-
-
inner fee :Fee
-
-
inner funding_account :FundingAccount
-
-
inner id :String
-
The unique identifier assigned by EBPP to the payment.
-
inner ID_PAYMENT :String
-
The unique identifier assigned by EBPP to the payment.
-
inner payment_amount_type :String
-
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 :String
-
The non fulfillment method for the payment.
-
inner payment_reference :String
-
The unique identifier in the client system for the payment.
-
inner payment_return_date :String
-
The date on which the ACH returns is received by EBPP.
-
inner payment_schedule_type :String
-
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 :String
-
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:wrappers/RecordedPayment}
-
Constructs a
RecordedPaymentfrom 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:wrappers/RecordedPayment Optional instance to populate.
-
forClient(client_key) → {module:wrappers/RecordedPayment}
-
Parameters:
Name Type Description client_keyString The client_key of RecordedPayment.
-
fromAccount(funding_account) → {module:wrappers/RecordedPayment}
-
Parameters:
Name Type Description funding_accountFundingAccount The funding_account of RecordedPayment.
-
toAccount(customer_account) → {module:wrappers/RecordedPayment}
-
Parameters:
Name Type Description customer_accountCustomerAccount The customer_account of RecordedPayment.
-
videChannel(channel) → {module:wrappers/RecordedPayment}
-
Parameters:
Name Type Description channelString The channel of RecordedPayment.
-
withCustomer(customer) → {module:wrappers/RecordedPayment}
-
Parameters:
Name Type Description customerCustomer The customer of RecordedPayment.
-
withCustomFields(custom_fields) → {module:wrappers/RecordedPayment}
-
Parameters:
Name Type Description custom_fieldsObject The custom_fields of RecordedPayment.
-
withDetails(payment_amount_type, amount, payment_date, payment_method) → {module:wrappers/RecordedPayment}
-
Parameters:
Name Type Description payment_amount_typeString The payment_amount_type of RecordedPayment.
amountString The amount of RecordedPayment.
payment_dateString The payment_date of RecordedPayment.
payment_methodString The payment_method of RecordedPayment.
-
withFee(fee) → {module:wrappers/RecordedPayment}
-
Parameters:
Name Type Description feeFee The fee of RecordedPayment.
-
withMemo(comments) → {module:wrappers/RecordedPayment}
-
Parameters:
Name Type Description commentsString The comments of RecordedPayment.
-
withReference(payment_reference) → {module:wrappers/RecordedPayment}
-
Parameters:
Name Type Description payment_referenceString The payment_reference of RecordedPayment.
-
withToken(token) → {module:wrappers/RecordedPayment}
-
Parameters:
Name Type Description tokenString The token of RecordedPayment.