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. | ||||||||
![]() |
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. | ||||||||||
![]() |
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 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. |