How to connect your Worldline Hosted Payments account in raisin.

raisin is implementing "Hosted Payments" across the platform in order to continue providing top-level security to you and your generous supporters.

With this change, payment fields (Card Number, Card Name, Expiry and CVV) will continue to be rendered, or "embedded," within your raisin events, but will now be physically hosted by your payment gateway provider, Worldline. Ultimately, the Payment Account your organization uses, where funds are deposited from does not change, but how it’s implemented does.

Your organization will be required to complete this transition by  October 31st, 2023. After this date, we will be sunsetting the current payment form.


To transition, there are four simple steps your organization will want to take, and that your Client Experience Manager is happy to support with:

  1. Create your API Key and Payments API Key in your Worldline account (this step can be skipped if your organization already has these Keys in your existing Payment Account in raisin).

  2. Copy your existing Worldline account credentials in raisin.
  3. Re-add your Worldline account in raisin with the “Worldline- Hosted” account type.
  4. Switch the Payment Gateway of live Events in raisin.

For campaigns with recurring donations, additional support will be required from our technical team to switch Payment Accounts. You can contact your Client Experience Manager, after successfully switching your first event to the new Payment Gateway Account, who will initiate this process for you.

Create your API Key and Payments API Key in your Worldline account

If your organization already has these Keys in your existing Payment Account in raisin, you can skip this step.

Please follow the steps outlined below, to create your API Key and Payments Key in your Worldline account.

  1. Login into your Worldline account. 
  2. On the left-hand side navigation menu, click on "Configuration", then "Payment Profile Configuration".

  3. Under the "Security Settings" area, copy the API access passcode (If this code does not appear, click on "Generate New Code"). This is your API Key.

    Screen Shot 2022-11-16 at 8.22.45 PM-1

    Your API Key,  will be needed when you re-add your Worldline account in raisin.

  4. Next, navigate to the left-hand side navigation menu, click on "Administration", > "Account Settings " > "Order Settings". 
  5. Copy the code that appears in the "API Access Passcode" field (if this code does not appear here, click on "Generate New Code"). This is your Payments API Key.

    Screen Shot 2022-11-16 at 8.47.03 PM

Your Payments API Key, will be needed when you re-add your Worldline account in raisin.

Copy your existing Worldline account credentials in raisin

To copy your existing Worldline account credentials, your raisin System Administrator can login to your raisin account, and click on "General Setup". From here, select "Manage Payment Accounts" on the left-hand side menu.

Select your existing Worldline account. From here, you'll want to copy your Merchant Id, API Key, Payments API Key, Transaction Username and Transaction Password. 

If your organization had to create your API Key and Payments API Keys in the initial step, then you do not need to copy the API Key and Payments API Key, in the existing Payment Account in raisin. 

Re-add your Worldline account in raisin with the “Worldline - Hosted” account type

Using the credentials you just copied, (and the API Key and Payments Key you created if applicable), you can re-add your Worldline account in raisin. This new Payment Account will replace your current Payment Account on raisin. The steps are as follows:

  1. Navigate to Manage Payment Accounts under General Setup.

  2. Click Create New Payment Account.
  3. Establish an Account Name for the new Worldline Hosted account, that differentiates it from your existing account.
  4. Choose "Worldline - Hosted" from the drop-down list of Payment Gateways.
  5. Choose the currency of the gateway.
  6. Enter your Merchant Id, API Key, Payments API Key, Transaction Username, and Transaction Password. 

    Screen Shot 2022-11-22 at 12.53.07 PM

  7. Re-add your Transaction Code Prefix. The Transaction Code prefix is public facing, and will be part of the Transaction Code reported in raisin and your Worldline journal respectively. 
  8. Click Add.

The styling of Hosted Payment fields for Credit Card Number, Cardholder Name, Expiration Date and CVV Code comes directly from Worldline, given that it is hosted on their platform. Worldline has default styling for these fields. Therefore, once you switch your Payment Account, within your live Events, it will automatically inherit the following look and feel:  

Screen Shot 2022-11-22 at 1.17.29 PM


Please note: raisin cannot make any modifications to the payment form, as this form is hosted directly within Worldline.

Switch the Payment Gateway of live Events in raisin

With the new Worldline Hosted account you've created, you'll then want to switch any live Events in raisin using your old Worldline account to new gateway you've just established.

In order to test your new Payment Gateway Account, we recommend switching one of your live events to it first. Ideally, the event you choose is low-traffic and allows one-time payments only. Make a small transaction, and if this transaction successfully processes, you can be safe in switching your remaining live events to this new Payment Account.

To ensure the credentials you've entered are correct, we recommend a quick test first:

  1. Go to Events, and select one of your low-traffic events, with one-time payments.
  2. If the event is on Multi-Pledge, Donations or Ticketing, go to Event Details, and scroll to Payment Account. If the event is on Pledge, go to Location Details, and scroll to the Payment Account.
  3. Select to name of the Hosted Payments account you re-added,  to make the event live.
  4. Save.
  5. Launch the front-end site and make a small donation.
  6. Regardless of the result, go to Reports > Transactions Report and check the payment status. If it was Failed, then the payment status will indicate the reasons Worldline declined the payment and may indicate an issue with your account, or that credentials were entered incorrectly. Contact Worldline and your raisin Client Experience Manager if this occurs.
    1. Log in to your Worldline account (not in raisin), and check the status of the payment you just submitted.


If the test is successful, follow these steps to switch all of your Live events to the new Worldline account:

  1. Go to the Events tab.
  2. From the Events list, select the Location Details of the Event.
  3. Scroll to Payment Account under Payment & Fundraising Information.
  4. Select the name of the Hosted Payments account you've created and tested. This will switch the destination of all new payments going forward.
  5. Save.
  6. Repeat for all other Events where your previous Worldline account was active.

Transferring recurring donations

Recurring donations are submitted via secure tokens that are unique to your payment gateway account. For this reason, you will be unable to switch the Payment Account for Events in raisin where there are ongoing recurring gifts.

Instead, for a seamless transition the your re-added Worldline Hosted account, raisin's technical teams can manually switch the Payment Gateway Account within these Events. 

To initiate this process, please notify your Client Experience Manager as soon as you have successfully established your newly re-added Worldline Hosted account in raisin. 

When does this transition need to be completed by?

Your organization will be required to complete this transition by October 31st, 2023. After this date, we will be sunsetting the current payment form.

If you have any questions or need any assistance with this transition, please don't hesitate to reach out to your dedicated Client Experience Manager!