Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!

 

Home > Aria6 core api > init_paypal_bill_agreement

init_paypal_bill_agreement

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.

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 8 Aria-assigned unique account identifier.
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
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
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
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
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.

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.

You must to post a comment.
Last modified
13:04, 12 Oct 2017

Tags

This page has no custom tags.

Classifications

This page has no classifications.