Pré-autorizações · Referência

Cancelar pré-autorização

Retira a oferta enquanto o fornecedor ainda não pediu a antecipação.

POST /api/integration/v1/pre-authorizations/{id}/cancel escopo preauth:write

Requisição

Parâmetro	Onde	Descrição
`id`	path	O `id` devolvido na criação (inteiro).

Sem corpo. Só a sua empresa, como tomadora, pode cancelar.

O que acontece

A operação vai para REPROVED, com stage: "PRE_AUTH" e motivo Cancelada via integração.
O evento pre_authorization.revoked é enviado aos webhooks.
Se a integração já tinha cancelado esta pré-autorização, nada muda e a resposta é a mesma.

Resposta

201 com a operação no mesmo formato da criação, agora com status: "REPROVED".

O 422 fica para quando não dá para cancelar, e o code diz por quê: o fornecedor já solicitou (PRE_AUTH_ALREADY_REQUESTED) ou ela terminou por outro motivo (PRE_AUTH_ALREADY_CLOSED). Nos dois casos, consulte a operação para ver o status.

Requisição

curl -X POST https://app.oneos.com.br/api/integration/v1/pre-authorizations/48213/cancel \
  -H "Authorization: Bearer $ONEOS_API_KEY"

const response = await fetch('https://app.oneos.com.br/api/integration/v1/pre-authorizations/48213/cancel', {
  method: 'POST',
  headers: { Authorization: `Bearer ${process.env.ONEOS_API_KEY}` },
})

// 201 também quando a integração já tinha cancelado: retentar é seguro
if (response.status === 422) {
  const [{ code }] = (await response.json()).errors
  // PRE_AUTH_ALREADY_REQUESTED: o fornecedor já solicitou
  // PRE_AUTH_ALREADY_CLOSED: encerrada por outro motivo (recusa, expiração…)
}

response = requests.post(
    "https://app.oneos.com.br/api/integration/v1/pre-authorizations/48213/cancel",
    headers={"Authorization": f"Bearer {os.environ['ONEOS_API_KEY']}"},
    timeout=30,
)

# 201 também quando a integração já tinha cancelado: retentar é seguro
if response.status_code == 422:
    code = response.json()["errors"][0]["code"]
    # PRE_AUTH_ALREADY_REQUESTED ou PRE_AUTH_ALREADY_CLOSED

<?php
$ch = curl_init('https://app.oneos.com.br/api/integration/v1/pre-authorizations/48213/cancel');
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('ONEOS_API_KEY')],
]);
$body = json_decode(curl_exec($ch), true);

201

{
  "id": 48213,
  "status": "REPROVED",
  "externalReference": "PED-4581",
  "payer": {
    "cnpj": "44555666000199",
    "name": "Construtora Exemplo LTDA"
  },
  "supplier": {
    "cnpj": "11222333000181",
    "name": "Fornecedor Exemplo ME"
  },
  "invoice": {
    "amount": 18400,
    "dueDate": "2026-11-30",
    "number": "48211",
    "withheldTaxAmount": 0
  },
  "expiresAt": "2026-09-19T02:59:59.000Z",
  "createdAt": "2026-09-15T13:00:00.000Z"
}

Erros

Status	Código	Quando acontece
400	`BAD_REQUEST`	O `id` não é um número.
403	`ANTICIPATION_NOT_PARTICIPANT`	A operação existe, mas a sua empresa não é a tomadora dela.
404	`ANTICIPATION_NOT_FOUND`	Não existe operação com esse `id` para a sua empresa.
409	`ANTICIPATION_INVALID_TRANSITION`	A operação mudou de estado durante a chamada. Repita: a resposta seguinte diz o estado final.
422	`PRE_AUTH_ALREADY_REQUESTED`	O fornecedor já solicitou a antecipação. A decisão agora é a aprovação, na plataforma.
422	`PRE_AUTH_ALREADY_CLOSED`	A pré-autorização já terminou por outro motivo: recusada pelo fornecedor, expirada, reprovada ou cancelada fora da integração (na plataforma, por exemplo).