- Standard webhooks<\/li>
- Adyen Giving merchant webhook<\/a><\/li><\/ul><\/td>\n<\/tr>\n
\n Setup steps<\/strong><\/td>\n Before you begin: - To check if your Customer Area<\/a> user has the required roles, go to Account<\/strong> > Users<\/strong>. If you need additional roles, contact your admin user.<\/li>
- Enable and integrate with the payment methods<\/a> that you want to support.
- Create and activate a donation campaign<\/a>.<\/li><\/ul><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
How it works<\/h2>\n
The donation flow depends on the donation moment<\/a>:<\/p>\n\n
\n\nGet details of your active donation campaigns<\/h2>\n
Depending on the donation moment<\/a> that you choose, get the details of your active donation campaigns at either moment:<\/p>\n
- \n
- When a shopper proceeds to pay for their original transaction with a payment method that supports donations.<\/li>\n
- When a shopper completes their original transaction with a payment method that supports donations, and the \/payments<\/a> or \/payments\/details<\/a> (for iDeal payments) response includes the donationToken<\/a> field.<\/li>\n<\/ul>\n
When you make a request to get your active donation campaigns, the response you receive depends on your donation type<\/a>:<\/p>\n\n
\n\nPresent the option to donate<\/h2>\n\n
\n\nMake a donation<\/h2>\n
Depending on the donation moment<\/a> for the campaign, you make a donation request at either time:<\/p>\n
- \n
- Pre-checkout donation<\/strong>: you first make a \/payments<\/a> request. If the payment is authorized, and the \/payments<\/a> or \/payments\/details<\/a> (for iDeal payments) response includes the donationToken<\/a> field, you make a donation request.<\/li>\n
- Post-checkout donation<\/strong>: you present the option to donate after the shopper completes the payment for their original transaction, you make a donation request and use the donationToken<\/a> you received in the \/payments<\/a> or \/payments\/details<\/a> (for iDeal payments) response.<\/li>\n<\/ul>\n\n
\n\nGet the donation outcome<\/h2>\n You get the donation outcome of each donation in a webhook message.\n
To receive these webhook messages, enable the Adyen Giving merchant webhook<\/a>, which includes
eventCode<\/code>: DONATION<\/strong><\/span>.<\/p>\nFor a successful donation, the event contains:<\/p>\n
- \n
success<\/code>: true<\/strong><\/span>.<\/li>\noriginalReference<\/code>: use this value to associate the donation with the shopper's original transaction.<\/li>\n<\/ul>\n\n<\/code-sample>\n<\/div>\n Test and go live<\/h2>\n
Before going live with your integration, use our test cards to test your integration<\/a>.<\/p>\n
See also<\/h2>\n
\n- \n API only integration\n <\/a><\/li>
- \n Webhooks\n <\/a><\/li>
- \n API Explorer\n <\/a><\/li>
- \n Monitor donations\n <\/a><\/li><\/ul><\/div>\n","url":"https:\/\/docs.adyen.com\/pt\/online-payments\/donations\/api-only","articleFields":{"description":"Add Adyen Giving Campaign Manager to an existing API-only integration.","feedback_component":true,"parameters":{"payment_method":"Giving","country_code":"NL","currency":"EUR","component_name":"donation","built_integration":"Built an API-only integration<\/a>"},"filters_component":false,"last_edit_on":"22-01-2024 10:14","page_id":"9ebf9f6b-2b70-4080-b53b-f6cda18b718c","decision_tree":"[]"},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/online-payments\/donations\/api-only","title":"Giving for API only","content":"Accept donations for a nonprofit with the Giving API-only integration that gives you the flexibility to customize the donation flow. You build your own donation form to accept donations, and have full control of the style, visual elements, and user interface.\nIf the shopper chooses to make a donation, the donation transaction uses the same payment method that the shopper used to make the original payment.\nWith an API-only integration, you can accept donations for fixed amounts, or allow the shopper to round up their transaction amount as a donation. You can present the option to donate before or after the shopper completes the payment for the original transaction.\nRequirements\nIn addition to the general Adyen Giving requirements, take into account the following information.\n\n\n\nRequirement\nDescription\n\n\n\n\nIntegration type\nMake sure that you have built an API only integration using Checkout API v67 or later.\n\n\nCustomer Area roles\nMake sure that you have the Donation campaigns manager role.\n\n\nWebhooks\nSubscribe to the following webhook(s): Standard webhooksAdyen Giving merchant webhook\n\n\nSetup steps\nBefore you begin: To check if your Customer Area user has the required roles, go to Account > Users. If you need additional roles, contact your admin user.Enable and integrate with the payment methods that you want to support.Create and activate a donation campaign.\n\n\n\nHow it works\nThe donation flow depends on the donation moment:\n\n\n \n \n \n \n\n\nGet details of your active donation campaigns\nDepending on the donation moment that you choose, get the details of your active donation campaigns at either moment:\n\nWhen a shopper proceeds to pay for their original transaction with a payment method that supports donations.\nWhen a shopper completes their original transaction with a payment method that supports donations, and the \/payments or \/payments\/details (for iDeal payments) response includes the donationToken field.\n\nWhen you make a request to get your active donation campaigns, the response you receive depends on your donation type:\n\n\n \n \n \n \n\n\nPresent the option to donate\n\n\n \n \n \n \n\n\nMake a donation\nDepending on the donation moment for the campaign, you make a donation request at either time:\n\nPre-checkout donation: you first make a \/payments request. If the payment is authorized, and the \/payments or \/payments\/details (for iDeal payments) response includes the donationToken field, you make a donation request.\nPost-checkout donation: you present the option to donate after the shopper completes the payment for their original transaction, you make a donation request and use the donationToken you received in the \/payments or \/payments\/details (for iDeal payments) response.\n\n\n\n \n \n \n \n\n\nGet the donation outcome\n You get the donation outcome of each donation in a webhook message.\nTo receive these webhook messages, enable the Adyen Giving merchant webhook, which includes eventCode: DONATION.\nFor a successful donation, the event contains:\n\nsuccess: true.\noriginalReference: use this value to associate the donation with the shopper's original transaction.\n\n\n \n\nTest and go live\nBefore going live with your integration, use our test cards to test your integration.\nSee also\n\n\n API only integration\n \n Webhooks\n \n API Explorer\n \n Monitor donations\n \n","type":"page","locale":"pt","boost":17,"hierarchy":{"lvl0":"Home","lvl1":"Online payments","lvl2":"Donations using Giving","lvl3":"Giving for API only"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/online-payments","lvl2":"https:\/\/docs.adyen.com\/pt\/online-payments\/donations","lvl3":"\/pt\/online-payments\/donations\/api-only"},"levels":4,"category":"Online Payments","category_color":"green","tags":["Giving"]},"articleFiles":{"api-pre-flow.svg":"
![\"\"](\"https:\/\/docs.adyen.com\/user\/pages\/docs\/02.online-payments\/24.donations\/04.api-only\/api-pre-flow.svg?decoding=auto&fetchpriority=auto\")
","campaign-manager-api.svg":"![\"\"](\"https:\/\/docs.adyen.com\/user\/pages\/docs\/02.online-payments\/24.donations\/04.api-only\/campaign-manager-api.svg?decoding=auto&fetchpriority=auto\")
","flow-post-checkout.svg":"![\"\"](\"https:\/\/docs.adyen.com\/user\/pages\/docs\/02.online-payments\/24.donations\/04.api-only\/flow-post-checkout.svg\")
","flow-pre-checkout.svg":"![\"\"](\"https:\/\/docs.adyen.com\/user\/pages\/docs\/02.online-payments\/24.donations\/04.api-only\/flow-pre-checkout.svg\")
","post-checkout.svg":"![\"\"](\"https:\/\/docs.adyen.com\/user\/pages\/docs\/02.online-payments\/24.donations\/04.api-only\/post-checkout.svg\")
","postman-logo-vertical-orange-2021.svg":"![\"\"](\"https:\/\/docs.adyen.com\/user\/pages\/docs\/02.online-payments\/24.donations\/04.api-only\/postman-logo-vertical-orange-2021.svg\")
","pre-checkout.svg":"![\"\"](\"https:\/\/docs.adyen.com\/user\/pages\/docs\/02.online-payments\/24.donations\/04.api-only\/pre-checkout.svg\")
"}}
- \n Webhooks\n <\/a><\/li>
- Post-checkout donation<\/strong>: you present the option to donate after the shopper completes the payment for their original transaction, you make a donation request and use the donationToken<\/a> you received in the \/payments<\/a> or \/payments\/details<\/a> (for iDeal payments) response.<\/li>\n<\/ul>\n\n
- Pre-checkout donation<\/strong>: you first make a \/payments<\/a> request. If the payment is authorized, and the \/payments<\/a> or \/payments\/details<\/a> (for iDeal payments) response includes the donationToken<\/a> field, you make a donation request.<\/li>\n
- Enable and integrate with the payment methods<\/a> that you want to support.
- To check if your Customer Area<\/a> user has the required roles, go to Account<\/strong> > Users<\/strong>. If you need additional roles, contact your admin user.<\/li>