init_paypal_bill_agreement_m
Input Arguments
| Req | Field Name | Field Type | Max Length | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
 |
client_no | long | 22 | Aria-assigned unique identifier indicating the Aria client providing service to this account. | ||||||||
|
auth_key | string | 32 | Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor. | ||||||||
 |
acct_no | long | 22 | Aria-assigned account identifier. This value is unique across all Aria-managed accounts. | ||||||||
| OR | ||||||||||||
| client_acct_id | string | 50 |
Client-defined account identifier. Note: 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:
|
|||||||||
| req_billing_address | long | 1 |
Specifies whether a billing address request should be sent to PayPal. Default Value is -1 (a NULL value will also set to -1).This value will also override any client level configuration setting in the Payment Gateways or Collection Groups section of the UI. Allowable values for req_billing_address:
|
|||||||||
| update_avs_return_address | long | 1 |
Specifies how to handle an AVS return address if req_billing_address is set to 1 – send an address verification request.Default Value is -1(a NULL value will also set to -1). This value will also override any client level configuration setting in the Payment Gateways or Collection Groups section of the UI. Allowable values for update_avs_return_address:
|
|||||||||
| paypal_credit | long | 22 |
PayPal Credit is a financing solution offered by PayPal. To buyers, the option to use PayPal Credit appears when checking out. Buyers fill out a short application and receive approval within seconds.To merchants (Aria clients), however, the payment appears no differently than any other Express Checkout transaction. The merchant still receives their money at the time of sale. PayPal handles remittance of payment from the buyers, and assumes the risk of non-payment. Allowable values for paypal_credit:
|
|||||||||
| in_context_checkout | long | 1 |
PayPal Express Checkout has a new checkout flow called In-Context checkout. The enhanced checkout flow provides a simplified checkout experience that replaces the classic Express Checkout redirection flow. On desktops, the PayPal payment flow takes place in a secure window that opens in front of the merchant website, while on small-screen devices (tablets and smartphones) the PayPal payment screens are optimized for full-page mode. In-context checkout offers a streamlined checkout flow that keeps customers local to your website throughout the payment authorization process. With this flow, customers are not redirected away from your website. Instead, the redesigned checkout experience presents PayPal screens in a secure window that sits atop your website page. This leads to a more natural and user-friendly checkout experience. However, if you detect that a user has a non-compatible browser, does not have JavaScript enabled, etc., you may want to use classic view. Allowable values for in_context_checkout:
|
|||||||||
| alt_caller_id | string | 30 | Person or process that submitted the API call. This can be someone's user ID, or the name of an application. | |||||||||
| optional_transaction_qualifiers | array | Array of additional values you can associate with this API call. | ||||||||||
 qualifier_name |
string | 100 | Name of the field you want to associate with this API call. | |||||||||
| qualifier_value |
string | 100 | Corresponding value of the field you want to associate with this API call. | |||||||||
 |
billing_group_no | long | 22 | Aria-assigned identifier of the billing group whose collection group you want to use for payment transactions. | ||||||||
| OR | ||||||||||||
| client_billing_group_id | string | 100 | Client-defined identifier of the billing group whose collection group you want to use for payment transactions. | |||||||||
| OR | ||||||||||||
| master_plan_instance_no | long | 22 | Aria-assigned identifier of the master plan instance associated with the billing group whose collection group you want to use for payment transactions. | |||||||||
| OR | ||||||||||||
| client_master_plan_instance_id | string | 100 | Client-defined identifier of the master plan instance associated with the billing group whose collection group you want to use for payment transactions. |
Output Arguments
| Field Name | Field Type | Description |
|---|---|---|
| error_code | long | Aria-assigned error identifier. 0 indicates no error. |
| error_msg | string | Description of any error that occurred. "OK" if there was no error. |
| return_url | string | Client configured return_url (aka PayPal Agreement Confirmation URL) to instruct the USS/Reg software what PayPal link it should use to direct the end user to the next step |
| token | string | PayPal supplied token that maintains the billing agreement session. Valid only for 15 minutes. |
| billing_group_no | long | Identifier of the billing group that you passed into this API. This is the billing group whose collection group you used for payment transactions. |
- © Copyright 2023 Aria Developer Central