Entrar

Cancelar card

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

Cancela um card. O card sai de circulacao na hora: deixa de contar como saldo, deixa de ser resgatavel e passa a ser lido como canceled em todo lugar.

O card nao tem coluna de status - canceled e derivado da data de cancelamento, entao este endpoint e o que significa "mudar o status do card para cancelado".

Cancelar card e mudanca de estado, nao movimento de dinheiro: o saldo nao e debitado nem devolvido, e nenhuma linha entra no ledger de flow do card. O card apenas sai de todas as consultas de saldo. Escolha a operacao pela intencao:

  • o card inteiro deve deixar de existir para o cliente - este endpoint;
  • o valor deve sair de um card que continua vivo - Ajustar saldo do card (manual_debit, registrado no ledger);
  • a compra foi revertida e o cashback dela tem que ir junto - cancele a transacao, nao o card.

Reversivel pelo Reativar card.

Card com reserva de resgate aberta e recusado com 409: o valor reservado ja foi debitado e espera liquidacao ou devolucao, entao cancelar o card deixaria esse valor preso. Resolva a reserva primeiro.

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.

Parâmetros do caminho

Name Type Description
id * integer Card id, as returned by the card endpoints.

Respostas

{
    "cardId": 95980,
    "canceledAt": "2026-11-09T14:32:05-03:00",
    "cardStatus": "canceled",
    "amount": 1250
}

Relacionados

Copied to clipboard