1. Ödeme Kimlik

Ödeme Kimlik (PaymentId) ile İptal Servisi

İptal

POST {{Private Base Address}}/api/paywall/private/cancel/by/paymentid

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: Ödeme Kimlik ile İptal 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

PaymentId

int

Evet

Ödeme başlatma sonrasında Paywall'dan gelen cevap nesnesi içerisinde yer alan PaymentId parametresi içerisindeki bilgidir

Date

date

Evet

İşlem tarihi.

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

Servise gönderilmesi gereken parametreler şu şekildedir :

{
    "Date": "2023-01-23",
    "PaymentId": 948488884,
    "MarketPlace": { // nullable
        "DeleteExistingRecords": false
    }
}

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-01-23",
            MerchantUniqueCode = "12222a2222a",
        };
        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/cancel", content);

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

package main

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

func main() {
    url := "{{Private Base Address}}/api/paywall/private/cancel"
    data := map[string]interface{}{
        "Date": "2023-01-23",
        "MerchantUniqueCode": "12222a2222a",
    }
    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))
}

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, Object> values = new HashMap<String, Object>() {{
            put("Date", "2023-01-23");
            put("MerchantUniqueCode", "12222a2222a");
        }};

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

        HttpRequest request = HttpRequest.newBuilder()
                .uri(new URI("{{Private Base Address}}/api/paywall/private/cancel"))
                .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

$url = '{{Private Base Address}}/api/paywall/private/cancel';
$data = array(
    'Date' => '2023-01-23',
    'MerchantUniqueCode' => '12222a2222a',
);

$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 */ }

var_dump($result);
?>

import requests
import json

url = "{{Private Base Address}}/api/paywall/private/cancel"
headers = {
    'Content-Type': 'application/json',
    'apikeyprivate': '%PRIVATEKEY%',
    'apiclientprivate': '%PRIVATECLIENT%',
}
data = {
    "Date": "2023-01-23",
    "MerchantUniqueCode": "12222a2222a",
}

response = requests.post(url, headers=headers, data=json.dumps(data))

print(response.json())

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

uri = URI.parse("{{Private Base Address}}/api/paywall/private/cancel")
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-01-23", MerchantUniqueCode: "12222a2222a"}.to_json

response = http.request(request)

puts response.body

import axios from 'axios';

const data = {
    Date: "2023-01-23",
    MerchantUniqueCode: "12222a2222a",
};

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

curl -X POST "{{Private Base Address}}/api/paywall/private/cancel" \
-H "Content-Type: application/json" \
-H "apikeyprivate: %PRIVATEKEY%" \
-H "apiclientprivate: %PRIVATECLIENT%" \
-d '{
    "Date": "2023-01-23",
    "MerchantUniqueCode": "12222a2222a"
}'

Servisten dönen parametreler şu şekildedir:

Parametreler ve açıklamaları

Parametre

Tip

Açıklama

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.

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

İptal V2

POST {{Private Base Address}}/api/paywall/private/cancel/v2/by/paymentid

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.

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

PaymentId

int

Evet

Ödeme başlatma sonrasında Paywall'dan gelen cevap nesnesi içerisinde yer alan PaymentId parametresi içerisindeki bilgidir

Date

date

Evet

İşlem tarihi.

MarketPlace:DeleteExistingRecords

bool

Hayır

Servise gönderilmesi gereken parametreler şu şekildedir :

{
    "Date": "2026-05-21",
    "PaymentId": 123456789,
    "MarketPlace": { // nullable
        "DeleteExistingRecords": false
    }
}

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-01-23",
            MerchantUniqueCode = "12222a2222a",
        };
        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/cancel", content);

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

package main

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

func main() {
    url := "{{Private Base Address}}/api/paywall/private/cancel"
    data := map[string]interface{}{
        "Date": "2023-01-23",
        "MerchantUniqueCode": "12222a2222a",
    }
    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))
}

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, Object> values = new HashMap<String, Object>() {{
            put("Date", "2023-01-23");
            put("MerchantUniqueCode", "12222a2222a");
        }};

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

        HttpRequest request = HttpRequest.newBuilder()
                .uri(new URI("{{Private Base Address}}/api/paywall/private/cancel"))
                .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

