The PaymentSetup wrapper module.
Members
-
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 :AuditInfo
-
-
inner card_cvv_number :String
-
This is never returned by Orbipay. This needs to be passed to Orbipay when making or editing a payment setup 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 (Orbipay) 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 setup.
-
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 Orbipay. This defaults to USD.
-
inner custom_fields :Object
-
The additional information or meta-information that Orbipay can accept, maintain and transmit back to the client. The custom fields need to be configured with Orbipay before they can be accepted. Orbipay 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 Orbipay, would be accepted in the requests.
-
inner customer :Customer
-
-
inner customer_account :CustomerAccount
-
-
inner deleted :String
-
The status of payment which says whether the payment is deleted or not
-
inner fee :Fee
-
-
inner funding_account :FundingAccount
-
-
inner id :String
-
The unique identifier assigned by Orbipay to the payment setup.
-
inner ID_CUSTOMER :String
-
The unique identifier assigned by EBPP to the customer.
-
inner ID_PAYMENT_SETUP :String
-
The unique identifier assigned by EBPP to the payment setup.
-
inner next_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_method :String
-
The fulfillment method for the payment.
-
inner payment_network_response :PaymentNetworkResponse
-
-
inner payment_schedule :PaymentSchedule
-
-
inner payment_setup_entry_date :String
-
The date on which the payment setup is captured in Orbipay. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.
-
inner payment_setup_reference :String
-
The unique identifier in the client system for the payment setup.
-
inner payment_setup_schedule_type :String
-
The schedule type for the payment setup.
-
inner status :String
-
The status of the payment.
-
inner url :String
-
This URL fetches the details of payment setup.
Methods
-
static constructFromObject(data, obj) → {module:wrappers/PaymentSetup}
-
Constructs a
PaymentSetupfrom 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/PaymentSetup Optional instance to populate.
-
forClient(client_key) → {module:wrappers/PaymentSetup}
-
Parameters:
Name Type Description client_keyString The client_key of PaymentSetup.
-
forCustomer(ID_CUSTOMER) → {module:wrappers/PaymentSetup}
-
Parameters:
Name Type Description ID_CUSTOMERString The ID_CUSTOMER of PaymentSetup.
-
fromAccount(funding_account) → {module:wrappers/PaymentSetup}
-
Parameters:
Name Type Description funding_accountFundingAccount The funding_account of PaymentSetup.
-
toAccount(customer_account) → {module:wrappers/PaymentSetup}
-
Parameters:
Name Type Description customer_accountCustomerAccount The customer_account of PaymentSetup.
-
videChannel(channel) → {module:wrappers/PaymentSetup}
-
Parameters:
Name Type Description channelString The channel of PaymentSetup.
-
withCustomFields(custom_fields) → {module:wrappers/PaymentSetup}
-
Parameters:
Name Type Description custom_fieldsObject The custom_fields of PaymentSetup.
-
withDetails(amount, card_cvv_number, payment_setup_schedule_type) → {module:wrappers/PaymentSetup}
-
Parameters:
Name Type Description amountString The amount of PaymentSetup.
card_cvv_numberString The card_cvv_number of PaymentSetup.
payment_setup_schedule_typeString The payment_setup_schedule_type of PaymentSetup.
-
withFee(fee) → {module:wrappers/PaymentSetup}
-
Parameters:
Name Type Description feeFee The fee of PaymentSetup.
-
withMemo(comments) → {module:wrappers/PaymentSetup}
-
Parameters:
Name Type Description commentsString The comments of PaymentSetup.
-
withPaymentSchedule(payment_schedule) → {module:wrappers/PaymentSetup}
-
Parameters:
Name Type Description payment_schedulePaymentSchedule The payment_schedule of PaymentSetup.
-
withReference(payment_setup_reference) → {module:wrappers/PaymentSetup}
-
Parameters:
Name Type Description payment_setup_referenceString The payment_setup_reference of PaymentSetup.
-
withStatus(status) → {module:wrappers/PaymentSetup}
-
Parameters:
Name Type Description statusString The status of PaymentSetup.