9. İade

İade Servisi

İade

POST {{Private Base Address}}/api/paywall/private/refund

Yukarıda verilmiş olan adrese istek atmanız yeterli olacaktır. Test ortamı ve Gerçek ortam için 'Base Address' istediğiniz gibi kullanabilirsiniz.

Önemli: İade servisini kullanabilmeniz için 'Header' alanında 'apikeyprivate' ve 'apiclientprivate' parametrelerini göndermeniz gerekmektedir. PaymentPrivateAPI Adresi

Gerekli header ve istek parametreleri:

Zorunlu header parametreleri

Parametre	Tip	Zorunlu	Açıklama
apikeyprivate	string	Evet	Üye işyeri panelinden temin etmiş olduğunuz Private Key.
apiclientprivate	string	Evet	Üye işyeri panelinden temin etmiş olduğunuz Private Client.

İstek gövdesi parametreleri

Parametre	Tip	Zorunlu	Açıklama
Date	date	Evet	Ödeme'nin gerçekleştiği tarih bilgisi
MerchantUniqueCode	string	Evet	Ödeme başlatma için gönderilen istek içerisindeki MerchantUniqueCode ile aynı değer olmalıdır. Bu kod sizin tarafınızdan işleme ait verilen tekil değerdir. İptal/İade/Ödeme Sorgulama işlemlerinin hepsinde bir ödemeyi tekilleştirmeniz ve takip etmeniz için kullanılmaktadır.
MarketPlace:DeleteExistingRecords	bool	Hayır	Pazaryeri kapsamında ilgili ödemenin hakediş onayının verilmesi durumunda, bu parametre true gönderilmelidir. True gönderilmesi durumunda var olan hakedişler, iptal emrinin başarılı olması sonrasında silinir
CompletePartialRefund	bool	Hayır	İlgili ödeme için öncesinde kısmi iade yapıldıya, yapılan kısmi iade ana tutardan düşülür ve kalan tutar için tekrar kısmi iade emriyle, iade işlemi tamamlanır

Servise gönderilmesi gereken parametreler şu şekildedir :

Json

{
    "Date": "2023-02-07",
    "MerchantUniqueCode": "AA90T0SD0ASF99",
    "CompletePartialRefund": false,
    "MarketPlace": { // nullable
        "DeleteExistingRecords": false
    }
}

C#

using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

public class Program
{
    private static readonly HttpClient client = new HttpClient();

    private static async Task Main()
    {
        var data = new 
        {
            Date = "2026-09-03",
            MerchantUniqueCode = "AA90T0SD0ASF99",
            CompletePartialRefund = false,
            MarketPlace = new 
            {
                DeleteExistingRecords = false
            }
        };
        var content = new StringContent(JsonConvert.SerializeObject(data), Encoding.UTF8, "application/json");
        content.Headers.Add("apikeyprivate", "%PRIVATEKEY%");
        content.Headers.Add("apiclientprivate", "%PRIVATECLIENT%");

        var response = await client.PostAsync("{{Payment Private Address}}/api/paywall/private/refund", content);

        var responseString = await response.Content.ReadAsStringAsync();
        Console.WriteLine(responseString);
    }
}

GO

package main

import (
    "bytes"
    "fmt"
    "io/ioutil"
    "net/http"
    "encoding/json"
)

func main() {
    url := "{{Payment Private Address}}/api/paywall/private/refund"
    data := map[string]interface{}{
        "Date":                  "2026-09-03",
        "MerchantUniqueCode":    "AA90T0SD0ASF99",
        "CompletePartialRefund": false,
        "MarketPlace": map[string]interface{}{
            "DeleteExistingRecords": false,
        },
    }
    reqBody, _ := json.Marshal(data)
    
    req, _ := http.NewRequest("POST", url, bytes.NewBuffer(reqBody))
    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("apikeyprivate", "%PRIVATEKEY%")
    req.Header.Set("apiclientprivate", "%PRIVATECLIENT%")
    
    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    
    body, _ := ioutil.ReadAll(resp.Body)
    fmt.Println(string(body))
}

Java

import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
import java.net.http.HttpResponse.BodyHandlers;
import java.util.HashMap;
import java.util.Map;
import com.fasterxml.jackson.databind.ObjectMapper;

public class Main {

    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();

        Map<String, Object> marketPlace = new HashMap<>();
        marketPlace.put("DeleteExistingRecords", false);

        Map<String, Object> values = new HashMap<>();
        values.put("Date", "2026-09-03");
        values.put("MerchantUniqueCode", "AA90T0SD0ASF99");
        values.put("CompletePartialRefund", false);
        values.put("MarketPlace", marketPlace);

