{"title":"Donations with Advanced 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\/advanced-flow","articleFields":{"feedback_component":true,"description":"Accept donations using the Advanced flow with Web Components or API only.","filters_component":true,"filters_config_folder":"donations-advanced","dynamic_minitoc":true,"dynamic_minitoc_context":".in-page-filtering--content"},"algolia":[{"url":"https:\/\/docs.adyen.com\/online-payments\/donations\/integration-options\/advanced-flow","title":"Donations with Advanced flow","content":"Our Giving Component shows the Giving donation form to the shopper after finishing their original payment.\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.\nYou can accept donations for fixed amounts, or allow the shopper to round up their transaction amount as a 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 Components v5.0.0 or later using the Advanced flowCheckout 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 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 components integrations 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+VzogMTMuIFdlYmhvb2sgbWVzc2FnZSB3aXRoIHBheW1lbnQgb3V0Y29tZSAKGet details of your active donation campaigns\nIf the shopper's payment is authorized, and the \/payments or \/payments\/details (for iDEAL payments) response includes the donationToken field, get the details of your active donation campaigns.\nFrom your server, make a POST \/donationCampaigns request, specifying:\n\n\n\nField name\nRequired\nDescription\n\n\n\n\nmerchantAccount\n\nYour merchant account name.\n\n\ncurrency\n\nThe three-character ISO currency code.\n\n\nlocale\n\nThe language in which you want to receive the donation campaign details in the response. The default is configured by the nonprofit. Set it to the shopper's language and country code, for example, en-US.\n\n\n\n\n \n\nThe response contains the details of your active donation campaigns. If there is at least one campaign in the response, show Giving in your payment form.\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\nShow Giving in your payment form\nTo show the Giving Component in your payment form:\n\n\nCreate a DOM element for Giving, placing it where you want the form to be rendered:\n<div id='donation-container'><\/div>\n\n\n\n\nUse the values you received in the \/donationCampaigns response to configure the Giving Component:\n\n\n\nParameter name\nRequired\nDescription\n\n\n\n\ndonation.type\n\nDefines the donation type. Possible values: - roundup - fixedAmounts\n\n\ndonation.currency\n\nThe three-character ISO currency code.\n\n\ndonation.maxRoundupAmount\nRound-up donations\nThe maximum amount a transaction can be rounded up to make a donation.\n\n\ndonation.values\nFixed amount donations\nThe object containing suggested donation amounts.\n\n\ncommercialTxAmount\nRound-up donations\nThe original transaction amount for the shopper's order, excluding the donation amount. The component uses this value to calculate the round-up donation amount.\n\n\nnonprofitName\n\nThe name of the nonprofit.\n\n\nnonprofitDescription\n\nThe description of the nonprofit.\n\n\nnonprofitUrl\n\nThe website URL of the nonprofit.\n\n\nlogoUrl\n\nThe URL for the nonprofit logo.\n\n\nbannerUrl\n\nThe URL for the banner for the campaign.\n\n\ntermsAndConditionsUrl\n\nThe URL for the terms and conditions page of the nonprofit.\n\n\nonDonate\n\nCreate an event handler for onDonate. This is called when the shopper selects the amount they want to donate. In the example below, we use handleOnDonate.\n\n\ncauseName\n\nThe cause of the nonprofit.\n\n\nonCancel\n\nCreate an event handler for onCancel. This is called when the shopper declines to donate. In the example below, we use handleOnCancel.\n\n\nshowCancelButton\n\nBy default, the Component shows a Not now button. Your shopper can select this button to decline to donate. Set to false to remove this button.\n\n\n\n\n\n\n\n\n\nIf you did not persist a previous instance of the AdyenCheckout object, create a new checkout object.\n\n\n\n\n\n\nUse the checkout.create method to create and mount an instance of the Giving Component.\n\n\n\nWhen the shopper selects a donation amount, the Component calls the onDonate event. If state.isValid is true, collect the values passed in state.data which contains the donation amount that the shopper selected.\n\n\nPass the state.data to your server.\n\nMake a donation\nDepending on the donation moment for the campaign, when you make the request for the donation is different:\n\nPre-checkout donation: Make the request for the donation immediately after the payment is authorized, because the shopper has already selected the donation amount.\nPost-checkout donation: Show the option to donate after the payment is authorized. After the shopper confirms the donation, make the request for the donation.\n\nMake a POST \/donations request, including the following:\n\nFor donations with Apple Pay, the parameters included in the request are different.\n\n\n\n\nField name\nRequired\nDescription\n\n\n\n\n amount\n\nThe currency and value of the donation.\n\n\n donationCampaignId\n\nThe unique campaign ID from the \/donationCampaigns response id field.\n\n\n paymentMethod\n \nFor cards or Google Pay: type: scheme For iDEAL: type: sepadirectdebit\n\n\n donationOriginalPspReference\n\nThe PSP reference of the original payment.\n\n\n donationToken\n\nFor cards, the donationToken from the \/payments, or \/payments\/details response. For iDEAL, the donationToken from the \/payments\/details response.\n\n\n reference\n\nThe reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens (\"-\"). Maximum length: 80 characters.\n\n\n merchantAccount\n\nThe merchant account identifier, with which you want to process the transaction.\n\n\n\n\n \n\nThe response contains:\n\nid: a unique resource identifier.\nstatus: the status of the donation. Possible values: completed, pending, or refused.\npayment: object that contains the result code, and the pspReference for the donation transaction.\nThe request body.\n\nDonations with Apple Pay\nWhen the shopper's original transaction uses Apple Pay, get the following information from the \/payments response:\n\n\n\nParameter\nDescription\n\n\n\n\npspReference\nThe PSP reference of the original Apple Pay payment.\n\n\ndonationToken\nThe token to use for the donation.\n\n\nadditionalData.paymentMethod.brand\nThe Apple Pay brand variant. For example, visa_applepay or mc_applepay.\n\n\n\nIn the \/donations request, include the following parameters:\n\n\n\nParameter\nRequired\nDescription\n\n\n\n\n amount\n\nThe currency and value of the donation.\n\n\n donationCampaignId\n\nThe unique campaign ID from the \/donationCampaigns response id field.\n\n\n donationOriginalPspReference\n\nThe pspReference from the \/payments response.\n\n\n donationToken\n\nThe donationToken from the \/payments response.\n\n\n merchantAccount\n\nThe merchant account identifier, with which you want to process the transaction.\n\n\n paymentMethod.type\n\nThe additionalData.paymentMethod.brand from the \/payments response. For example, visa_applepay or mc_applepay.\n\n\n reference\n\nThe reference to uniquely identify a payment.\n\n\n\n\n \nGet the donation outcome\nYou get the outcome of each donation in a webhook message.\nFor cards, you can show the shopper if their donation is successful after you get the webhook message. For iDEAL, you get the webhook event a day or more later. You can send the outcome to the shopper using email or mobile messaging.\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 Web Components integration guide\n \n Donations with Sessions 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 Advanced 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\/advanced-flow"},"levels":5,"category":"Online Payments","category_color":"green","tags":["Donations","Advanced"]},{"url":"https:\/\/docs.adyen.com\/online-payments\/donations\/integration-options\/advanced-flow?platform=Web&integration=Components","title":"Web Components","content":"Our Giving Component shows the Giving donation form to the shopper after finishing their original payment.\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.\nYou can accept donations for fixed amounts, or allow the shopper to round up their transaction amount as a 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 Components v5.0.0 or later using the Advanced flowCheckout 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 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 components integrations 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+VzogMTMuIFdlYmhvb2sgbWVzc2FnZSB3aXRoIHBheW1lbnQgb3V0Y29tZSAKGet details of your active donation campaigns\nIf the shopper's payment is authorized, and the \/payments or \/payments\/details (for iDEAL payments) response includes the donationToken field, get the details of your active donation campaigns.\nFrom your server, make a POST \/donationCampaigns request, specifying:\n\n\n\nField name\nRequired\nDescription\n\n\n\n\nmerchantAccount\n\nYour merchant account name.\n\n\ncurrency\n\nThe three-character ISO currency code.\n\n\nlocale\n\nThe language in which you want to receive the donation campaign details in the response. The default is configured by the nonprofit. Set it to the shopper's language and country code, for example, en-US.\n\n\n\n\n \n\nThe response contains the details of your active donation campaigns. If there is at least one campaign in the response, show Giving in your payment form.\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\nShow Giving in your payment form\nTo show the Giving Component in your payment form:\n\n\nCreate a DOM element for Giving, placing it where you want the form to be rendered:\n<div id='donation-container'><\/div>\n\n\n\n\nUse the values you received in the \/donationCampaigns response to configure the Giving Component:\n\n\n\nParameter name\nRequired\nDescription\n\n\n\n\ndonation.type\n\nDefines the donation type. Possible values: - roundup - fixedAmounts\n\n\ndonation.currency\n\nThe three-character ISO currency code.\n\n\ndonation.maxRoundupAmount\nRound-up donations\nThe maximum amount a transaction can be rounded up to make a donation.\n\n\ndonation.values\nFixed amount donations\nThe object containing suggested donation amounts.\n\n\ncommercialTxAmount\nRound-up donations\nThe original transaction amount for the shopper's order, excluding the donation amount. The component uses this value to calculate the round-up donation amount.\n\n\nnonprofitName\n\nThe name of the nonprofit.\n\n\nnonprofitDescription\n\nThe description of the nonprofit.\n\n\nnonprofitUrl\n\nThe website URL of the nonprofit.\n\n\nlogoUrl\n\nThe URL for the nonprofit logo.\n\n\nbannerUrl\n\nThe URL for the banner for the campaign.\n\n\ntermsAndConditionsUrl\n\nThe URL for the terms and conditions page of the nonprofit.\n\n\nonDonate\n\nCreate an event handler for onDonate. This is called when the shopper selects the amount they want to donate. In the example below, we use handleOnDonate.\n\n\ncauseName\n\nThe cause of the nonprofit.\n\n\nonCancel\n\nCreate an event handler for onCancel. This is called when the shopper declines to donate. In the example below, we use handleOnCancel.\n\n\nshowCancelButton\n\nBy default, the Component shows a Not now button. Your shopper can select this button to decline to donate. Set to false to remove this button.\n\n\n\n\n\n\n\n\n\nIf you did not persist a previous instance of the AdyenCheckout object, create a new checkout object.\n\n\n\n\n\n\nUse the checkout.create method to create and mount an instance of the Giving Component.\n\n\n\nWhen the shopper selects a donation amount, the Component calls the onDonate event. If state.isValid is true, collect the values passed in state.data which contains the donation amount that the shopper selected.\n\n\nPass the state.data to your server.\n\nMake a donation\nDepending on the donation moment for the campaign, when you make the request for the donation is different:\n\nPre-checkout donation: Make the request for the donation immediately after the payment is authorized, because the shopper has already selected the donation amount.\nPost-checkout donation: Show the option to donate after the payment is authorized. After the shopper confirms the donation, make the request for the donation.\n\nMake a POST \/donations request, including the following:\n\nFor donations with Apple Pay, the parameters included in the request are different.\n\n\n\n\nField name\nRequired\nDescription\n\n\n\n\n amount\n\nThe currency and value of the donation.\n\n\n donationCampaignId\n\nThe unique campaign ID from the \/donationCampaigns response id field.\n\n\n paymentMethod\n \nFor cards or Google Pay: type: scheme For iDEAL: type: sepadirectdebit\n\n\n donationOriginalPspReference\n\nThe PSP reference of the original payment.\n\n\n donationToken\n\nFor cards, the donationToken from the \/payments, or \/payments\/details response. For iDEAL, the donationToken from the \/payments\/details response.\n\n\n reference\n\nThe reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens (\"-\"). Maximum length: 80 characters.\n\n\n merchantAccount\n\nThe merchant account identifier, with which you want to process the transaction.\n\n\n\n\n \n\nThe response contains:\n\nid: a unique resource identifier.\nstatus: the status of the donation. Possible values: completed, pending, or refused.\npayment: object that contains the result code, and the pspReference for the donation transaction.\nThe request body.\n\nDonations with Apple Pay\nWhen the shopper's original transaction uses Apple Pay, get the following information from the \/payments response:\n\n\n\nParameter\nDescription\n\n\n\n\npspReference\nThe PSP reference of the original Apple Pay payment.\n\n\ndonationToken\nThe token to use for the donation.\n\n\nadditionalData.paymentMethod.brand\nThe Apple Pay brand variant. For example, visa_applepay or mc_applepay.\n\n\n\nIn the \/donations request, include the following parameters:\n\n\n\nParameter\nRequired\nDescription\n\n\n\n\n amount\n\nThe currency and value of the donation.\n\n\n donationCampaignId\n\nThe unique campaign ID from the \/donationCampaigns response id field.\n\n\n donationOriginalPspReference\n\nThe pspReference from the \/payments response.\n\n\n donationToken\n\nThe donationToken from the \/payments response.\n\n\n merchantAccount\n\nThe merchant account identifier, with which you want to process the transaction.\n\n\n paymentMethod.type\n\nThe additionalData.paymentMethod.brand from the \/payments response. For example, visa_applepay or mc_applepay.\n\n\n reference\n\nThe reference to uniquely identify a payment.\n\n\n\n\n \nGet the donation outcome\nYou get the outcome of each donation in a webhook message.\nFor cards, you can show the shopper if their donation is successful after you get the webhook message. For iDEAL, you get the webhook event a day or more later. You can send the outcome to the shopper using email or mobile messaging.\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 Web Components integration guide\n \n Donations with Sessions 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 Advanced 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\/advanced-flow"},"levels":5,"category":"Online Payments","category_color":"green","tags":["Web","Components"]},{"url":"https:\/\/docs.adyen.com\/online-payments\/donations\/integration-options\/advanced-flow?platform=Web&integration=API only","title":"Web 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.Requirements\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 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.Enable and integrate with the payment methods that you want to support.Create and activate a donation campaign.\n\n\nHow it works\nThe donation flow depends on the donation moment:\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\nPresent the option to donate\n\n\n \n \n \n \n\nMake a donation\nDepending on the donation moment for the campaign, when you make the request for the donation is different:\n\nPre-checkout donation: Make the request for the donation immediately after the payment is authorized, because the shopper has already selected the donation amount.\nPost-checkout donation: Show the option to donate after the payment is authorized. After the shopper confirms the donation, make the request for the donation.\n\nMake a POST \/donations request, including the following:\n\nFor donations with Apple Pay, the parameters included in the request are different.\n\n\n\n\nField name\nRequired\nDescription\n\n\n\n\n amount\n\nThe currency and value of the donation.\n\n\n donationCampaignId\n\nThe unique campaign ID from the \/donationCampaigns response id field.\n\n\n paymentMethod\n \nFor cards or Google Pay: type: scheme For iDEAL: type: sepadirectdebit\n\n\n donationOriginalPspReference\n\nThe PSP reference of the original payment.\n\n\n donationToken\n\nFor cards, the donationToken from the \/payments, or \/payments\/details response. For iDEAL, the donationToken from the \/payments\/details response.\n\n\n reference\n\nThe reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens (\"-\"). Maximum length: 80 characters.\n\n\n merchantAccount\n\nThe merchant account identifier, with which you want to process the transaction.\n\n\n\n\n \n\nThe response contains:\n\nid: a unique resource identifier.\nstatus: the status of the donation. Possible values: completed, pending, or refused.\npayment: object that contains the result code, and the pspReference for the donation transaction.\nThe request body.\n\nDonations with Apple Pay\nWhen the shopper's original transaction uses Apple Pay, get the following information from the \/payments response:\n\n\n\nParameter\nDescription\n\n\n\n\npspReference\nThe PSP reference of the original Apple Pay payment.\n\n\ndonationToken\nThe token to use for the donation.\n\n\nadditionalData.paymentMethod.brand\nThe Apple Pay brand variant. For example, visa_applepay or mc_applepay.\n\n\n\nIn the \/donations request, include the following parameters:\n\n\n\nParameter\nRequired\nDescription\n\n\n\n\n amount\n\nThe currency and value of the donation.\n\n\n donationCampaignId\n\nThe unique campaign ID from the \/donationCampaigns response id field.\n\n\n donationOriginalPspReference\n\nThe pspReference from the \/payments response.\n\n\n donationToken\n\nThe donationToken from the \/payments response.\n\n\n merchantAccount\n\nThe merchant account identifier, with which you want to process the transaction.\n\n\n paymentMethod.type\n\nThe additionalData.paymentMethod.brand from the \/payments response. For example, visa_applepay or mc_applepay.\n\n\n reference\n\nThe reference to uniquely identify a payment.\n\n\n\n\n \nGet the donation outcome\nYou get the outcome of each donation in a webhook message.\nFor cards, you can show the shopper if their donation is successful after you get the webhook message. For iDEAL, you get the webhook event a day or more later. You can send the outcome to the shopper using email or mobile messaging.\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 API only integration\n \n Donations with Sessions flow\n \n Webhooks\n \n API Explorer\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 Advanced 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\/advanced-flow"},"levels":5,"category":"Online Payments","category_color":"green","tags":["Web","API only"]}]}