Summary

API Name	save_paypal_bill_agreement_m
Class	account_services_m
Update Version	6.33

Description

Confirms that a billing agreement has been accepted by the account user, and that PayPal is able to authorize a payment against that billing agreement. The token is a PayPal session token created by the init_paypal_bill_agreement call. If the billing agreement was accepted, then Aria saves the associated agreement identifier in the database to use for future transactions with this account.The merchant must have their PayPal Payment Receiving Preferences (under Profile on PayPal) set to block "pay with eCheck" (the box must be checked, and this does not prevent PayPal users from funding transactions with their bank account). If this is not done, any end user who needs to pay remaining balances (beyond the amount in their PayPal account) with a bank account will be unable to make payments. When the box is checked, such bank account funded payments will be secured by the user's credit card in case the bank account transfer fails. The merchant may also choose to have alternate currencies converted to their primary currency on that screen. Merchants who would like to collect in multiple currencies should either elect to convert there, or add additional Currency Balances in their PayPal Profile.

Inputs

Name

Type

Length

Required

Description

client_no

long

22

Yes

Aria-assigned unique identifier indicating the Aria client providing service to this account.

auth_key

string

32

Yes

Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call.

acct_no

long

Yes

Aria-assigned account identifier. This value is unique across all Aria-managed accounts.

Alternative required field: client_acct_id

client_acct_id

string

50

Yes

Client-defined account identifier.

Alternative required field: acct_no

token

string

20

Yes

PayPal assigned session token retrieved with init_paypal_bill_agreement

billing_group_no

long

22

Yes

The unique identifier of the billing group.

Alternative required field: client_billing_group_id, master_plan_instance_no, or client_master_plan_instance_id

client_billing_group_id

string

100

Yes

The client-defined identifier of the billing group.

Alternative required field: billing_group_no, master_plan_instance_no, or client_master_plan_instance_id

master_plan_instance_no

long

22

Yes

The unique identifier of the master plan instance.

Alternative required field: billing_group_no, client_billing_group_id, or client_master_plan_instance_id

client_master_plan_instance_id

string

100

Yes

The client-defined identifier of the master plan instance.

Alternative required field: billing_group_no, client_billing_group_id, or master_plan_instance_no

auth_reversal

string

20

No

Determine whether to reverse the authorization immediately. If setting is false and a reversal is desired later, it would require using the reverse_authorized_electronic_payment_m API

Allowed values:

Value	Description
True	will reverse the authorization.
False	will not reverse the authorization. (Default)

Outputs

Name	Type	Length	Required	Description
error_code	long		No	Aria-assigned error identifier. 0 indicates no error.
error_msg	string		No	Description of any error that occurred. "OK" if there was no error.
bill_agreement_id	string	32	No	Unique ID of the bill agreement (also referred to as a token).
paypal_email	string		No
paypal_payerid	string		No
paypal_payerstatus	string		No
paypal_countrycode	string		No
paypal_shiptoname	string		No
paypal_shiptostreet	string		No
paypal_shipttostreet2	string		No
paypal_shiptocity	string		No
paypal_shiptostate	string		No
paypal_shiptozip	string		No
paypal_shiptocountrycode	string		No
paypal_addressstatus	string		No
auth_no	long		No	Aria-assigned authorization identifier.
proc_payment_id	string		No	The authorization transaction identifier provided by the payment processor.