{"info":{"_postman_id":"3065e830-9385-46c0-a95e-53428aae26d1","name":"ChangeUp Donation API Reference","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"25013896","collectionId":"3065e830-9385-46c0-a95e-53428aae26d1","publishedId":"2sBXinGACm","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-03-30T02:38:28.000Z"},"item":[{"name":"Widget Components","item":[{"name":"Create donation widget","id":"fe057d54-cdff-4e38-9c84-bc2eb97a5485","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-client-id","value":"{{x-client-id}}","description":"

(Required) - Client id

\n","type":"text"},{"key":"x-api-key","value":"{{x-api-key}}","description":"

(Required) - API Secret key

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"widgetName\": \"Stadium 1\",\n \"type\": \"donate-at-checkout\",\n \"environment\": \"test\",\n \"charityDefault\": \"0810af66-23b3-4f26-9c09-83960cd6713b\",\n \"charitySecond\": \"77577d91-c264-4ac4-b66a-9b7913f0137b\",\n \"charityThird\": \"77577d91-c264-4ac4-b66a-9b7913f0137b\",\n \"showDescriptions\": false,\n \"whoDonates\": \"customer+merchant\",\n \"whatFormat\": \"roundup\",\n \"whatAmountFixed\": 1,\n \"whatAmountPercent\": 10,\n \"showCharityLogos\": true,\n \"textDonationHeader\": \"Donate the change and we'll match it!\",\n \"textSubtitle\": \"Your purchase supports our awesome charity partner and we're matching your donation!\",\n \"supersize\": false,\n \"supersizeAmountOne\": 1 ,\n \"supersizeAmountTwo\": 2,\n \"supersizeAmountThree\": 5,\n \"textSupersizeHeadline\": \"Increase your donation amount?\",\n \"optInPlacement\": \"description\",\n \"metadata\": {\n \"merchantName\": \"teststore\",\n \"merchantId\": \"3234243243243242\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"/v1/widgets","description":"

Widget needs to be generated to enable donation(s) creation

\n
\n

Note: Three charities can be assinged per widget

\n
\n
Request Body Properties
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeDescription
widgetNameStringRequired
Widget name associated with your store or merchant
typeStringOptional
Widget functionality type
environmentStringRequired
Whether to create a widget in the Test or Live environment
charityDefaultStringOptional
The default charity to be used for donation(s). The first charity listed will be assigned as the default
charitySecondStringOptional
Second charity assigned to the widget
charityThirdStringOptional
Third charity assigned to the widget
showDescriptionsBooleanOptional
Whether to enable the charity descriptions for the widget
whoDonatesStringRequired
Who makes the donation?
Example: customer, merchant or customer+merchant
whatFormatStringRequired
What's the donation format? Example: round or percent or fixed
whatAmountFixedNumberOptional
If the fixed value was provided in the whatFormat field, provide the fixed amount value
whatAmountPercentNumberOptional
If the percent value was provided in the whatFormat field, provide the percent value
showCharityLogosBooleanRequired
Whether to show the charity logos during checkout
textDonationHeaderStringOptional
Text entry for the donation header
textSubtitleStringOptional
Text entry for the donation subtitle
supersizeBooleanRequired
Whether to activate the Supersize feature. True/false
supersizeAmountOneNumberOptional
If supersize was true, set a Supersize amount. 1 is represented as $1.00, as an example
supersizeAmountTwoNumberOptional
Additional supersize amount. 2 is represented as $2.00, as an example
supersizeAmountThreeNumberOptional
Additional supersize amount. 3 is represented as $3.00, as an example
textSupersizeHeadlineStringOptional
The headline for the Supersize feature
optInPlacementStringOptional
Position of the opt-in checkbox
metadataObjectOptional
Additional descriptive data for this widget
\n
","urlObject":{"path":["v1","widgets"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"fdc59711-4417-45e9-94e4-495106b5b42d","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"/v1/platforms/widgets"},"code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"_id\": \"d21650a6-36d4-493b-912f-545aef5bace0\",\n \"widgetName\": \"Stadium 1\",\n \"type\": \"donate-at-checkout\",\n \"environment\": \"test\",\n \"charityDefault\": \"0810af66-23b3-4f26-9c09-83960cd6713b\",\n \"charitySecond\": \"77577d91-c264-4ac4-b66a-9b7913f0137b\",\n \"charityThird\": \"77577d91-c264-4ac4-b66a-9b7913f0137b\",\n \"showDescriptions\": false,\n \"who\": \"customer+merchant\",\n \"what\": \"roundup\",\n \"whatAmountFixed\": 1,\n \"whatAmountPercent\": 10,\n \"showCharityLogos\": true,\n \"textDonationHeader\": \"Donate the change and we'll match it!\",\n \"textSubtitle\": \"Your purchase supports our awesome charity partner and we're matching your donation!\",\n \"supersize\": false,\n \"supersizeAmountOne\": 1,\n \"supersizeAmountTwo\": 2,\n \"supersizeAmountThree\": 5,\n \"textSupersizeHeadline\": \"Increase your donation amount?\",\n \"optInPlacement\": \"description\",\n \"metadata\": {\n \"merchantName\": \"teststore\",\n \"merchantId\": \"3234243243243242\"\n }\n}"}],"_postman_id":"fe057d54-cdff-4e38-9c84-bc2eb97a5485"},{"name":"Update widget","id":"963f9629-407f-4b7f-9803-ef774ff7a517","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"x-client-id","value":"{{x-client-id}}","description":"

(Required) - Client id

\n","type":"text"},{"key":"x-api-key","value":"{{x-api-key}}","description":"

(Required) - API Secret key

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"widgetName\": \"Stadium 1\",\n \"type\": \"donate-at-checkout\",\n \"environment\": \"test\",\n \"charityDefault\": \"0810af66-23b3-4f26-9c09-83960cd6713b\",\n \"charitySecond\": \"77577d91-c264-4ac4-b66a-9b7913f0137b\",\n \"charityThird\": \"77577d91-c264-4ac4-b66a-9b7913f0137b\",\n \"showDescriptions\": false,\n \"whoDonates\": \"customer+merchant\",\n \"whatFormat\": \"roundup\",\n \"whatAmountFixed\": 1,\n \"whatAmountPercent\": 10,\n \"showCharityLogos\": true,\n \"textDonationHeader\": \"Donate the change and we'll match it!\",\n \"textSubtitle\": \"Your purchase supports our awesome charity partner and we're matching your donation!\",\n \"supersize\": false,\n \"supersizeAmountOne\": 1 ,\n \"supersizeAmountTwo\": 2,\n \"supersizeAmountThree\": 5,\n \"textSupersizeHeadline\": \"Increase your donation amount?\",\n \"optInPlacement\": \"description\",\n \"metadata\": {\n \"merchantName\": \"teststore\",\n \"merchantId\": \"3234243243243242\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"/v1/widgets/:id","description":"

Update widget by id

\n
Request Body Properties
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeDescription
widgetNameStringRequired
Widget name associated with your store or merchant
typeStringOptional
Widget functionality type
environmentStringRequired
Whether to create a widget in the Test or Live environment
charityDefaultStringOptional
The default charity to be used for donation(s). The first charity listed will be assigned as the default
charitySecondStringOptional
Second charity assigned to the widget
charityThirdStringOptional
Third charity assigned to the widget
showDescriptionsBooleanOptional
Whether to enable the charity descriptions for the widget
whoDonatesStringRequired
Who makes the donation?
Example: customer, merchant or customer+merchant
whatFormatStringRequired
What's the donation format. Example: roundup or percent or fixed
whatAmountFixedNumberOptional
If fixed value was provided in the whatFormat field, provide the fixed amount value
whatAmountPercentNumberOptional
If the percent value was provided in the whatFormat field, provide the percent value
showCharityLogosBooleanRequired
Whether to show the charity logos during checkout
textDonationHeaderStringOptional
Text entry for the donation header
textSubtitleStringOptional
Text entry for the donation subtitle
supersizeBooleanRequired
Whether to activate the Supersize feature. True/false
supersizeAmountOneNumberOptional
If supersize was true, set a Supersize amount. 1 is represented as $1.00, as an example
supersizeAmountTwoNumberOptional
Additional supersize amount. 2 is represented as $2.00, as an example
supersizeAmountThreeNumberOptional
Additional supersize amount. 3 is represented as $3.00, as an example
textSupersizeHeadlineStringOptional
The headline for the Supersize feature
optInPlacementStringOptional
Position of the opt-in checkbox
metadataObjectOptional
Additional descriptive data for this widget
\n
","urlObject":{"path":["v1","widgets",":id"],"host":[""],"query":[],"variable":[{"description":{"content":"

Widget Id

\n","type":"text/plain"},"type":"any","value":"d21650a6-36d4-493b-912f-545aef5bace0","key":"id"}]}},"response":[{"id":"0ac1a763-0b54-4d8e-a6ea-be492f247ca0","name":"Success","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":""},"url":{"raw":"/v1/platforms/widgets/:id","host":[""],"path":["v1","platforms","widgets",":id"],"variable":[{"key":"id","value":"d21650a6-36d4-493b-912f-545aef5bace0","description":"Widget Id"}]}},"code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"_id\": \"d21650a6-36d4-493b-912f-545aef5bace0\",\n \"widgetName\": \"Stadium 1\",\n \"type\": \"donate-at-checkout\",\n \"environment\": \"test\",\n \"charityDefault\": \"0810af66-23b3-4f26-9c09-83960cd6713b\",\n \"charitySecond\": \"77577d91-c264-4ac4-b66a-9b7913f0137b\",\n \"charityThird\": \"77577d91-c264-4ac4-b66a-9b7913f0137b\",\n \"showDescriptions\": false,\n \"who\": \"customer+merchant\",\n \"what\": \"roundup\",\n \"whatAmountFixed\": 1,\n \"whatAmountPercent\": 10,\n \"showCharityLogos\": true,\n \"textDonationHeader\": \"Donate the change and we'll match it!\",\n \"textSubtitle\": \"Your purchase supports our awesome charity partner and we're matching your donation!\",\n \"supersize\": false,\n \"supersizeAmountOne\": 1,\n \"supersizeAmountTwo\": 2,\n \"supersizeAmountThree\": 5,\n \"textSupersizeHeadline\": \"Increase your donation amount?\",\n \"optInPlacement\": \"description\",\n \"metadata\": {\n \"merchantName\": \"teststore\",\n \"merchantId\": \"3234243243243242\"\n }\n}"}],"_postman_id":"963f9629-407f-4b7f-9803-ef774ff7a517"},{"name":"Fetch donation widget by id","id":"2c489d03-36c6-48e4-a3d3-f0aa59292907","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-client-id","value":"{{x-client-id}}","description":"

(Required) - Client id

\n","type":"text"},{"key":"x-api-key","value":"{{x-api-key}}","description":"

(Required) - API Secret key

\n","type":"text"}],"url":"/v1/widgets/:id","description":"

Fetch donation widget by Id

\n","urlObject":{"path":["v1","widgets",":id"],"host":[""],"query":[],"variable":[{"description":{"content":"

Widget Id

\n","type":"text/plain"},"type":"any","value":"d21650a6-36d4-493b-912f-545aef5bace0","key":"id"}]}},"response":[{"id":"9db72885-e464-4e1b-9b92-7bf5d19195a3","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"/v1/platforms/widgets/:id","host":[""],"path":["v1","platforms","widgets",":id"],"variable":[{"key":"id","value":"d21650a6-36d4-493b-912f-545aef5bace0"}]}},"code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"_id\": \"d21650a6-36d4-493b-912f-545aef5bace0\",\n \"widgetName\": \"Stadium 1\",\n \"type\": \"donate-at-checkout\",\n \"environment\": \"test\",\n \"charityDefault\": \"0810af66-23b3-4f26-9c09-83960cd6713b\",\n \"charitySecond\": \"77577d91-c264-4ac4-b66a-9b7913f0137b\",\n \"charityThird\": \"77577d91-c264-4ac4-b66a-9b7913f0137b\",\n \"showDescriptions\": false,\n \"who\": \"customer+merchant\",\n \"what\": \"roundup\",\n \"whatAmountFixed\": 1,\n \"whatAmountPercent\": 10,\n \"showCharityLogos\": true,\n \"textDonationHeader\": \"Donate the change and we'll match it!\",\n \"textSubtitle\": \"Your purchase supports our awesome charity partner and we're matching your donation!\",\n \"supersize\": false,\n \"supersizeAmountOne\": 1,\n \"supersizeAmountTwo\": 2,\n \"supersizeAmountThree\": 5,\n \"textSupersizeHeadline\": \"Increase your donation amount?\",\n \"optInPlacement\": \"description\",\n \"metadata\": {\n \"merchantName\": \"teststore\",\n \"merchantId\": \"3234243243243242\"\n }\n}"}],"_postman_id":"2c489d03-36c6-48e4-a3d3-f0aa59292907"},{"name":"Fetch all donation widgets","id":"4e8ae7cc-2828-490e-99db-008ce385aa1b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-client-id","value":"{{x-client-id}}","description":"

(Required) - Client id

\n","type":"text"},{"key":"x-api-key","value":"{{x-api-key}}","description":"

(Required) - API Secret key

\n","type":"text"}],"url":"/v1/widgets","description":"

Fetch all widgets

\n","urlObject":{"path":["v1","widgets"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"52e888de-dde1-40a3-906d-a2f10de58534","name":"Success","originalRequest":{"method":"GET","header":[],"url":"/v1/platforms/widgets"},"code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"_id\": \"d21650a6-36d4-493b-912f-545aef5bace0\",\n \"widgetName\": \"Stadium 1\",\n \"type\": \"donate-at-checkout\",\n \"environment\": \"test\",\n \"charityDefault\": \"0810af66-23b3-4f26-9c09-83960cd6713b\",\n \"charitySecond\": \"77577d91-c264-4ac4-b66a-9b7913f0137b\",\n \"charityThird\": \"77577d91-c264-4ac4-b66a-9b7913f0137b\",\n \"showDescriptions\": false,\n \"who\": \"customer+merchant\",\n \"what\": \"roundup\",\n \"whatAmountFixed\": 1,\n \"whatAmountPercent\": 10,\n \"showCharityLogos\": true,\n \"textDonationHeader\": \"Donate the change and we'll match it!\",\n \"textSubtitle\": \"Your purchase supports our awesome charity partner and we're matching your donation!\",\n \"supersize\": false,\n \"supersizeAmountOne\": 1,\n \"supersizeAmountTwo\": 2,\n \"supersizeAmountThree\": 5,\n \"textSupersizeHeadline\": \"Increase your donation amount?\",\n \"optInPlacement\": \"description\",\n \"metadata\": {\n \"merchantName\": \"teststore\",\n \"merchantId\": \"3234243243243242\"\n }\n },\n {\n \"_id\": \"e21650a6-36d4-493b-912f-545aef5bace9\",\n \"widgetName\": \"Stadium 1\",\n \"type\": \"donate-at-checkout\",\n \"environment\": \"test\",\n \"charityDefault\": \"0870af66-23b3-4f26-9c09-83960cd67139\",\n \"charitySecond\": \"87577d91-c264-4ac4-b66a-9b7913f01376\",\n \"charityThird\": \"47577d91-c464-4ac4-b66a-9b7913f01371\",\n \"showDescriptions\": false,\n \"who\": \"customer+merchant\",\n \"what\": \"roundup\",\n \"whatAmountFixed\": 1,\n \"whatAmountPercent\": 10,\n \"showCharityLogos\": true,\n \"textDonationHeader\": \"Donate the change and we'll match it!\",\n \"textSubtitle\": \"Your purchase supports our awesome charity partner and we're matching your donation!\",\n \"supersize\": false,\n \"supersizeAmountOne\": 1,\n \"supersizeAmountTwo\": 2,\n \"supersizeAmountThree\": 5,\n \"textSupersizeHeadline\": \"Increase your donation amount?\",\n \"optInPlacement\": \"description\",\n \"metadata\": {\n \"merchantName\": \"teststore\",\n \"merchantId\": \"3234243243243242\"\n }\n }\n]"}],"_postman_id":"4e8ae7cc-2828-490e-99db-008ce385aa1b"}],"id":"ee409c4f-9347-4f8b-980a-ffeb9ac96172","description":"

