Saltar para o conteúdo
RemindCash

Paginação e idempotência

Percorra os endpoints de listagem página a página e torne cada escrita segura para repetir com um Idempotency-Key.

Estado da API pública

A API v1 usa chaves bearer da empresa e exige um período de plano ativo. Os endpoints de rascunhos e de comunicação de pagamentos não enviam mensagens a clientes. Os exemplos usam marcadores — nunca cole uma chave real em código partilhado.

Paginação

Os endpoints de listagem (GET /v1/receivables, GET /v1/reminder-attempts) são paginados.

Parâmetro de consulta Descrição
per_page Itens por página, de 1 a 100. Predefinição: 25.
page Número da página, a começar em 1.

Cada resposta de listagem inclui um objeto meta:

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

Continue a pedir a page seguinte até current_page × per_page chegar a total. As cobranças são ordenadas por id; as tentativas de lembrete, das mais recentes para as mais antigas.

Idempotência

Cada escrita — criar, atualizar, pagamento, pausar, retomar, cancelar — exige um cabeçalho Idempotency-Key.

  • De 16 a 128 caracteres: letras, algarismos, ., _, : ou -.
  • Use uma chave nova e única para cada operação pretendida, por exemplo um UUID ou invoice-1042-payment-1.
  • As chaves são válidas dentro da sua 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

O que acontece numa repetição:

Pedido repetido Resultado
Mesma chave, mesma operação e mesmo corpo É devolvida a resposta original; nada é criado duas vezes.
Mesma chave com um corpo ou operação diferente 409 conflict.
Chave em falta ou mal formada 422 validation_failed com um erro no campo Idempotency-Key.

A comparação ignora a ordem das chaves JSON, por isso {"a":1,"b":2} e {"b":2,"a":1} contam como o mesmo corpo.