İşlem İadesi

Zotlo API servisi ile iade işlemlerinizi gerçekleştirin

Bu API hizmeti, Zotlo üzerinden yapılan satın almalar ve aboneliklerle ilgili iade işlemleri için kullanılır.

İade işlemi servisi POST metoduyla çalışır. İade işleminin gerçekleşmesi çin transactionId parametresinin gönderilmesi zorunludur.

URL	https://api.zotlo.com/v1/payment/refund
Request Parameters	transactionId: iade yapılmak istenen işlemin transactionId bilgisidir. refundReason: İadenin yapılma nedenidir. refundUser: İade işlemini yapan kullanıcı bilgileridir. String olarak gönderilebilir.

Örnek İstek

İşlem iadesi servisine istek gönderirken gerekli olan Access Key ve Access Secret bilgilerine, Zotlo Panel'de yer alan Developer Tools/API Keys sayfasından ulaşabilirsiniz.

Application ID bilgisinin gönderilmesi zorunlu değildir.

POST https://api.zotlo.com/v1/payment/refund HTTP/1.1
AccessKey: ••••••
AccessSecret: ••••••
Content-Type: application/json
ApplicationId: •
Language: ••
{
    "transactionId": "0741a0ac-21d8-4750-941f-064f340700c3",
    "refundReason": "User request!",
}

Başarılı Cevap Örneği

{
  "meta": {
    "requestId": "246a8e676214-REQ-659557ea5289c",
    "httpStatus": 200
  },
  "result": {
    "providerResponse": [],
    "transaction": {
      "id": 57333,
      "payment_type": "subscription",
      "original_transaction_id": "d8ff7792-1c63-4370-be93-447dacaa09ea",
      "transaction_id": "0741a0ac-21d8-4750-941f-064f340700c3",
      "package_id": "premium",
      "team_id": 5,
      "app_id": 5,
      "status": "renewal",
      "create_date": "2024-01-03 12:47:20",
      "purchase_date": "2024-01-03 12:47:20",
      "original_purchase_date": "2023-01-03 12:47:16",
      "price": "12.00",
      "currency": "TRY",
      "country": "TR",
      "expire_date": "2025-01-03 12:47:16",
      "subscriber_id": "905456757656",
      "credit_card": "11111111****4111",
      "refund_price": "5.00",
      "refund_date": "2024-01-03 12:49:46",
      "refund_reason": "{\"reason\":\"Test .\",\"user\":\"API: \"}",
      "is_refund": 1,
      "provider_id": 8,
      "provider_transaction_id": "e963981a-4ee1-494b-b1e8-73db2a694c58",
      "provider_status": "unknown",
      "provider_name": "Zotlo",
      "comment": null,
      "json_payload": null,
      "quantity": 1,
      "package_price": "12.00",
      "subscription_id": 5370,
      "is_transfer": null
    },
    "refundHistory": [
      {
        "id": 3627,
        "team_id": 5,
        "app_id": 5,
        "provider_id": 8,
        "package_id": "premium",
        "subscriber_id": "905456757656",
        "transaction_id": "0741a0ac-21d8-4750-941f-064f340700c3",
        "country": "TR",
        "price": "5.00",
        "currency": "TRY",
        "exchange_rate": "[]",
        "reason": "{\"reason\":\"Test .\",\"user\":\"API: \"}",
        "refund_date": "2024-01-03 12:49:46"
      }
    ]
  }
}

Başarılı Cevap Parametreleri

Başarılı dönen cevapta yer alan parametreler aşağıdaki gibidir.

Alan	Açıklama
providerResponse	Ödeme sağlayıcı tarafından dönülen iade cevabıdır.
transaction	İade edilen ödemeye ait son bilgiler dönülür.

Başarısız Cevap Örneği

Servislerimizden HTTP status code olarak başarılı durumlarda 200 dönmektedir. Başarısız durumlarda ise 400 ya da 500 Http StatusCode dönmektedir. Örnek hata cevabı aşağıdaki şekildedir.

{
    "meta": {
        "requestId": "75472fafd4f9-REQ-65982cee82930",
        "httpStatus": 400,
        "errorMessage": "İadesini yapmak istediğiniz sipariş numarasına ait bir satın alma bulunamadı.",
        "errorCode": "400013"
    },
    "result": []
}

Başarısız Cevap Parametreleri

Alan	Açıklama
requestId	Zotlo tarafından işleminiz için üretilen ve saklanan benzersiz istek parametresidir.
httpStatus	İlgili cevaba ait HttpStatus kodudur. Standart kodlar olan, 400 ya da 500 dönmektedir.
errorMessage	Alınan hatanın detayıdır. Hata mesajı, gönderdiğiniz dil parametresine göre her dile özel verilmektedir.
errorCode	İlgili hatanın Zotlo'daki hata kodudur.
result	Bu alanın alabileceği değerler dinamiktir. Eğer hata sonucunda ilgili servisten bir cevap dönülmesi gerekiyorsa dolu gelecektir. Aksi durumlarda ise boş object olarak gelmektedir.