{"title":"Donations with Sessions flow","category":"default","creationDate":1779206567,"content":"
\n \n <\/in-page-filtering>\n<\/div>\n
\n <\/div>\n","url":"https:\/\/docs.adyen.com\/online-payments\/donations\/integration-options\/sessions-flow","articleFields":{"feedback_component":true,"description":"Accept donations using the Sessions flow with Web Drop-in or Components.","filters_component":true,"filters_config_folder":"donations-sessions","dynamic_minitoc":true,"dynamic_minitoc_context":".in-page-filtering--content"},"algolia":[{"url":"https:\/\/docs.adyen.com\/online-payments\/donations\/integration-options\/sessions-flow","title":"Donations with Sessions flow","content":"With the Sessions flow, Drop-in handles the donation flow automatically. After a successful payment, if the shopper is eligible to donate, Drop-in shows the donation form to the shopper.\nIf the shopper chooses to donate, the donation transaction uses the same payment method that the shopper used for the original payment.\nYou can accept donations for fixed amounts, or allow the shopper to round up their transaction amount as a donation.\nYou do not need to pass any donation-specific parameters in your \/sessions request. Drop-in manages the full donation flow, including presenting the campaign and processing the donation.Requirements\nIn addition to the general Adyen Giving requirements, take into account the following requirements.\n\n\n\nRequirement\nDescription\n\n\n\n\nIntegration type\nMake sure that you have integrated with: Web Drop-in v6.36.0 or later using the Sessions flowCheckout API v72 or later\n\n\nCustomer Area roles\nMake sure that you have the Donation campaigns manager role.\n\n\nWebhooks\nSubscribe to the following webhooks: 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.Set up a Drop-in integration for the payment methods that you want to support.Create and activate a donation campaign.\n\n\nHow it works\n\nThe shopper goes to the checkout page.\nYour server creates a payment session.\nWhen you create a global configuration object for AdyenCheckout, optionally add a configuration object for donations.\nDrop-in shows the payment form.\nThe shopper uses submits the payment on your checkout page.\nDrop-in handles the payment flow.\nIf the payment is successful, Drop-in checks if you have an active donation campaign in your Adyen Customer Area.\nIf you have an active donation campaign, Drop-in shows the donation form.\nThe shopper chooses to donate or declines.\nDrop-in handles the donation flow.\nGet the donation result from the donation.onDonationSuccess callback\nAdyen sends a webhook message with the donation outcome.\n\nCnNlcXVlbmNlRGlhZ3JhbQogICAgcGFydGljaXBhbnQgUyBhcyBTaG9wcGVyCiAgICBwYXJ0aWNpcGFudCBGIGFzIFlvdXIgY2xpZW50IHdlYnNpdGUKICAgIHBhcnRpY2lwYW50IFNWIGFzIFlvdXIgc2VydmVyCiAgICBwYXJ0aWNpcGFudCBBIGFzIEFkeWVuCiAgICBwYXJ0aWNpcGFudCBXIGFzIFlvdXIgd2ViaG9vayBzZXJ2ZXIKCiAgICBTLT4+RjogMS4gR28gdG8gY2hlY2tvdXQgcGFnZQogICAgU1YtPj5BOiAyLiBDcmVhdGUgcGF5bWVudCBzZXNzaW9uCiAgICBBLS0+PlNWOiBSZXR1cm4gc2Vzc2lvbiBkYXRhCiAgICBTVi0tPj5GOiBQYXNzIHNlc3Npb24gZGF0YQogICAgTm90ZSBvdmVyIEY6IDMuIEFkZCBvcHRpb25hbCBkb25hdGlvbiBjb25maWd1cmF0aW9uIGFuZCBpbml0aWFsaXplIERyb3AtaW4KICAgIEYtPj5TOiA0LiBEcm9wLWluIHNob3dzIHBheW1lbnQgZm9ybQogICAgUy0+PkY6IDUuIFN1Ym1pdCBwYXltZW50CiAgICBOb3RlIG92ZXIgRjogNi4gRHJvcC1pbiBoYW5kbGVzIHBheW1lbnQgZmxvdwogICAgRi0+PkE6IERyb3AtaW4gc2VuZHMgcGF5bWVudCBkYXRhCiAgICBOb3RlIG92ZXIgQTogNy4gQ2hlY2sgZm9yIGFjdGl2ZSBkb25hdGlvbiBjYW1wYWlnbgogICAgQS0tPj5GOiBTZXNzaW9uIHJlc3VsdCBhbmQgZG9uYXRpb24gY2FtcGFpZ24gZGF0YQogICAgb3B0IElmIHlvdSBoYXZlIGFjdGl2ZSBkb25hdGlvbiBjYW1wYWlnbgogICAgICAgIEYtPj5TOiA4LiBEcm9wLWluIHNob3dzIGRvbmF0aW9uIGZvcm0KICAgICAgICBTLT4+RjogOS4gRG9uYXRlIG9yIGRlY2xpbmUKICAgICAgICBOb3RlIG92ZXIgRjogMTAuIERyb3AtaW4gaGFuZGxlcyBkb25hdGlvbiBmbG93CiAgICAgICAgRi0+PkE6IERyb3AtaW4gc2VuZHMgZG9uYXRpb24gZGF0YQogICAgICAgIEEtLT4+RjogMTEuIERvbmF0aW9uIHJlc3VsdCAKICAgICAgICBBLT4+VzogMTIuIFdlYmhvb2sgbWVzc2FnZSB3aXRoIGRvbmF0aW9uIG91dGNvbWUKICAgIGVuZAogICAgQS0+Plc6IDEzLiBXZWJob29rIG1lc3NhZ2Ugd2l0aCBwYXltZW50IG91dGNvbWUgCg==Add Giving configuration\nWhen you create a global configuration object for Drop-in, you can optionally add configuration for donations.\nTo receive donation results and customize behavior, add a donation object to your checkout configuration. The donation configuration is optional, but if you include it, you must include the event handlers to get donation outcomes on your client website.\nEvent handlers:\n\n\n\nProperty\nRequired\nDescription\n\n\n\n\nonDonationSuccess\n\nCalled when the donation is completed or the shopper declines to donate. Receives an object with didDonate: true or false.\n\n\nonDonationFailure\n\nCalled when an error occurs in the donation creation or when a donation fails.\n\n\n\nConfiguration parameters:\n\n\n\nProperty\nRequired\nDescription\n\n\n\n\nautoMount\n\nSpecifies if Drop-in automatically shows the donation form after a successful payment. Set to false to not show the donation form after the payment is completed. Default: true.\n\n\ndelay\n\nThe delay in milliseconds after a successful payment before Drop-in shows the donation form.\n\n\n\n\n \n\nAfter a successful payment, if the shopper is eligible to donate, Drop-in shows the donation form. By default, the donation form is mounted in the same container as Drop-in.\nYou do not need to create or configure the Donation component separately. Drop-in handles the full donation flow, including:\n\nShowing the donation campaign details (nonprofit name, description, logo, banner).\nPresenting the donation amounts or round-up option, depending on the donation type.\nProcessing the donation.\nGet the donation outcome\nYou can get the outcome of each donation in a webhook message. This enables you to inform shoppers by email or mobile messaging about their donation, provided you have the shopper's contact details.\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 \nTest and go live\nBefore going live with your integration, use our test cards to test your integration.See also\n\n\n Sessions flow integration guide\n \n Donations with Advanced flow\n \n Webhooks\n \n Giving on adyen.com\n \n Monitor donations\n \n","type":"page","locale":"en","boost":16,"hierarchy":{"lvl0":"Home","lvl1":"Online payments","lvl2":"Donations using Giving","lvl3":"Integrate Adyen Giving with online payments","lvl4":"Donations with Sessions flow"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/","lvl1":"https:\/\/docs.adyen.com\/online-payments","lvl2":"https:\/\/docs.adyen.com\/online-payments\/donations","lvl3":"https:\/\/docs.adyen.com\/online-payments\/donations\/integration-options","lvl4":"\/online-payments\/donations\/integration-options\/sessions-flow"},"levels":5,"category":"Online Payments","category_color":"green","tags":["Donations","Sessions"]},{"url":"https:\/\/docs.adyen.com\/online-payments\/donations\/integration-options\/sessions-flow?platform=Web&integration=Drop-in","title":"Web Drop-in","content":"With the Sessions flow, Drop-in handles the donation flow automatically. After a successful payment, if the shopper is eligible to donate, Drop-in shows the donation form to the shopper.\nIf the shopper chooses to donate, the donation transaction uses the same payment method that the shopper used for the original payment.\nYou can accept donations for fixed amounts, or allow the shopper to round up their transaction amount as a donation.\nYou do not need to pass any donation-specific parameters in your \/sessions request. Drop-in manages the full donation flow, including presenting the campaign and processing the donation.Requirements\nIn addition to the general Adyen Giving requirements, take into account the following requirements.\n\n\n\nRequirement\nDescription\n\n\n\n\nIntegration type\nMake sure that you have integrated with: Web Drop-in v6.36.0 or later using the Sessions flowCheckout API v72 or later\n\n\nCustomer Area roles\nMake sure that you have the Donation campaigns manager role.\n\n\nWebhooks\nSubscribe to the following webhooks: 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.Set up a Drop-in integration for the payment methods that you want to support.Create and activate a donation campaign.\n\n\nHow it works\n\nThe shopper goes to the checkout page.\nYour server creates a payment session.\nWhen you create a global configuration object for AdyenCheckout, optionally add a configuration object for donations.\nDrop-in shows the payment form.\nThe shopper uses submits the payment on your checkout page.\nDrop-in handles the payment flow.\nIf the payment is successful, Drop-in checks if you have an active donation campaign in your Adyen Customer Area.\nIf you have an active donation campaign, Drop-in shows the donation form.\nThe shopper chooses to donate or declines.\nDrop-in handles the donation flow.\nGet the donation result from the donation.onDonationSuccess callback\nAdyen sends a webhook message with the donation outcome.\n\nCnNlcXVlbmNlRGlhZ3JhbQogICAgcGFydGljaXBhbnQgUyBhcyBTaG9wcGVyCiAgICBwYXJ0aWNpcGFudCBGIGFzIFlvdXIgY2xpZW50IHdlYnNpdGUKICAgIHBhcnRpY2lwYW50IFNWIGFzIFlvdXIgc2VydmVyCiAgICBwYXJ0aWNpcGFudCBBIGFzIEFkeWVuCiAgICBwYXJ0aWNpcGFudCBXIGFzIFlvdXIgd2ViaG9vayBzZXJ2ZXIKCiAgICBTLT4+RjogMS4gR28gdG8gY2hlY2tvdXQgcGFnZQogICAgU1YtPj5BOiAyLiBDcmVhdGUgcGF5bWVudCBzZXNzaW9uCiAgICBBLS0+PlNWOiBSZXR1cm4gc2Vzc2lvbiBkYXRhCiAgICBTVi0tPj5GOiBQYXNzIHNlc3Npb24gZGF0YQogICAgTm90ZSBvdmVyIEY6IDMuIEFkZCBvcHRpb25hbCBkb25hdGlvbiBjb25maWd1cmF0aW9uIGFuZCBpbml0aWFsaXplIERyb3AtaW4KICAgIEYtPj5TOiA0LiBEcm9wLWluIHNob3dzIHBheW1lbnQgZm9ybQogICAgUy0+PkY6IDUuIFN1Ym1pdCBwYXltZW50CiAgICBOb3RlIG92ZXIgRjogNi4gRHJvcC1pbiBoYW5kbGVzIHBheW1lbnQgZmxvdwogICAgRi0+PkE6IERyb3AtaW4gc2VuZHMgcGF5bWVudCBkYXRhCiAgICBOb3RlIG92ZXIgQTogNy4gQ2hlY2sgZm9yIGFjdGl2ZSBkb25hdGlvbiBjYW1wYWlnbgogICAgQS0tPj5GOiBTZXNzaW9uIHJlc3VsdCBhbmQgZG9uYXRpb24gY2FtcGFpZ24gZGF0YQogICAgb3B0IElmIHlvdSBoYXZlIGFjdGl2ZSBkb25hdGlvbiBjYW1wYWlnbgogICAgICAgIEYtPj5TOiA4LiBEcm9wLWluIHNob3dzIGRvbmF0aW9uIGZvcm0KICAgICAgICBTLT4+RjogOS4gRG9uYXRlIG9yIGRlY2xpbmUKICAgICAgICBOb3RlIG92ZXIgRjogMTAuIERyb3AtaW4gaGFuZGxlcyBkb25hdGlvbiBmbG93CiAgICAgICAgRi0+PkE6IERyb3AtaW4gc2VuZHMgZG9uYXRpb24gZGF0YQogICAgICAgIEEtLT4+RjogMTEuIERvbmF0aW9uIHJlc3VsdCAKICAgICAgICBBLT4+VzogMTIuIFdlYmhvb2sgbWVzc2FnZSB3aXRoIGRvbmF0aW9uIG91dGNvbWUKICAgIGVuZAogICAgQS0+Plc6IDEzLiBXZWJob29rIG1lc3NhZ2Ugd2l0aCBwYXltZW50IG91dGNvbWUgCg==Add Giving configuration\nWhen you create a global configuration object for Drop-in, you can optionally add configuration for donations.\nTo receive donation results and customize behavior, add a donation object to your checkout configuration. The donation configuration is optional, but if you include it, you must include the event handlers to get donation outcomes on your client website.\nEvent handlers:\n\n\n\nProperty\nRequired\nDescription\n\n\n\n\nonDonationSuccess\n\nCalled when the donation is completed or the shopper declines to donate. Receives an object with didDonate: true or false.\n\n\nonDonationFailure\n\nCalled when an error occurs in the donation creation or when a donation fails.\n\n\n\nConfiguration parameters:\n\n\n\nProperty\nRequired\nDescription\n\n\n\n\nautoMount\n\nSpecifies if Drop-in automatically shows the donation form after a successful payment. Set to false to not show the donation form after the payment is completed. Default: true.\n\n\ndelay\n\nThe delay in milliseconds after a successful payment before Drop-in shows the donation form.\n\n\n\n\n \n\nAfter a successful payment, if the shopper is eligible to donate, Drop-in shows the donation form. By default, the donation form is mounted in the same container as Drop-in.\nYou do not need to create or configure the Donation component separately. Drop-in handles the full donation flow, including:\n\nShowing the donation campaign details (nonprofit name, description, logo, banner).\nPresenting the donation amounts or round-up option, depending on the donation type.\nProcessing the donation.\nGet the donation outcome\nYou can get the outcome of each donation in a webhook message. This enables you to inform shoppers by email or mobile messaging about their donation, provided you have the shopper's contact details.\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 \nTest and go live\nBefore going live with your integration, use our test cards to test your integration.See also\n\n\n Sessions flow integration guide\n \n Donations with Advanced flow\n \n Webhooks\n \n Giving on adyen.com\n \n Monitor donations\n \n","type":"page","locale":"en","boost":16,"hierarchy":{"lvl0":"Home","lvl1":"Online payments","lvl2":"Donations using Giving","lvl3":"Integrate Adyen Giving with online payments","lvl4":"Donations with Sessions flow"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/","lvl1":"https:\/\/docs.adyen.com\/online-payments","lvl2":"https:\/\/docs.adyen.com\/online-payments\/donations","lvl3":"https:\/\/docs.adyen.com\/online-payments\/donations\/integration-options","lvl4":"\/online-payments\/donations\/integration-options\/sessions-flow"},"levels":5,"category":"Online Payments","category_color":"green","tags":["Web","Drop-in"]},{"url":"https:\/\/docs.adyen.com\/online-payments\/donations\/integration-options\/sessions-flow?platform=Web&integration=Components","title":"Web Components","content":"With the Sessions flow, the Component handles the donation flow automatically. After a successful payment, if the shopper is eligible to donate, the Component shows the donation form to the shopper.\nIf the shopper chooses to donate, the donation transaction uses the same payment method that the shopper used for the original payment.\nYou can accept donations for fixed amounts, or allow the shopper to round up their transaction amount as a donation.\nYou do not need to pass any donation-specific parameters in your \/sessions request. the Component manages the full donation flow, including presenting the campaign and processing the donation.Requirements\nIn addition to the general Adyen Giving requirements, take into account the following requirements.\n\n\n\nRequirement\nDescription\n\n\n\n\nIntegration type\nMake sure that you have integrated with: Web the Component v6.36.0 or later using the Sessions flowCheckout API v72 or later\n\n\nCustomer Area roles\nMake sure that you have the Donation campaigns manager role.\n\n\nWebhooks\nSubscribe to the following webhooks: 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.Set up a the Component integration for the payment methods that you want to support.Create and activate a donation campaign.\n\n\nHow it works\n\nThe shopper goes to the checkout page.\nYour server creates a payment session.\nWhen you create a global configuration object for AdyenCheckout, optionally add a configuration object for donations.\nThe Component shows the payment form.\nThe shopper submits the payment on your checkout page.\nThe Component handles the payment flow.\nIf the payment is successful, the Component checks if you have an active donation campaign in your Adyen Customer Area.\nIf you have an active donation campaign, the Component shows the donation form.\nThe shopper chooses to donate or declines.\nThe Component handles the donation flow.\nGet the donation result from the donation.onDonationSuccess callback\nAdyen sends a webhook message with the donation outcome.\n\nCnNlcXVlbmNlRGlhZ3JhbQogICAgcGFydGljaXBhbnQgUyBhcyBTaG9wcGVyCiAgICBwYXJ0aWNpcGFudCBGIGFzIFlvdXIgY2xpZW50IHdlYnNpdGUKICAgIHBhcnRpY2lwYW50IFNWIGFzIFlvdXIgc2VydmVyCiAgICBwYXJ0aWNpcGFudCBBIGFzIEFkeWVuCiAgICBwYXJ0aWNpcGFudCBXIGFzIFlvdXIgd2ViaG9vayBzZXJ2ZXIKCiAgICBTLT4+RjogMS4gR28gdG8gY2hlY2tvdXQgcGFnZQogICAgU1YtPj5BOiAyLiBDcmVhdGUgcGF5bWVudCBzZXNzaW9uCiAgICBBLS0+PlNWOiBSZXR1cm4gc2Vzc2lvbiBkYXRhCiAgICBTVi0tPj5GOiBQYXNzIHNlc3Npb24gZGF0YQogICAgTm90ZSBvdmVyIEY6IDMuIEFkZCBvcHRpb25hbCBkb25hdGlvbiBjb25maWd1cmF0aW9uIGFuZCBpbml0aWFsaXplIENvbXBvbmVudAogICAgRi0+PlM6IDQuIENvbXBvbmVudCBzaG93cyBwYXltZW50IGZvcm0KICAgIFMtPj5GOiA1LiBTdWJtaXQgcGF5bWVudAogICAgTm90ZSBvdmVyIEY6IDYuIENvbXBvbmVudCBoYW5kbGVzIHBheW1lbnQgZmxvdwogICAgRi0+PkE6IENvbXBvbmVudCBzZW5kcyBwYXltZW50IGRhdGEKICAgIE5vdGUgb3ZlciBBOiA3LiBDaGVjayBmb3IgYWN0aXZlIGRvbmF0aW9uIGNhbXBhaWduCiAgICBBLS0+PkY6IFNlc3Npb24gcmVzdWx0IGFuZCBkb25hdGlvbiBjYW1wYWlnbiBkYXRhCiAgICBvcHQgSWYgeW91IGhhdmUgYWN0aXZlIGRvbmF0aW9uIGNhbXBhaWduCiAgICAgICAgRi0+PlM6IDguIENvbXBvbmVudCBzaG93cyBkb25hdGlvbiBmb3JtCiAgICAgICAgUy0+PkY6IDkuIERvbmF0ZSBvciBkZWNsaW5lCiAgICAgICAgTm90ZSBvdmVyIEY6IDEwLiBDb21wb25lbnQgaGFuZGxlcyBkb25hdGlvbiBmbG93CiAgICAgICAgRi0+PkE6IENvbXBvbmVudCBzZW5kcyBkb25hdGlvbiBkYXRhCiAgICAgICAgQS0tPj5GOiAxMS4gRG9uYXRpb24gcmVzdWx0IAogICAgICAgIEEtPj5XOiAxMi4gV2ViaG9vayBtZXNzYWdlIHdpdGggZG9uYXRpb24gb3V0Y29tZQogICAgZW5kCiAgICBBLT4+VzogMTMuIFdlYmhvb2sgbWVzc2FnZSB3aXRoIHBheW1lbnQgb3V0Y29tZSAKAdd Giving configuration\nWhen you create a global configuration object for the Component, you can optionally add configuration for donations.\nTo receive donation results and customize behavior, add a donation object to your checkout configuration. The donation configuration is optional, but if you include it, you must include the event handlers to get donation outcomes on your client website.\nEvent handlers:\n\n\n\nProperty\nRequired\nDescription\n\n\n\n\nonDonationSuccess\n\nCalled when the donation is completed or the shopper declines to donate. Receives an object with didDonate: true or false.\n\n\nonDonationFailure\n\nCalled when an error occurs in the donation creation or when a donation fails.\n\n\n\nConfiguration parameters:\n\n\n\nProperty\nRequired\nDescription\n\n\n\n\nautoMount\n\nSpecifies if the Component automatically shows the donation form after a successful payment. Set to false to not automatically show the donation form after the payment is completed. You can show the donation form in a separate container by creating a new Donation Component instead. Default: true.\n\n\ndelay\n\nThe delay in milliseconds after a successful payment before the Component shows the donation form.\n\n\n\n\n \n\nShow the donation form in a separate container\nBy default, the Component mounts the donation form in the same container as the original Component. To mount it in a different container:\n\nSet donation.autoMount to false.\nCreate a new Donation Component in the onPaymentCompleted callback, passing the reference to the DOM element that you want to mount the Component into.\n\n\n \nGet the donation outcome\nYou can get the outcome of each donation in a webhook message. This enables you to inform shoppers by email or mobile messaging about their donation, provided you have the shopper's contact details.\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 \nTest and go live\nBefore going live with your integration, use our test cards to test your integration.See also\n\n\n Sessions flow integration guide\n \n Donations with Advanced flow\n \n Webhooks\n \n Giving on adyen.com\n \n Monitor donations\n \n","type":"page","locale":"en","boost":16,"hierarchy":{"lvl0":"Home","lvl1":"Online payments","lvl2":"Donations using Giving","lvl3":"Integrate Adyen Giving with online payments","lvl4":"Donations with Sessions flow"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/","lvl1":"https:\/\/docs.adyen.com\/online-payments","lvl2":"https:\/\/docs.adyen.com\/online-payments\/donations","lvl3":"https:\/\/docs.adyen.com\/online-payments\/donations\/integration-options","lvl4":"\/online-payments\/donations\/integration-options\/sessions-flow"},"levels":5,"category":"Online Payments","category_color":"green","tags":["Web","Components"]}]}