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.
Movimientos de tarjetas de regalo
Objetos
GiftCardTransaction
idintegerobligatorioID del registro, único entre los registros de su tipo en la tienda.
gift_card_idintegerobligatorioID de la tarjeta de regalo (/v1/gift-cards).
typestringobligatorioTipo 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
amountintegerobligatorioImporte con signo en unidades mínimas de la moneda: positivo — la deuda creció, negativo — bajó, 0 — bloqueo y su levantamiento.
balance_afterintegerobligatorioSaldo de la tarjeta después de este movimiento.
currencystringobligatorioMoneda de los importes, código ISO 4217: la moneda de la tienda.
- Valores:
ARSUSDBRLCLPCOPMXNPENRUB
order_idinteger o nullobligatorioID del pedido.
payment_idinteger o nullobligatorioID 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 nullobligatorioID 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 nullobligatorioMotivo del ajuste o nota del personal; null si no hay.
created_atstring (date-time)obligatorioCuá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
limitintegerTamaño de página: hasta 250 registros; 50 por defecto.
- Mínimo:
- 1
- Máximo:
- 250
cursorstringCursor 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_idintegerSolo los movimientos de esta tarjeta de regalo.
- Mínimo:
- 1
payment_idintegerSolo los movimientos de este pago.
- Mínimo:
- 1
Respuestas
200Éxito
application/json
Registros de la página.
deletedarray de objectobligatorioRegistros 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
idintegerobligatorioID del registro borrado.
deleted_atstring (date-time)obligatorioCuándo se borró el registro.
next_cursorstring o nullobligatorioCursor de la página siguiente; null en la última.
has_morebooleanobligatoriotrue si hay una página siguiente.
sync_cursorstring o nullobligatorioEn 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-AuthenticatestringobligatorioEsquema 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-AuthenticatestringEsquema 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-AfterintegerobligatorioSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve RateLimitProblem
503La tienda no está disponible por ahora
Encabezados
Retry-AfterintegerSegundos 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
curl "https://api.saleya.app/v1/gift-card-transactions" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"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
entryintegerobligatorioID 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-AuthenticatestringobligatorioEsquema 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-AuthenticatestringEsquema 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-AfterintegerobligatorioSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve RateLimitProblem
503La tienda no está disponible por ahora
Encabezados
Retry-AfterintegerSegundos 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
curl "https://api.saleya.app/v1/gift-card-transactions/{entry}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"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"
}