> For the complete documentation index, see [llms.txt](https://developer.paywall.one/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.paywall.one/odeme-servisi/3.-non-secure-sigorta.md).
# 3. Non-Secure (Sigorta)
{% hint style="danger" %}
Not: Sigortacılık alanındaki işleyişi desteklemek ve kolaylaştırmak adına Kart numarasının ilk 8 ve son 4 hanesi ile işlem gerçekleştirilmesi için uygulanan bir yöntemdir.
{% endhint %}
`POST` `{{Base Adres}}/api/paywall/payment/startdirect/insurance`
{% hint style="info" %}
Önemli: **Ödeme** servisini kullanabilmeniz için 'Header' alanında '**apikeypublic**' ve '**apiclientpublic**' parametrelerini göndermeniz gerekmektedir.\
\
[**PaymentAPI Adresi**](/ortam.md)
{% endhint %}
**Servise gönderilecek örnek ****JSON**** ve ****örnek kodlar**** aşağıdaki gibidir.**
| Parametre | Tip | Zorunlu | Açıklama |
|---|
| apikeypublic | string | Evet | Üye işyeri panelinden temin etmiş olduğunuz Public Key. |
| apiclientpublic | string | Evet | Üye işyeri panelinden temin etmiş olduğunuz Public Client. |
**Paywall İstek Payload**
{% tabs %}
{% tab title="JSON" %}
{% code lineNumbers="true" %}
```json5
{
"PaymentDetail": {
"Amount": 4.44,
"MerchantUniqueCode": "{{$guid}}",
"TrackingCode": "TrackingCode1",
"CurrencyId": 1,
"MerchantSuccessBackUrl": "https://itspaywall.com/successful",
"MerchantFailBackUrl": "https://itspaywall.com/unsuccessful",
"Installment": 1,
"ChannelId": 0,
"TagId": 0,
"ClientIP": "1.1.1.1",
"ProviderBased": false,
"ProviderKey": "providerkey",
"PosBased": false,
"PosId": 0,
"Half2D": false,
"PayRouteByPass": false,
"PayRouteType": 0,
"RouteGroupKey": "route-003"
},
"Card": {
"OwnerName": "test",
"CardNoFirst": "41197901",
"CardNoLast": "6389",
"IdentityNumber": "17654932298",
"UseAdditionalIdentityNumber": true,
"AdditionalIdentityNumber": "1010101010"
"UniqueCode": "",
"CardSave": {
"Nickname": "test karti",
"RelationalId1": "007",
"RelationalId2": "",
"RelationalId3": "",
"Save": false
}
},
"Customer": {
"FullName": "FullName",
"Phone": "5555555555",
"Email": "enes@paywall.one",
"Country": "Country",
"City": "City",
"Address": "Address",
"IdentityNumber": "IdentityNumber",
"TaxNumber": "TaxNumber"
"DeviceFingerprint": "FingerPrint",
"UserAgent": "UserAgent",
"UserRegisteredAt": "2026-01-13T12:00:00",
"Location": {
"Country": "Turkey",
"City": "Istanbul",
"Region": "europe",
"Lat": "41.07",
"Lon": "29.00"
}
},
"UseFraudParameters": false,
"FraudParameters":{
"BypassFraud": false,
"OverrideActualParameters": false,
"DeviceFingerprint": "test-FRD",
"Amount": 101,
"ClientIP": "1.1.1.1",
"CountryCode": "TR-FRD",
"UserAgent": "UserAgent-FRD",
"Email": "FRD@gmail.com",
"Phone": "5435435454-FRD",
"UserRegisteredAt": "2026-01-13T12:00:00",
"Location": {
"Country": "Turkey",
"City": "Istanbul",
"Region": "europe",
"Lat": "41.07",
"Lon": "29.00"
}
}
}
```
{% endcode %}
{% endtab %}
{% tab title="C#" %}
using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
public class Program
{
static readonly HttpClient client = new HttpClient();
public class PaymentDetail
{
public double Amount { get; set; }
public string MerchantUniqueCode { get; set; }
public int CurrencyId { get; set; }
public string MerchantSuccessBackUrl { get; set; }
public string MerchantFailBackUrl { get; set; }
public int Installment { get; set; }
public int ChannelId { get; set; }
public int TagId { get; set; }
public bool Half2D { get; set; }
}
public class CardInsurance
{
public string OwnerName { get; set; }
public string UniqueCode { get; set; }
public CardSave? CardSave { get; set; }
public string IdentityNumber { get; set; }
public string CardNoFirst { get; set; }
public string CardNoLast { get; set; }
public string TempCardToken { get; set; }
}
public class Customer
{
public string FullName { get; set; }
public string Phone { get; set; }
public string Email { get; set; }
public string Country { get; set; }
public string City { get; set; }
public string Address { get; set; }
public string IdentityNumber { get; set; }
public string TaxNumber { get; set; }
}
public class Product
{
public string ProductId { get; set; }
public string ProductName { get; set; }
public string ProductCategory { get; set; }
public string ProductDescription { get; set; }
public double ProductAmount { get; set; }
}
public class Root
{
public PaymentDetail PaymentDetail { get; set; }
public Card Card { get; set; }
public Customer Customer { get; set; }
public Product[] Products { get; set; }
}
public static async Task Main()
{
Root root = new Root
{
PaymentDetail = new PaymentDetail
{
Amount = 9.85,
MerchantUniqueCode = "AJSHFSAKFHASKHFA",
CurrencyId = 1,
MerchantSuccessBackUrl = "https://merchantsite.site.com/success",
MerchantFailBackUrl = "https://merchantsite.site.com/fail",
Installment = 1,
ChannelId = 0,
TagId = 0,
Half2D = false
},
Card = new Card
{
OwnerName = "John Doe",
IdentityNumber = "11111111110",
CardNoFirst = "54456766",
CardNoLast = "1234",
UniqueCode = ""
},
Customer = new Customer
{
FullName = "FullName",
Phone = "5336662211",
Email = "enes@xcompany.com",
Country = "Country",
City = "City",
Address = "Address",
IdentityNumber = "IdentityNumber",
TaxNumber = "TaxNumber"
},
Products = new Product[] {
new Product {
ProductId = "ProductId",
ProductName = "ProductName",
ProductCategory = "ProductCategory",
ProductDescription = "ProductDescription",
ProductAmount = 9.85
}
}
};
string json = JsonConvert.SerializeObject(root, Formatting.Indented);
var data = new StringContent(json, Encoding.UTF8, "application/json");
client.DefaultRequestHeaders.Add("apikeypublic", "%%");
client.DefaultRequestHeaders.Add("apiclientpublic", "%%");
var url = "{{Base Adres}}/api/paywall/payment/startdirect/insurance";
var response = await client.PostAsync(url, data);
string result = response.Content.ReadAsStringAsync().Result;
Console.WriteLine(result);
}
}
{% endtab %}
{% tab title="GO" %}
```go
package main
import (
"bytes"
"encoding/json"
"fmt"
"io/ioutil"
"net/http"
)
type PaymentDetail struct {
Amount float64 `json:"Amount"`
MerchantUniqueCode string `json:"MerchantUniqueCode"`
CurrencyId int `json:"CurrencyId"`
MerchantSuccessBackUrl string `json:"MerchantSuccessBackUrl"`
MerchantFailBackUrl string `json:"MerchantFailBackUrl"`
Installment int `json:"Installment"`
ChannelId int `json:"ChannelId"`
TagId int `json:"TagId"`
Half2D bool `json:"Half2D"`
}
type Card struct {
OwnerName string `json:"OwnerName"`
Number string `json:"Number"`
ExpireMonth string `json:"ExpireMonth"`
ExpireYear string `json:"ExpireYear"`
Cvv string `json:"Cvv"`
UniqueCode string `json:"UniqueCode"`
}
type Customer struct {
FullName string `json:"FullName"`
Phone string `json:"Phone"`
Email string `json:"Email"`
Country string `json:"Country"`
City string `json:"City"`
Address string `json:"Address"`
IdentityNumber string `json:"IdentityNumber"`
TaxNumber string `json:"TaxNumber"`
}
type Product struct {
ProductId string `json:"ProductId"`
ProductName string `json:"ProductName"`
ProductCategory string `json:"ProductCategory"`
ProductDescription string `json:"ProductDescription"`
ProductAmount float64 `json:"ProductAmount"`
}
type Data struct {
PaymentDetail PaymentDetail `json:"PaymentDetail"`
Card Card `json:"Card"`
Customer Customer `json:"Customer"`
Products []Product `json:"Products"`
}
type ResponseData struct {
ErrorCode int
Result bool
Message string
Body string
}
func main() {
data := Data{
PaymentDetail: PaymentDetail{
Amount: 9.85,
MerchantUniqueCode: "AJSHFSAKFHASKHFA",
CurrencyId: 1,
MerchantSuccessBackUrl: "https://merchantsite.site.com/success",
MerchantFailBackUrl: "https://merchantsite.site.com/fail",
Installement: 1,
ChannelId: 0,
TagId: 0,
Half2D: false,
},
Card: Card{
OwnerName: "John Doe",
Number: "5528790000000008",
ExpireMonth: "12",
ExpireYear: "2030",
Cvv: "123",
UniqueCode: "",
},
Customer: Customer{
FullName: "FullName",
Phone: "5336662211",
Email: "enes@xcompany.com",
Country: "Country",
City: "City",
Address: "Address",
IdentityNumber: "IdentityNumber",
TaxNumber: "TaxNumber",
},
Products: []Product{
{
ProductId: "ProductId",
ProductName: "ProductName",
ProductCategory: "ProductCategory",
ProductDescription: "ProductDescription",
ProductAmount: 9.85,
},
},
}
payloadBuf := new(bytes.Buffer)
json.NewEncoder(payloadBuf).Encode(data)
req, _ := http.NewRequest("POST", "{{Base Adres}}/api/paywall/payment/startdirect/insurance", payloadBuf)
req.Header.Set("Content-Type", "application/json")
req.Header.Set("apikeypublic", "%%")
req.Header.Set("apiclientpublic", "%%")
client := &http.Client{}
res, e := client.Do(req)
if e != nil {
panic(e)
}
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
var responseData ResponseData
json.Unmarshal(body, &responseData)
fmt.Println("ErrorCode: ", responseData.ErrorCode)
fmt.Println("Result: ", responseData.Result)
fmt.Println("Message: ", responseData.Message)
fmt.Println("Body: ", responseData.Body)
}
```
{% endtab %}
{% tab title="Java" %}
```xml
com.fasterxml.jackson.core
jackson-databind
2.12.5
com.squareup.okhttp3
okhttp
4.9.0
```
```java
import okhttp3.*;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.node.ObjectNode;
import java.io.IOException;
public class Main {
public static void main(String[] args) throws IOException {
OkHttpClient client = new OkHttpClient();
ObjectMapper mapper = new ObjectMapper();
// Create JSON in a readable way
ObjectNode rootNode = mapper.createObjectNode();
rootNode.put("Amount", 9.85);
rootNode.put("MerchantUniqueCode", "AJSHFSAKFHASKHFA");
rootNode.put("CurrencyId", 1);
rootNode.put("MerchantSuccessBackUrl", "https://merchantsite.site.com/success");
rootNode.put("MerchantFailBackUrl", "https://merchantsite.site.com/fail");
rootNode.put("Installment", 1);
rootNode.put("ChannelId", 0);
rootNode.put("TagId", 0);
rootNode.put("Half2D", false);
// and so on for all fields
String json = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(rootNode);
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, json);
Request request = new Request.Builder()
.url("{{Base Adres}}/api/paywall/payment/startdirect/insurance")
.post(body)
.addHeader("Content-Type", "application/json")
.addHeader("apikeypublic", "%%")
.addHeader("apiclientpublic", "%%")
.build();
Response response = client.newCall(request).execute();
System.out.println(response.body().string());
}
}
```
{% endtab %}
{% tab title="PHP" %}
```php
array(
"Amount" => 9.85,
"MerchantUniqueCode" => "AJSHFSAKFHASKHFA",
"CurrencyId" => 1,
"MerchantSuccessBackUrl" => "https://merchantsite.site.com/success",
"MerchantFailBackUrl" => "https://merchantsite.site.com/fail",
"Installment" => 1,
"ChannelId" => 0,
"TagId" => 0,
"Half2D" => false
),
"Card" => array(
"OwnerName" => "John Doe",
"Number" => "5528790000000008",
"ExpireMonth" => "12",
"ExpireYear" => "2030",
"Cvv" => "123",
"UniqueCode" => ""
),
"Customer" => array(
"FullName" => "FullName",
"Phone" => "5336662211",
"Email" => "enes@xcompany.com",
"Country" => "Country",
"City" => "City",
"Address" => "Address",
"IdentityNumber" => "IdentityNumber",
"TaxNumber" => "TaxNumber"
),
"Products" => array(
array(
"ProductId" => "ProductId",
"ProductName" => "ProductName",
"ProductCategory" => "ProductCategory",
"ProductDescription" => "ProductDescription",
"ProductAmount" => 9.85
)
)
);
$options = array(
'http' => array(
'header' => "Content-type: application/json\r\n" .
"apikeypublic: %PUBLICKEY%\r\n" .
"apiclientpublic: %PUBLICCLIENT%\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";
// Decode Body
$body = json_decode($response->Body);
var_dump($result);
?>
```
{% endtab %}
{% tab title="Python" %}
```python
import requests
import json
url = '{{Base Adres}}/api/paywall/payment/startdirect/insurance'
headers = {
'Content-Type': 'application/json',
'apikeypublic': '%%',
'apiclientpublic': '%%'
}
data = {
"PaymentDetail": {
"Amount": 9.85,
"MerchantUniqueCode": "AJSHFSAKFHASKHFA",
"CurrencyId": 1,
"MerchantSuccessBackUrl": "https://merchantsite.site.com/success",
"MerchantFailBackUrl": "https://merchantsite.site.com/fail",
"Installment": 1,
"ChannelId": 0,
"TagId": 0,
"Half2D": False
},
"Card": {
"OwnerName": "John Doe",
"Number": "5528790000000008",
"ExpireMonth": "12",
"ExpireYear": "2030",
"Cvv": "123",
"UniqueCode": ""
},
"Customer": {
"FullName": "FullName",
"Phone": "5336662211",
"Email": "enes@xcompany.com",
"Country": "Country",
"City": "City",
"Address": "Address",
"IdentityNumber": "IdentityNumber",
"TaxNumber": "TaxNumber"
},
"Products": [{
"ProductId": "ProductId",
"ProductName": "ProductName",
"ProductCategory": "ProductCategory",
"ProductDescription": "ProductDescription",
"ProductAmount": 9.85
}]
}
response = requests.post(url, headers=headers, data=json.dumps(data))
if response.status_code == 200:
response_data = response.json()
print("ErrorCode: ", response_data.get('ErrorCode'))
print("Result: ", response_data.get('Result'))
print("Message: ", response_data.get('Message'))
body = json.loads(response_data.get('Body'))
print(body)
else:
print(f'Request failed with status code {response.status_code}')
```
{% endtab %}
{% tab title="Ruby" %}
```ruby
require 'net/http'
require 'uri'
require 'json'
uri = URI.parse("{{Base Adres}}/api/paywall/payment/startdirect/insurance")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri.path, {
'Content-Type' => 'application/json',
'apikeypublic' => '%%',
'apiclientpublic' => '%%'
})
request.body = JSON.generate({
"PaymentDetail" => {
"Amount" => 9.85,
"MerchantUniqueCode" => "AJSHFSAKFHASKHFA",
"CurrencyId" => 1,
"MerchantSuccessBackUrl" => "https://merchantsite.site.com/success",
"MerchantFailBackUrl" => "https://merchantsite.site.com/fail",
"Installment" => 1,
"ChannelId" => 0,
"TagId" => 0,
"Half2D" => false
},
"Card" => {
"OwnerName" => "John Doe",
"Number" => "5528790000000008",
"ExpireMonth" => "12",
"ExpireYear" => "2030",
"Cvv" => "123",
"UniqueCode" => ""
},
"Customer" => {
"FullName" => "FullName",
"Phone" => "5336662211",
"Email" => "enes@xcompany.com",
"Country" => "Country",
"City" => "City",
"Address" => "Address",
"IdentityNumber" => "IdentityNumber",
"TaxNumber" => "TaxNumber"
},
"Products" => [
{
"ProductId" => "ProductId",
"ProductName" => "ProductName",
"ProductCategory" => "ProductCategory",
"ProductDescription" => "ProductDescription",
"ProductAmount" => 9.85
}
]
})
response = http.request(request)
puts response.body
```
{% endtab %}
{% tab title="TypeScript" %}
```typescript
import axios, { AxiosResponse } from 'axios';
interface ResponseData {
ErrorCode: number;
Result: boolean;
Message: string;
Body: string;
}
let data = {
PaymentDetail: {
Amount: 9.85,
MerchantUniqueCode: "AJSHFSAKFHASKHFA",
CurrencyId: 1,
MerchantSuccessBackUrl: "https://merchantsite.site.com/success",
MerchantFailBackUrl: "https://merchantsite.site.com/fail",
Installment: 1,
ChannelId: 0,
TagId: 0,
Half2D: false
},
Card: {
OwnerName: "John Doe",
Number: "5528790000000008",
ExpireMonth: "12",
ExpireYear: "2030",
Cvv: "123",
UniqueCode: ""
},
Customer: {
FullName: "FullName",
Phone: "5336662211",
Email: "enes@xcompany.com",
Country: "Country",
City: "City",
Address: "Address",
IdentityNumber: "IdentityNumber",
TaxNumber: "TaxNumber"
},
Products: [{
ProductId: "ProductId",
ProductName: "ProductName",
ProductCategory: "ProductCategory",
ProductDescription: "ProductDescription",
ProductAmount: 9.85
}]
};
let config = {
method: 'post',
url: '{{Base Adres}}/api/paywall/payment/startdirect/insurance',
headers: {
'Content-Type': 'application/json',
'apikeypublic': '%%',
'apiclientpublic': '%%'
},
data : data
};
axios(config)
.then(function (response: AxiosResponse) {
console.log(response.data);
})
.catch(function (error) {
console.log(error);
});
```
{% endtab %}
{% tab title="Curl" %}
```sh
curl --location --request POST '{{Base Adres}}/api/paywall/payment/startdirect/insurance' \
--header 'Content-Type: application/json' \
--header 'apikeypublic: %%PUBLICKEY%%' \
--header 'apiclientpublic: %%PUBLICCLIENT%%' \
--data-raw '{
"PaymentDetail": {
"Amount": 9.85,
"MerchantUniqueCode": "FASLSZDPOT3535BFNGI",
"CurrencyId": 1,
"MerchantSuccessBackUrl": "https://merchantsite.site.com/success",
"MerchantFailBackUrl": "https://merchantsite.site.com/fail",
"Installment": 1,
"ChannelId": 0,
"TagId": 0,
"Half2D": false
},
"Card": {
"OwnerName": "John Doe",
"Number": "5528790000000008",
"ExpireMonth": "12",
"ExpireYear": "2030",
"Cvv": "123",
"UniqueCode": ""
},
"Customer": {
"FullName": "FullName",
"Phone": "5336662211",
"Email": "enes@xcompany.com",
"Country": "Country",
"City": "City",
"Address": "Address",
"IdentityNumber": "IdentityNumber",
"TaxNumber": "TaxNumber"
},
"Products": [{
"ProductId": "ProductId",
"ProductName": "ProductName",
"ProductCategory": "ProductCategory",
"ProductDescription": "ProductDescription",
"ProductAmount": 9.85
}]
}'
```
{% endtab %}
{% endtabs %}
**Gerekli istek parametreleri :**
Ana Dizin: PaymentDetail
| Parametre | Tip | Zorunlu | Açıklama |
|---|
| Amount | decimal | Evet | Ödeme sepet tutarı. |
| 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.
Uzunluk: 250 karakter |
| TrackingCode | string | Hayır | Ödeme'nin tarafınızdaki ikincil takip numarası olarak kullanılabilir. MerchantUniqueCode parametresine ek ilişkilendirmeniz gereken ek bilgiyi bu parametre altında gönderebilirsiniz.
Önemli not: Tekil değildir, tekrar tekrar verilebilir. İhtiyaç halinde tekilliği sizin tarafınızdan yönetilmelidir |
| CurrencyId | int | Evet | Para birimi
Bkz: İncele |
| Installment | int | Evet | Taksit bilgisi, tek çekim için 1 gönderilmelidir |
| ClientIP | string | Evet | İşlemi gerçekleştiren tarafın IP bilgisi. Müşteri/Kullanıcı/Üye vb.
Uzunluk: 15 karakter |
| TagId | int? | Hayır | Ödemelerinize etiketleme uygulamak istediğinizde kullanılır |
| ChannelId | int? | Hayır | Ödemelerinizin Paywall'a iletildiği kanalları ayrıştırmak istediğinizde kullanılır |
| EndOfTheDay | int? | Hayır | Gün sonu değeridir. Bağlı sağlayıcılar arasından ödemenizin sadece "Ertesi Gün" ödemeleri sağlayıcılardan geçmesini istediğinizde bu parametreyi dolu göndermelisiniz
Bkz: İncele |
| RegionId | short? | Hayır | Ödemenizin hangi ülke altındaki sağlayıcılardan geçmesini istediğinizi belirtebileceğiniz parametredir. Belirtilmediği durumda ödemeniz 'Global' olarak işlenir |
| ProviderBased | bool | Hayır | Ödemenizin hangi sağlayıcıdan geçmesi gerektiğine kendi tarafınızda karar verdiğinizde kullanılır |
| ProviderKey | string | Evet/Hayır | Ödemenizin geçmesini istediğiniz sağlayıcı anahtarı
Bkz: Liste |
| PosBased | bool | Hayır | Ödemenizin hangi sağlayıcıdan geçmesi gerektiğine kendi tarafınızda karar verdiğinizde kullanılır |
| PosId | int | Evet/Hayır | Ödemenizin geçmesini istediğiniz sağlayıcının bağlantı kimlik numarasıdır. Paywall panelinden temin bağlı sağlayıcılar listesinde yer almaktadır |
| PayRouteByPass | bool | Hayır | Paywall panelinden ayarlanan PayRoute ayarlı bypass edilmek isteniyor mu? Bu parametreyle varsayılan ayarı ezebilir, ödeme özelinde routing tipini değiştirebilirsiniz |
| PayRouteType | short | Evet/Hayır | PayRouteByPass parametresinin true gönderilmesi durumda, PayRouteType parametresi de dolu gönderilmelidir. Ödeme özelinde routing tipinin ne olacağını bu parametreyle belirtebilirsiniz
Bkz: PayRoute Tipleri |
| RouteGroupKey | string | Evet/Hayır | Paywall panelinden PayRoute'un RouteGroup ayarlanması veya ödeme özelinde PayRoute'un bypass edilmesi ve PayRouteType'ın RouteGroup olarak belirtilmesi durumda ödemenin hangi RouteGroup özelinde işleneceğini bu parametreyle belirtmeniz gerekmektedir |
| MarketPlace > BasketAmount | decimal | Hayır | Pazaryeri kapsamında kullanılır |
Ana Dizin: Card
| Parametre | Tip | Zorunlu | Açıklama |
|---|
| OwnerName | string | Evet/Hayır | Ödemenin alınacağı kart sahibinin adı soyadı.
Uzunluk: 150 karakter |
| CardNoFirst | string | Evet/Hayır | Kart numarasının ilk 8 rakamı
Uzunluk: 20 karakter
|
| CardNoLast | string | Evet/Hayır | kart numarasının son 4 rakamı |
| IdentityNumber | string | Evet/Hayır | Kullanıcının TCKN numarası veya vergi kimlik numarası |
| UseAdditionalIdentityNumber | bool | Evet/Hayır | Sigortacılık ödemelerinde kullanılan kartlar bazı durumlarda TCKN bazı durumlarda ise VKN bilgisine bağlı olabilir. Bu ayrımdan emin değilseniz ve kart sahibinin her 2 bilgisine de sahipseniz, 2 bilgiyi de aynı anda Paywall'a iletebilirsiniz. Paywall öncelikli olarak IdentityNumber ile ödemeyi almayı dener, eğer ödeme başarısız olursa ve UseAdditionalIdentityNumber parametresini true göndermişseniz, başarsız olan ödeme bir de AdditionalIdentityNumber parametresi ile denenir |
| AdditionalIdentityNumber | string | Evet/Hayır | Kart sahibinin alternatif kimlik bilgisi. UseAdditionalIdentityNumber parametresi true gönderildiğinde kullanılır |
| UniqueCode | string | Evet/Hayır | Kayıtlı karta ait kimlik bilgisi. Kaydetme ve listeleme anında Paywall'dan döner |
| TempCardToken | string | Evet/Hayır | Geçici kayıtlı kart (Client-Side Tokenization) ile ödeme almak istediğinizde kullanılması gereken parametredir |
Partner? >
PartnerBased | bool? | Evet/Hayır | Kartları Partner tabanlı kurguladığınızda kullanılacak parametredir |
Partner? >
PartnerIdentity | string | Evet/Hayır | Kartları Partner tabanlı kurguladığınızda, şirketinizin Paywall'daki partnerlik kimlik bilgisidir. Bu bilgiyi Paywall panelinden edinebilirsiniz |
CardSave? >
Save | bool | Evet/Hayır | Ödeme anında, ödemenin başarılı olması durumunda kartın kayıt edilmesi istenirse True gönderilmelidir. True gönderildiğinde CardSave objesi altındaki diğer parametreler dikkate alınır |
CardSave? >
Nickname | string | Evet/Hayır | Kart'a ait takma isimdir |
CardSave? >
RelationalId1 | string | Evet/Hayır | Kart'ın ilişki değeridir |
CardSave? >
RelationalId2 | string | Evet/Hayır | Kart'ın ikinci (ağaç yapısı) ilişki değeridir |
CardSave? >
RelationalId3 | string | Evet/Hayır | Kart'ın üçüncü (ağaç yapısı) ilişki değeridir |
Ana Dizin: Customer
| Parametre | Tip | Zorunlu | Açıklama |
|---|
| FullName | string | Evet | Üye işyeri tarafındaki alıcıya ait ad |
| Phone | string | Evet | Üye işyeri tarafındaki alıcıya ait GSM numarası. |
| Email | string | Evet | İşyeri tarafındaki alıcıya ait e-posta bilgisi. |
| Country | string | Evet | Üye işyeri tarafındaki alıcıya ait ülke bilgisi. |
| City | string | Evet | Üye işyeri tarafındaki alıcıya ait şehir bilgisi. |
| Address | string | Evet | Üye işyeri tarafındaki alıcıya ait kayıt adresi. |
| IdentityNumber | string | Hayır | Üye işyeri tarafındaki alıcıya ait kimlik (TCKN) numarası. |
| TaxNumber | string | Hayır | Üye işyeri tarafındaki alıcıya ait vergi kimlik numarası. |
| DeviceFingerprint | string | Hayır | Üye işyeri tarafındaki alıcıya ait cihaz parmak izi bilgisi |
| UserAgent | string | Hayır | Üye işyeri tarafındaki alıcıya ait kullanımda olan useragent bilgileri |
| UserRegisteredAt | datetime | Hayır | Kullanıcının sisteminizdeki kayıt tarihidir. UTC olarak gönderilmelidir. |
| Location | Location | Hayır | Kullanıcının konum bilgilerinin iletildiği obje |
Ana Dizin: Location
| Parametre | Tip | Zorunlu | Açıklama |
|---|
| Country | string | Hayır | Kullanıcının ülke bilgisi |
| City | string | Hayır | Kullanıcının şehir bilgisi |
| Region | string | Hayır | Kullanıcının bölge bilgisi |
| Lat | string | Hayır | Kullanıcı konumunun harita üzerindeki enlem bilgisi |
| Lon | string | Hayır | Kullanıcı konumunun harita üzerindeki boylam bilgisi |
{% hint style="info" %}
Fraud kontrolleri için FraudParameters dizini içindeki parametrelerin geçerli olması için Ana Dizin içerisinde bulunan UserFraudParameters bilgisinin **True** olarak gönderilmesi gerekmektedir. Aksi durumda PaymentDetail içerisindeki bilgiler ile Fraud kontrolü yapılacaktır.
{% endhint %}
Ana Dizin: FraudParameters
| Parametre | Tip | Zorunlu | Açıklama |
|---|
| ByPassFraud | string | Evet | True gönderilmesi durumunda önceden ayarlanmış fraud kontrollerinin bypass edilmesini sağlar. |
| OverrideActualParameters | string | Evet | True gönderilmesi durumunda fraud kontrolleri için "PaymentDetail" dizini altındaki parametreler yerine "FraudParameters" altındaki parametreler ile işlemler devam eder ve kayıt altına alınır. |
| DeviceFingerprint | string | Hayır | Fraud kontrolüne girecek cihaz parmak izi bilgisi. |
| Amount | string | Hayır | Fraud kontrolüne girecek tutar bilgisi. |
| ClientIP | string | Hayır | Fraud kontrolüne girecek müşteri IP bilgisi. |
| CountryCode | string | Hayır | Fraud kontrolüne girecek ülke kodu bilgisi. |
| UserAgent | string | Hayır | Fraud kontrolüne girecek UserAgent'ların listesi |
| Email | string | Hayır | Fraud kontrolüne girecek e-mail adres bilgisi |
| Phone | string | Hayır | Fraud kontrolüne girecek telefon numarası bilgisi |
| UserRegisteredAt | datetime | Hayır | Kullanıcının sisteminizdeki kayıt tarihidir. UTC olarak gönderilmelidir. |
| Location | Location | Hayır | Kullanıcının konum bilgilerinin iletildiği obje |
**Servisten dönen parametreler şu şekildedir:**
Parametre 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. |
| Body | nesne | İşlem hatalıysa, bu hataya dair belirtilen kodudur. |
{% tabs %}
{% tab title="JSON" %}
{% code lineNumbers="true" %}
```json
{
"ErrorCodeType": 1,
"ErrorMessage": null,
"ErrorCode": 0,
"Result": true,
"Message": "",
"Body": {
"Payment": {
"PaymentId": 2090323,
"ActivityId": 4201860,
"UniqueCode": "142e9761-9591-4b33-a61f-a2f81f9cc1ec",
"MerchantUniqueKey": "3ef9ef3f-5cc8-46bf-84ee-03f665c698c6",
"TrackingCode": "tracking-code-1234567890-for-documentation",
"PaymentGatewayId": 4939,
"PaymentGatewayName": "gg",
"PaymentGatewayProviderId": 1052,
"PaymentGatewayProviderName": "ProviderName",
"PaymentGatewayProviderKey": "ProviderKey",
"Products": [
{
"Id": 24156879,
"MemberId": 0,
"ProductId": "test-id-1234567890-for-documentation",
"ProductName": "test Hizmeti",
"ProductCategory": "test",
"ProductDescription": "test 123",
"ProductAmount": 100.0,
"IsMarketPlaceSales": false,
"MemberEarningCalculated": false,
"MemberEarning": 0.0
}
],
"Card": {
"Saved": false,
"RelationalId1": "",
"RelationalId2": "",
"RelationalId3": "",
"UniqueCode": ""
},
"ExternalInfo": {
"PaymentActivityTypeId": 0,
"PaymentExternalAuthCode": "",
"PaymentExternalOrderId": "",
"PaymentExternalTransId": "",
"PaymentExternalHostReference": "",
"PaymentExternalMerchantId": ""
}
},
"Error": {
"ProviderErrorCode": null,
"ProviderErrorMessage": null,
"BankErrorCode": null,
"BankErrorMessage": null,
"IsHttpError": false,
"HttpStatusCode": 200,
"HasPaywallUnifiedError": false,
"UnifiedByPaywall": {
"ErrorCode": "",
"ErrorMessage": ""
}
},
"Fraud": {
"Evaluated": true,
"Action": "Allow",
"Score": 0,
"MatchedRules": "",
"FraudRuleIds": "",
"FraudRuleExternalIds": "",
"BlockedByBlacklist": false,
"BlacklistType": null,
"Message": "",
"ReviewUrl": "",
"IsAsyncFraudPending": false
}
}
}
```
{% endcode %}
{% endtab %}
{% tab title="JSON - Fraud Review" %}
{% code lineNumbers="true" %}
```json
{
"ErrorCodeType": 1,
"ErrorMessage": null,
"ErrorCode": 0,
"Result": true,
"Message": "",
"Body": {
"Payment": {
"PaymentId": 2090323,
"ActivityId": 4201860,
"UniqueCode": "142e9761-9591-4b33-a61f-a2f81f9cc1ec",
"MerchantUniqueKey": "3ef9ef3f-5cc8-46bf-84ee-03f665c698c6",
"TrackingCode": "tracking-code-1234567890-for-documentation",
"PaymentGatewayId": 4939,
"PaymentGatewayName": "gg",
"PaymentGatewayProviderId": 1052,
"PaymentGatewayProviderName": "ProviderName",
"PaymentGatewayProviderKey": "ProviderKey",
"Products": [
{
"Id": 24156879,
"MemberId": 0,
"ProductId": "test-id-1234567890-for-documentation",
"ProductName": "test Hizmeti",
"ProductCategory": "test",
"ProductDescription": "test 123",
"ProductAmount": 100.0,
"IsMarketPlaceSales": false,
"MemberEarningCalculated": false,
"MemberEarning": 0.0
}
],
"Card": {
"Saved": false,
"RelationalId1": "",
"RelationalId2": "",
"RelationalId3": "",
"UniqueCode": ""
},
"ExternalInfo": {
"PaymentActivityTypeId": 0,
"PaymentExternalAuthCode": "",
"PaymentExternalOrderId": "",
"PaymentExternalTransId": "",
"PaymentExternalHostReference": "",
"PaymentExternalMerchantId": ""
}
},
"Error": {
"ProviderErrorCode": null,
"ProviderErrorMessage": null,
"BankErrorCode": null,
"BankErrorMessage": null,
"IsHttpError": false,
"HttpStatusCode": 200,
"HasPaywallUnifiedError": false,
"UnifiedByPaywall": {
"ErrorCode": "",
"ErrorMessage": ""
}
},
"Fraud": {
"Evaluated": true,
"Action": "Review",
"Score": 0,
"MatchedRules": "test2",
"FraudRuleIds": "aa43f0f3-b539-4c3e-bf8e-2169d507583d",
"FraudRuleExternalIds": "",
"BlockedByBlacklist": false,
"BlacklistType": null,
"Message": "Ödeme incelemeye alındı",
"ReviewUrl": "",
"IsAsyncFraudPending": false
}
}
}
```
{% endcode %}
{% endtab %}
{% tab title="JSON - Fraud Score Block" %}
{% code lineNumbers="true" %}
```json
{
"ErrorCodeType": 1,
"ErrorMessage": null,
"ErrorCode": 0,
"Result": true,
"Message": "",
"Body": {
"Payment": {
"PaymentId": 2090323,
"ActivityId": 4201860,
"UniqueCode": "142e9761-9591-4b33-a61f-a2f81f9cc1ec",
"MerchantUniqueKey": "3ef9ef3f-5cc8-46bf-84ee-03f665c698c6",
"TrackingCode": "tracking-code-1234567890-for-documentation",
"PaymentGatewayId": 4939,
"PaymentGatewayName": "gg",
"PaymentGatewayProviderId": 1052,
"PaymentGatewayProviderName": "ProviderName",
"PaymentGatewayProviderKey": "ProviderKey",
"Products": [
{
"Id": 24156879,
"MemberId": 0,
"ProductId": "test-id-1234567890-for-documentation",
"ProductName": "test Hizmeti",
"ProductCategory": "test",
"ProductDescription": "test 123",
"ProductAmount": 100.0,
"IsMarketPlaceSales": false,
"MemberEarningCalculated": false,
"MemberEarning": 0.0
}
],
"Card": {
"Saved": false,
"RelationalId1": "",
"RelationalId2": "",
"RelationalId3": "",
"UniqueCode": ""
},
"ExternalInfo": {
"PaymentActivityTypeId": 0,
"PaymentExternalAuthCode": "",
"PaymentExternalOrderId": "",
"PaymentExternalTransId": "",
"PaymentExternalHostReference": "",
"PaymentExternalMerchantId": ""
}
},
"Error": {
"ProviderErrorCode": null,
"ProviderErrorMessage": null,
"BankErrorCode": null,
"BankErrorMessage": null,
"IsHttpError": false,
"HttpStatusCode": 200,
"HasPaywallUnifiedError": false,
"UnifiedByPaywall": {
"ErrorCode": "",
"ErrorMessage": ""
}
},
"Fraud": {
"Evaluated": true,
"Action": "Block",
"Score": 70,
"MatchedRules": "test2",
"FraudRuleIds": "kk43f0f3-b639-4c3e-kf8e-2169d507582c",
"FraudRuleExternalIds": "",
"BlockedByBlacklist": false,
"BlacklistType": null,
"Message": "Yüksek risk sebebi ile engellendi",
"ReviewUrl": "",
"IsAsyncFraudPending": false
}
}
}
```
{% endcode %}
{% endtab %}
{% tab title="JSON - Block" %}
{% code lineNumbers="true" %}
```json
{
"ErrorCodeType": 1,
"ErrorMessage": null,
"ErrorCode": 0,
"Result": true,
"Message": "",
"Body": {
"Payment": {
"PaymentId": 2090323,
"ActivityId": 4201860,
"UniqueCode": "142e9761-9591-4b33-a61f-a2f81f9cc1ec",
"MerchantUniqueKey": "3ef9ef3f-5cc8-46bf-84ee-03f665c698c6",
"TrackingCode": "tracking-code-1234567890-for-documentation",
"PaymentGatewayId": 4939,
"PaymentGatewayName": "gg",
"PaymentGatewayProviderId": 1052,
"PaymentGatewayProviderName": "ProviderName",
"PaymentGatewayProviderKey": "ProviderKey",
"Products": [
{
"Id": 24156879,
"MemberId": 0,
"ProductId": "test-id-1234567890-for-documentation",
"ProductName": "test Hizmeti",
"ProductCategory": "test",
"ProductDescription": "test 123",
"ProductAmount": 100.0,
"IsMarketPlaceSales": false,
"MemberEarningCalculated": false,
"MemberEarning": 0.0
}
],
"Card": {
"Saved": false,
"RelationalId1": "",
"RelationalId2": "",
"RelationalId3": "",
"UniqueCode": ""
},
"ExternalInfo": {
"PaymentActivityTypeId": 0,
"PaymentExternalAuthCode": "",
"PaymentExternalOrderId": "",
"PaymentExternalTransId": "",
"PaymentExternalHostReference": "",
"PaymentExternalMerchantId": ""
}
},
"Error": {
"ProviderErrorCode": null,
"ProviderErrorMessage": null,
"BankErrorCode": null,
"BankErrorMessage": null,
"IsHttpError": false,
"HttpStatusCode": 200,
"HasPaywallUnifiedError": false,
"UnifiedByPaywall": {
"ErrorCode": "",
"ErrorMessage": ""
}
},
"Fraud": {
"Evaluated": true,
"Action": "Block",
"Score": 100,
"MatchedRules": "test2",
"FraudRuleIds": "aa43f0f3-b539-4c3e-bf8e-2169d507582c",
"FraudRuleExternalIds": "",
"BlockedByBlacklist": false,
"BlacklistType": null,
"Message": "Ödeme engellendi",
"ReviewUrl": "",
"IsAsyncFraudPending": false
}
}
}
```
{% endcode %}
{% endtab %}
{% endtabs %}