İçeriğe geç
RemindCash

Ödeme takibi

Müşterinizin bildirdiği ödemeleri kaydedin; bir alacağın hatırlatmalarını duraklatın, sürdürün veya iptal edin.

Herkese açık API durumu

Burada anlatılan v1 API uygulanmış ve test edilmiştir, ancak api.remindcash.com henüz herkese açık değildir. Son kabul testlerinden sonra açılacak; o zamana kadar istekler 503 döner. Örneklerde yer tutucular kullanılır — gerçek bir anahtarı asla paylaşılan koda yapıştırmayın.

RemindCash ödeme işlemez. Müşteriniz size ödeme yaptığında, hatırlatmaların kalan tutarı kullanması — ya da tamamen ödendiğinde durması — için ödemeyi kaydedin.

Ödeme kaydetme

POST /v1/receivables/{id}/payments bildirilen bir ödemeyi kaydeder. receivables:write kapsamı ve bir Idempotency-Key gerektirir.

Alan Zorunlu Kurallar
amount Evet En fazla iki ondalıklı pozitif metin.
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, ödemeden sonraki alacak durumunu gösterir: etkin bir alacak partially_paid olur, kalan tutar sıfırlandığında ise paid olur. Ödenmiş bir alacak için başka hatırlatma gönderilmez.

Duraklatma, sürdürme ve iptal

Yöntem Yol İzin verilen durumlar
POST /v1/receivables/{id}/pause active, partially_paid
POST /v1/receivables/{id}/resume paused (etkin veya kısmen ödenmiş durumdan duraklatıldıysa)
POST /v1/receivables/{id}/cancel draft, active, paused, partially_paid, disputed

Her istek 10 ile 500 karakter arasında bir reason ve bir Idempotency-Key gerektirir. Gerekçe alacağın denetim geçmişinde saklanır.

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"
    }
}

Sürdürme ayrıca doğrulanmış, uygun bir müşteri iletişim bilgisi ve kalan bakiye gerektirir. Mevcut durumdan izin verilmeyen bir değişiklik, action alan hatasıyla 422 validation_failed döndürür. Sürdürme, duraklatma sırasında atlanan hatırlatma adımlarını asla yeniden oynatmaz.