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.
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:
|
|
![]() |
token | string | 20 | PayPal assigned session token retrieved with init_paypal_bill_agreement |
![]() |
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. | |
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. | ||
![]() |
string | 100 | Name of the field you want to associate with this API call. | |
![]() |
string | 100 | Corresponding value of the field you want to associate with this API call. |
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_m 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_m API. |
proc_payment_id | string | Authorization identifier assigned by the payment gateway. |