Skip to content

Seguimiento de pagos

Recorde los pagos que su cliente reportó, y detenga, reanude o cancele los recordatorios para un crédito.

Situación de la API pública

La API v1 utiliza las teclas de portador con un sistema operativo y requiere un período de plan activo. Los puntos finales de facturación y borrado no envían mensajes de clientes. Ejemplos usan los marcadores de posición — nunca pegan una clave real en código compartido.

RemindCash no procesa pagos. Cuando su cliente le paga, regístrelo para que los recordatorios usen el importe restante — o detenga una vez que se paga completamente.

Registrar un pago

POST /v1/receivables/{id}/payments registra un pago reportado. Necesita el alcance receivables:write y un Idempotency-Key.

Campo Necesidades Reglas
amount Sí. Positivo cadena decimal, hasta dos decimales.
BASH
curl https://api.remindcash.com/v1/receivables/1/payments \
  --request POST \
  --header "Authorization: Bearer $REMINDCASH_API_KEY" \
  --header "Idempotency-Key: payment-inv-1042-0001" \
  --header "Content-Type: application/json" \
  --data '{ "amount": "250.00" }'
JSON
{
    "data": {
        "id": 1,
        "receivable_id": 1,
        "amount_minor": 25000,
        "remaining_after_minor": 100000,
        "status_after": "draft",
        "recorded_at": "2026-10-11T12:58:05.000000Z"
    }
}

status_after muestra el estado del crédito después del pago: para un crédito activo se convierte en partially_paid, y paid una vez que no queda nada. Un crédito pagado no recibe ningún recordatorio adicional.

Pausa, reanudar y cancelar

Método Camino Sumas acreditadas
POST /v1/receivables/{id}/pause active, partially_paid
POST /v1/receivables/{id}/resume paused (cuando se detuvo de pago activo o parcialmente)
POST /v1/receivables/{id}/cancel draft, active, paused, partially_paid, disputed

Cada solicitud necesita un reason entre 10 y 500 caracteres y un Idempotency-Key. La razón está almacenada en el historial de auditorías por cobrar.

BASH
curl https://api.remindcash.com/v1/receivables/1/pause \
  --request POST \
  --header "Authorization: Bearer $REMINDCASH_API_KEY" \
  --header "Idempotency-Key: pause-inv-1042-000001" \
  --header "Content-Type: application/json" \
  --data '{ "reason": "Customer asked for one more week." }'
JSON
{
    "data": {
        "id": 1,
        "status": "paused",
        "paid_minor": 0,
        "version": "049a6c669d9211215001be5a324c3f5c9e057797ef4d89e21c8aa632578a87ae"
    }
}

Resumir también requiere un contacto cliente verificado y elegible y un saldo restante. Un cambio que no se permite desde el estado actual devuelve 422 validation_failed con un error de campo action. Resumir nunca vuelve a reproducir recordatorio pasos que fueron saltados mientras se detuvo.