        String requestBody = new ObjectMapper().writeValueAsString(values);

        HttpRequest request = HttpRequest.newBuilder()
                .uri(new URI("{{Payment Private Address}}/api/paywall/private/refund"))
                .setHeader("Content-Type", "application/json")
                .setHeader("apikeyprivate", "%PRIVATEKEY%")
                .setHeader("apiclientprivate", "%PRIVATECLIENT%")
                .POST(HttpRequest.BodyPublishers.ofString(requestBody))
                .build();

        HttpResponse<String> response = client.send(request, BodyHandlers.ofString());

        System.out.println(response.body());
    }
}

PHP

<?php
$url = '{{Payment Private Address}}/api/paywall/private/refund';
$data = array(
    "Date" => "2026-09-03",
    "MerchantUniqueCode" => "AA90T0SD0ASF99",
    "CompletePartialRefund" => false,
    "MarketPlace" => array(
        "DeleteExistingRecords" => false
    )
);
$options = array(
    'http' => array(
        'header' => "Content-type: application/json\r\n" .
            "apikeyprivate: %PRIVATEKEY%\r\n" .
            "apiclientprivate: %PRIVATECLIENT%\r\n",
        'method' => 'POST',
        'content' => json_encode($data),
    ),
);
$context = stream_context_create($options);
$result = file_get_contents($url, false, $context);
if ($result === FALSE) { /* Handle error */
}

// Decode
$response = json_decode($result);

// ErrorCode-Result-Message
if ($response) {
    echo "ErrorCode: " . ($response->ErrorCode ?? '') . "\n";
    echo "Result: " . (!empty($response->Result) ? "true" : "false") . "\n";
    echo "Message: " . ($response->Message ?? '') . "\n";
}
?>

Python

import requests
import json

url = '{{Payment Private Address}}/api/paywall/private/refund'
headers = {
    'Content-Type': 'application/json',
    'apikeyprivate': '%PRIVATEKEY%',
    'apiclientprivate': '%PRIVATECLIENT%',
}
data = {
    "Date": "2026-09-03",
    "MerchantUniqueCode": "AA90T0SD0ASF99",
    "CompletePartialRefund": False,
    "MarketPlace": {
        "DeleteExistingRecords": False
    }
}
response = requests.post(url, headers=headers, data=json.dumps(data))

response_data = response.json()

print('ErrorCode:', response_data.get('ErrorCode'))
print('Result:', response_data.get('Result'))
print('Message:', response_data.get('Message'))

Ruby

require 'net/http'
require 'uri'
require 'json'

uri = URI.parse("{{Payment Private Address}}/api/paywall/private/refund")
http = Net::HTTP.new(uri.host, uri.port)

request = Net::HTTP::Post.new(uri.request_uri, {
    'Content-Type' => 'application/json',
    'apikeyprivate' => '%PRIVATEKEY%',
    'apiclientprivate' => '%PRIVATECLIENT%'
})
request.body = {
    Date: "2026-09-03",
    MerchantUniqueCode: "AA90T0SD0ASF99",
    CompletePartialRefund: false,
    MarketPlace: {
        DeleteExistingRecords: false
    }
}.to_json

response = http.request(request)

puts response.body

TypeScript

const axios = require('axios');

const data = {
    Date: "2026-09-03",
    MerchantUniqueCode: "AA90T0SD0ASF99",
    CompletePartialRefund: false,
    MarketPlace: {
        DeleteExistingRecords: false
    }
};

axios.post('{{Payment Private Address}}/api/paywall/private/refund', data, {
    headers: {
        'Content-Type': 'application/json',
        'apikeyprivate': '%PRIVATEKEY%',
        'apiclientprivate': '%PRIVATECLIENT%',
    }
})
    .then((response: any) => {
        console.log(response.data);
    })
    .catch((error: any) => {
        console.error(error);
    });

Curl

curl -X POST "{{Payment Private Address}}/api/paywall/private/refund" \
-H "Content-Type: application/json" \
-H "apikeyprivate: %PRIVATEKEY%" \
-H "apiclientprivate: %PRIVATECLIENT%" \
-d '{
    "Date": "2026-09-03",
    "MerchantUniqueCode": "AA90T0SD0ASF99",
    "CompletePartialRefund": false,
    "MarketPlace": {
        "DeleteExistingRecords": false
    }
}'

Servisten dönen parametreler şu şekildedir:

Parametreler ve açıklamaları

