Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
// 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
// }
// ]
// }
loJson = createobject("CkJsonObject")
loJson.UpdateString("updates[0].giftTransactionId","<SFDC_GIFT_TRANSACTION_ID>")
loJson.UpdateString("updates[0].transactionStatus","Paid")
loJson.UpdateString("updates[0].processorReference","string")
loJson.UpdateString("updates[0].gatewayReference","string")
loJson.UpdateString("updates[0].lastGatewayResponseCode","invalid_cvc")
loJson.UpdateString("updates[0].lastGatewayErrorMessage","The card’s security code is invalid. Check the card’s security code or use a different card.")
loJson.UpdateString("updates[0].lastGatewayProcessedDateTime","2023-07-06T21:57:51Z")
loJson.UpdateNumber("updates[0].processorTransactionFee","0.5")
loJson.UpdateNumber("updates[0].gatewayTransactionFee","0.25")
loJson.UpdateNumber("updates[0].donorCoverAmount","10.5")
loJson.UpdateString("updates[1].giftTransactionId","<SFDC_GIFT_TRANSACTION_ID>")
loJson.UpdateString("updates[1].transactionStatus","Paid")
loJson.UpdateString("updates[1].processorReference","string")
loJson.UpdateString("updates[1].gatewayReference","string")
loJson.UpdateString("updates[1].lastGatewayResponseCode","invalid_cvc")
loJson.UpdateString("updates[1].lastGatewayErrorMessage","The card’s security code is invalid. Check the card’s security code or use a different card.")
loJson.UpdateString("updates[1].lastGatewayProcessedDateTime","2023-07-06T21:57:51Z")
loJson.UpdateNumber("updates[1].processorTransactionFee","1.00")
loJson.UpdateNumber("updates[1].gatewayTransactionFee","0.45")
loJson.UpdateNumber("updates[1].donorCoverAmount","20.00")
// Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loResp = loHttp.PostJson3("https://domain.com/services/data/v{{version}}/connect/fundraising/transactions/payment-updates","application/json",loJson)
if (loHttp.LastMethodSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loJson
return
endif
loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loResp.Header
? "Failed."
release loResp
release loHttp
release loJson
release loSbResponseBody
release loJResp
return
endif
release loResp
// 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
lnSuccesses = loJResp.IntOf("successes")
lnFailures = loJResp.IntOf("failures")
lnNotProcessed = loJResp.IntOf("notProcessed")
i = 0
lnCount_i = loJResp.SizeOfArray("details")
do while i < lnCount_i
loJResp.I = i
llSuccess = loJResp.BoolOf("details[i].success")
lcHref = loJResp.StringOf("details[i].links.gifttransaction.href")
lcId = loJResp.StringOf("details[i].links.gifttransaction.id")
i = i + 1
enddo
release loHttp
release loJson
release loSbResponseBody
release loJResp
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}"
}
]
}
