Add a pledge gift with installments to a batch

Gustavo Hernandez

I've been trying to record a Pledge gift using https://api.sky.blackbaud.com/gft-gifts/v2/batchgifts/{batchId} endpoint. I have recorded the pledge gift and i can verify the Raiser's Edge NXT View. However, the installments and payment method are not recorded. Also, it seems that the ReceiptStatus property is wrong, i get the next error "A gift receipt must have a valid receipt status" with the error code GiftReceiptMustHaveValidReceiptStatus. However, If i change the property to receipt_status then it no longer give errors, but it doesn't appear in the gift registry in Raiser's Edge NXT. Here is an example of code:

{
"amount": {
"value": 1
},
"gift_splits": [
{
"amount": {
"value": 1
},
"fund_id": "383",
"campaign_id": "413",
"appeal_id": "1033"
}
],
"comments": "Test",
"anonymous": true,
"constituent": {
"id": "167708"
},
"gift_date": "2025-02-25T18:22:16Z",
"gift_post_status": "DoNotPost",
"gift_post_date": null,
"gift_type": "Pledge",
"send_reminder": false,
"pledge_installments": [
{
"amount": 1,
"date": "2025-02-26T08:00:00Z"
}
],
"payments": [
{
"amount": {
"value": 1
},
"method": "Cash"
}
],
"receipts": [
{
"ReceiptStatus": "DONOTRECEIPT",
"receipt_amount": {
"value": 1
}
}
],
"acknowledgements": [
{
"status": "NotAcknowledged"
}
],
"custom_fields": [
{
"category": 84,
"date": "2025-02-25T18:22:16Z",
"description": "http://localhost:8080/"
},
{
"category": 85,
"date": "2025-02-25T18:22:16Z",
"description": "Radiotón"
}
]
}

Is there an error in the JSON configuration that is causing problems?

Alex Wong

@Gustavo Hernandez
API doc has an issue with using the “title” as the name on the JSON, which is wrong.

if you click the { } for the codeview, you will see:

Gustavo Hernandez

Thank you very much, I no longer have any issues with the reciept status. However, I am unable to register the installments and payment method. Any idea what else could be the problem?
I am attaching the JSON and screenshot of Raiser's Edge NXT View.

{
"amount": {
"value": 1
},
"gift_splits": [
{
"amount": {
"value": 1
},
"fund_id": "383",
"campaign_id": "413",
"appeal_id": "1033"
}
],
"comments": "Test",
"anonymous": true,
"constituent": {
"id": "167708"
},
"gift_date": "2025-02-28T16:51:36Z",
"gift_post_status": "DoNotPost",
"gift_post_date": null,
"gift_type": "Pledge",
"send_reminder": false,
"pledge_installments": [
{
"amount": 1,
"date": "2025-03-01T08:00:00Z"
}
],
"payments": [
{
"amount": {
"value": 1
},
"method": "Cash",
"PaymentMethod": "Cash"
}
],
"receipts": [
{
"receipt_status": "DoNotReceipt",
"receipt_amount": {
"value": 1
}
}
],
"acknowledgements": [
{
"status": "NotAcknowledged"
}
],
"custom_fields": [
{
"category": 84,
"date": "2025-02-28T16:51:36Z",
"description": "http://localhost/"
},
{
"category": 85,
"date": "2025-02-28T16:51:36Z",
"description": "Radiotón"
}
]
}

The payment method doesn´t appear

Installments are not created

Alex Wong

@Gustavo Hernandez
what you are trying to use the payments property to do?

looking at your JSON, you are specifying $1 and Cash. This doesn't make sense. You are adding a pledge record to the batch, if you want to add pledge payment, that's cannot be done in the same gift add.

If you are trying to specify the payment method

Then your JSON should be:

"payments": [
{
"method": "Cash"
}
]

again the problem here is the “title” PaymentMethod is wrong, you need to click the coding { } icon to see the actual property name: method.

As for your installment, what you have is correct, just not showing in the gift batch editing. if you commit the batch, you will see the installment is created.