init_paypal_bill_agreement_m Guide
- Last updated
-
-
Save as PDF
Creates a session with PayPal so that an account user can set up a billing agreement with an Aria client. The call returns a session token from PayPal, plus a client configured return_url (aka PayPal Agreement Confirmation URL) to instruct the USS/Reg software where it should direct the end user for the next step. PayPal will consider the token valid for 15 minutes. This API call does not store any information in the Aria database, but requires that the followup call to save_paypal_bill_agreement call is made while the token is valid.
| API Specification: |
init_paypal_bill_agreement_m |
| Required Fields: |
- <client_no>
- <auth_key>
- <acct_no> or <client_acct_id>
- <billing_group_no> or client_billing_group_id> or <master_plan_instance_no> or <client_master_plan_instance_id>
|
Additional Guidance:
Input Fields
| Field Name: |
Notes: |
| <client_acct_id> |
If you pass in a <client_acct_id> and an <acct_no>, Aria will use this order of precedence to decide which account to take action on:
- <acct_no>
- <client_acct_id>
|
| <req_billing_address> |
Allowable Values
| Values |
Description |
| -1 |
Use Configuration Settings. |
| 0 |
Do not send an address verification request. |
| 1 |
Send an address verification request. |
|
| <update_avs_return_address> |
Allowable Values
| Values |
Description |
| -1 |
Use Configuration Settings. |
| 0 |
Do not update Aria billing address from PPEC AVS results and ignore results. |
| 1 |
Update Aria billing address from PPEC AVS results. |
|
| <paypal_credit> |
Allowable Values
| Values |
Description |
| 0 |
Do not include paypal_credit feature |
| 1 |
Include paypal_credit feature |
|
| <in_context_checkout> |
Allowable Values
| Values |
Description |
| 0 |
Use classic. |
| 1 |
Use In-Context Checkout. |
|
