Skip to content

Pagination and idempotency

Page through list endpoints and make every write safe to retry with an Idempotency-Key.

Public API status

The v1 API described here is implemented and tested, but api.remindcash.com is not yet open to the public. It opens after final acceptance testing; until then requests return 503. Examples use placeholders — never paste a real key into shared code.

Pagination

List endpoints (GET /v1/receivables, GET /v1/reminder-attempts) are paginated.

Query parameter Description
per_page Items per page, 1–100. Default 25.
page Page number, starting at 1.

Each list response includes a meta object:

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

Keep requesting the next page until current_page × per_page reaches total. Receivables are ordered by id; reminder attempts are newest first.

Idempotency

Every write — create, update, payment, pause, resume, cancel — requires an Idempotency-Key header.

  • 16 to 128 characters: letters, digits, ., _, : or -.
  • Use a new unique key per intended operation, for example a UUID or invoice-1042-payment-1.
  • Keys are scoped to your company.
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

What happens on a repeat:

Repeat request Result
Same key, same operation and same body The original response is returned; nothing is created twice.
Same key with a different body or operation 409 conflict.
Missing or malformed key 422 validation_failed with an Idempotency-Key field error.

The comparison ignores the order of JSON keys, so {"a":1,"b":2} and {"b":2,"a":1} count as the same body.