Skip to main content
Cada regla establece una tasa, una ventana de elegibilidad y filtros de comercio opcionales, y puede limitarse a una sola subcuenta. Usa la API de Cashback Rules para crear, actualizar y listar las reglas que financia tu plataforma, y luego pagar el cashback bajo demanda desde tu saldo disponible en USD.

Endpoints

Pagar cashback

Envía un objeto vacío a POST /cashback_rules/payout para distribuir todo el cashback elegible. Establece cashback_rule_id para distribuir una regla, account_id para pagar a una subcuenta o transaction_id para pagar una transacción de tarjeta. Si hay varios filtros, todos deben coincidir.
Usa un encabezado Idempotency-Key al solicitar un pago. Una respuesta 202 con status: "processing" confirma que el procesamiento se puso en cola y repite los filtros proporcionados. Una respuesta 200 con status: "failed" significa que la cola rechazó la solicitud. Estos estados describen la programación, no la finalización del pago. Los trabajos de transacciones reintentan los fallos automáticamente. Añade USD a la billetera de financiación si no tiene fondos suficientes. Las solicitudes repetidas omiten los pagos ya registrados, y la idempotencia del libro contable evita créditos duplicados. Respuesta:

Atributos

string
requerido
ID de la regla de cashback, con el prefijo cicbr_.
string
requerido
Cuándo se creó la regla, como marca de tiempo ISO 8601.
string | null
requerido
Descripción opcional de la regla de cashback.
string | null
requerido
Cuándo se descartó la regla, como marca de tiempo ISO 8601. Null significa que no se ha descartado.
string | null
requerido
Fin exclusivo de la ventana de elegibilidad, como marca de tiempo ISO 8601. Null significa que no vence.
string
requerido
Cuenta de plataforma designada para financiar el cashback, con el prefijo biz_. Se deriva de la credencial autenticada.
string | null
requerido
Código de categoría de comercio (MCC) de cuatro dígitos. Null coincide con cualquier MCC. Cuando ambos filtros de comercio son null, scoped_account_id es obligatorio.
string | null
requerido
Nombre de comercio sin procesar informado por el proveedor de la tarjeta. Null coincide con cualquier nombre de comercio. Cuando se establece, coincide junto con cualquier filtro de MCC; no es una coincidencia por subcadena ni por nombre para mostrar enriquecido.
integer
requerido
Tasa de cashback en puntos básicos. 100 significa 1 % y 10000 significa 100 %.
string | null
requerido
ID de la subcuenta, con el prefijo biz_. Null designa a todas las subcuentas directas de la plataforma que financia.
string
requerido
Inicio inclusivo de la ventana de elegibilidad de la regla, como marca de tiempo ISO 8601.
string
requerido
Cuándo se actualizó la regla por última vez, como marca de tiempo ISO 8601.
CashbackRule