İçeriğe geç
KuryeSoft

API başvurusu

Ödeme tiplerini listele

Kurye firmasında tanımlı etkin ödeme tipleri.
GEThttps://kurye.firmaniz.com/api/v1/payment-types

Sipariş gönderirken ödemeyi payment.kind (tür) ile ya da buradaki id ile (payment.payment_type_id) belirtirsiniz. Firma aynı türden birden çok ödeme tipi tanımladıysa (ör. iki ayrı yemek kartı) doğru olanı seçmek için id kullanın.

collect_from_customer: true olan tiplerde kurye kapıda tahsilat yapar; false olanlarda (önceden ödenmiş) tahsil edilecek tutar her zaman 0 olur.

Liste kurye firması tarafından değiştirilebilir; sabit kodlamak yerine günde bir kez çekip saklayın.

Örnek istek

curl "https://kurye.firmaniz.com/api/v1/payment-types" \
  -H "X-Api-Key: $KURYESOFT_API_KEY"

Yanıt

200 Başarılı

Etkin ödeme tipleri, paneldeki sırayla.

itemsnesne dizisi
Ödeme tipleri.
items[].idtam sayı
Ödeme tipi kimliği.
items[].namemetin
Firmanın verdiği ad.
items[].kindmetin
Ödeme türü.

Değerler: cash, card, online, meal_card, other

items[].collect_from_customermantıksal
Kurye kapıda tahsilat yapar mı.
200 · application/json
{
  "items": [
    {
      "id": 1,
      "name": "Kapıda Nakit",
      "kind": "cash",
      "collect_from_customer": true
    },
    {
      "id": 2,
      "name": "Kapıda Kredi Kartı",
      "kind": "card",
      "collect_from_customer": true
    },
    {
      "id": 3,
      "name": "Online Ödeme",
      "kind": "online",
      "collect_from_customer": false
    },
    {
      "id": 4,
      "name": "Yemek Kartı",
      "kind": "meal_card",
      "collect_from_customer": true
    }
  ]
}

Hatalar

Hata gövdesi her zaman { "error": { "code", "message", "fields" } } biçimindedir. Bu uçta karşılaşabileceğiniz kodlar (bütün liste için Hatalar):

API_KEY_REQUIRED
HTTP:401
Anlamı:İstekte API anahtarı yok ya da ks_ ile başlamıyor.
API_KEY_INVALID
HTTP:401
Anlamı:Anahtar yanlış, silinmiş ya da pasif.
İpucu:

429 RATE_LIMITED ve 5xx yanıtlarında kısa bir beklemeyle yeniden deneyin. Bkz. Yeniden deneme.