Address fields are not being passed to the API

[Benunc]

Issue Overview

The Give API is not picking up Donor Address data in either the Donor endpoint or the Donation endpoint.

Expected Behavior

When a donation is processed, the Donation and Donor endpoints should include donor address data.

Current Behavior

Currently on the Donation Endpoint, there are the following fields:

"ID"
"transaction_id"
"key"
"total"
"gateway"
"name"
"fname"
"lname"
"email"
"date"
"form" {
   "id"
   "name"
   "price"
            },
"payment_meta": {
   "fees": [],
   "currency": "USD"
            }

Currently on the Donor endpoint there are the following fields:

"info": {
   "user_id"
   "username"
   "display_name"
   "customer_id"
   "first_name"
   "last_name"
   "email"
            },
"stats": {
   "total_donations"
   "total_spent"
            }

Steps to Reproduce

1. Create a form with address required
2. Submit a donation
3. Check the API URL donation endpoint here: http://yoursite.com/give-api/donations/?key=YOURPUBLICKEYHERE&token=YOURTOKENHERE and the Donor endpoint here: http://yoursite.com/give-api/donor/?key=YOURPUBLICKEYHERE&token=YOURTOKENHERE following the instructions in the API reference: https://givewp.com/documentation/developers/give-api-reference/
4. No Address field is there.

[mathetos]

@Benunc Did you also check the /donation endpoint instead of just the /donor endpoint?

[Benunc]

Yes, as noted in the issue. Neither endpoint is functional for addresses.

[DevinWalker]

The donor address and billing address are separate from each other. See #370 for details. Despite this, the billing address should be included within the payment_meta array on the both endpoints

[kevinwhoffman]

@DevinWalker I just left feedback on #370 (comment). Do you think that issue needs resolved before fixing the API here? If the location of where donor addresses are saved within the database changes, that will affect where the API retrieves them from.

[DevinWalker]

@kevinwhoffman please review my comment on #370 and LMK what you think. If you agree the location of the billing address in _give_payment_meta stays in place then we can proceed here.

[kevinwhoffman]

@DevinWalker I agree that billing address stays within _give_payment_meta, so I can fix the Donations endpoint, but addresses in the Donor endpoint should wait until the changes mentioned in #370 are complete. Agree?

[DevinWalker]

Agree, yes. Ideally we'll loop through the _give_payment_meta array and output the contents within the API response which should show other payment meta besides address if using FFM or custom code.

[DevinWalker]

@emgk can you take care of this for me?

[emgk]

Sure, @DevinWalker I will check

[emgk]

I have reproduced this issue and found that \donations endpoint containing payment billing_address but not donor_address and \donor has no address in it.

Despite this, the billing address should be included within the payment_meta array on the both endpoints

@DevinWalker as mentioned in above line, do we need to include payment_meta array in /donor endpoint as well? Because billing_address may vary for each donation created by any particular donor, so how would we determine which billing_address it should contain for the specific donor?

[DevinWalker]

Hey @emgk - the /donations/ endpoint should only have the billing address for that payment. The /donor/ endpoint should loop through all the addresses attached to the donor and output them. You don't need to include all the payment meta info.

[mathetos]

Just tested and this works perfectly. Just wanted to confirm. See here: