Payment and AutoPay Setup widget use
Yardi has two browser forms that can be inserted into a website iframe/div to handle payment processing and auto pay enrollment. You will need special access to use these forms so please speak to your account manager before attempting to use them. These are not located within the API since they contain a user interface though API access is required to gather the required data for calling them. Each widget has it’s own link. Links shown here are for our Sandbox testing environment. Links for production can be obtained from your account manager.
Payment Widget
Link:
https://estoresbx.centershift.com/payment/pay_form.aspx?accountID= <account_guid>&siteID=<site_id>&acctID=<acct_id>& rentalID=<rental_id>&totalDue=<total_due>&cycles=<cycles>
Parameters (all parameters are required)
| Name | DataType |
|---|---|
| accountID | GUID |
| Description | This is a GUID you will be assigned when your account for using these widgets is setup. |
| siteID | Long |
| Description | This is ID for the site that owns the account. |
| acctID | Long |
| Description | This is the ID for the account containing the rental to be paid. |
| rentalID | Long |
| Description | This is the ID for the rental to be paid. |
| totalDue | Decimal |
| Description | This is the amount that will be paid. This amount must match the total due for the number of cycles being paid. This information can be obtained from GetTotalDue or GetTotalDuePastDue. |
| cycles | Integer |
| Description | This is the number of cycles (months) to be paid. This information can be obtained from GetTotalDue or GetTotalDuePastDue. |
The following can cause errors either initially or after submitting a payment:
- A rental is in auction – If a rental is currently scheduled for auction it cannot be paid for with this widget. Contacting the site will be required.
- The total_due amount passed in does not match the total due for the number of cycles passed in.
- The total_due/cycles passed in does not bring the account current.
- Required data is missing or not of the correct type.
- Payment was attempted but declined by the processor.
- Payment was approved but not able to be posted to the account.
Auto Pay Enrollment Widget
This allows creating a new auto pay or canceling an existing auto pay record.
Link:
https://estoresbx.centershift.com/payment/autopay_form.aspx?accountID= <account_guid>&siteID=<site_id>&acctID=<acct_id>& rentalID=<rental_id>&autoPaymentID=<auto_pay_id>
Parameters
| Name | DataType |
|---|---|
| accountID | GUID |
| Description | This is a GUID you will be assigned when your account for using these widgets is setup. |
| siteID | Long |
| Description | This is ID for the site that owns the account. |
| acctID | Long |
| Description | This is the ID for the account containing the rental to be paid. |
| rentalID | Long |
| Description | This is the ID for the rental to be paid. |
| autoPaymentID Optional | Long |
| Description | This is the ID for the current auto pay record. This should be passed if there is a current record to be cancelled. Otherwise the parameter should be left off the query string entirely. To obtain this ID you can call GetAutoPaySettings |
The following can cause errors either initially or after submitting the request:
- A rental is past due and an auto pay record is to be created. A rental must be current to set up auto pay.
- Required data is missing or not of the correct type.
- An update to the data failed.
Yardi Store Developer eXchange 