PowerBuilder / Salesforce Platform APIs / Update Gift Transaction Payments
Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_Json
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
integer li_Success
string ls_Href
string ls_Id
integer li_Successes
integer li_Failures
integer li_NotProcessed
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "updates": [
// {
// "giftTransactionId": "<SFDC_GIFT_TRANSACTION_ID>",
// "transactionStatus": "Paid",
// "processorReference": "string",
// "gatewayReference": "string",
// "lastGatewayResponseCode": "invalid_cvc",
// "lastGatewayErrorMessage": "The card’s security code is invalid. Check the card’s security code or use a different card.",
// "lastGatewayProcessedDateTime": "2023-07-06T21:57:51Z",
// "processorTransactionFee": 0.5,
// "gatewayTransactionFee": 0.25,
// "donorCoverAmount": 10.5
// },
// {
// "giftTransactionId": "<SFDC_GIFT_TRANSACTION_ID>",
// "transactionStatus": "Paid",
// "processorReference": "string",
// "gatewayReference": "string",
// "lastGatewayResponseCode": "invalid_cvc",
// "lastGatewayErrorMessage": "The card’s security code is invalid. Check the card’s security code or use a different card.",
// "lastGatewayProcessedDateTime": "2023-07-06T21:57:51Z",
// "processorTransactionFee": 1.00,
// "gatewayTransactionFee": 0.45,
// "donorCoverAmount": 20.00
// }
// ]
// }
loo_Json = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")
loo_Json.UpdateString("updates[0].giftTransactionId","<SFDC_GIFT_TRANSACTION_ID>")
loo_Json.UpdateString("updates[0].transactionStatus","Paid")
loo_Json.UpdateString("updates[0].processorReference","string")
loo_Json.UpdateString("updates[0].gatewayReference","string")
loo_Json.UpdateString("updates[0].lastGatewayResponseCode","invalid_cvc")
loo_Json.UpdateString("updates[0].lastGatewayErrorMessage","The card’s security code is invalid. Check the card’s security code or use a different card.")
loo_Json.UpdateString("updates[0].lastGatewayProcessedDateTime","2023-07-06T21:57:51Z")
loo_Json.UpdateNumber("updates[0].processorTransactionFee","0.5")
loo_Json.UpdateNumber("updates[0].gatewayTransactionFee","0.25")
loo_Json.UpdateNumber("updates[0].donorCoverAmount","10.5")
loo_Json.UpdateString("updates[1].giftTransactionId","<SFDC_GIFT_TRANSACTION_ID>")
loo_Json.UpdateString("updates[1].transactionStatus","Paid")
loo_Json.UpdateString("updates[1].processorReference","string")
loo_Json.UpdateString("updates[1].gatewayReference","string")
loo_Json.UpdateString("updates[1].lastGatewayResponseCode","invalid_cvc")
loo_Json.UpdateString("updates[1].lastGatewayErrorMessage","The card’s security code is invalid. Check the card’s security code or use a different card.")
loo_Json.UpdateString("updates[1].lastGatewayProcessedDateTime","2023-07-06T21:57:51Z")
loo_Json.UpdateNumber("updates[1].processorTransactionFee","1.00")
loo_Json.UpdateNumber("updates[1].gatewayTransactionFee","0.45")
loo_Json.UpdateNumber("updates[1].donorCoverAmount","20.00")
// Adds the "Authorization: Bearer <access_token>" header.
loo_Http.AuthToken = "<access_token>"
loo_Resp = loo_Http.PostJson3("https://domain.com/services/data/v{{version}}/connect/fundraising/transactions/payment-updates","application/json",loo_Json)
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_Json
return
end if
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_Json
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_Resp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "successes": 2,
// "failures": 0,
// "notProcessed": 0,
// "details": [
// {
// "success": true,
// "links": {
// "gifttransaction": {
// "href": "/services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_TRANSACTION_ID>",
// "id": "<SFDC_GIFT_TRANSACTION_ID>"
// }
// }
// },
// {
// "success": true,
// "links": {
// "gifttransaction": {
// "href": "/services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_TRANSACTION_ID>",
// "id": "<SFDC_GIFT_TRANSACTION_ID>"
// }
// }
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
li_Successes = loo_JResp.IntOf("successes")
li_Failures = loo_JResp.IntOf("failures")
li_NotProcessed = loo_JResp.IntOf("notProcessed")
i = 0
li_Count_i = loo_JResp.SizeOfArray("details")
do while i < li_Count_i
loo_JResp.I = i
li_Success = loo_JResp.BoolOf("details[i].success")
ls_Href = loo_JResp.StringOf("details[i].links.gifttransaction.href")
ls_Id = loo_JResp.StringOf("details[i].links.gifttransaction.id")
i = i + 1
loop
destroy loo_Http
destroy loo_Json
destroy loo_SbResponseBody
destroy loo_JResp
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-d '{
"updates": [
{
"giftTransactionId": "<SFDC_GIFT_TRANSACTION_ID>",
"transactionStatus": "Paid",
"processorReference": "string",
"gatewayReference": "string",
"lastGatewayResponseCode": "invalid_cvc",
"lastGatewayErrorMessage": "The card’s security code is invalid. Check the card’s security code or use a different card.",
"lastGatewayProcessedDateTime": "2023-07-06T21:57:51Z",
"processorTransactionFee": 0.5,
"gatewayTransactionFee": 0.25,
"donorCoverAmount": 10.5
},
{
"giftTransactionId": "<SFDC_GIFT_TRANSACTION_ID>",
"transactionStatus": "Paid",
"processorReference": "string",
"gatewayReference": "string",
"lastGatewayResponseCode": "invalid_cvc",
"lastGatewayErrorMessage": "The card’s security code is invalid. Check the card’s security code or use a different card.",
"lastGatewayProcessedDateTime": "2023-07-06T21:57:51Z",
"processorTransactionFee": 1.00,
"gatewayTransactionFee": 0.45,
"donorCoverAmount": 20.00
}
]
}'
https://domain.com/services/data/v{{version}}/connect/fundraising/transactions/payment-updates
Postman Collection Item JSON
{
"name": "Update Gift Transaction Payments",
"request": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"updates\": [\n {\n \"giftTransactionId\": \"<SFDC_GIFT_TRANSACTION_ID>\",\n \"transactionStatus\": \"Paid\",\n \"processorReference\": \"string\",\n \"gatewayReference\": \"string\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\",\n \"processorTransactionFee\": 0.5,\n \"gatewayTransactionFee\": 0.25,\n \"donorCoverAmount\": 10.5\n },\n {\n \"giftTransactionId\": \"<SFDC_GIFT_TRANSACTION_ID>\",\n \"transactionStatus\": \"Paid\",\n \"processorReference\": \"string\",\n \"gatewayReference\": \"string\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\",\n \"processorTransactionFee\": 1.00,\n \"gatewayTransactionFee\": 0.45,\n \"donorCoverAmount\": 20.00\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/transactions/payment-updates",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"connect",
"fundraising",
"transactions",
"payment-updates"
]
},
"description": "Update the gateway and processor metadata for gift transactions.\n\n## Required Attributes:\n\n- giftTransactionId\n \n- transactionStatus"
},
"response": [
{
"name": "Status201-UpdateTransactionPaymentSuccess",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"updates\": [\n {\n \"giftTransactionId\": \"<SFDC_GIFT_TRANSACTION_ID>\",\n \"transactionStatus\": \"Paid\",\n \"processorReference\": \"string\",\n \"gatewayReference\": \"string\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\",\n \"processorTransactionFee\": 0.5,\n \"gatewayTransactionFee\": 0.25,\n \"donorCoverAmount\": 10.5\n },\n {\n \"giftTransactionId\": \"<SFDC_GIFT_TRANSACTION_ID>\",\n \"transactionStatus\": \"Paid\",\n \"processorReference\": \"string\",\n \"gatewayReference\": \"string\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\",\n \"processorTransactionFee\": 1.00,\n \"gatewayTransactionFee\": 0.45,\n \"donorCoverAmount\": 20.00\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/transactions/payment-updates",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"connect",
"fundraising",
"transactions",
"payment-updates"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": ""
}
],
"cookie": [
],
"body": "{\n \"successes\": 2,\n \"failures\": 0,\n \"notProcessed\": 0,\n \"details\": [\n {\n \"success\": true,\n \"links\": {\n \"gifttransaction\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_TRANSACTION_ID>\",\n \"id\": \"<SFDC_GIFT_TRANSACTION_ID>\"\n }\n }\n },\n {\n \"success\": true,\n \"links\": {\n \"gifttransaction\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_TRANSACTION_ID>\",\n \"id\": \"<SFDC_GIFT_TRANSACTION_ID>\"\n }\n }\n }\n ]\n}"
},
{
"name": "Status201-UpdateTransactionPaymentRequestValidationFailed",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"updates\": [\n {\n \"giftTransactionId\": \"INVALID GIFT TRANSACTION ID\",\n \"transactionStatus\": \"Paid\",\n \"processorReference\": \"string\",\n \"gatewayReference\": \"string\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\",\n \"processorTransactionFee\": 0.5,\n \"gatewayTransactionFee\": 0.25,\n \"donorCoverAmount\": 10.5\n },\n {\n \"giftTransactionId\": \"<SFDC_GIFT_TRANSACTION_ID>\",\n \"transactionStatus\": \"Paid\",\n \"processorReference\": \"string\",\n \"gatewayReference\": \"string\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\",\n \"processorTransactionFee\": 1.00,\n \"gatewayTransactionFee\": 0.45,\n \"donorCoverAmount\": 20.00\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/transactions/payment-updates",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"connect",
"fundraising",
"transactions",
"payment-updates"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": ""
}
],
"cookie": [
],
"body": "{\n \"successes\": 1,\n \"failures\": 1,\n \"notProcessed\": 0,\n \"details\": [\n {\n \"success\": false,\n \"errors\": {\n \"field\": \"id\",\n \"message\": \"<invalid id message>\"\n }\n },\n {\n \"success\": true,\n \"links\": {\n \"gifttransaction\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_TRANSACTION_ID>\",\n \"id\": \"<SFDC_GIFT_TRANSACTION_ID>\"\n }\n }\n }\n ]\n}"
},
{
"name": "Status201-UpdateTransactionPaymentDatabaseFailure",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"updates\": [\n {\n \"giftTransactionId\": \"<SFDC_GIFT_TRANSACTION_ID>\",\n \"transactionStatus\": \"Invalid Transaction Status\",\n \"processorReference\": \"string\",\n \"gatewayReference\": \"string\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\",\n \"processorTransactionFee\": 0.5,\n \"gatewayTransactionFee\": 0.25,\n \"donorCoverAmount\": 10.5\n },\n {\n \"giftTransactionId\": \"<SFDC_GIFT_TRANSACTION_ID>\",\n \"transactionStatus\": \"Paid\",\n \"processorReference\": \"string\",\n \"gatewayReference\": \"string\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\",\n \"processorTransactionFee\": 1.00,\n \"gatewayTransactionFee\": 0.45,\n \"donorCoverAmount\": 20.00\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/transactions/payment-updates",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"connect",
"fundraising",
"transactions",
"payment-updates"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": ""
}
],
"cookie": [
],
"body": "// This is a scenario where there is a validation rule on the Gift Transaction object requiring the donor cover amount to be less than 10.00. One database error occurs for the 10.50 cover amount, causing the other two to be rolled back with success of false and no record links.\n{\n \"successes\": 0,\n \"failures\": 1,\n \"notProcessed\": 1,\n \"details\": [\n {\n \"success\": false,\n \"errors\": {\n \"message\": \"Donor cover amount must be less than 10.00\"\n }\n },\n {\n \"success\": false\n }\n ]\n}"
},
{
"name": "Status201-UpdateTransactionPaymentWithExternalIds",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"updates\": [\n {\n \"giftTransaction\": {\n \"externalId\": {\n \"fieldName\": \"<EXTERNAL_ID_FIELD_NAME>\",\n \"fieldValue\": \"<EXTERNAL_ID_FIELD_VALUE>\"\n }\n },\n \"transactionStatus\": \"Paid\",\n \"processorReference\": \"string\",\n \"gatewayReference\": \"string\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\",\n \"processorTransactionFee\": 0.5,\n \"gatewayTransactionFee\": 0.25,\n \"donorCoverAmount\": 10.5\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/transactions/payment-updates",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"connect",
"fundraising",
"transactions",
"payment-updates"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": ""
}
],
"cookie": [
],
"body": "{\n \"successes\": 1,\n \"failures\": 0,\n \"notProcessed\": 0,\n \"details\": [\n {\n \"success\": true,\n \"links\": {\n \"gifttransaction\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_TRANSACTION_ID>\",\n \"id\": \"<SFDC_GIFT_TRANSACTION_ID>\"\n }\n }\n }\n ]\n}"
},
{
"name": "Status400-BadRequestError",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"updates\": [\n {\n \"giftTransactionId\": \"<SFDC_GIFT_TRANSACTION_ID>\",\n \"transactionStatus\": \"Paid\",\n \"processorReference\": \"string\",\n \"gatewayReference\": \"string\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\",\n \"processorTransactionFee\": 0.5,\n \"gatewayTransactionFee\": 0.25,\n \"donorCoverAmount\": 10.5\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/transactions/payment-updates",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"connect",
"fundraising",
"transactions",
"payment-updates"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": ""
}
],
"cookie": [
],
"body": "// Even if the JSON request is valid, this is an example of a 400 error code that will be returned if duplicate matching rules are not active. Any non 200 error code would have a similar response structure.\n{\n \"errorCode\": \"UNKNOWN_EXCEPTION\",\n \"message\": \"Provide active duplicate matching rules on Account and Person Account for donor matching. -- industries.fundraisingops.connect.impl.validator.ValidatorUtil.validateMatchingMethod(ValidatorUtil.java:103)\"\n}"
}
]
}
