Movimientos de tarjetas de regalo

Movimientos de las tarjetas: emisión, canje, devolución a la tarjeta, ajuste, anulación y bloqueo. Solo se agregan.

Cargando el índice de búsqueda…

Movimientos de tarjetas de regalo

Objetos

GiftCardTransaction

  • idintegerobligatorio

    ID del registro, único entre los registros de su tipo en la tienda.

  • gift_card_idintegerobligatorio

    ID de la tarjeta de regalo (/v1/gift-cards).

  • typestringobligatorio

    Tipo de movimiento: issue — emisión; redeem — pago con la tarjeta; refund — devolución de una compra a la tarjeta; adjust — ajuste manual; void — anulación (se devolvió la tarjeta o no se pagó); block y unblock — bloqueo y su levantamiento, sin importe; transfer_out y transfer_in — traspaso de saldo al reemitir, de la tarjeta vieja a la nueva.

    Valores:
    issueredeemrefundadjustvoidblockunblocktransfer_outtransfer_in
  • amountintegerobligatorio

    Importe con signo en unidades mínimas de la moneda: positivo — la deuda creció, negativo — bajó, 0 — bloqueo y su levantamiento.

  • balance_afterintegerobligatorio

    Saldo de la tarjeta después de este movimiento.

  • currencystringobligatorio

    Moneda de los importes, código ISO 4217: la moneda de la tienda.

    Valores:
    ARSUSDBRLCLPCOPMXNPENRUB
  • order_idinteger o nullobligatorio

    ID del pedido.

  • payment_idinteger o nullobligatorio

    ID del pago (/v1/payments): pago con el medio gift_card o el pago de la venta de la tarjeta; null si no hay pago.

  • refund_idinteger o nullobligatorio

    ID de la devolución (/v1/refunds) que devolvió dinero a la tarjeta o por la tarjeta misma; null si no hay devolución.

  • notestring o nullobligatorio

    Motivo del ajuste o nota del personal; null si no hay.

  • created_atstring (date-time)obligatorio

    Cuándo se creó el registro.

Endpoints

Movimientos de tarjetas de regalo: emisión, canje, devolución a la tarjeta, ajuste, anulación, bloqueo y traspaso de saldo

get/gift-card-transactions

Scope: finance:read

Parámetros

Query

  • limitinteger

    Tamaño de página: hasta 250 registros; 50 por defecto.

    Mínimo:
    1
    Máximo:
    250
  • cursorstring

    Cursor opaco: next_cursor de la página anterior, o sync_cursor de la última página guardado por la sincronización anterior. El listado va en orden de confirmación, así que el cursor de sincronización devuelve luego solo lo que cambió después de él.

    Largo máximo:
    4096
  • updated_sincestring (date-time)

    Solo los registros cambiados después de este momento, ISO 8601 con zona horaria. Un filtro de la primera sincronización; después se sigue con el cursor.

    Patrón:
    ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,6})?(Z|[+-]\d{2}:\d{2})$
  • gift_card_idinteger

    Solo los movimientos de esta tarjeta de regalo.

    Mínimo:
    1
  • payment_idinteger

    Solo los movimientos de este pago.

    Mínimo:
    1

Respuestas

200Éxito

application/json

  • dataarray de GiftCardTransactionobligatorio

    Registros de la página.

  • deletedarray de objectobligatorio

    Registros borrados de la base desde el cursor, como marcas de eliminación: solo con include_deleted=true en la continuación por el cursor de sincronización.

    Campos · 2
    • idintegerobligatorio

      ID del registro borrado.

    • deleted_atstring (date-time)obligatorio

      Cuándo se borró el registro.

  • next_cursorstring o nullobligatorio

    Cursor de la página siguiente; null en la última.

  • has_morebooleanobligatorio

    true si hay una página siguiente.

  • sync_cursorstring o nullobligatorio

    En la última página — el cursor desde el que continuar más tarde: con él llega solo lo que cambió después de esta página. null en las demás.