Parametre	Tip	Açılama
Body	object	Ödemeye ilişkin detay içeren JSON (opsiyonel)
ErrorCode	int	Hata kodu. İşlem başarılı ise '0' değerini döner.
Result	bool	True ya da false değeri döner. İşlem başarılı iste 'true' değerini döner
Message	string	İşlem hatalıysa, bu hataya dair belirtilen mesajdır, locale parametresine göre dil desteği sunar.

Json

{
    "ErrorCode": 0,
    "Result": true,
    "Message": "Success",
    "Body": null
}

İade Servisi

İade V2

POST {{Private Base Address}}/api/paywall/private/refund/v2

Yukarıda verilmiş olan adrese istek atmanız yeterli olacaktır. Test ortamı ve Gerçek ortam için 'Base Address' istediğiniz gibi kullanabilirsiniz.

Önemli: İade servisini kullanabilmeniz için 'Header' alanında 'apikeyprivate' ve 'apiclientprivate' parametrelerini göndermeniz gerekmektedir. PaymentPrivateAPI Adresi

Gerekli header ve istek parametreleri:

Zorunlu header parametreleri

Parametre	Tip	Zorunlu	Açıklama
apikeyprivate	string	Evet	Üye işyeri panelinden temin etmiş olduğunuz Private Key.
apiclientprivate	string	Evet	Üye işyeri panelinden temin etmiş olduğunuz Private Client.

İstek gövdesi parametreleri

Parametre	Tip	Zorunlu	Açıklama
Date	date	Evet	Ödeme'nin gerçekleştiği tarih bilgisi
MerchantUniqueCode	string	Evet	Ödeme başlatma için gönderilen istek içerisindeki MerchantUniqueCode ile aynı değer olmalıdır. Bu kod sizin tarafınızdan işleme ait verilen tekil değerdir. İptal/İade/Ödeme Sorgulama işlemlerinin hepsinde bir ödemeyi tekilleştirmeniz ve takip etmeniz için kullanılmaktadır.
MarketPlace:DeleteExistingRecords	bool	Hayır	Pazaryeri kapsamında ilgili ödemenin hakediş onayının verilmesi durumunda, bu parametre true gönderilmelidir. True gönderilmesi durumunda var olan hakedişler, iptal emrinin başarılı olması sonrasında silinir
CompletePartialRefund	bool	Hayır	İlgili ödeme için öncesinde kısmi iade yapıldıya, yapılan kısmi iade ana tutardan düşülür ve kalan tutar için tekrar kısmi iade emriyle, iade işlemi tamamlanır

Servise gönderilmesi gereken parametreler şu şekildedir :

Json

{
    "Date": "2026-09-03",
    "MerchantUniqueCode": "aabbccdd-1122-3344-5566-aabbccddeeff",
    "CompletePartialRefund": false,
    "MarketPlace": { // nullable
        "DeleteExistingRecords": false
    }
}

C#

using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

public class Program
{
    private static readonly HttpClient client = new HttpClient();

    private static async Task Main()
    {
        var data = new 
        {
            Date = "2026-09-03",
            MerchantUniqueCode = "AA90T0SD0ASF99",
            CompletePartialRefund = false,
            MarketPlace = new 
            {
                DeleteExistingRecords = false
            }
        };
        var content = new StringContent(JsonConvert.SerializeObject(data), Encoding.UTF8, "application/json");
        content.Headers.Add("apikeyprivate", "%PRIVATEKEY%");
        content.Headers.Add("apiclientprivate", "%PRIVATECLIENT%");

        var response = await client.PostAsync("{{Payment Private Address}}/api/paywall/private/refund/v2", content);

        var responseString = await response.Content.ReadAsStringAsync();
        Console.WriteLine(responseString);
    }
}

GO

package main

import (
    "bytes"
    "fmt"
    "io/ioutil"
    "net/http"
    "encoding/json"
)

func main() {
    url := "{{Payment Private Address}}/api/paywall/private/refund/v2"
    data := map[string]interface{}{
        "Date":                  "2026-09-03",
        "MerchantUniqueCode":    "AA90T0SD0ASF99",
        "CompletePartialRefund": false,
        "MarketPlace": map[string]interface{}{
            "DeleteExistingRecords": false,
        },
    }
    reqBody, _ := json.Marshal(data)
    
    req, _ := http.NewRequest("POST", url, bytes.NewBuffer(reqBody))
    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("apikeyprivate", "%PRIVATEKEY%")
    req.Header.Set("apiclientprivate", "%PRIVATECLIENT%")
    
    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    
    body, _ := ioutil.ReadAll(resp.Body)
    fmt.Println(string(body))
}

Java

import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
import java.net.http.HttpResponse.BodyHandlers;
import java.util.HashMap;
import java.util.Map;
import com.fasterxml.jackson.databind.ObjectMapper;

