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.
Servers
- https://management-test.adyen.com/v3
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
companyId |
String | Yes |
The unique identifier of the company account. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
pageNumber |
Integer | No |
The number of the page to fetch. |
goal[] |
Array | No |
One or more United Nations Sustainable Development Goals to return nonprofit organizations for. Format: |
pageSize |
Integer | No |
The number of items to have on a page, maximum 100. The default is 10 items on a page. Default value: 10 |
searchTerm |
String | No |
A query to return nonprofit organizations for, maximum 100 characters. For example, |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
accountHolderIds[] |
Array | Yes |
The unique identifiers of the account holders to be included in a donation campaign. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.