İçeriğe geç
siparis.app geliştiriciAnahtarları yönet ↗

Siparişler

Ödemeleri ve para özetini getir

GET/v1/orders/{id}/payments

Siparişin tahsilat ve geri ödemelerini ve bütün siparişin para özetini okuyun; mutabakatta kullanın.

Gereken izin

Bearer anahtarı ve orders:read, payments:read

Maliyet

2 puan (bağlantı başına 60 saniyede 600 puan)

Tekrar anahtarı

Gerekmez (okuma).

İstek

Temel adres: https://api.siparis.app/v1

Yol parametreleri

AlanTürZorunluAçıklamaÖrnek
idmetinEvetOkunacak kaynağın ord_ önekli dış kimliği."ord_1234567890abcdef1234567890abcdef"

Sorgu parametreleri

AlanTürZorunluAçıklamaÖrnek
limittam sayı (en az 1; en çok 100)HayırSayfa başına kayıt/olay adayı sayısı; varsayılan 50, en az 1, en çok 100.50
cursormetin (en çok 4096 karakter) · null olabilirHayırÖnceki yanıtın next_cursor değeri; çözmeyin, aynı kaynak, yetki ve süzgeçlerle aynen gönderin."SUNUCUDAN_DONEN_IMLEC"

Örnek istek

curl --fail-with-body --silent --show-error --request GET \
  "${SIPARIS_API_URL:-https://api.siparis.app/v1}/orders/ord_1234567890abcdef1234567890abcdef/payments?limit=50" \
  -H "Authorization: Bearer $SIPARIS_API_KEY"
import json
import os
from urllib.request import Request, build_opener, HTTPRedirectHandler
from urllib.error import HTTPError

# İmzalı indirme hedefine Bearer taşımamak için yönlendirme kendiliğinden izlenmez.
class NoRedirect(HTTPRedirectHandler):
    def redirect_request(self, req, fp, code, msg, headers, newurl):
        return None

base = os.environ.get("SIPARIS_API_URL", "https://api.siparis.app/v1")
headers = {
    "Authorization": "Bearer " + os.environ["SIPARIS_API_KEY"],
}
request = Request(base + "/orders/ord_1234567890abcdef1234567890abcdef/payments?limit=50", headers=headers, method="GET")
try:
    with build_opener(NoRedirect).open(request, timeout=30) as response:
        print(response.read().decode("utf-8"))
except HTTPError as error:
    print(error.code, error.read().decode("utf-8"))
    raise
// Node.js 22+; anahtar yalnız sunucunun ortam değişkenindedir.
const base = process.env.SIPARIS_API_URL ?? "https://api.siparis.app/v1";
if (!process.env.SIPARIS_API_KEY) throw new Error("SIPARIS_API_KEY gerekli");
const response = await fetch(base + "/orders/ord_1234567890abcdef1234567890abcdef/payments?limit=50", {
  method: "GET",
  headers: {
    "Authorization": `Bearer ${process.env.SIPARIS_API_KEY}`,
  },
  redirect: "manual", // 307 hedefini Bearer olmadan ayrı istekte okuyun.
  signal: AbortSignal.timeout(30_000),
});
const text = await response.text();
if (!response.ok) throw new Error(`${response.status}: ${text}`);
console.log(text);

Kimlik içeren yollarda örnek kimliği kendi liste yanıtınızdan alın. SIPARIS_API_KEY sunucu ortamında tanımlı olmalı; yerelde SIPARIS_API_URL ile /v1 içeren adresi değiştirin. Üretimde tekrar kurallarını uygulayın.

Yanıt

200 İstek başarıyla tamamlandı.

İçerik türü: application/json

{
  "data": [
    {
      "amount": "120.00",
      "channel": "bank",
      "created_at": "2026-10-16T09:00:00Z",
      "currency": "TRY",
      "id": "col_1234567890abcdef1234567890abcdef",
      "kind": "payment",
      "settled_at": "2026-10-16T09:00:00Z",
      "status": "succeeded",
      "test": false,
      "type": "collection"
    }
  ],
  "has_more": false,
  "next_cursor": null,
  "summary": {
    "carried": "0.00",
    "collect_due": "0.00",
    "collected": "120.00",
    "currency": "TRY",
    "has_collection": true,
    "kept": "120.00",
    "legacy": false,
    "refund_due": "0.00",
    "reserved": "0.00",
    "returned": "0.00",
    "test": false
  }
}
Yanıt alanları (25)
AlanTürZorunluAçıklamaÖrnek
dataliste: nesneEvetBu sayfanın görünür kayıtları; boş liste de geçerli bir sayfadır.
amountmetinEvetİşlem tutarı; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."120.00"
channelmetinEvetSatış veya tahsilat kanalı."bank"
created_attarih-saatEvetOluşturulma zamanı; RFC 3339 UTC."2026-10-16T09:00:00Z"
idmetinEvetKaynağın dış kimliği; col_ ve 32 küçük onaltılık karakter. İç sayısal kimlik kullanılmaz."col_1234567890abcdef1234567890abcdef"
kindmetinEvetTahsilat veya iade işlem türü."payment"
settled_attarih-saat · null olabilirEvetKesinleşme zamanı; RFC 3339 UTC. Değer yoksa null."2026-10-16T09:00:00Z"
statusmetinEvetTahsilat/geri ödeme durumu."succeeded"
testtrue/falseEvetDeneme işlemi ise true; gerçek para hareketiyle karıştırmayın.false
typemetin (seçenekler: collection, refund)Evetcollection: tahsilat; refund: geri ödeme."collection"
currencysabit "TRY"HayırPara birimi; v1 tutarları Türk lirasıdır."TRY"
has_moretrue/falseEvetTaranacak başka sayfa varsa true; olaylarda boş data ile de true olabilir.false
next_cursormetin · null olabilirEvetSonraki sayfa için aynen gönderilecek opak imleç; kaynak listesi bittiyse null.null
summarynesneEvetSiparişin bütün tahsilat ve iadelerinden hesaplanan para özeti; yalnız bu sayfanın toplamı değildir.
carriedmetinEvetBaşka siparişe devreden hak (+), başka siparişten gelen mahsup (−); TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."0.00"
collect_duemetinEvetHenüz tahsil edilmesi gereken; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."0.00"
collectedmetinEvetTahsil edilen toplam; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."120.00"
has_collectiontrue/falseEvetEn az bir tahsilat kaydı varsa true.true
keptmetinEvetTahsilatlardan geri ödemeler çıktıktan sonra kalan; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."120.00"
legacytrue/falseEvetEski kayıt biçiminden gelen özetse true.false
refund_duemetinEvetHenüz müşteriye dönmesi gereken; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."0.00"
reservedmetinEvetDevam eden geri ödemeler için ayrılan; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."0.00"
returnedmetinEvetGeri ödenen toplam; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."0.00"
testtrue/falseEvetDeneme işlemi ise true; gerçek para hareketiyle karıştırmayın.false
currencysabit "TRY"HayırPara birimi; v1 tutarları Türk lirasıdır."TRY"

Hatalar

Bu uca özgü hata yok.

Ortak hatalar (anahtar, izin, istek biçimi, hız sınırı, tekrar anahtarı) her uçta aynıdır: Hata kodları › Ortak hatalar.