Listar parcerias

curl -X GET "https://api.chargefy.io/v1/affiliations?side=affiliates&limit=10" \
  -H "Authorization: Bearer {{API_KEY}}"

{
  "object": "list",
  "data": [
    {
      "id": "aff_7Dk9mQ2vX5rT8pWN",
      "object": "affiliation",
      "affiliate_organization": "org_5Nq8rT2wX7mK4pV9",
      "created_at": "2026-10-26T12:00:00Z",
      "ended_at": null,
      "ended_by_organization": null,
      "livemode": true,
      "metadata": {},
      "organization": "org_7Dk9mQ2vX5rT8pWN",
      "source": "platform",
      "status": "active",
      "updated_at": "2026-10-26T12:00:00Z"
    }
  ],
  "has_more": false,
  "url": "/v1/affiliations"
}

{
  "error": {
    "code": "invalid_request",
    "message": "Invalid side, status, limit or cursor.",
    "type": "invalid_request_error"
  }
}

{
  "error": {
    "code": "authentication_failed",
    "message": "Invalid API key provided.",
    "type": "authentication_error"
  }
}

Use a API key da sua organização. O acesso é permitido apenas quando sua organização é um dos dois lados da parceria.

string

padrão:"affiliates"

affiliates lista os afiliados da sua organização; programs lista os programas dos quais ela participa.

string

Filtra por active ou ended. Sem filtro, retorna ambos.

integer

padrão:"10"

De 1 a 100.

string

ID da última parceria do lote anterior.

string

ID para voltar ao lote imediatamente anterior. Não pode ser combinado com starting_after.

curl -X GET "https://api.chargefy.io/v1/affiliations?side=affiliates&limit=10" \
  -H "Authorization: Bearer {{API_KEY}}"

{
  "object": "list",
  "data": [
    {
      "id": "aff_7Dk9mQ2vX5rT8pWN",
      "object": "affiliation",
      "affiliate_organization": "org_5Nq8rT2wX7mK4pV9",
      "created_at": "2026-10-26T12:00:00Z",
      "ended_at": null,
      "ended_by_organization": null,
      "livemode": true,
      "metadata": {},
      "organization": "org_7Dk9mQ2vX5rT8pWN",
      "source": "platform",
      "status": "active",
      "updated_at": "2026-10-26T12:00:00Z"
    }
  ],
  "has_more": false,
  "url": "/v1/affiliations"
}

{
  "error": {
    "code": "invalid_request",
    "message": "Invalid side, status, limit or cursor.",
    "type": "invalid_request_error"
  }
}

{
  "error": {
    "code": "authentication_failed",
    "message": "Invalid API key provided.",
    "type": "authentication_error"
  }
}

Chargefy for Platforms

Esta seção só se aplica a contas com o produto Chargefy for Platforms habilitado. Nesse produto, uma plataforma opera pagamentos para suas organizações filhas.

Use a chave da plataforma e o header Organization da organização filha que está consultando ou encerrando a parceria. A filha precisa estar ativa na sua rede.

cURL

curl -X GET "https://api.chargefy.io/v1/affiliations?side=affiliates&limit=10" \
  -H "Authorization: Bearer {{PLATFORM_API_KEY}}" \
  -H "Organization: org_7Dk9mQ2vX5rT8pWN"

curl -X GET "https://api.chargefy.io/v1/affiliations?side=affiliates&limit=10" \
  -H "Authorization: Bearer {{API_KEY}}"

{
  "object": "list",
  "data": [
    {
      "id": "aff_7Dk9mQ2vX5rT8pWN",
      "object": "affiliation",
      "affiliate_organization": "org_5Nq8rT2wX7mK4pV9",
      "created_at": "2026-10-26T12:00:00Z",
      "ended_at": null,
      "ended_by_organization": null,
      "livemode": true,
      "metadata": {},
      "organization": "org_7Dk9mQ2vX5rT8pWN",
      "source": "platform",
      "status": "active",
      "updated_at": "2026-10-26T12:00:00Z"
    }
  ],
  "has_more": false,
  "url": "/v1/affiliations"
}

{
  "error": {
    "code": "invalid_request",
    "message": "Invalid side, status, limit or cursor.",
    "type": "invalid_request_error"
  }
}

{
  "error": {
    "code": "authentication_failed",
    "message": "Invalid API key provided.",
    "type": "authentication_error"
  }
}

Fundamentos da API

MCP

Objetos de sistema

Webhooks e eventos

SDKs

Chargefy for Platforms

​Chargefy for Platforms

Chargefy for Platforms