Ambiente de simulação — nenhuma cobrança real. Os pagamentos, Pix e cartões deste sandbox são sintéticos.
W Wolf Sandbox Docs Criar conta
Navegação

Referência da API

Organizations

Organizações do usuário autenticado (sessão do app do seller).

get/v1/me/organizations

Listar minhas organizações (listMyOrganizations)

Organizações do usuário da sessão. Com mais de uma, envie wolf-organization-id nas demais rotas.

rate limit: api_authenticated
  • Autenticação: sessão do app do seller
  • URL: https://api.v2.wolfpayteste.online/v1/me/organizations

Resposta 200

Organizações.

Resposta 200 de listMyOrganizations
Campo Tipo Detalhes
data obrigatório Organization[]
Exemplo de resposta 200 json
{
  "data": [
    {
      "id": "org_6a5b4c3d2e1f00918273645546372819",
      "seller_id": "sel_8f7e6d5c4b3a29180716253443526170",
      "legal_name": "Estúdio Exemplo Ltda",
      "display_name": "Estúdio Exemplo",
      "status": "active",
      "role": "OWNER",
      "capabilities": [
        "payments:read",
        "payments:write",
        "refunds:write",
        "offers:read",
        "offers:write",
        "organization:close",
        "organization:settings"
      ],
      "timezone": "America/Sao_Paulo"
    }
  ]
}

Erros

get/v1/organization/closure-request

Consultar pedido de encerramento (getOrganizationClosureRequest)

Pedido de encerramento da organização atual, ou data: null se não houver.

rate limit: api_authenticated
  • Autenticação: sessão do app do seller
  • URL: https://api.v2.wolfpayteste.online/v1/organization/closure-request

Parâmetros

NomeOndeTipoDetalhes
wolf-organization-id cabeçalho string

Só para sessão do app do seller com mais de uma organização (senão 409 TENANT_SELECTION_REQUIRED). Ignorado para API keys.

Padrão ^org_

Resposta 200

Pedido atual (ou null).

Resposta 200 de getOrganizationClosureRequest
Campo Tipo Detalhes
data obrigatório OrganizationClosureRequest | null
Exemplo de resposta 200 json
{
  "data": {
    "id": "ocr_2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a",
    "organization_id": "org_6a5b4c3d2e1f00918273645546372819",
    "reason": "Encerrando a operação de testes.",
    "requested_at": "2026-11-06T12:00:00.000Z"
  }
}

Erros

post/v1/organization/closure-request

Pedir o encerramento da organização (requestOrganizationClosure)

Só o OWNER, pela sessão do app. Registra o pedido para a operação da Wolf (nada é apagado; o ledger fica intacto). Repetir devolve o pedido existente com 200.

rate limit: api_authenticated
  • Autenticação: sessão do app do seller
  • URL: https://api.v2.wolfpayteste.online/v1/organization/closure-request

Parâmetros

NomeOndeTipoDetalhes
wolf-organization-id cabeçalho string

Só para sessão do app do seller com mais de uma organização (senão 409 TENANT_SELECTION_REQUIRED). Ignorado para API keys.

Padrão ^org_

Corpo da requisição (opcional)

Objeto CreateOrganizationClosureRequest

Corpo de requestOrganizationClosure
Campo Tipo Detalhes
reason string

1 a 500 caracteres

Exemplo de corpo json
{
  "reason": "Encerrando a operação de testes."
}

Resposta 200

Já existia um pedido; ele é devolvido sem mudança.

Objeto OrganizationClosureRequest

Resposta 200 de requestOrganizationClosure
Campo Tipo Detalhes
id obrigatório string

Começa com ocr_

organization_id obrigatório string

Começa com org_

reason obrigatório string | null
requested_at obrigatório string
Exemplo de resposta 200 json
{
  "id": "ocr_2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a",
  "organization_id": "org_6a5b4c3d2e1f00918273645546372819",
  "reason": "Encerrando a operação de testes.",
  "requested_at": "2026-11-06T12:00:00.000Z"
}

Resposta 201

Pedido registrado.

Objeto OrganizationClosureRequest

Resposta 201 de requestOrganizationClosure
Campo Tipo Detalhes
id obrigatório string

Começa com ocr_

organization_id obrigatório string

Começa com org_

reason obrigatório string | null
requested_at obrigatório string
Exemplo de resposta 201 json
{
  "id": "ocr_2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a",
  "organization_id": "org_6a5b4c3d2e1f00918273645546372819",
  "reason": "Encerrando a operação de testes.",
  "requested_at": "2026-11-06T12:00:00.000Z"
}

Erros

post/v1/organizations

Criar organização (createOrganization)

Cria a organização do usuário da sessão. display_name é o nome público do checkout (2 a 80 caracteres; padrão: legal_name). Na edição de simulação, com a aprovação automática ligada, a organização já nasce ativa.

rate limit: api_authenticated
  • Autenticação: sessão do app do seller
  • URL: https://api.v2.wolfpayteste.online/v1/organizations

