Home > Aria6 User Documentation > Aria6 core api > save_paypal_bill_agreement


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.

Input Arguments

Req Field Name Field Type Max Length Description
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
required-icon.png acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
required-icon.png token string 20 PayPal assigned session token retrieved with init_paypal_bill_agreement
  auth_reversal string 12

Determines whether to automatically reverse an authorization for the amount passed into the init_paypal_bill_agreement API. 

If you set this field to false and you choose to reverse the authorization later, you can call the reverse_authorized_electronic_payment API.

Allowable values for auth_reversal

  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.
  brd_arrow.gif qualifier_name string 100 Name of the field you want to associate with this API call.
  brd_arrow.gif 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.
bill_agreement_id string Unique ID of the bill agreement (also referred to as a token).
paypal_email string Email address of buyer.
paypal_payerid string Unique PayPal Customer Account identification number.
paypal_payerstatus string Status of buyer. Values are verified and unverified.
paypal_countrycode string The country or locale code that identifies payer's account location. For example, United States could have an "en_US" or "en-US" code depending on language support priority.
paypal_shiptoname string Person's name associated with this shipping address.
paypal_shiptostreet string First or primary street address for shipping. 
paypal_shipttostreet2 string Second street address for shipping.
paypal_shiptocity string Name of city for shipping. 
paypal_shiptostate string State or province for shipping. 
paypal_shiptozip string U.S. ZIP code or other country-specific postal code for shipping. 
paypal_shiptocountrycode string Country or locale code for shipping. 
paypal_addressstatus string Status of street address on file with PayPal.
auth_no long Aria-assigned authorization identifier. You can pass this identifier into the reverse_authorized_electronic_payment API if you choose to reverse a payment authorization that was not automatically voided based on your <auth_reversal> setting in the save_paypal_bill_agreement API.
proc_payment_id string Authorization identifier assigned by the payment gateway.
Last modified


This page has no custom tags.


This page has no classifications.