401Falta el token, es inválido, venció o fue revocado

Encabezados

  • WWW-Authenticatestringobligatorio

    Esquema de autenticación (RFC 6750).

    Ejemplo:
    Bearer

application/problem+json

Devuelve Problem

403El plan, la dirección IP o los scopes del token no permiten la solicitud

Encabezados

  • WWW-Authenticatestring

    Esquema de autenticación (RFC 6750).

    Ejemplo:
    Bearer error="insufficient_scope", scope="locations:read"

application/problem+json

Devuelve ForbiddenProblem

410El cursor de sincronización supera el plazo de conservación de eliminaciones o se emitió antes de restaurar la base de datos

application/problem+json

Devuelve Problem

422Un parámetro es inválido o desconocido

application/problem+json

Devuelve ValidationProblem

429Se agotó el límite de solicitudes

Encabezados

  • Retry-Afterintegerobligatorio

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve RateLimitProblem

503La tienda no está disponible por ahora

Encabezados

  • Retry-Afterinteger

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve Problem

Errores de este endpoint

Los errores comunes, como token, acceso, validación de la entrada y límite de solicitudes, pueden venir de cualquier endpoint; están en el catálogo: Errores

Ejemplo de solicitud
curl "https://api.saleya.app/v1/gift-card-transactions" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Ejemplo de respuesta · 200
{
  "data": [
    {
      "id": 0,
      "gift_card_id": 0,
      "type": "issue",
      "amount": 0,
      "balance_after": 0,
      "currency": "ARS",
      "order_id": 0,
      "payment_id": 0,
      "refund_id": 0,
      "note": "string",
      "created_at": "2026-01-15T12:00:00Z"
    }
  ],
  "deleted": [
    {
      "id": 0,
      "deleted_at": "2026-01-15T12:00:00Z"
    }
  ],
  "next_cursor": "string",
  "has_more": true,
  "sync_cursor": "string"
}

Movimiento de la tarjeta de regalo

get/gift-card-transactions/{entry}

Scope: finance:read

Parámetros

Ruta

  • entryintegerobligatorio

    ID del movimiento de la tarjeta de regalo.

Respuestas

200Éxito

application/json

Devuelve GiftCardTransaction

401Falta el token, es inválido, venció o fue revocado

Encabezados

  • WWW-Authenticatestringobligatorio

    Esquema de autenticación (RFC 6750).

    Ejemplo:
    Bearer

application/problem+json

Devuelve Problem

403El plan, la dirección IP o los scopes del token no permiten la solicitud

Encabezados

  • WWW-Authenticatestring

    Esquema de autenticación (RFC 6750).

    Ejemplo:
    Bearer error="insufficient_scope", scope="locations:read"

application/problem+json

Devuelve ForbiddenProblem

404El objeto no existe o no está disponible para la aplicación

application/problem+json

Devuelve Problem

422Un parámetro es inválido o desconocido

application/problem+json

Devuelve ValidationProblem

429Se agotó el límite de solicitudes

Encabezados

  • Retry-Afterintegerobligatorio

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve RateLimitProblem

503La tienda no está disponible por ahora

Encabezados

  • Retry-Afterinteger

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve Problem

Los errores comunes, como token, acceso, validación de la entrada y límite de solicitudes, pueden venir de cualquier endpoint; están en el catálogo: Errores

Ejemplo de solicitud
curl "https://api.saleya.app/v1/gift-card-transactions/{entry}" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Ejemplo de respuesta · 200
{
  "id": 0,
  "gift_card_id": 0,
  "type": "issue",
  "amount": 0,
  "balance_after": 0,
  "currency": "ARS",
  "order_id": 0,
  "payment_id": 0,
  "refund_id": 0,
  "note": "string",
  "created_at": "2026-01-15T12:00:00Z"
}