ADadyen
Donation campaigns

Get a list of nonprofits

Changed on

Returns a list of supported nonprofit organizations to choose from when creating a donation campaign. The list only contains nonprofits that are compatible with all the account holders specified in the request.

post/companies/{companyId}/nonprofits

Request

  • Base URL
    https://management-test.adyen.com/v3
  • URL
    https://management-test.adyen.com/v3/companies/{companyId}/nonprofits
  • Auth
    • HTTP basic
    • or API key in header X-API-Key

Path parameters

companyIdstring required

The unique identifier of the company account.

Query parameters

searchTermstring

A query to return nonprofit organizations for, maximum 100 characters. For example, &searchTerm=clean%20water.

pageNumberinteger

The number of the page to fetch.

pageSizeinteger

The number of items to have on a page, maximum 100. The default is 10 items on a page.

goalstring[]

One or more United Nations Sustainable Development Goals to return nonprofit organizations for. Format: unsdg_<number>, for example, &goal=unsdg_6&goal=unsdg_2.

Request body

accountHolderIdsstring[] required

The unique identifiers of the account holders to be included in a donation campaign.

Response

OK - the request has succeeded.

itemsTotalinteger required

Total number of items.

pagesTotalinteger required

Total number of pages.

Changes