Tarjetas de regalo

Las tarjetas de regalo de la tienda: valor nominal, saldo y deuda de la tienda por cada una. El código no se guarda ni se devuelve.

Cargando el índice de búsqueda…

Tarjetas de regalo

Objetos

GiftCard

  • idintegerobligatorio

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

  • last4stringobligatorio

    Los últimos cuatro caracteres del código de la tarjeta: con ellos se la reconoce en manos del cliente. El código no se guarda.

  • statusstringobligatorio

    Estado: pending_payment — vendida con un medio que no es efectivo, pago aún sin confirmar; disabled — bloqueada (perdida, disputa), la deuda se mantiene; deactivated — anulada, saldo cancelado. Con el cuarto valor la tarjeta está vigente: se acepta como pago si le queda saldo y no venció.

    Valores:
    activepending_paymentdisableddeactivated
  • currencystringobligatorio

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

    Valores:
    ARSUSDBRLCLPCOPMXNPENRUB
  • initial_amountintegerobligatorio

    Valor nominal al emitirla, en unidades mínimas de la moneda.

  • balanceintegerobligatorio

    Saldo de la tarjeta en unidades mínimas de la moneda: la suma de sus movimientos (/v1/gift-card-transactions).

  • outstandingintegerobligatorio

    La deuda de la tienda por la tarjeta: el saldo, salvo en una tarjeta sin pagar (pending_payment), por la que no entró dinero. Una tarjeta bloqueada o vencida mantiene su deuda.

  • expires_atstring (date-time) o nullobligatorio

    Fin de la vigencia; null si no vence. Una tarjeta vencida no se acepta como pago.

  • issued_atstring (date-time)obligatorio

    Cuándo se emitió la tarjeta.

  • issued_order_idinteger o nullobligatorio

    ID del pedido (/v1/orders) con el que se vendió la tarjeta; null si se emitió sin venta (compensación, promo).

  • reissued_from_idinteger o nullobligatorio

    ID de la tarjeta cuyo saldo se traspasó acá al reemitirla; null en una emisión común.

  • customer_idinteger o null

    ID del cliente titular (/v1/customers); null si es al portador. Solo con acceso a clientes.

  • notestring o nullobligatorio

    Nota del personal al emitirla; null si no hay.

  • created_atstring (date-time)obligatorio

    Cuándo se creó el registro.

  • updated_atstring (date-time)obligatorio

    Cuándo cambió el registro por última vez.

Endpoints

Tarjetas de regalo: valor nominal, saldo y deuda de la tienda por cada tarjeta

get/gift-cards

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})$

Respuestas

200Éxito

application/json

  • dataarray de GiftCardobligatorio

    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-cards" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Ejemplo de respuesta · 200
{
  "data": [
    {
      "id": 0,
      "last4": "string",
      "status": "active",
      "currency": "ARS",
      "initial_amount": 0,
      "balance": 0,
      "outstanding": 0,
      "expires_at": "2026-01-15T12:00:00Z",
      "issued_at": "2026-01-15T12:00:00Z",
      "issued_order_id": 0,
      "reissued_from_id": 0,
      "customer_id": 0,
      "note": "string",
      "created_at": "2026-01-15T12:00:00Z",
      "updated_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"
}

Tarjeta de regalo

get/gift-cards/{card}

Scope: finance:read

Parámetros

Ruta

  • cardintegerobligatorio

    ID de la tarjeta de regalo.

Respuestas

200Éxito

application/json

Devuelve GiftCard

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-cards/{card}" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Ejemplo de respuesta · 200
{
  "id": 0,
  "last4": "string",
  "status": "active",
  "currency": "ARS",
  "initial_amount": 0,
  "balance": 0,
  "outstanding": 0,
  "expires_at": "2026-01-15T12:00:00Z",
  "issued_at": "2026-01-15T12:00:00Z",
  "issued_order_id": 0,
  "reissued_from_id": 0,
  "customer_id": 0,
  "note": "string",
  "created_at": "2026-01-15T12:00:00Z",
  "updated_at": "2026-01-15T12:00:00Z"
}