public class Main {

    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();

        Map<String, Object> marketPlace = new HashMap<>();
        marketPlace.put("DeleteExistingRecords", false);

        Map<String, Object> values = new HashMap<>();
        values.put("Date", "2026-09-03");
        values.put("MerchantUniqueCode", "AA90T0SD0ASF99");
        values.put("CompletePartialRefund", false);
        values.put("MarketPlace", marketPlace);

        String requestBody = new ObjectMapper().writeValueAsString(values);

        HttpRequest request = HttpRequest.newBuilder()
                .uri(new URI("{{Payment Private Address}}/api/paywall/private/refund/v2"))
                .setHeader("Content-Type", "application/json")
                .setHeader("apikeyprivate", "%PRIVATEKEY%")
                .setHeader("apiclientprivate", "%PRIVATECLIENT%")
                .POST(HttpRequest.BodyPublishers.ofString(requestBody))
                .build();

        HttpResponse<String> response = client.send(request, BodyHandlers.ofString());

        System.out.println(response.body());
    }
}

PHP

<?php
$url = '{{Payment Private Address}}/api/paywall/private/refund/v2';
$data = array(
    "Date" => "2026-09-03",
    "MerchantUniqueCode" => "AA90T0SD0ASF99",
    "CompletePartialRefund" => false,
    "MarketPlace" => array(
        "DeleteExistingRecords" => false
    )
);
$options = array(
    'http' => array(
        'header' => "Content-type: application/json\r\n" .
            "apikeyprivate: %PRIVATEKEY%\r\n" .
            "apiclientprivate: %PRIVATECLIENT%\r\n",
        'method' => 'POST',
        'content' => json_encode($data),
    ),
);
$context = stream_context_create($options);
$result = file_get_contents($url, false, $context);
if ($result === FALSE) { /* Handle error */
}

// Decode
$response = json_decode($result);

// ErrorCode-Result-Message
if ($response) {
    echo "ErrorCode: " . ($response->ErrorCode ?? '') . "\n";
    echo "Result: " . (!empty($response->Result) ? "true" : "false") . "\n";
    echo "Message: " . ($response->Message ?? '') . "\n";
}
?>

Python

import requests
import json

url = '{{Payment Private Address}}/api/paywall/private/refund/v2'
headers = {
    'Content-Type': 'application/json',
    'apikeyprivate': '%PRIVATEKEY%',
    'apiclientprivate': '%PRIVATECLIENT%',
}
data = {
    "Date": "2026-09-03",
    "MerchantUniqueCode": "AA90T0SD0ASF99",
    "CompletePartialRefund": False,
    "MarketPlace": {
        "DeleteExistingRecords": False
    }
}
response = requests.post(url, headers=headers, data=json.dumps(data))

response_data = response.json()

print('ErrorCode:', response_data.get('ErrorCode'))
print('Result:', response_data.get('Result'))
print('Message:', response_data.get('Message'))

Ruby

require 'net/http'
require 'uri'
require 'json'

uri = URI.parse("{{Payment Private Address}}/api/paywall/private/refund/v2")
http = Net::HTTP.new(uri.host, uri.port)

request = Net::HTTP::Post.new(uri.request_uri, {
    'Content-Type' => 'application/json',
    'apikeyprivate' => '%PRIVATEKEY%',
    'apiclientprivate' => '%PRIVATECLIENT%'
})
request.body = {
    Date: "2026-09-03",
    MerchantUniqueCode: "AA90T0SD0ASF99",
    CompletePartialRefund: false,
    MarketPlace: {
        DeleteExistingRecords: false
    }
}.to_json

response = http.request(request)

puts response.body

TypeScript

const axios = require('axios');

const data = {
    Date: "2026-09-03",
    MerchantUniqueCode: "AA90T0SD0ASF99",
    CompletePartialRefund: false,
    MarketPlace: {
        DeleteExistingRecords: false
    }
};

axios.post('{{Payment Private Address}}/api/paywall/private/refund/v2', data, {
    headers: {
        'Content-Type': 'application/json',
        'apikeyprivate': '%PRIVATEKEY%',
        'apiclientprivate': '%PRIVATECLIENT%',
    }
})
    .then((response: any) => {
        console.log(response.data);
    })
    .catch((error: any) => {
        console.error(error);
    });

Curl

curl -X POST "{{Payment Private Address}}/api/paywall/private/refund/v2" \
-H "Content-Type: application/json" \
-H "apikeyprivate: %PRIVATEKEY%" \
-H "apiclientprivate: %PRIVATECLIENT%" \
-d '{
    "Date": "2026-09-03",
    "MerchantUniqueCode": "AA90T0SD0ASF99",
    "CompletePartialRefund": false,
    "MarketPlace": {
        "DeleteExistingRecords": false
    }
}'

