--- title: "In-person donations using Adyen Giving" description: "Enable your users to accept in-person donations from shoppers using Adyen Giving." url: "https://docs.adyen.com/platforms/in-person-payments/donations-in-person" source_url: "https://docs.adyen.com/platforms/in-person-payments/donations-in-person.md" canonical: "https://docs.adyen.com/platforms/in-person-payments/donations-in-person" last_modified: "2026-05-26T13:48:55+02:00" language: "en" --- # In-person donations using Adyen Giving Enable your users to accept in-person donations from shoppers using Adyen Giving. [View source](/platforms/in-person-payments/donations-in-person.md) ##### Read more ![Giving logo](/user/pages/docs/05.platforms/28.in-person-payments/08.donations-in-person/giving.svg?decoding=auto\&fetchpriority=auto) Learn about Adyen Giving [in your online checkout](/platforms/online-payments/donations-online). With Adyen Giving, your users can give shoppers the option to donate to a nonprofit organization when shoppers make an in-store purchase. To enable this, you set up donation campaigns for [account holder resources](/platforms/account-structure-resources#balance-platform-resources). When a campaign has been started and a shopper chooses to donate, the donation is processed as a separate transaction. Adyen covers all fees and the donation amount is transferred to the nonprofit in full. This means you can split amounts and fees on the original transaction, but not on the donation transaction. ## Requirements Before you begin, take into account the following requirements, limitations, and preparations. | Requirement | Description | | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Integration type** | Adyen for Platforms merchants with a platform model, using a Terminal API integration with payment terminals or a Standalone solution. The terminals must use terminal software version 1.109 or later. Some terminals or features require software version 1.110 or later. | | **[Customer Area roles](/account/user-roles)** | Make sure that you have the following roles:- **Donation campaigns viewer**: to view donation campaigns and access campaign insights. - **Donation campaigns manager**: to create, start, edit, and end donation campaigns and access campaign insights. | | **[Webhooks](/development-resources/webhooks)** | Subscribe to the **[Adyen Giving merchant webhook](/development-resources/webhooks/webhook-types#other-webhooks)**. | | **Hardware** | See [Supported terminals](/platforms/donations#terminals) for a list of terminal models that support Giving, and the donation settings that are supported on these terminals. | | **Limitations** | Note the following limitations:- The maximum number of account holders that you can assign to a donation campaign is 400. - A store can only be part of one active campaign at the same time. - Make sure that you are using [supported payment methods](/platforms/donations#supported-payment-methods) and [supported regions and currencies](/platforms/donations#supported-currencies). | | **Setup steps** | Before you begin, make sure that the nonprofit you choose has been onboarded to Adyen, or pick one of our [pre-approved nonprofits](https://www.adyen.com/giving/nonprofit) that have already been onboarded. | ## How it works To enable your users to accept donations at the point of sale: 1. [Choose a nonprofit](/platforms/donations#nonprofit-organizations). 2. [Set up a donation campaign](#set-up-a-donation-campaign) in your Customer Area, under **Giving** > **Campaigns**.\ You need to select: * The account holders that you want to make the campaign available to. * The nonprofit. * The stores and [donation settings](#donation-settings). 3. Optionally [configure a donation campaign logo](#logo) to show as the standby screen on payment terminals. 4. To be able to inform shoppers about their donation, implement either or both of the following methods: * Generate a [shopper receipt for the donation](#two-step-donation-response). This is only possible if you use the [two-step interaction flow](#interaction-flow). * Use [Giving webhook messages](#giving-webhook) to send shoppers a receipt by email or mobile messaging. 5. Start the campaign from the **Campaigns** overview in your Customer Area. After the next scheduled reboot of the payment terminals, the terminals automatically show the donation options from the campaign after every payment, except when the terminal is offline or the payment method is not supported by Adyen Giving. ## Donation settings With our Giving integration, you have the flexibility to choose a combination of interaction flow and donation type. You configure these choices in your [donation campaign](#set-up-a-donation-campaign). However, there are limitations to the supported choices, depending on [region and currency](/platforms/donations#supported-currencies), [payment method](/platforms/donations#supported-payment-methods), and [terminal model](/platforms/donations#terminals). ### Interaction flow You can choose to use a one-step flow or a two-step flow. Technically, there are two transactions: one for the payment and one for the donation. But in the one-step flow, the payment and the donation are shown as a single transaction, and shoppers need to present their card only once. In the two-step flow, shoppers need to present their card twice. With a Terminal API integration, this enables you to provide the shopper with a receipt for their donation, because you can [retrieve the full donation transaction response](#two-step-donation-response). The two-step flow also supports more payment methods than the one-step flow. The effect on your payment terminals is as follows: 1. After you have set up and activated your donation campaign, both flows start in the same way: 1. You initiate a payment for the goods your shopper is purchasing. 2. The shopper presents their card on the payment terminal. 2. From this moment, the flows are different: | One-step flow | Two-step flow | | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | | | The terminal screen shows that the payment is approved, and... | | The terminal presents the [options to donate](#donation-type) to the nonprofit. | ... the terminal also presents the [options to donate](#donation-type) to the nonprofit. | | If the shopper chooses to donate, the terminal processes the donation. | If the shopper chooses to donate, the terminal starts the donation transaction for the amount the shopper specified and asks for the card. | | | The shopper presents their card on the terminal to complete the donation transaction. | | The terminal shows a confirmation to thank the shopper. | The terminal shows a confirmation to thank the shopper. | | The terminal shows that the payment is approved. | | In both flows: * The terminal does not prompt for a donation when it is offline or after a gift card payment. * If the shopper selects the donation option *Not now*, the terminal shows a confirmation screen with a message that no donation was made. ### Donation type You can present the following donation types on the payment terminal screen: * **Fixed amounts**: configure up to three fixed amounts to present to shoppers. * **Round up**: allow shoppers to donate by rounding up the transaction amount of their purchase. You can enable the round-up feature on its own, or together with one fixed amount. The terminal always shows a *"Not now"* option that the shopper can select to skip donating. The following example screens are for the two-step flow, showing that the payment was approved. | Fixed amounts | Round up | Round up and one fixed amount | | --------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ![Screen with fixed amounts](/images/3/1/c/e/2/31ce2c08be6c5c1214d5079ec759031d9bcf317f-fixed-amounts.png "Fixed amount options") | ![Round-up screen](/images/2/6/6/0/0/2660074ff62e17ae512d04a372524b11410bc1ee-round-up.png "Round-up option") | ![Screen with round-up and one fixed amount](/images/3/8/f/d/a/38fda23a0238d1e5431bc3d85e0d1e15177cd4b4-round-up-and-fixed.png "Round-up option and one fixed amount option") | ## Set up a donation campaign for account holders The Campaigns user interface in the Customer Area guides you through setting up a donation campaign, and shows example screens. The main steps to create an Adyen Giving donation campaign for your account holders are as follows: 1. In your [Customer Area](https://ca-test.adyen.com/), go to **Giving** > **Campaigns**. 2. Select **Create new campaign** > **For account holders**. 3. Add the account holders to the campaign, one by one or as a group: * One by one: select **Search accounts**, select your balance platform, and search by account holder ID or reference, legal entity ID or name, or email address. Then select **Add** in the tile of the individual account holder. * Group: select **Submit a list of accounts**, select your balance platform, enter a comma-separated list of account holder IDs, and select **Add**. The UI will inform you if an account holder has already been added or cannot be found on the selected balance platform. 4. Select the campaign details: * The nonprofit. * Either a specific cause, or "General fundraising". * The sales channel: online payments (ecommerce), in-person payments (point of sale), or both. 5. If you selected online payments, first select the stores that the campaign applies to.\ Then select the donation type. When you choose fixed amounts and enter the amounts in your default currency, we automatically add equivalent amounts in other currencies if necessary for the selected stores. 6. If you selected in-person payments, first select the stores that the campaign applies to.\ Then select: * The one-step or two-step interaction flow. * Timeouts for the donation prompt and the payment screen. * The text to show on the donation screen on the terminal: the name of the nonprofit or the cause you selected. * The donation type. When you choose fixed amounts and enter the amounts in your default currency, we automatically add equivalent amounts in other currencies if necessary for the selected stores. 7. Review the summary. When everything is correct, select **Create campaign**. The campaign is now set up, but not active yet. When you are ready to activate the campaign: 1. In your [Customer Area](https://ca-test.adyen.com/), go to **Giving** > **Campaigns**. 2. Find the tile for the campaign, and select **Start**. ## (Optional) Configure a logo You can configure your terminal's standby screen to show a logo for your donation campaign. Follow the instructions in the Customer Area under **In-person payments** > **Terminal Settings** > **Customisation** > **Logo**. | Model | Requirements | | ------------------------------------------------ | --------------------------------------------- | | AMS 1 | Dimensions: 480 x 800 File size: max. 1 MB | | P630 | Dimensions: 320 x 480 File size: max. 1 MB | | e280 | Dimensions: 320 x 444 File size: max. 512 KB | | e285p | Dimensions: 240 x 284 File size: max. 512 KB | | M400 | Dimensions: 854 x 432 File size: max. 512 KB | | M450 | Dimensions: 1280 x 800 File size: max. 100 MB | | P400 Plus | Dimensions: 320 x 450 File size: max. 512 KB | | S1E | Dimensions: 720 x 1280 File size: max. 1 MB | | S1E2L | Dimensions: 720 x 1280 File size: max. 1 MB | | S1F2 | Dimensions: 720 x 1280 File size: max. 1 MB | | S1F2L | Dimensions: 720 x 1280 File size: max. 1 MB | | [SFO1](/point-of-sale/android-terminals/themes/) | Dimensions: 1280 x 800 File size: max. 100 MB | | S1U2 | Dimensions: 720 x 1280 File size: max. 1 MB | | V240m Plus | Dimensions: 320 x 450 File size: max. 512 KB | | V400c Plus | Dimensions: 320 x 450 File size: max. 512 KB | | V400m | Dimensions: 320 x 450 File size: max. 512 KB | ![Terminal screen with Giving logo](/images/4/c/7/1/4/4c7148a5a8f6040debc0843dac4e95e7f38fc203-pos-logo.png) ## (Optional) Get the two-step donation response If you are using the two-step flow in a Terminal API integration, you can retrieve the full response for the donation transaction through a transaction status request. A reason to retrieve the donation response is that this includes a `PaymentReceipt` object that you can use to generate a shopper receipt for the donation. It is only possible to retrieve the donation transaction response in the two-step flow. 1. [Make a transaction status request](/point-of-sale/basic-tapi-integration/verify-transaction-status), specifying: * The standard [`SaleToPOIRequest.MessageHeader` ](/point-of-sale/design-your-integration/terminal-api#request-message-header)object, with `MessageClass` set to **Service** and `MessageCategory` set to **TransactionStatus**. | Parameter | Required | Description | | ----------------- | ------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | | `ProtocolVersion` | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | **3.0** | | `MessageClass` | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | **Service** | | `MessageCategory` | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | **TransactionStatus** | | `MessageType` | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | **Request** | | `SaleID` | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | Your unique ID for the POS system component to send this request from. | | `ServiceID` | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | Your unique ID for this request, consisting of 1-10 alphanumeric characters. Must be unique within the last 48 hours for the terminal (`POIID`) being used. | | `POIID` | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | The unique ID of the terminal to send this request to. Format: *\[device model]-\[serial number]*. | - The [TransactionStatusRequest](https://docs.adyen.com/api-explorer/terminal-api/latest/post/transactionstatus) object with: * `ReceiptReprintFlag`: **true** * `DocumentQualifier`: The receipt data you want to receive in the response. Can be one or both of: * **CashierReceipt**: cashier receipt, including signature data. * **CustomerReceipt**: shopper receipt. * `MessageReference`: this object identifies what you want to receive: | Parameter | Description | | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `MessageCategory` | **Payment**. | | `SaleID` | **AdyenGiving**. If you specify this `SaleID` and omit the `ServiceID`, you will get the response for the latest donation made on the terminal that you route the transaction status request to. | | `ServiceID` | The `adyen_giving_service_id` from the original payment response. Use this parameter to retrieve the response for a specific donation instead of the latest donation made on the terminal. | The example below shows how to check the status of a donation with the `adyen_giving_service_id` **8ha5925831**. #### JSON ```json { "SaleToPOIRequest": { "MessageHeader": { "ProtocolVersion": "3.0", "MessageClass": "Service", "MessageCategory": "TransactionStatus", "MessageType": "Request", "SaleID": "POSSystemID12345", "ServiceID": "29246", "POIID": "M400-260193322" }, "TransactionStatusRequest": { "ReceiptReprintFlag": true, "DocumentQualifier": [ "CashierReceipt", "CustomerReceipt" ], "MessageReference": { "MessageCategory": "Payment", "SaleID": "AdyenGiving", "ServiceID": "8ha5925831" } } } } ``` #### Java ```java String serviceID = "YOUR_UNIQUE_ATTEMPT_ID"; String saleID = "YOUR_CASH_REGISTER_ID"; String POIID = "YOUR_TERMINAL_ID"; String transactionID = "YOUR_UNIQUE_TRANSACTION_ID"; SaleToPOIRequest saleToPOIRequest = new SaleToPOIRequest(); MessageHeader messageHeader = new MessageHeader(); messageHeader.setProtocolVersion("3.0"); messageHeader.setMessageClass( MessageClassType.SERVICE ); messageHeader.setMessageCategory( MessageCategoryType.TRANSACTIONSTATUS ); messageHeader.setMessageType( MessageType.REQUEST ); messageHeader.setServiceID(serviceID); messageHeader.setSaleID(saleID); messageHeader.setPOIID(POIID); saleToPOIRequest.setMessageHeader(messageHeader); TransactionStatusRequest transactionStatusRequest = new TansactionStatusRequest(); transactionStatusRequest.setReceiptReprintFlag(true); transactionStatusRequest.setDocumentQualifier("CashierReceipt", "CustomerReceipt"); MessageReference messageReference = new MessageReference(); messageReference.setMessageCategory("Payment"); messageReference.setSaleID("AdyenGiving"); messageReference.setServiceID("8ha5925831"); transactionStatusRequest.setMessageReference(messageReference); saleToPOIRequest.setTransactionStatusRequest(transactionStatusRequest); terminalAPIRequest.setSaleToPOIRequest(saleToPOIRequest); ``` 2. In the [TransactionStatusResponse](https://docs.adyen.com/api-explorer/terminal-api/latest/post/transactionstatus#responses-200-Response), note the `RepeatedMessageResponse`. This contains the response for the donation transaction. Use the `RepeatedMessageResponse.PaymentReceipt` object to generate a shopper receipt for the donation. **Transaction status response with the donation response** ```json { "SaleToPOIResponse": { "MessageHeader": { "MessageCategory": "TransactionStatus", "MessageClass": "Service", "MessageType": "Response", "POIID": "M400-260193322", "SaleID": "POSSystemID12345", "ServiceID": "29246" }, "TransactionStatusResponse": { "MessageReference": { "MessageCategory": "Payment", "SaleID": "AdyenGiving" }, "RepeatedMessageResponse": { "MessageHeader": { "DeviceID": "6", "MessageCategory": "Payment", "MessageClass": "Service", "MessageType": "Response", "POIID": "M400-260193322", "SaleID": "AdyenGiving", "ServiceID": "8ha5925831" }, "RepeatedResponseMessageBody": { "PaymentResponse": { "POIData": { "POIReconciliationID": "1001", "POITransactionID": { "TimeStamp": "2020-12-02T16:16:48.000Z", "TransactionID": "6JuQ001604433524001.NC6HT9CRT65ZGN82" } }, "PaymentReceipt": [ { "DocumentQualifier": "CashierReceipt", ... }, { "DocumentQualifier": "CustomerReceipt", ... } ], "PaymentResult": { "AmountsResp": { "AuthorizedAmount": 5, "Currency": "EUR" }, "OnlineFlag": true, "PaymentAcquirerData": {...}, "PaymentInstrumentData": {...} }, "Response": { "AdditionalResponse": "...", "Result": "Success" }, "SaleData": { "SaleTransactionID": { "TimeStamp": "2020-11-03T19:58:44.000Z", "TransactionID": "6JuQ001604433524001" } } } } }, "Response": { "AdditionalResponse": "...", "Result": "Success" } } } } ``` ## Giving webhook You 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. To receive these webhook messages, enable the [Adyen Giving merchant webhook](/development-resources/webhooks/webhook-types#other-webhooks), which includes `eventCode`: **DONATION**. For a successful donation, the event contains: * `success`: **true**. * `originalReference`: use this value to associate the donation with the shopper's original transaction. **Successful donation webhook event** ```json { "live": "false", "notificationItems": [ { "NotificationRequestItem": { "additionalData": { "originalMerchantAccountCode": "YOUR_MERCHANT_ACCOUNT" }, "amount": { "currency": "EUR", "value": 500 }, "originalReference": "V4HZ4RBFJGXXGN82", "eventCode": "DONATION", "eventDate": "2022-07-07T13:18:13+02:00", "merchantAccountCode": "CHARITY_DONATION_ACCOUNT", "merchantReference": "YOUR_DONATION_REFERENCE", "paymentMethod": "visa", "pspReference": "Z58FGTKBRCQ2WN27", "reason": "033899:1111:03/2030", "success": "true" } } ] } ``` ## See also * [Campaign lifecycle management](/platforms/donations#campaign-lifecycle-management) * [Giving for online platform payments](/platforms/online-payments/donations-online) * [Reports and dashboard](/reporting/donation-campaigns)