POST - Gift (Batch) missing batch_number & batch_id in response

Marlin Integrations · September 2023

Hello,

We would like to record the batch_number & batch_id upon successful gift creation in a batch.

We're using this API endpoint https://api.sky.blackbaud.com/gift/v1/giftbatches/{batch_id}/gifts

The documentation states that the batch_number & batch_id are supposed to be included in the response

efcfe117bf43a19690b73f1fc564a8c2-huge-im

However, although we are receiving a successful response with no errors at all, the batch_number & batch_id are missing in the response.

We only receive this:

{"errors":[],"gifts":[{"errors":[],"id":"545493","acknowledgements":[],"amount":{"value":3},"constituent_id":"334472","date":"2023-09-12T21:41:13","fundraisers":[],"gift_splits":[{"id":"671012","amount":{"value":3},"appeal_id":"1568","campaign_id":"2","fund_id":"19"}],"gift_status":"Active","is_anonymous":false,"linked_gifts":[],"lookup_id":"d247fc3c-9712-4ff8-95fc-e7a71b1291ce","origin":"{\\"name\\": \\"API\\"}","payments":[{"payment_method":"CreditCard"}],"post_status":"DoNotPost","receipts":[{"amount":{"value":3},"date":"2023-09-12T21:41:13","status":"RECEIPTED"}],"reference":"Newly added gift","soft_credits":[],"subtype":"EDH","type":"Donation"}]}

Is there any way to enforce the batch_number & batch_id to be included in the response?

Any advice will be highly appreciated.

Alex Wong · September 2023

@Marlin Integrations
First of all, I think the response schema in the documentation is likely incorrect. You should open a support case with Blackbaud if you haven't already.

Secondly, I'm wondering why you need the batch_id and batch_number properties. You are using the POST Gift (Batch) endpoint which requires you to provide a batch_id for the batch you want to post into, meaning before you make the call, you already know what the batch_id is. Same with batch_number, it is provided by you in the Request Body JSON, so the batch_number is something that you “formulate” in your code already that is used in the Request Body. So I'm wondering why you would need these 2 properties back.

Marlin Integrations · September 2023

@Alex Wong
Our expectation was that if the batch_id suppose to be included in the response then we can't be 100% sure the gift was pushed into the batch with the provided batch_id. I understand the chance that the gift won't be pushed into the requested batch is probably very low or zero but we would like to be 100% sure.

Alex Wong · September 2023

@Marlin Integrations
while you are setting up this automation/integration, testing will reveal if the API is working as expected. If a gift did not get created into the batch, you should be getting a error response from the API, and that's how you tell if your POST api succeeded or not. If it is not working in this manner, that's a support ticket to BB.

Marlin Integrations · September 2023

@Alex Wong Thanks for your response. The reason we want to get the 2 properties back in the response is to have 100% confirmation that the gift was added to the batch number and ID specified. One of our clients has stated that they have had a few occurrences where a gift has been put into a different batch. We believe this is because it was manually moved but wanted to be able to record the batch ID and number in the response to be 100% confident.

POST - Gift (Batch) missing batch_number & batch_id in response

Comments

Categories