Get all company charities selection

GET 
/v1/auth/company/charities

This call is designed to retrieve a structured list of charities to be displayed during the payment process. The list is returned deterministically, considering the same set of values input. Specifically, if an company_id is provided, whitelist/blacklist logic will be invoked. For instance, if a whitelist is defined in the data model, a charity will only appear if there's a whitelist match. Conversely, if a blacklist is specified in the data model, a charity will only be displayed if there's no blacklist match. This logic is applicable both at the charity and company level, where either entity can include/exclude a specific counterparty. Moreover, if the 'cents ai' feature is enabled, additional refinements such as filtering charities based on company sectors or consumer user location will be implemented.

Request

Query Parameters

cents_ai boolean

Enable centsAI retrieve, if false all charities will be returned

cents_ai_parameters string

Additional parameters used by cent AI to refine the results, it's a JSON string converted in base64

Responses

200

successful operation

application/json

Schema

Schema

• Array [

id uuid

cents id of the charity

name string

The name of the charity

stripe_id Stripe_ID

Stripe ID of the charity

sectors string[]

sectors to be used for blacklist/whitelist from company gateway side

company_blacklist_sectors string[]

List of sectors of companies to be excluded

company_blacklist string[]

List of companies to be exclude

company_whitelist_sectors string[]

List of sectors of companies to be included, if empty all companies will be included

company_whitelist string[]

List of companies to be included, if empty all companies will be included

areas

object[]

Array [

region string

The region of action

country string

The country of action

]

categories

undefined[]

Array [

category_id UUID

Cents ID of the category

name string

Category name

description string

Category description

causes

undefined[]

Array [

name

object

The name of the cause

key string

The key of the cause

translations

object

The translations

en string

The english translation

it string

The italian translation

description

object

en string

The english translation

it string

The italian translation

]

]

• ]

Example (from schema)

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Fondazione Umberto Venovesi",
    "stripe_id": "ch_zo0p1q2r3s4t5u6v7w8x9y0",
    "sectors": [
      [
        "Public Sector"
      ]
    ],
    "company_blacklist_sectors": [
      [
        "sector 1",
        "sector 2"
      ]
    ],
    "company_blacklist": [
      [
        "company_id_1",
        "company_id_2"
      ]
    ],
    "company_whitelist_sectors": [
      [
        "sector 1",
        "sector 2"
      ]
    ],
    "company_whitelist": [
      [
        "company_id_1",
        "company_id_2"
      ]
    ],
    "areas": [
      {
        "region": "Kenya",
        "country": "Africa"
      }
    ],
    "categories": [
      {
        "category_id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "Alberi",
        "description": "Seminiamo Alberi",
        "causes": [
          {
            "name": {
              "key": "Cause",
              "translations": {
                "en": "Cause",
                "it": "Causa"
              }
            },
            "description": {
              "en": "Cause Description",
              "it": "Descrizione Causa"
            }
          }
        ]
      }
    ]
  }
]

401

Unauthorized

402

Payment Required

Loading...