Saltar para o conteúdo
RemindCash

Início rápido

Crie uma chave de API e, depois, crie e leia a sua primeira cobrança em rascunho em poucos minutos.

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.

Este guia cria uma cobrança em rascunho através da API e lê-a de volta. Nada é enviado ao seu cliente.

1. Crie uma chave de API

Na aplicação, abra Definições → Chaves de API e crie uma chave com as permissões receivables:read e receivables:write.

  • Só os proprietários e administradores da empresa podem gerir chaves.
  • A sua conta precisa de um e-mail verificado e de autenticação de dois fatores, e confirma a palavra-passe antes de gerir chaves.
  • A chave é mostrada uma única vez. Copie-a para um cofre de segredos; o RemindCash guarda apenas um hash.
  • As chaves expiram ao fim de 30 dias. Veja Autenticação para a rotação.

2. Mantenha a chave fora do código

BASH
export REMINDCASH_API_KEY="<your-api-key>"

3. Crie uma cobrança em rascunho

Cada escrita precisa de um cabeçalho Idempotency-Key, para que um pedido repetido nunca crie um duplicado.

BASH
curl https://api.remindcash.com/v1/receivables \
  --request POST \
  --header "Authorization: Bearer $REMINDCASH_API_KEY" \
  --header "Idempotency-Key: create-inv-1042-0001" \
  --header "Content-Type: application/json" \
  --data '{
    "customer": { "display_name": "Studio North", "email": "billing@studionorth.example" },
    "amount": "1250.00",
    "currency": "USD",
    "due_date": "2026-10-15",
    "external_reference": "INV-1042",
    "description": "Website redesign"
  }'

A resposta é 201 Created:

JSON
{
    "data": {
        "id": 1,
        "customer_id": 1,
        "amount_minor": 125000,
        "paid_minor": 0,
        "currency": "USD",
        "due_date": "2026-10-15",
        "status": "draft",
        "external_reference": "INV-1042",
        "description": "Website redesign",
        "version": "4e6fea39ae2fab8ccb843657f081d276513739a71787c060a007b65e3acbbbc1"
    }
}

4. Leia-a de volta

BASH
curl https://api.remindcash.com/v1/receivables/1 \
  --header "Authorization: Bearer $REMINDCASH_API_KEY"

5. Ative-a na aplicação

Abra a cobrança na aplicação, confirme os contactos e a autorização do cliente, reveja o calendário de lembretes e ative-a. A ativação não está disponível através da API.

A seguir: Conceitos.