"},"isInherited":false},"method":"GET","header":[],"url":"https://partner-staging.changeup.com/v2/cause/search?q=feeding&page=1&page_size=5&search_location=90,90&country=840&state=US-CA&category=P30&visibility=donate&ruleset_tag=apple-pay&foundation=3K69AK1RX7&apple_approved=true&sort=default","description":"Search for cuases from benevity
\n\n\n\n| Query | \nValue | \nDescription | \n
\n\n\n\n| q | \nString | \nA string containing one or more search keywords. | \n
\n\n| page | \nNumber | \nWhich page of the search results to show. | \n
\n\n| page_size | \nNumber | \nThe number of search results to return per page. | \n
\n\n| search_location | \n[string] | \nThe origin point of the search, expressed as latitude,longitude. Generally, results physically closer to this point will be ranked higher in the results. Latitude must be between -90 and 90, and longitude must be between -180 and 180. | \n
\n\n| state | \n[string] | \nThe search result is filtered based on the state, province or region associated with the project or cause. The filter values are the extended version of ISO 3166-2 standard and can be found in the response facets. This parameter can be used multiple times for different values. The values will be OR'd together. | \n
\n\n| category | \n[string] | \nThe search result is filtered based on the categories and subcategories the project or cause is associated with. The filter values are the extended version of NTEE standard and can be found in the response facets. This parameter can be used multiple times for different values. The values will be OR'd together. | \n
\n\n| ruleset_tag | \n[string] | \nYour company's program is determined by filter rules that may have tags associated to them. This parameter allows you to specify through tags what filter rules should be considered when determining a result's visibility level. | \n
\n\n| foundation | \n[string] | \nYour company can be registered with one or more foundations. This parameter allows you to specify what foundations should be considered when determining a result's visibility level. | \n
\n\n| apple_approved | \nBoolean | \nThe search result is filtered based on the apple approved causes. Value true means that causes are support Apple Pay. | \n
\n\n| sort | \nString | \nSort results based on selected option. If ommitted, the default option will be selected. An invalid option will result in a bad request. A distance sort requires a valid search_location parameter, an internal server error will occur otherwise.
Sort by: default, distance or popularity | \n
\n\n
\n
A string containing one or more search keywords.
\n","type":"text/plain"},"key":"q","value":"feeding"},{"description":{"content":"Which page of the search results to show.
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"The number of search results to return per page.
\n","type":"text/plain"},"key":"page_size","value":"5"},{"description":{"content":"The origin point of the search, expressed as latitude,longitude. Generally, results physically closer to this point will be ranked higher in the results. Latitude must be between -90 and 90, and longitude must be between -180 and 180.
\n","type":"text/plain"},"key":"search_location","value":"90,90"},{"description":{"content":"The search result is filtered based on the country associated with the project or cause. The filter values can be either the ISO 3166 standard numeric codes or the extended version of alphanumeric codes which can be found in the response facets. This parameter can be used multiple times for different values. The values will be OR'd together. Example: 840 or 124
\n","type":"text/plain"},"key":"country","value":"840"},{"description":{"content":"The search result is filtered based on the state, province or region associated with the project or cause. The filter values are the extended version of ISO 3166-2 standard and can be found in the response facets. This parameter can be used multiple times for different values. The values will be OR'd together.
\n","type":"text/plain"},"key":"state","value":"US-CA"},{"description":{"content":"The search result is filtered based on the categories and subcategories the project or cause is associated with. The filter values are the extended version of NTEE standard and can be found in the response facets. This parameter can be used multiple times for different values. The values will be OR'd together.
\n","type":"text/plain"},"key":"category","value":"P30"},{"description":{"content":"Filter results based on what actions may be taken. For example a visibility of donate will only return causes that may be donated to. Loosening the filter to program will additionally return causes that may be linked to as part of your company's program but cannot receive donation. Each visibility level is a subset of the next, ending at inactive which allows the full set of results. Values may include\ndonate, program, nominate, ineligible or inactive
\n","type":"text/plain"},"key":"visibility","value":"donate"},{"description":{"content":"Your company's program is determined by filter rules that may have tags associated to them. This parameter allows you to specify through tags what filter rules should be considered when determining a result's visibility level.
\n","type":"text/plain"},"key":"ruleset_tag","value":"apple-pay"},{"description":{"content":"Your company can be registered with one or more foundations. This parameter allows you to specify what foundations should be considered when determining a result's visibility level.
\n","type":"text/plain"},"key":"foundation","value":"3K69AK1RX7"},{"description":{"content":"The search result is filtered based on the apple approved causes. Value true means that causes are support Apple Pay.
\n","type":"text/plain"},"key":"apple_approved","value":"true"},{"description":{"content":"Sort results based on selected option. If ommitted, the default option will be selected. An invalid option will result in a bad request. A distance sort requires a valid search_location parameter, an internal server error will occur otherwise.\nSort by: default, distance or popularity
\n","type":"text/plain"},"key":"sort","value":"default"}],"variable":[]}},"response":[{"id":"dda1810d-1640-4667-9e12-646a2fc15e48","name":"Untitled Example","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":""}],"url":{"raw":"https://partner-staging.changeup.com/v2/cause/search?q=q&page=page&page_size=page_size&search_location=search_location&country=&state=&category=&visibility=donate&ruleset_tag=&foundation=&apple_approved=true&sort=default","host":["https://partner-staging.changeup.com"],"path":["v2","cause","search"],"query":[{"key":"q","value":"q"},{"key":"page","value":"page"},{"key":"page_size","value":"page_size"},{"key":"search_location","value":"search_location"},{"key":"country","value":""},{"key":"state","value":""},{"key":"category","value":""},{"key":"visibility","value":"donate"},{"key":"ruleset_tag","value":""},{"key":"foundation","value":""},{"key":"apple_approved","value":"true"},{"key":"sort","value":"default"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"bd79de73-87f3-469e-9827-c950aada1108"},{"name":"Get Donation Cause Details","id":"40d4fd0b-51dc-4ff1-8b76-f50757ccf43b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"","value":""},"isInherited":false},"method":"GET","header":[],"url":"https://partner-staging.changeup.com/v2/cause/:cause_uuid","description":"Search Benevity by cause
\n\n\n\n| Params | \nValue | \nDescription | \n
\n\n\n\n| cause_uuid | \nString | \nRequired Benevity cause id | \n
\n\n
\n
(Required)
\n","type":"text/plain"},"type":"any","value":"840-911570421","key":"cause_uuid"}]}},"response":[{"id":"fc4b6852-dde5-489a-8bbd-bd1acf229ac0","name":"Untitled Example","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":""}],"url":{"raw":"https://partner-staging.changeup.com/v2/cause/:cause_uuid","host":["https://partner-staging.changeup.com"],"path":["v2","cause",":cause_uuid"],"variable":[{"key":"cause_uuid","value":"cause_uuid","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"40d4fd0b-51dc-4ff1-8b76-f50757ccf43b"}],"id":"caa6aa4d-90f3-49a6-8e40-91ff90172941","_postman_id":"caa6aa4d-90f3-49a6-8e40-91ff90172941","description":""},{"name":"partner","item":[{"name":"Calculates the total donations that a partner has made. By default includes all causes and all donating entities","id":"a6c1710d-e315-43d2-9145-fb32ea88b7ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"","value":""},"isInherited":false},"method":"GET","header":[],"url":"https://partner-staging.changeup.com/v2/partner/total_donations?donating_entity=consumer&cause_id=840-911570421","description":"Partner
\n\n\n\n| Query | \nValue | \nDescripton | \n
\n\n\n\n| donating_entity | \nString | \nDonation entity type. Example consumer | \n
\n\n| cause_id | \nString | \nBenevity cauase uuid | \n
\n\n
\n
Donation entity type. Example: consumer
\n","type":"text/plain"},"key":"donating_entity","value":"consumer"},{"description":{"content":"Benevity cauase uuid
\n","type":"text/plain"},"key":"cause_id","value":"840-911570421"}],"variable":[]}},"response":[{"id":"cfa3b0e5-e4ab-4f0f-89b2-f42939f89c31","name":"Untitled Example","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":""}],"url":{"raw":"https://partner-staging.changeup.com/v2/partner/total_donations?donating_entity=partner&cause_id=cause_id","host":["https://partner-staging.changeup.com"],"path":["v2","partner","total_donations"],"query":[{"key":"donating_entity","value":"partner"},{"key":"cause_id","value":"cause_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"a6c1710d-e315-43d2-9145-fb32ea88b7ed"}],"id":"018273b1-bc87-4b21-9173-2fe42881692b","_postman_id":"018273b1-bc87-4b21-9173-2fe42881692b","description":""}],"id":"d89e26ec-28dc-413d-ac3f-1cfd3289d5d0","_postman_id":"d89e26ec-28dc-413d-ac3f-1cfd3289d5d0","description":""},{"name":"API v1 - Legacy","item":[{"name":"cause","item":[{"name":"Search causes","id":"c1744598-caf7-4814-b040-906fd63da151","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"","value":""},"isInherited":false},"method":"GET","header":[],"url":"https://partner-staging.changeup.com/partner/v1/cause/search?page_size=1&offset=1&sort=ASC&organization_name=organization_name&includeOnlyVerified=true&exclude=","urlObject":{"path":["partner","v1","cause","search"],"host":["https://partner-staging.changeup.com"],"query":[{"key":"page_size","value":"1"},{"key":"offset","value":"1"},{"description":{"content":"comma separated list of fields to sort with optional direction FIELD:ASC (default) or FIELD:DESC
\n","type":"text/plain"},"key":"sort","value":"ASC"},{"key":"organization_name","value":"organization_name"},{"key":"includeOnlyVerified","value":"true"},{"key":"exclude","value":""}],"variable":[]}},"response":[{"id":"ce85c83a-4f61-4b14-b34b-d46228f6767d","name":"Untitled Example","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"x-changeup-api-key","value":""}],"url":{"raw":"https://partner-staging.changeup.com/partner/v1/cause/search?page_size=page_size&offset=offset&sort=ASC&organization_name=organization_name&includeOnlyVerified=true&exclude=","host":["https://partner-staging.changeup.com"],"path":["partner","v1","cause","search"],"query":[{"key":"page_size","value":"page_size"},{"key":"offset","value":"offset"},{"key":"sort","value":"ASC"},{"key":"organization_name","value":"organization_name"},{"key":"includeOnlyVerified","value":"true"},{"key":"exclude","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"c1744598-caf7-4814-b040-906fd63da151"},{"name":"Get Donation Cause Details","id":"6f09bed1-ac51-4197-a047-0273b18de327","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"","value":""},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://partner-staging.changeup.com/partner/v1/cause/:cause_uuid","urlObject":{"path":["partner","v1","cause",":cause_uuid"],"host":["https://partner-staging.changeup.com"],"query":[],"variable":[{"description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"840-911570421","key":"cause_uuid"}]}},"response":[{"id":"5b8646bd-1e55-4324-ae83-812a583e2cae","name":"Untitled Example","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"x-changeup-api-key","value":""}],"url":{"raw":"https://partner-staging.changeup.com/partner/v1/cause/:cause_uuid","host":["https://partner-staging.changeup.com"],"path":["partner","v1","cause",":cause_uuid"],"variable":[{"key":"cause_uuid","value":"cause_uuid","description":"(Required) "}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"affiliation_code\": -41771074.755492955,\n \"applepay\": false,\n \"asset_code\": 2255914.917578399,\n \"banner_image_url\": \"nisi dolore veniam qui ut\",\n \"deductibility_code\": -43341013.1929135,\n \"description\": \"amet esse sunt ex\",\n \"ein\": \"sed amet sunt\",\n \"facebook_id\": \"culpa amet in magna\",\n \"feature_image_url\": \"consequat\",\n \"feature_weight\": \"in sed\",\n \"foundation_code\": -16827847.01868254,\n \"geo_city\": \"qui proident irure sunt\",\n \"geo_lat\": -67537214.74493308,\n \"geo_lon\": 84572496.76583344,\n \"geo_rating\": -19082035.576608375,\n \"geo_state\": \"fugiat ea\",\n \"geo_street_name\": \"officia nostrud \",\n \"geo_street_number\": \"est ullamco\",\n \"geo_street_type\": \"Ut non aute\",\n \"geo_zip\": \"ea \",\n \"income_code\": 6533205.433183432,\n \"is_feature\": false,\n \"is_trending\": false,\n \"logo_image_url\": \"exercitation\",\n \"mission_statement\": \"ex\",\n \"ntee_code\": \"Ut ipsum\",\n \"organization_code\": 45367530.97385645,\n \"organization_name\": \"consequat dolor\",\n \"organization_uuid\": \"culpa Lorem nisi veniam\",\n \"trending_weight\": \"mollit sit\",\n \"twitter_handle\": \"aliquip Lorem fugiat\",\n \"website\": \"sunt velit\"\n }\n}"}],"_postman_id":"6f09bed1-ac51-4197-a047-0273b18de327"}],"id":"935db64f-38e3-48cc-80e2-b23a17825a42","_postman_id":"935db64f-38e3-48cc-80e2-b23a17825a42","description":""},{"name":"Record a batch of donations","id":"d17a296f-68c2-419d-9c20-d78b3fb9a8e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"","value":""},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"donations\": [\n {\n \"cause_uuid\": \"840-520851555\",\n \"partner_attributable_user_email_address\": \"john.doe@example.com\",\n \"partner_attributable_user_first_name\": \"John\",\n \"partner_attributable_user_id\": \"328bc913-1643-43b0-80e9-2cbdd2117838\",\n \"partner_attributable_user_last_name\": \"Doe\",\n \"partner_donation_amount_micros\": 1000000,\n \"partner_transaction_id\": \"9019209b-7afc-4bd0-92eb-7d11bfc09107\",\n \"user_donation_amount_micros\": 1000000,\n \"country\": \"840\",\n \"currency\": \"USD\"\n },\n {\n \"cause_uuid\": \"840-520851555\",\n \"partner_attributable_user_email_address\": \"john.doe@example.com\",\n \"partner_attributable_user_first_name\": \"John\",\n \"partner_attributable_user_id\": \"328bc913-1643-43b0-80e9-2cbdd2117838\",\n \"partner_attributable_user_last_name\": \"Doe\",\n \"partner_donation_amount_micros\": 1000000,\n \"partner_transaction_id\": \"9019209b-7afc-4bd0-92eb-7d11bfc09107\",\n \"user_donation_amount_micros\": 1000000,\n \"country\": \"840\",\n \"currency\": \"USD\"\n }\n ],\n \"child_organization_id\": \"328bc913-1643-43b0-80e9-2cbdd2117838\"\n}","options":{"raw":{"language":"json"}}},"url":"https://partner-staging.changeup.com/partner/v1/donations","description":"Request Body Fields
\n\n\n\n| Field | \nType | \nDescription | \nOptional / Required | \n
\n\n\n\n| cause_uuid | \nString | \nBenevity Cause Id | \nRequired | \n
\n\n| user_donation_amount_micros | \nNumber | \nUser Donation Amount in Micros | \nRequired | \n
\n\n| partner_donation_amount_micros | \nNumber | \nPartner Donation Amount in Micros | \nOptional | \n
\n\n| partner_attributable_user_id | \nString | \nUser Id | \nRequired | \n
\n\n| partner_attributable_user_email_address | \nString | \nUser email address | \nOptional | \n
\n\n| partner_attributable_user_first_name | \nString | \nUser first name | \nOptional | \n
\n\n| partner_attributable_user_last_name | \nString | \nUser last name | \nOptional | \n
\n\n| partner_transaction_id | \nString | \nTransaction Id - Reference number | \nRequired | \n
\n\n| country | \nString | \nISO country number | \nRequired | \n
\n\n| currency | \nString | \nCurrency code | \nRequired | \n
\n\n| partner_order_date | \nString | \nPartner order date | \nOptional | \n
\n\n| child_organization_id | \nString | \nDonation made to child Organization Id | \nOptional | \n
\n\n
\n
Donation entity type. Example: consumer
\n","type":"text/plain"},"key":"donating_entity","value":"consumer"},{"description":{"content":"Benevity cauase uuid
\n","type":"text/plain"},"key":"cause_id","value":"840-911570421"}],"variable":[]}},"response":[{"id":"aa9d2cb0-0b5e-40af-9b8b-2bc92d505020","name":"Untitled Example","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"x-changeup-api-key","value":""}],"url":{"raw":"https://partner-staging.changeup.com/partner/v1/partner/total_donations?donating_entity=consumer&cause_id=840-911570421","host":["https://partner-staging.changeup.com"],"path":["partner","v1","partner","total_donations"],"query":[{"key":"donating_entity","value":"consumer","description":"Donation entity type. Example: consumer"},{"key":"cause_id","value":"840-911570421","description":"Benevity cauase uuid"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {}\n}"}],"_postman_id":"4206994d-e906-4a95-8e0f-cfdd446b7853"}],"id":"d09ec438-e8e9-47b7-8c17-5339a0343892","description":"Legacy
\n","_postman_id":"d09ec438-e8e9-47b7-8c17-5339a0343892"}],"event":[{"listen":"prerequest","script":{"id":"dc38fc15-e7b4-42d2-8ddc-b755a88fa02b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"02aefd5e-491a-486f-bfaa-8f9964011bd5","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://partner-staging.changeup.com","type":"string"}]}