Requisitos previos: un token de acceso Bearer con el alcance
CREATE_SHARE_LINK, y una cuenta con el envío de tarjetas virtuales alojadas habilitado. Si tu cuenta no está habilitada, la API devuelve un error de permisos que te dirige a tu representante de Fluz.Qué significa “alojado” / “bucle abierto”. Un enlace alojado apunta a una página de activación alojada por Fluz. Bucle abierto significa que el destinatario reclama una tarjeta virtual de red que puede usarse en comercios elegibles, sujeta a las reglas de tu programa.
Cómo funciona
- Tu plataforma llama a
generateVCShareLinkscon la oferta, el límite de la tarjeta, la cantidad, la fuente de fondos y el método de entrega. - Fluz crea una solicitud de compartido y una URL alojada por cada enlace solicitado.
- La entrega depende de
shareMethod:GENERATE_URL: Fluz devuelve las URLs alojadas en la respuesta de la API y tú las distribuyes por tu cuenta.EMAIL: Fluz envía por correo electrónico a cada destinatario su enlace.PHONE_NUMBER: Fluz envía por SMS a cada destinatario su enlace.
- El destinatario abre el enlace alojado, inicia sesión, completa la verificación y reclama la tarjeta.
- Fluz emite una tarjeta virtual de una sola carga al destinatario, financiada desde la cuenta del remitente.
Autenticación
Todas las operaciones de enlaces para compartir de Send Cards usan la API GraphQL de Fluz.CREATE_SHARE_LINK.
Operaciones
generateVCShareLinks
Creaquantity enlaces para compartir alojados.
Campos de entrada
Métodos de entrega
Reglas de validación
cardLimitdebe ser un número entero y cumplir el mínimo del programa.offerIddebe ser un UUID v4 válido para una oferta activa y compartible.quantitydebe ser un número entero.- Al usar
EMAILoPHONE_NUMBER, la longitud de la lista de destinatarios debe ser igual aquantity. userCashBalanceIddebe ser una cuenta de gasto válida propiedad de la cuenta del remitente.- No incluyas múltiples fuentes de fondos.
- Las solicitudes inválidas o mal formadas fallan la validación y no crean enlaces para compartir.
Ejemplo: generar URLs para tu propia entrega
Ejemplo: enviar enlaces por correo electrónico a destinatarios
Ejemplo: enviar enlaces por SMS a destinatarios
Respuesta
shareLinks es una URL alojada para una solicitud de compartido.
getVCShareLinks
UsagetVCShareLinks para listar enlaces generados, recuperar IDs de lote y de exhibición, inspeccionar objetivos de entrega y verificar el estado.
Campos de entrada
Para la primera consulta, filtra por
shareObjectStatuses. La respuesta incluye shareRequestBatchId y shareRequestDisplayId, que puedes usar para búsquedas posteriores o desactivación.
Ejemplos
Campos de respuesta
deactivateVCShareLinks
UsadeactivateVCShareLinks para vencer enlaces generados, por ejemplo si un lote se envió por error o si es necesario revocar un enlace no reclamado.
Campos de entrada
Ejemplo
Respuesta
Devuelve una cadena de confirmación, por ejemplo:Experiencia de activación del destinatario
Cuando un destinatario abre un enlace alojado, se le dirige a una página de activación alojada por Fluz.- El destinatario abre el enlace de tarjeta virtual alojado.
- El destinatario inicia sesión o crea una cuenta a través del flujo de autenticación de Fluz.
- Los usuarios existentes completan 2FA antes de ver o reclamar la tarjeta.
- Si el destinatario no tiene una dirección de facturación registrada, se le solicita agregar una. Se requiere una dirección de facturación para compras en línea.
- Si la tarjeta aún no ha sido emitida, el destinatario establece un NIP.
- Fluz emite la tarjeta virtual al destinatario.
- Una vez emitida, el destinatario puede ver los detalles y la actividad de la tarjeta.
Vencimiento y congelamiento de la tarjeta
daysUntilExpiration determina la ventana de validez del enlace alojado.
La fecha de vencimiento resultante se utiliza para dos comportamientos relacionados:
- Antes de reclamar: después de la fecha de vencimiento, el enlace ya no se puede reclamar.
- Después de reclamar: la fecha de vencimiento se convierte en la fecha de bloqueo/congelación de la tarjeta. Después de esa fecha, la tarjeta emitida se congela y ya no se puede gastar.
daysUntilExpiration, se usa el valor predeterminado del programa.
Reglas del programa
Las reglas del programa pueden variar por socio. Confirma los valores finales para tu programa con tu representante de Fluz.Referencia de estados
Errores comunes
Notas y limitaciones
- Esta API es solo para tarjetas virtuales alojadas. No se admiten enlaces de tarjetas de regalo alojadas.
- La API devuelve URLs de destino alojadas, no URLs cortas.
userCashBalanceIdes obligatorio en la práctica.- El tipo de objeto y el tipo de tarjeta están fijos para esta fase y no deben incluirse en solicitudes públicas de la API.
Próximos pasos
Visión general de Send Cards
La narrativa completa de la función — recorrido del destinatario, reglas del programa y referencia completa de errores.
Crear una orden masiva
Emite muchas tarjetas a la vez para distribución programática.