A component is a piece of functionality powered by the ChangeUp APIs. A donate-at-checkout widget is a small block of code generated by the APIs that enable embedding the donation functionality in your application.

\n","_postman_id":"ee409c4f-9347-4f8b-980a-ffeb9ac96172"},{"name":"Create donation","id":"5e0060eb-a1aa-4c29-9830-f14d98443218","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"ad44f9tolL0Q64zihoeuFTkA6wRqHWtNRZEaqfJghr6","description":"

(Required) - API Key Secret

\n","type":"text"},{"key":"x-client-id","value":"64ea17367eb6abe306f06bc5bcb918cc4","description":"

(Required) - Client Secret

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"donations\": [\n {\n \"userDonationAmount\": 50, //(number - required) number is represented in cents,\n \"partnerDonationAmount\": 50, // (number - optinal) number is represented in cents,\n \"delayReportBy\": \"number (optional) // delay transaction from xdays\",\n \"causeId\": \"string (required) // eg causeId from DMS\",\n \"widget\": \"string (required) // eg widgetId from DMS\",\n \"transactionId\": \"string (required) // eg: internaltransaction id\",\n \"transactionOrderDate\": \"string (optional) // eg: 2026-02-07T23:58:19\" \n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://60e0f09a-fe11-4d85-8a1a-f37e8dda3e09.mock.pstmn.io/v1/donations","description":"