Servisten dönen parametreler şu şekildedir:

Parametreler ve açıklamaları

Parametre	Tip	Açılama
Body	object	Ödemeye ilişkin detay içeren JSON (opsiyonel)
ErrorCode	int	Hata kodu. İşlem başarılı ise '0' değerini döner.
Result	bool	True ya da false değeri döner. İşlem başarılı iste 'true' değerini döner
Message	string	İşlem hatalıysa, bu hataya dair belirtilen mesajdır, locale parametresine göre dil desteği sunar.
Payment.PaymentId	int	İade edilen ödemenin sistem tarafından atanan benzersiz kimlik numarası.
Payment.UniqueCode	string	Ödemeye ait sistem tarafından üretilen tekil UUID değeri.
Payment.MerchantUniqueKey	string	Üye işyerine ait tekil UUID anahtar değeri.
Payment.TrackingCode	string	İade işlemine ait takip kodu.
Payment.Installment	byte	İşlemde uygulanan taksit sayısı
Payment.PaymentGatewayId	int	İşlemin gerçekleştiği sağlayıcının bağlantısının kimlik bilgisi
Payment.PaymentGatewayName	string	İşlemin gerçekleştiği sağlayıcının bağlantısına verilen isim
Payment.PaymentGatewayProviderName	string	İşlemin gerçekleştiği sağlayıcının sistem ismi
Payment.PaymentGatewayProviderKey	string	İşlemin gerçekleştiği sağlayıcının sistemdeki anahtar kodu
Payment.RelationalId1	string	Kart ile ilişkilendirilen unique bilgi
Payment.RelationalId2	string	Kart ile ilişkilendirilen ikinci unique bilgi
Payment.RelationalId3	string	Kart ile ilişkilendirilen üçüncü unique bilgi
Error.ProviderErrorCode	string	Ödeme sağlayıcısından dönen hata kodu. İşlem başarılı ise boş string döner.
Error.ProviderErrorMessage	string	Ödeme sağlayıcısından dönen hata mesajı. İşlem başarılı ise boş string döner.
ExternalInfo.PaymentActivityTypeId	int	Ödeme aktivite tipi kimliği. İade işlemleri için 2 değerini döner.
ExternalInfo.PaymentExternalAuthCode	string	Ödeme sağlayıcısından dönen yetkilendirme kodu.
ExternalInfo.PaymentExternalOrderId	string	Ödeme sağlayıcısındaki harici sipariş kimliği. Sağlayıcı tarafından dönülmüyorsa boş string olabilir.
ExternalInfo.PaymentExternalTransId	string	Ödeme sağlayıcısındaki harici işlem kimliği. Genellikle UniqueCode ile aynı değeri taşır.
ExternalInfo.PaymentExternalHostReference	string	Ödeme sağlayıcısının host sistemi tarafından atanan referans kodu.
ExternalInfo.PaymentExternalMerchantId	string	Ödeme sağlayıcısındaki harici üye işyeri kimliği. Sağlayıcı tarafından dönülmüyorsa boş string olabilir.

Json

{
    "ErrorCodeType": 1,
    "ErrorMessage": null,
    "ErrorCode": 0,
    "Result": true,
    "Message": "Payment refunded successfully",
    "Body": {
        "Payment": {
            "PaymentId": 22904168,
            "UniqueCode": "0cfe60c5-3039-40d6-bef1-3d3bad9641da",
            "MerchantUniqueKey": "f87d9c32-9ac7-4969-bbf4-3eaf2bfb6a06",
            "TrackingCode": "tracking-code-1234567890-for-documentation",
            "Installment": 1,
            "PaymentGatewayId": 1475,
            "PaymentGatewayName": "demoiyziWP",
            "PaymentGatewayProviderName": "Iyzico",
            "PaymentGatewayProviderKey": "Iyzico",
            "RelationalId1": "test24243252599390",
            "RelationalId2": "",
            "RelationalId3": ""
        },
        "Error": {
            "ProviderErrorCode": "",
            "ProviderErrorMessage": ""
        },
        "ExternalInfo": {
            "PaymentActivityTypeId": 2,
            "PaymentExternalAuthCode": "961688",
            "PaymentExternalOrderId": "",
            "PaymentExternalTransId": "0cfe60c5-3039-40d6-bef1-3d3bad9641da",
            "PaymentExternalHostReference": "mock00001iyzihostrfn",
            "PaymentExternalMerchantId": ""
        }
    }
}