Corpo da requisição

Objeto CreateOrganizationRequest

Corpo de createOrganization
Campo Tipo Detalhes
legal_name obrigatório string

2 a 160 caracteres

display_name string

2 a 80 caracteres

Exemplo de corpo json
{
  "legal_name": "Estúdio Exemplo Ltda",
  "display_name": "Estúdio Exemplo"
}

Resposta 201

Organização criada.

Objeto Organization

Resposta 201 de createOrganization
Campo Tipo Detalhes
id obrigatório string

Começa com org_

seller_id obrigatório string

Começa com sel_

legal_name obrigatório string
display_name obrigatório string
status obrigatório string
role obrigatório string
capabilities obrigatório string[]
timezone obrigatório string

Valores: America/Sao_Paulo, America/Araguaina, America/Bahia, America/Belem, America/Boa_Vista, America/Campo_Grande, America/Cuiaba, America/Eirunepe, America/Fortaleza, America/Maceio, America/Manaus, America/Noronha, America/Porto_Velho, America/Recife, America/Rio_Branco, America/Santarem, UTC

Exemplo de resposta 201 json
{
  "id": "org_6a5b4c3d2e1f00918273645546372819",
  "seller_id": "sel_8f7e6d5c4b3a29180716253443526170",
  "legal_name": "Estúdio Exemplo Ltda",
  "display_name": "Estúdio Exemplo",
  "status": "review",
  "role": "OWNER",
  "capabilities": [
    "payments:read",
    "payments:write",
    "refunds:write",
    "offers:read",
    "offers:write",
    "organization:close",
    "organization:settings"
  ],
  "timezone": "America/Sao_Paulo"
}

Erros

patch/v1/organizations/current

Atualizar a organização atual (updateCurrentOrganization)

Muda o fuso da organização (timezone), usado por todos os períodos do painel ("hoje" começa à meia-noite local). Só OWNER ou ADMIN, pela sessão do app. Auditado como organization.timezone_changed quando o valor muda; repetir o mesmo valor não muda nada. Repetir a requisição com a mesma Idempotency-Key e o mesmo corpo devolve a mesma resposta com idempotent-replayed: true; corpo diferente → 409 IDEMPOTENCY_CONFLICT.

Idempotency-Key obrigatória rate limit: api_authenticated
  • Autenticação: sessão do app do seller
  • URL: https://api.v2.wolfpayteste.online/v1/organizations/current

Parâmetros

NomeOndeTipoDetalhes
Idempotency-Keyobrigatório cabeçalho string

Chave escolhida pelo cliente (8 a 255 caracteres). Mesma chave + mesmo corpo = mesma resposta; corpo diferente = 409 IDEMPOTENCY_CONFLICT. Guardada por 24 h.

8 a 255 caracteres

wolf-organization-id cabeçalho string

Só para sessão do app do seller com mais de uma organização (senão 409 TENANT_SELECTION_REQUIRED). Ignorado para API keys.

Padrão ^org_

Corpo da requisição

Objeto UpdateCurrentOrganizationRequest

Corpo de updateCurrentOrganization
Campo Tipo Detalhes
timezone obrigatório string

Valores: America/Sao_Paulo, America/Araguaina, America/Bahia, America/Belem, America/Boa_Vista, America/Campo_Grande, America/Cuiaba, America/Eirunepe, America/Fortaleza, America/Maceio, America/Manaus, America/Noronha, America/Porto_Velho, America/Recife, America/Rio_Branco, America/Santarem, UTC

Exemplo de corpo json
{
  "timezone": "America/Manaus"
}

Resposta 200

Organização atualizada.

Objeto Organization

Resposta 200 de updateCurrentOrganization
Campo Tipo Detalhes
id obrigatório string

Começa com org_

seller_id obrigatório string

Começa com sel_

legal_name obrigatório string
display_name obrigatório string
status obrigatório string
role obrigatório string
capabilities obrigatório string[]
timezone obrigatório string

Valores: America/Sao_Paulo, America/Araguaina, America/Bahia, America/Belem, America/Boa_Vista, America/Campo_Grande, America/Cuiaba, America/Eirunepe, America/Fortaleza, America/Maceio, America/Manaus, America/Noronha, America/Porto_Velho, America/Recife, America/Rio_Branco, America/Santarem, UTC

Exemplo de resposta 200 json
{
  "id": "org_6a5b4c3d2e1f00918273645546372819",
  "seller_id": "sel_8f7e6d5c4b3a29180716253443526170",
  "legal_name": "Estúdio Exemplo Ltda",
  "display_name": "Estúdio Exemplo",
  "status": "active",
  "role": "OWNER",
  "capabilities": [
    "payments:read",
    "payments:write",
    "refunds:write",
    "offers:read",
    "offers:write",
    "organization:close",
    "organization:settings"
  ],
  "timezone": "America/Manaus"
}

Erros