Send a single or batch of donations.

\n

Creates a single donation or batch donations. Batch donations accepts a limit of 15 per request. to any nonprofit.

\n
\n

Note: To schedule a future to be posted at a future date, set the delayReportBy field (e.g., a value of 5 will delay the report for 5 days). This allows you to cancel a donation before it is finalized. Please note that once a donation is posted after the delay period, it cannot be cancelled. The maximum allowable delay is 90 days.

\n
\n","urlObject":{"path":["v1","donations"],"host":["https://60e0f09a-fe11-4d85-8a1a-f37e8dda3e09.mock.pstmn.io"],"query":[],"variable":[]}},"response":[{"id":"7baf9e5f-26f1-4b98-8f5b-de8bd6183860","name":"Success","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"","description":"(Required) "},{"key":"x-client-id","value":"","description":"(Required) "},{"key":"Content-Type","value":"application/json"}],"url":"https://60e0f09a-fe11-4d85-8a1a-f37e8dda3e09.mock.pstmn.io/v1/donations"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"statusCode\": 200,\n \"success\": true,\n \"id\": \"cmmz7tdu7000mml01kabz72aa\",\n \"sourceId\": \"USER\",\n \"status\": \"pending\",\n \"transactionId\": \"eff3db80-3aeb-4d0e-b32f-e8f42708962b\"\n }\n]"},{"id":"91149330-99db-4ed1-8357-9cfb8d7e486d","name":"Error","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"","description":"(Required) "},{"key":"x-client-id","value":"","description":"(Required) "},{"key":"Content-Type","value":"application/json"}],"url":"https://60e0f09a-fe11-4d85-8a1a-f37e8dda3e09.mock.pstmn.io/v1/donations"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"}],"_postman_id":"5e0060eb-a1aa-4c29-9830-f14d98443218"},{"name":"Fetch and filter donations","id":"7914c4ff-70be-41b5-a226-75a1a88e3336","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"ad44f9tolL0Q64zihoeuFTkA6wRqHWtNRZEaqfJghr6","description":"

