Entrar

Cancelar cards en lote

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

Cancela hasta 100 cards en una llamada. Valen las mismas reglas de Cancelar card: el card sale de circulacion, deja de contar como saldo y se lee como canceled, sin mover dinero y sin escribir linea en el ledger de flow.

La falla parcial es normal, no es error. En un lote de 100 se espera que algunos cards ya esten cancelados, que uno no exista y que otro tenga reserva de canje abierta. La respuesta es 200 con el desenlace de cada item; el 400 queda para la peticion mal formada (sin ids, arriba del tope, un id no numerico).

Desenlaces posibles por item:

outcome Significado
canceled El card fue cancelado por esta llamada
already_canceled Ya estaba cancelado - no se hizo nada, viene el canceledAt
has_open_reservation Rechazado: hay valor reservado esperando liquidacion o devolucion (reservedTotal, en centavos)
not_found No existe card con ese id en la organizacion

Ejecute antes con dryRun. Devuelve exactamente lo que pasaria item por item mas el amountRemoved - cuanto saldo saldria de circulacion - sin escribir nada.

Como indicar cuales cards: ; separa items y : arma un rango cerrado - 1512200:1512299;1512305 significa "del 1512200 al 1512299, mas el 1512305". Es la misma gramatica de las collections del catalog. Tambien se acepta un arreglo de ids. El tope de 100 aplica al conjunto expandido: 1:1000 se rechaza, no se trunca.

El rango nunca cruza organizaciones: un id que pertenece a otra cuenta vuelve not_found y queda intacto - todas las consultas aqui estan limitadas por organizacion, y not_found es tambien la respuesta correcta para que la llamada no sirva de sonda sobre cards ajenos.

Un id repetido en la misma llamada se procesa una sola vez. Guarde el batchId de la respuesta: es lo que amarra los cards de una misma operacion.

Try-it values populated from environment ACME (Demo)


Autenticación

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.

Encabezados

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.

Cuerpo de la petición

Content-Type: application/json

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

Respuestas

{
    "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