Encerrar parceria

curl -X DELETE "https://api.chargefy.io/v1/affiliations/aff_7Dk9mQ2vX5rT8pWN" \
  -H "Authorization: Bearer {{API_KEY}}"

{
  "id": "aff_7Dk9mQ2vX5rT8pWN",
  "object": "affiliation",
  "affiliate_organization": "org_5Nq8rT2wX7mK4pV9",
  "created_at": "2026-10-26T12:00:00Z",
  "ended_at": "2026-10-26T13:00:00Z",
  "ended_by_organization": "org_7Dk9mQ2vX5rT8pWN",
  "livemode": true,
  "metadata": {},
  "organization": "org_7Dk9mQ2vX5rT8pWN",
  "source": "platform",
  "status": "ended",
  "updated_at": "2026-10-26T13:00:00Z"
}

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

{
  "error": {
    "code": "resource_missing",
    "message": "Affiliation not found.",
    "type": "invalid_request_error"
  }
}

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

string

obrigatório

ID da parceria (aff_*).

O encerramento impede incluir a parceria em vendas novas. Vendas já realizadas permanecem no histórico. Qualquer lado pode encerrar; repetir o pedido preserva a data do primeiro encerramento. A operação exige uma chave do modo real.

curl -X DELETE "https://api.chargefy.io/v1/affiliations/aff_7Dk9mQ2vX5rT8pWN" \
  -H "Authorization: Bearer {{API_KEY}}"

{
  "id": "aff_7Dk9mQ2vX5rT8pWN",
  "object": "affiliation",
  "affiliate_organization": "org_5Nq8rT2wX7mK4pV9",
  "created_at": "2026-10-26T12:00:00Z",
  "ended_at": "2026-10-26T13:00:00Z",
  "ended_by_organization": "org_7Dk9mQ2vX5rT8pWN",
  "livemode": true,
  "metadata": {},
  "organization": "org_7Dk9mQ2vX5rT8pWN",
  "source": "platform",
  "status": "ended",
  "updated_at": "2026-10-26T13:00:00Z"
}

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

{
  "error": {
    "code": "resource_missing",
    "message": "Affiliation not found.",
    "type": "invalid_request_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 DELETE "https://api.chargefy.io/v1/affiliations/aff_7Dk9mQ2vX5rT8pWN" \
  -H "Authorization: Bearer {{PLATFORM_API_KEY}}" \
  -H "Organization: org_7Dk9mQ2vX5rT8pWN"

curl -X DELETE "https://api.chargefy.io/v1/affiliations/aff_7Dk9mQ2vX5rT8pWN" \
  -H "Authorization: Bearer {{API_KEY}}"

{
  "id": "aff_7Dk9mQ2vX5rT8pWN",
  "object": "affiliation",
  "affiliate_organization": "org_5Nq8rT2wX7mK4pV9",
  "created_at": "2026-10-26T12:00:00Z",
  "ended_at": "2026-10-26T13:00:00Z",
  "ended_by_organization": "org_7Dk9mQ2vX5rT8pWN",
  "livemode": true,
  "metadata": {},
  "organization": "org_7Dk9mQ2vX5rT8pWN",
  "source": "platform",
  "status": "ended",
  "updated_at": "2026-10-26T13:00:00Z"
}

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

{
  "error": {
    "code": "resource_missing",
    "message": "Affiliation not found.",
    "type": "invalid_request_error"
  }
}

Fundamentos da API

MCP

Objetos de sistema

Webhooks e eventos

SDKs

Encerrar parceria

Chargefy for Platforms

​Chargefy for Platforms

Chargefy for Platforms