get_paypal_avs_status_m Sample Call and Response
This example requests the PayPal Address Verification Service (AVS) status for a PayPal member's email address on an account, based on the get_paypal_avs_status_m method defined in plsql_m_r73.yml.
This example includes every required field for the call. The response includes every field the method returns, since this method has a small, fixed set of output fields rather than a repeatable array.
Sample call
{
"rest_call": "get_paypal_avs_status_m",
"output_format": "json",
"client_no": 100848,
"auth_key": "8cfb51c1c9110f4152c",
"acct_no": 5017732,
"email": "dana.brooks@example.com",
"billing_group_no": 3312
}
The rest_call and output_format fields are envelope fields added by the REST layer; they do not appear in the method's own argument list. The account is identified by acct_no, the Aria-assigned account identifier, rather than by its alternative, client_acct_id; only one of the two belongs in a single call. Similarly, billing_group_no, the Aria-assigned billing group number, is used instead of its alternative, client_billing_group_id. The email field is the PayPal member's email address and is logged in masked form by Aria for privacy.
Sample response
{
"error_code": 0,
"error_msg": "OK",
"bill_agreement_id": "B-8KX40912LP3339217",
"email": "dana.brooks@example.com",
"paypal_confirmationcode": "Confirmed",
"paypal_streetmatch": "Matched",
"paypal_zipmatch": "Matched",
"paypal_countrycode": "US",
"paypal_token": "EC-5AC12345XY6789012ABCDEFGHIJKLMNOPQRSTUV"
}
An error_code of zero and an error_msg of "OK" indicate the request completed successfully. The paypal_confirmationcode value of Confirmed means the postal address on file matches PayPal's records, since the paypal_streetmatch value of Matched means the street address matched and the paypal_zipmatch value of Matched means the zip code matched as well; other allowable values for these three fields are None and, for confirmationcode, Unconfirmed, which the method returns when the email address or address details do not match PayPal's records. The paypal_token value is an encrypted token that, when passed to a Buy Now button, restricts the buyer to the verified email address and postal address for twenty-four hours. This example leaves out the error_details field, since it is marked nonpublic in the method definition.