Criar parceria entre organizações filhas

curl -X POST "https://api.chargefy.io/v1/affiliations" \
  -H "Authorization: Bearer {{PLATFORM_API_KEY}}" \
  -H "Organization: org_7Dk9mQ2vX5rT8pWN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: criar-parceria-001" \
  -d '{"affiliate_organization":"org_5Nq8rT2wX7mK4pV9"}'

{
  "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"
}

{
  "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"
  }
}

{
  "error": {
    "code": "permission_denied",
    "message": "Access denied.",
    "type": "invalid_request_error"
  }
}

{
  "error": {
    "code": "affiliation_exists",
    "message": "The affiliation already exists.",
    "type": "invalid_request_error"
  }
}

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.

A criação direta está disponível somente para Chargefy for Platforms. A organização que integra sua própria operação pode consultar e encerrar suas parcerias, mas sua API key não cria parcerias sem aceite. As duas organizações precisam ser filhas ativas da mesma plataforma e ter documentos fiscais diferentes. A afiliada precisa ter cadastro financeiro aprovado. A plataforma responde pelo vínculo, que nasce sem convite e com source: "platform". Use uma chave do modo real com escopo platform_admin e envie o header Organization da organização dona do programa. A parceria é compartilhada entre os modos e não gera comissão de afiliado automaticamente.

string

obrigatório

ID da organização filha que será afiliada.

curl -X POST "https://api.chargefy.io/v1/affiliations" \
  -H "Authorization: Bearer {{PLATFORM_API_KEY}}" \
  -H "Organization: org_7Dk9mQ2vX5rT8pWN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: criar-parceria-001" \
  -d '{"affiliate_organization":"org_5Nq8rT2wX7mK4pV9"}'

{
  "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"
}

{
  "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"
  }
}

{
  "error": {
    "code": "permission_denied",
    "message": "Access denied.",
    "type": "invalid_request_error"
  }
}

{
  "error": {
    "code": "affiliation_exists",
    "message": "The affiliation already exists.",
    "type": "invalid_request_error"
  }
}

Erros de domínio

Código	Quando acontece	Como corrigir
`platform_required`	A chave pertence a uma organização comum	Use uma chave de Chargefy for Platforms
`permission_denied`	Uma das organizações não é filha ativa da plataforma	Confira a organização e o vínculo com a plataforma
`affiliate_activation_required`	O cadastro financeiro da afiliada não está aprovado	Conclua a ativação antes de criar a parceria
`affiliation_self`	As duas organizações são a mesma	Escolha outra organização
`affiliation_same_document`	Os documentos fiscais são iguais	Escolha uma organização com documento diferente
`affiliation_exists`	Já existe parceria ativa ou convite aceito aguardando ativação	Use a parceria existente ou encerre antes de criar outra
`livemode_required`	A chave é de teste	Use uma chave do modo real

Organizações com documentos diferentes podem formar parcerias mesmo quando uma é pessoa física e a outra é pessoa jurídica.

curl -X POST "https://api.chargefy.io/v1/affiliations" \
  -H "Authorization: Bearer {{PLATFORM_API_KEY}}" \
  -H "Organization: org_7Dk9mQ2vX5rT8pWN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: criar-parceria-001" \
  -d '{"affiliate_organization":"org_5Nq8rT2wX7mK4pV9"}'

{
  "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"
}

{
  "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"
  }
}

{
  "error": {
    "code": "permission_denied",
    "message": "Access denied.",
    "type": "invalid_request_error"
  }
}

{
  "error": {
    "code": "affiliation_exists",
    "message": "The affiliation already exists.",
    "type": "invalid_request_error"
  }
}

Fundamentos da API

MCP

Objetos de sistema

Webhooks e eventos

SDKs

Criar parceria entre organizações filhas

Erros de domínio

​Erros de domínio

Erros de domínio