Skip to main content
Cria um link permanente e reutilizável que permite a sub-organizações (OrgB, OrgC, OrgT) realizarem o onboarding através do embed da organização pai (OrgA).

​
Autenticação

Requer Organization Access Token (OAT) ou sessão de usuário via header Authorization: Bearer.

​
Corpo da Requisição

​
organization_id
string
ID da organização pai. Obrigatório quando autenticado via sessão de usuário (não necessário com OAT).
​
fee_percent
number
default:"0"
Percentual de taxa (0–100) que será aplicado às sub-organizações criadas por este link.
​
onboarding_options
object
Opções que configuram o comportamento do fluxo de onboarding.

​
Resposta

​
id
string
ID único do link criado (UUID)
​
token
string
Token público reutilizável para uso no embed
​
parent_organization_id
string
ID da organização pai
​
fee_percent
number
Percentual de taxa configurado
​
onboarding_options
object
Opções de onboarding salvas
​
created_at
string
Data de criação (ISO 8601)

​
Exemplo

curl -X POST "https://api.chargefy.io/api/v1/onboarding-links/" \
  -H "Authorization: Bearer $CHARGEFY_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "fee_percent": 5,
    "onboarding_options": {
      "send_invite": true
    }
  }'

​
Resposta de Exemplo

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "token": "obl_abc123xyz",
  "parent_organization_id": "org_abc123",
  "fee_percent": 5,
  "onboarding_options": {
    "send_invite": true
  },
  "created_at": "2026-03-20T10:00:00Z"
}