(Required)

\n","type":"text"},{"key":"x-client-id","value":"64ea17367eb6abe306f06bc5bcb918cc4","description":"

(Required)

\n","type":"text"}],"url":"https://60e0f09a-fe11-4d85-8a1a-f37e8dda3e09.mock.pstmn.io/v1/donations","description":"

List all donation(s) associated with a partner account in a paginated list.

\n","urlObject":{"path":["v1","donations"],"host":["https://60e0f09a-fe11-4d85-8a1a-f37e8dda3e09.mock.pstmn.io"],"query":[{"disabled":true,"description":{"content":"

Limit of records to return

\n","type":"text/plain"},"key":"limit","value":"30"},{"disabled":true,"description":{"content":"

Which page to return. This endpoint is paginated.

\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"

(Optional) - Filter by charity Id

\n","type":"text/plain"},"key":"charityId","value":"cml8u99jg0004jy017qbr7gtf"},{"disabled":true,"description":{"content":"

(Optional) - Your transaction id used to create the donation(s)

\n","type":"text/plain"},"key":"transactionId","value":"p12444"},{"disabled":true,"description":{"content":"

(Optional) - Filter donations with a start date MM/DD/YYY

\n","type":"text/plain"},"key":"startDate","value":"05-10-2025"},{"disabled":true,"description":{"content":"

