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 | Aria-assigned account identifier. | |
OR | ||||
client_acct_id | long | Client-defined identifier for the account. This value is unique across all Aria-managed accounts. | ||
![]() |
string | PayPal email address of the PayPal member. | ||
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). |
string | Email address of the PayPal member | |
paypal_confirmationcode | string | Indicates whether the address is a confirmed address on file at PayPal. It is one of the following values: Note: The values Confirmed and Unconfirmed both indicate that the member email address passed verification. None - The request value of the Email element does not match any email address on file at PayPal. Confirmed - If the response value of the StreetMatch element is Matched, the entire postal address is confirmed. Unconfirmed - PayPal responds that the postal address is unconfirmed. |
paypal_streetmatch | string | Indicates whether the street address matches address information on file at PayPal. It is one of the following values: None - The request value of the Email element does not match any email address on file at PayPal. No comparison of other request values was made. Matched - The request value of the Street element matches the first 3 single-byte characters of a postal address on file for the PayPal member. Unmatched - The request value of the Street element does not match any postal address on file for the PayPal member. |
paypal_zipmatch | string | Indicates whether the zip address matches address information on file at PayPal. It is one of the following values: None - The request value of the Street element was unmatched. No comparison of the Zip element was made. Matched - The request value of the Zip element matches the ZIP code of the postal address on file for the PayPal member. Unmatched - The request value of the Zip element does not match the ZIP code of the postal address on file for the PayPal member. |
paypal_countrycode | string | Country code (ISO 3166) on file for the PayPal email address. |
paypal_token | string | The token contains encrypted information about the member's email address and postal address. If you pass the value of the token in the HTML variable address_api_token of Buy Now buttons, PayPal prevents the buyer from using an email address or postal address other than those that PayPal verified with this API call. The token is valid for 24 hours. |