Entrar

Cancelar cards em lote

POST https://{organization}.myguper.com/api/loyalty/cards/cancel

Cancela ate 100 cards numa chamada. Valem as mesmas regras do Cancelar card - o card sai de circulacao, deixa de contar como saldo e passa a ser lido como canceled, sem mover dinheiro e sem gravar linha no ledger de flow.

Falha parcial e normal, nao e erro. Num lote de 100 e esperado que alguns cards ja estejam cancelados, um nao exista e outro tenha reserva de resgate aberta. A resposta e 200 com o desfecho de cada item; o 400 fica para pedido malformado (sem ids, acima do teto, id nao numerico).

Desfechos possiveis por item:

outcome Significado
canceled O card foi cancelado por esta chamada
already_canceled Ja estava cancelado - nada foi feito, vem o canceledAt
has_open_reservation Recusado: ha valor reservado esperando liquidacao ou devolucao (reservedTotal, em centavos)
not_found Nao existe card com esse id na organizacao

Rode antes com dryRun. Ele devolve exatamente o que aconteceria item a item mais o amountRemoved - quanto saldo sairia de circulacao - sem escrever nada.

Como dizer quais cards: ; separa itens e : faz faixa fechada - 1512200:1512299;1512305 quer dizer "do 1512200 ao 1512299, mais o 1512305". E a mesma gramatica das collections do catalog. Um array de ids tambem e aceito. O teto de 100 vale para o conjunto expandido: 1:1000 e recusado, nao truncado.

A faixa nunca atravessa organizacoes: id que pertence a outra conta volta not_found e fica intocado - todas as consultas aqui sao escopadas por organizacao, e not_found e tambem a resposta certa para a chamada nao servir de sonda sobre card de outra conta.

Id repetido na mesma chamada e processado uma vez so. Guarde o batchId da resposta: e ele que amarra os cards de uma mesma operacao.

Try-it values populated from environment ACME (Demo)


Autenticação

Token

Send your user token in the x-guper-authorization header. Endpoints that support a Public mode (e.g. acúmulo and resgate previews) accept the same request without the header — Private mode adds customer data and a confirmation token to the response.

Cabeçalhos

Name Type Description
x-guper-authorization * string User token issued by Guper. Omit only on endpoints that explicitly support a Public mode.
Content-Type * string Always `application/json` for endpoints that accept a JSON body.

Corpo da requisição

Content-Type: application/json

{
    "ids": "1512200:1512299;1512305;1512310",
    "dryRun": false                                             // optional
}

Respostas

{
    "batchId": "cb_6f2e91a4c3d1",
    "dryRun": false,
    "summary": {
        "requested": 4,
        "canceled": 1,
        "reactivated": 0,
        "already_canceled": 1,
        "not_canceled": 0,
        "has_open_reservation": 1,
        "not_found": 1,
        "amountRemoved": 31200
    },
    "results": [
        { "id": 1512200, "outcome": "canceled", "amount": 31200 },
        { "id": 1512201, "outcome": "already_canceled", "canceledAt": "2026-11-09T18:02:11-03:00" },
        { "id": 1512207, "outcome": "has_open_reservation", "reservedTotal": 5000 },
        { "id": 9999999, "outcome": "not_found" }
    ]
}

Relacionados

Copied to clipboard