Get a list of nonprofits

post/companies/{companyId}/nonprofits

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.

Endpoint destination URL

https://management-test.adyen.com/v3/companies/{companyId}/nonprofits

Query Parameters

Required

Optional

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

Minimum: 1Maximum: 100

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

Minimum: 1

The number of the page to fetch.

Min length: 1Max length: 100

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

Path Parameters

Required

Optional

The unique identifier of the company account.

Request Parameters

Required

Optional

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

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

200 - OK
The request has succeeded.
_linksobject
Pagination references.
firstobject
The first page.
hrefstring
lastobject
The last page.
hrefstring
nextobject
The next page. Only present if there is a next page.
hrefstring
prevobject
The previous page. Only present if there is a previous page.
hrefstring
selfobject
The current page.
hrefstring
itemsTotalinteger
Total number of items.
nonprofitsarray[object]
The supported nonprofit organizations.
causesarray[object]
The causes that the nonprofit supports.
bannerUrlstring
The URL to the banner of the cause.
descriptionstring
The description of the cause.
idstring
The unique identifier of the cause. This value is generated by Adyen.
localesarray[string]
The locales that the cause supports, in IETF BCP 47 format.
namestring
The name of the cause.
descriptionstring
The description of the nonprofit.
goalsarray[string]
The goals of the nonprofit.
idstring
The unique identifier of the nonprofit organization. This value is generated by Adyen.
localesarray[string]
The locales that the nonprofit supports, in IETF BCP 47 format.
logoUrlstring
The URL to the logo of the nonprofit.
namestring
The name of the nonprofit.
regionsarray[string]
The regions where the nonprofit operates, in ISO 3166-1 alpha-2 format.
termsAndConditionsUrlstring
The URL to the terms and conditions of the nonprofit.
websitestring
The URL to the website of the nonprofit.
pagesTotalinteger
Total number of pages.
400 - Bad Request
A problem reading or understanding the request.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.
401 - Unauthorized
Authentication required.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.
403 - Forbidden
Insufficient permissions to process the request.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.
422 - Unprocessable Entity
A request validation error.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.
500 - Internal Server Error
The server could not process the request.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.

Get a list of nonprofits

HTTP Responses

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity

500 - Internal Server Error