Tarjeta de regalo canjeada | Documentación API de Recurrente

{
  "event_type": "gift_card.redeem",
  "id": "gc_ab12cd34",
  "api_version": "2024-04-24",
  "transaction": {
    "id": "gct_ab12cd34",
    "kind": "redeem",
    "amount_in_cents": -10000,
    "balance_after_in_cents": 15000,
    "currency": "GTQ",
    "account_id": "ac_ab12cd34",
    "created_at": "2026-10-07T16:00:00Z"
  },
  "account_id": "ac_ab12cd34",
  "code": "GC-2BCD-FG3H",
  "status": "active",
  "currency": "GTQ",
  "initial_amount_in_cents": 25000,
  "balance_in_cents": 15000,
  "recipient": {
    "name": "Ana López",
    "email": "ana@example.com"
  },
  "message": "¡Feliz cumpleaños!",
  "delivered_at": "2026-10-07T15:00:00Z",
  "purchaser": {
    "name": "Lucía Pérez",
    "email": "lucia@example.com"
  },
  "checkout_id": "ch_ab12cd34",
  "public_url": "https://app.recurrente.com/s/mi-negocio/regalo/GC-2BCD-FG3H",
  "transactions": [],
  "created_at": "2026-10-07T15:00:00Z"
}

Se emite cuando la tarjeta paga parte o todo de un checkout, o un canje en mostrador (POST /gift_cards/{gift_card_id}/redemption). transaction.account_id es la sucursal que la tomó.

Payload

The payload of this webhook request is an object.

event_typestringRequiredformat: "^[a-z0-9_.-]+$"

Tipo exacto del evento enviado por Recurrente.

idstringRequired

api_versionstringRequired

transactionobjectRequired

Un movimiento del saldo de una tarjeta. amount_in_cents lleva signo (un canje es negativo).

connectedboolean or nullOptional

Presente como true cuando el evento proviene de una cuenta conectada.

account_idstring or nullOptional

La cuenta que la vendió.

codestringOptional

El código que se canjea. Es un secreto al portador.

statusenumOptional

Allowed values:

currencystringOptional

initial_amount_in_centsintegerOptional

balance_in_centsintegerOptional

expires_ondate or nullOptional

recipientobjectOptional

messagestring or nullOptional

deliver_ondate or nullOptional

delivered_atdatetime or nullOptional

purchaserobjectOptional

checkout_idstring or nullOptional

El checkout que la vendió.

public_urlstringOptional

La página de saldo de la tarjeta, la que abre su QR.

transactionslist of objectsOptional

Sus movimientos, del más viejo al más nuevo.

created_atdatetimeOptional

Response

200

Tu endpoint respondió exitosamente.