(Optional) - Filter donations with a end date

\n","type":"text/plain"},"key":"endDate","value":"06-10-2025"},{"disabled":true,"description":{"content":"

(Optional) - sort asc or desc

\n","type":"text/plain"},"key":"sortOrder","value":"desc"},{"disabled":true,"description":{"content":"

(Optional) - sort by any field

\n","type":"text/plain"},"key":"sortBy","value":"transactionId"}],"variable":[]}},"response":[{"id":"adb89014-27d5-4bef-af1b-a7c318760182","name":"Sucess","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"","description":"(Required) "},{"key":"x-client-id","value":"","description":"(Required) "}],"url":{"raw":"https://60e0f09a-fe11-4d85-8a1a-f37e8dda3e09.mock.pstmn.io/v1/donations","host":["https://60e0f09a-fe11-4d85-8a1a-f37e8dda3e09.mock.pstmn.io"],"path":["v1","donations"],"query":[{"key":"limit","value":"30","type":"text","disabled":true},{"key":"page","value":"1","type":"text","disabled":true},{"key":"charityId","value":"cml8u99jg0004jy017qbr7gtf","type":"text","disabled":true},{"key":"transactionId","value":"p12444","type":"text","disabled":true},{"key":"startDate","value":"05-10-2025","type":"text","disabled":true},{"key":"endDate","value":"06-10-2025","type":"text","disabled":true},{"key":"sortOrder","value":"desc","type":"text","disabled":true},{"key":"sortBy","value":"transactionId","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"docs\": [\n {\n \"id\": \"cmmz6lpxc004mmt01fc1ea4nl\",\n \"partnerId\": \"cm8brntw4000508lhetd69ncv\",\n \"daf\": \"benevity\",\n \"dafAccountType\": \"MERCHANT_PAID_FEES\",\n \"amount\": 5,\n \"causeId\": \"840-050395601\",\n \"charityId\": \"cml60yr0j0000k1012zx8y2gr\",\n \"transactionId\": \"91c0418d-9278-4b66-b3c5-9460787457be\",\n \"currency\": \"USD\",\n \"country\": \"US\",\n \"jobId\": null,\n \"invoiceId\": null,\n \"receipt\": null,\n \"environment\": \"test\",\n \"type\": \"user\",\n \"transactionOrderDate\": \"2026-03-20T17:37:03.892Z\",\n \"reason\": null,\n \"source\": \"USER\",\n \"widgetId\": \"cm8bs2hj1000elb0163rwv28x\",\n \"delayReportBy\": 0,\n \"status\": \"complete\",\n \"invoiced\": false,\n \"generateReceipt\": false,\n \"invoicedAt\": null,\n \"reportTransactionAt\": \"2026-03-20T17:37:08.873Z\",\n \"createdAt\": \"2026-03-20T17:37:08.651Z\",\n \"updatedAt\": \"2026-03-20T17:37:08.875Z\",\n \"benevityDonationCreatedAt\": \"2026-03-20T17:37:10.436Z\",\n \"benevityResponse\": [\n {\n \"data\": {\n \"id\": \"1f713e45-b4f2-416b-baa5-2e12aedb27ee\",\n \"type\": \"donations\",\n \"attributes\": {\n \"funds\": {\n \"amount\": 5,\n \"source\": \"USER\",\n \"paymentType\": \"DONATION_REPORT\",\n \"currencyCode\": \"USD\"\n },\n \"state\": {\n \"processingStatus\": \"ACCEPTED\",\n \"statusLastUpdated\": \"2026-03-20T17:37:10.289Z\"\n },\n \"destination\": {\n \"recipientId\": \"840-050395601\"\n }\n }\n }\n }\n ]\n }\n ],\n \"meta\": {\n \"total\": 10,\n \"lastPage\": 11,\n \"currentPage\": 1,\n \"perPage\": 30,\n \"prev\": null,\n \"next\": 2\n }\n}"}],"_postman_id":"7914c4ff-70be-41b5-a226-75a1a88e3336"},{"name":"Fetch donation by id","id":"bf18f17d-3945-4aa3-9aa0-7b27f82e5313","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"ad44f9tolL0Q64zihoeuFTkA6wRqHWtNRZEaqfJghr6","description":"

(Required)

\n","type":"text"},{"key":"x-client-id","value":"64ea17367eb6abe306f06bc5bcb918cc4","description":"

(Required)

\n","type":"text"}],"url":"https://60e0f09a-fe11-4d85-8a1a-f37e8dda3e09.mock.pstmn.io/v1/donations/:id","description":"

Use to fetch the status and details of a single donation by Id

\n","urlObject":{"path":["v1","donations",":id"],"host":["https://60e0f09a-fe11-4d85-8a1a-f37e8dda3e09.mock.pstmn.io"],"query":[],"variable":[{"id":"5231209a-2c60-44ea-8bf9-c3c6154020bf","description":{"content":"

(Required) - donation id

\n","type":"text/plain"},"type":"any","value":"cmmz7tdu7000mml01kabz72aa","key":"id"}]}},"response":[{"id":"6b9995d0-b7a5-41f8-9c6b-2ebdac4607e9","name":"Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"","description":"(Required) "},{"key":"x-client-id","value":"","description":"(Required) "}],"url":{"raw":"https://60e0f09a-fe11-4d85-8a1a-f37e8dda3e09.mock.pstmn.io/v1/donations/:id","host":["https://60e0f09a-fe11-4d85-8a1a-f37e8dda3e09.mock.pstmn.io"],"path":["v1","donations",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"cmkxeytld00039kd2of33musy\",\n \"partnerId\": \"cm8brntw4000508lhetd69ncv\",\n \"daf\": \"benevity\",\n \"dafAccountType\": \"MERCHANT_PAID_FEES\",\n \"amount\": 10,\n \"causeId\": \"840-271720480\",\n \"charityId\": \"cm8yp19ue000ijx019ythvd1i\",\n \"transactionId\": \"0c3d0149-a19b-4781-b288-b139a2ca0bf9\",\n \"currency\": \"USD\",\n \"country\": \"840\",\n \"jobId\": \"831e69ce-4d7c-4168-9dff-48f8d3c892d5\",\n \"invoiceId\": null,\n \"receipt\": null,\n \"environment\": \"test\",\n \"type\": \"partner\",\n \"transactionOrderDate\": \"2026-01-28T02:36:19.372Z\",\n \"reason\": \"not needed\",\n \"source\": \"COMPANY\",\n \"widgetId\": \"cm8bs2hj1000elb0163rwv28x\",\n \"delayReportBy\": 1,\n \"status\": \"cancelled\",\n \"invoiced\": false,\n \"generateReceipt\": false,\n \"invoicedAt\": null,\n \"reportTransactionAt\": \"2026-01-29T02:36:19.638Z\",\n \"createdAt\": \"2026-01-28T02:36:19.921Z\",\n \"updatedAt\": \"2026-01-28T03:11:43.710Z\",\n \"benevityDonationCreatedAt\": null,\n \"benevityResponse\": [],\n \"widget\": {\n \"id\": \"cm8bs2hj1000elb0163rwv28x\",\n \"widgetName\": \"Test Widget\"\n },\n \"charity\": {\n \"id\": \"cm8yp19ue000ijx019ythvd1i\",\n \"displayName\": \"TEAM RUBICON\"\n }\n}"}],"_postman_id":"bf18f17d-3945-4aa3-9aa0-7b27f82e5313"},{"name":"Cancel a donation","id":"8a8bd81a-8e1b-4e36-a909-e1ff71c421f5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"x-api-key","value":"ad44f9tolL0Q64zihoeuFTkA6wRqHWtNRZEaqfJghr6","description":"

(Required)

\n","type":"text"},{"key":"x-client-id","value":"64ea17367eb6abe306f06bc5bcb918cc4","description":"

(Required)

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reason\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://60e0f09a-fe11-4d85-8a1a-f37e8dda3e09.mock.pstmn.io/v1/donations/:id/cancel","description":"

Cancel a donation that has not been posted to a DAF. When a donation is posted, it goes from:

\n

PENDING -> COMPLETED

\n

Donation(s) marked as COMPLETED cannot be canceled.

\n

Once a donation is canceled, the status will be marked as CANCELED.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeDescription
reasonStringOptional
Reason for canceling the donation
\n
","urlObject":{"path":["v1","donations",":id","cancel"],"host":["https://60e0f09a-fe11-4d85-8a1a-f37e8dda3e09.mock.pstmn.io"],"query":[],"variable":[{"id":"7a5f3f38-1e2d-4a62-b31c-229c88df1298","description":{"content":"

(Required) - donation id

\n","type":"text/plain"},"type":"any","value":"cmmz7tdu7000mml01kabz72aa","key":"id"}]}},"response":[{"id":"2ac38fbe-44ed-4ec9-82ff-2ea6d039effe","name":"Success","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"","description":"(Required) "},{"key":"x-client-id","value":"","description":"(Required) "},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"reason\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://60e0f09a-fe11-4d85-8a1a-f37e8dda3e09.mock.pstmn.io/v1/donations/:id/cancel","host":["https://60e0f09a-fe11-4d85-8a1a-f37e8dda3e09.mock.pstmn.io"],"path":["v1","donations",":id","cancel"],"variable":[{"key":"id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"donation cmmz7tdu7000mml01kabz72aa cancelled\"\n}"}],"_postman_id":"8a8bd81a-8e1b-4e36-a909-e1ff71c421f5"}],"event":[{"listen":"prerequest","script":{"id":"5082a4dd-7b74-444d-a4dd-d8c945b8ec90","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"603847f3-ff71-482a-a41e-02c36d531d84","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://60e0f09a-fe11-4d85-8a1a-f37e8dda3e09.mock.pstmn.io"},{"key":"baseUrlDms","value":""}]}