Skip to content
RemindCash

Pagination and idempotency

Página a través de los puntos finales de lista y hacer que cada escritura sea segura para volver a entrar con un Ídempotency-Key.

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.

Pagination

Los puntos finales de la lista (GET /v1/receivables, GET /v1/reminder-attempts) están paginados.

Parámetro de consultas Descripción
per_page Artículos por página, 1–100. Predeterminado 25.
page Número de página, comenzando a 1.

Cada respuesta de la lista incluye un objeto meta:

JSON
{ "meta": { "current_page": 1, "per_page": 25, "total": 1 } }

Siga solicitando el siguiente page hasta que current_page × per_page llegue a total. Los valores son pedidos por id; los intentos de recordatorio son los primeros más recientes.

Idempotencia

Cada escritura — crear, actualizar, pagar, pausar, reanudar, cancelar— requiere un encabezado Idempotency-Key.

  • 16 a 128 caracteres: letras, dígitos, ., _, : o -.
  • Utilice una nueva clave única por operación prevista, por ejemplo un UUID o invoice-1042-payment-1.
  • Las claves están sujetas a su empresa.
HTTP
POST /v1/receivables/1/payments HTTP/1.1
Host: api.remindcash.com
Authorization: Bearer <your-api-key>
Idempotency-Key: payment-inv-1042-0001
Content-Type: application/json

Lo que sucede en una repetición:

Solicitud de repetición Resultado
Mismo llave, misma operación y el mismo cuerpo La respuesta original es devuelta; nada se crea dos veces.
Mismo llave con un cuerpo o operación diferente 409 conflict.
Llave perdida o malformada 422 validation_failed con un error de campo Idempotency-Key.

La comparación ignora el orden de las teclas JSON, por lo que {"a":1,"b":2} y {"b":2,"a":1} cuentan como el mismo cuerpo.