Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.chargefy.io/llms.txt

Use this file to discover all available pages before exploring further.

Retorna o estado atual do hosted flow, incluindo o result quando o cadastro já foi submetido.

​
Autenticação

Requer API key de plataforma com escopo administrativo via header Authorization: Bearer.

​
Query Params

​
id
string
required
ID do hosted flow (hf_*).

​
Resposta

​
id
string
ID do hosted flow.
​
platform_id
string
ID da plataforma.
​
organization_id
string
ID da sub-organização vinculada.
​
status
string
Estado atual do flow.
​
taxpayer_id
string
CPF/CNPJ normalizado.
​
return_url
string
URL de retorno configurada.
​
external_reference
string | null
Referência externa recebida na criação.
​
metadata
object
Metadados recebidos na criação.
​
result
object | null
Snapshot final, preenchido após FINISHED.
​
seller_activation_status
string | null
Status financeiro mais recente do seller.
​
organization
object | null
Resumo da sub-organização.

​
Exemplo

cURL
curl -X GET "https://api.chargefy.io/v1/hosted-flow-retrieve?id=hf_abc123" \
  -H "Authorization: Bearer $CHARGEFY_PLATFORM_API_KEY"
Response
{
  "id": "hf_abc123",
  "platform_id": "plat_abc",
  "organization_id": "org_seller_new",
  "type": "onboarding",
  "status": "FINISHED",
  "taxpayer_id": "12345678000190",
  "taxpayer_type": "business",
  "return_url": "https://example.com/onboarding/return",
  "error_url": null,
  "external_reference": "seller_123",
  "metadata": {
    "workspace_id": "ws_789"
  },
  "result": {
    "organization_id": "org_seller_new",
    "seller_activation_status": "pending",
    "bank_account": {
      "holder_name": "Acme Ltda",
      "bank_code": "260",
      "bank_name": "Nu Pagamentos S.A.",
      "routing_number": "0001",
      "account_number_last4": "5678",
      "type": "checking"
    }
  },
  "seller_activation_status": "pending",
  "organization": {
    "id": "org_seller_new",
    "name": "Acme Ltda"
  }
}