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

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.

Servise gönderilmesi gereken parametreler şu şekildedir:

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

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 = "2023-02-07",
            MerchantUniqueCode = "AA90T0SD0ASF99"
        };
        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("{{Private Base 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 := "{{Private Base Address}}/api/paywall/private/refund"
    data := map[string]string{
        "Date": "2023-02-07",
        "MerchantUniqueCode": "AA90T0SD0ASF99",
    }
    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.HttpHeaders;
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;

public class Main {

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

        Map<String, String> values = new HashMap<String, String>() {{
            put("Date", "2023-02-07");
            put("MerchantUniqueCode", "AA90T0SD0ASF99");
        }};

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

        HttpRequest request = HttpRequest.newBuilder()
                .uri(new URI("{{Private Base 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 = '{{Private Base Address}}/api/paywall/private/refund';
$data = array(
    "Date" => "2023-02-07",
    "MerchantUniqueCode" => "AA90T0SD0ASF99",
);
$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
echo "ErrorCode: " . $response->ErrorCode . "\n";
echo "Result: " . ($response->Result ? "true" : "false") . "\n";
echo "Message: " . $response->Message . "\n";
?>

Python

import requests
import json

url = '{{Private Base Address}}/api/paywall/private/refund'
headers = {
    'Content-Type': 'application/json',
    'apikeyprivate': '%PRIVATEKEY%',
    'apiclientprivate': '%PRIVATECLIENT%',
}
data = {
    "Date": "2023-02-07",
    "MerchantUniqueCode": "AA90T0SD0ASF99",
}
response = requests.post(url, headers=headers, data=json.dumps(data))

response_data = response.json()

print('ErrorCode:', response_data['ErrorCode'])
print('Result:', response_data['Result'])
print('Message:', response_data['Message'])

Ruby

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

uri = URI.parse("{{Private Base 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: "2023-02-07", MerchantUniqueCode: "AA90T0SD0ASF99"}.to_json

response = http.request(request)

puts response.body

TypeScript

const axios = require('axios');

const data = {
    Date: "2023-02-07",
    MerchantUniqueCode: "AA90T0SD0ASF99"
};

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

Curl

curl -X POST "{{Private Base Address}}/api/paywall/private/refund" \
-H "Content-Type: application/json" \
-H "apikeyprivate: %PRIVATEKEY%" \
-H "apiclientprivate: %PRIVATECLIENT%" \
-d '{
    "Date": "2023-02-07",
    "MerchantUniqueCode": "AA90T0SD0ASF99"
}'

Servisten dönen cevap:

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
}