Get a list of active donation campaigns

POST {{baseUrl}}/donationCampaigns

Queries the available donation campaigns for a donation based on the donation context (like merchant account, currency, and locale). The response contains active donation campaigns.

Request Body

{"merchantAccount"=>"{{YOUR_MERCHANT_ACCOUNT}}", "currency"=>"EUR"}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring
Idempotency-KeynullA unique identifier for the message with a maximum of 64 characters (we recommend a UUID).

RESPONSES

status: OK

{"donationCampaigns":[{"id":"DONATION_CAMPAIGN_ID","campaignName":"DONATION_CAMPAIGN_NAME","donation":{"currency":"EUR","donationType":"fixedAmounts","values":[]},"nonprofitName":"NONPROFIT_NAME","causeName":"NONPROFIT_CAUSE","nonprofitDescription":"NONPROFIT_DESCRIPTION.","nonprofitUrl":"NONPROFIT_WEBSITE_URL","logoUrl":"NONPROFIT_LOGO_URL","bannerUrl":"NONPROFIT_BANNER_URL","termsAndConditionsUrl":"NONPROFIT_TERMS_AND_CONDITIONS_URL"},{"id":"DONATION_CAMPAIGN_ID","campaignName":"DONATION_CAMPAIGN_NAME","donation":{"currency":"EUR","donationType":"roundup","maxRoundupAmount":100},"nonprofitName":"NONPROFIT_NAME","causeName":"NONPROFIT_CAUSE","nonprofitDescription":"NONPROFIT_DESCRIPTION.","nonprofitUrl":"NONPROFIT_WEBSITE_URL","logoUrl":"NONPROFIT_LOGO_URL","bannerUrl":"NONPROFIT_BANNER_URL","termsAndConditionsUrl":"NONPROFIT_TERMS_AND_CONDITIONS_URL"}]}