$url = '{{Private Base Address}}/api/paywall/private/cancel';
$data = array(
    'Date' => '2023-01-23',
    'MerchantUniqueCode' => '12222a2222a',
);

$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 */ }

var_dump($result);
?>

import requests
import json

url = "{{Private Base Address}}/api/paywall/private/cancel"
headers = {
    'Content-Type': 'application/json',
    'apikeyprivate': '%PRIVATEKEY%',
    'apiclientprivate': '%PRIVATECLIENT%',
}
data = {
    "Date": "2023-01-23",
    "MerchantUniqueCode": "12222a2222a",
}

response = requests.post(url, headers=headers, data=json.dumps(data))

print(response.json())

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

uri = URI.parse("{{Private Base Address}}/api/paywall/private/cancel")
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-01-23", MerchantUniqueCode: "12222a2222a"}.to_json

response = http.request(request)

puts response.body

import axios from 'axios';

const data = {
    Date: "2023-01-23",
    MerchantUniqueCode: "12222a2222a",
};

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

curl -X POST "{{Private Base Address}}/api/paywall/private/cancel" \
-H "Content-Type: application/json" \
-H "apikeyprivate: %PRIVATEKEY%" \
-H "apiclientprivate: %PRIVATECLIENT%" \
-d '{
    "Date": "2023-01-23",
    "MerchantUniqueCode": "12222a2222a"
}'

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.

PaymentId

int

İade edilen ödemenin sistem tarafından atanan benzersiz kimlik numarası.

UniqueCode

string

Ödemeye ait sistem tarafından üretilen tekil UUID değeri.

MerchantUniqueKey

string

Üye işyerine ait tekil UUID anahtar değeri.

TrackingCode

string

İade işlemine ait takip kodu.

ProviderErrorCode

string

Ödeme sağlayıcısından dönen hata kodu. İşlem başarılı ise boş string döner.

ProviderErrorMessage

string

Ödeme sağlayıcısından dönen hata mesajı. İşlem başarılı ise boş string döner.

PaymentActivityTypeId

int

Ödeme aktivite tipi kimliği. İade işlemleri için 2 değerini döner.

PaymentExternalAuthCode

string

Ödeme sağlayıcısından dönen yetkilendirme kodu.

PaymentExternalOrderId

string

Ödeme sağlayıcısındaki harici sipariş kimliği. Sağlayıcı tarafından dönülmüyorsa boş string olabilir.

PaymentExternalTransId

string

Ödeme sağlayıcısındaki harici işlem kimliği. Genellikle UniqueCode ile aynı değeri taşır.

PaymentExternalHostReference

string

Ödeme sağlayıcısının host sistemi tarafından atanan referans kodu.

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.

{
    "ErrorCodeType": 1,
    "ErrorMessage": null,
    "ErrorCode": 0,
    "Result": true,
    "Message": "Payment cancelled successfully",
    "Body": {
        "Payment": {
            "PaymentId": 123456789,
            "UniqueCode": "aabbccdd-1122-3344-5566-aabbccddeeff",
            "MerchantUniqueKey": "aabbccdd-1122-3344-5566-aabbccddeeff",
            "TrackingCode": "tracking-code-1234567890-for-documentation"
        },
        "Error": {
            "ProviderErrorCode": "",
            "ProviderErrorMessage": ""
        },
        "ExternalInfo": {
            "PaymentActivityTypeId": 3,
            "PaymentExternalAuthCode": "123456",
            "PaymentExternalOrderId": "",
            "PaymentExternalTransId": "aabbccdd-1122-3344-5566-aabbccddeeff",
            "PaymentExternalHostReference": "mock00001iyzihostrfn",
            "PaymentExternalMerchantId": ""
        }
    }
}

Previous11. İptal Next2. Paywall İşlem Numarası

Last updated 1 month ago