2. Initiate 3D Model

When you send a request to the Paywall 3D Model payment service, if the request is successful, a Paywall payment link is returned in the response. You should open this link in your application. The li

POST {{Base Adres}}/api/paywall/payment/start3dmodel

Important: In order to use the 3D Model Initiation service, you must send the ‘apikeypublic’ and ‘apiclientpublic’ parameters in the Header field. PaymentAPI Address

Sample JSON and example codes to be sent to the service are as follows.

Parameter

Type

Compulsory

Description

apikeypublic

string

Yes

The Public Key obtained from the merchant panel.

apiclientpublic

string

Yes

The Public Client obtained from the merchant panel.

Paywall Request Payload

{
    "PaymentDetail": {
        "Amount": 1.00,
        "MerchantUniqueCode": "22123222256226225",
        "TrackingCode": "TrackingCode1",
        "Half3D": false,
        "MerchantSuccessBackUrl": "https://domain.com/callback",
        "MerchantFailBackUrl": "https://domain.com/callback",
        "ClientIP": "0.0.0.0",
        "CurrencyId": 1,
        "Installment": 1,
        "ChannelId": 0,
        "TagId": 0,
        "EndOfTheDay": 1,
        "RegionId": 1,
        "ProviderBased": false,
        "ProviderKey": "providerkey",
        "PosBased": false,
        "PosId": 0,
        "MarketPlace": {
            "BasketAmount": 1.00
        },
        "PayRouteByPass": false,
        "PayRouteType": 0,
        "RouteGroupKey": "route-003"
    },
    "Card":{
        "OwnerName":"Iyzico Kartı",
        "Number":"5528790000000008",
        "ExpireMonth":"12",
        "ExpireYear":"2030",
        "Cvv":"123",
        "ForceCvv": false, // Sadece kayıtlı kartlar için
        "UniqueCode":"",
        "TempCardToken": "",
        "Partner": { // Nullable
            "PartnerBased": false,
            "PartnerIdentity": ""
        },
        "CardSave": {
            "Nickname": "Kredi kartım",
            "RelationalId1": "userid19283746",
            "RelationalId2": "",
            "RelationalId3": "",
            "Save": true
        }
    },
    "Customer":{
        "FullName":"FullName",
        "Phone":"5336662211",
        "Email":"[email protected]",
        "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"
        }
    },
    "Products":[{
        "ProductId": "ProductId",
        "ProductName": "ProductName",
        "ProductCategory": "ProductCategory",
        "ProductDescription": "ProductDescription",
        "ProductAmount": 1.0,
        "MemberId": 0,
        "MemberCustomCommission": false,
        "MemberCommission": 0,
        "MemberEarningCalculated": false,
        "MemberEarning": 0
    }],
    "UseFraudParameters": false, 
    "FraudParameters":{     
        "BypassFraud": false,        
        "OverrideActualParameters": false,
        "DeviceFingerprint": "test-FRD",
        "Amount": 101,       
        "ClientIP": "1.1.1.1",        
        "CountryCode": "TR-FRD",        
        "UserAgent": "UserAgent-FRD",        
        "Email": "[email protected]",        
        "Phone": "5435435454-FRD",
        "UserRegisteredAt": "2026-01-13T12:00:00",
        "Location": {
            "Country": "Turkey",
            "City": "Istanbul",
            "Region": "europe",
            "Lat": "41.07",
            "Lon": "29.00"
        }
    }
}

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 Half3D { get; set; }
    }

    public class Card
    {
        public string OwnerName { get; set; }
        public string Number { get; set; }
        public string ExpireMonth { get; set; }
        public string ExpireYear { get; set; }
        public string Cvv { get; set; }
        public string UniqueCode { 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,
                Half3D = false
            },
            Card = new Card
            {
                OwnerName = "John Doe",
                Number = "5528790000000008",
                ExpireMonth = "12",
                ExpireYear = "2030",
                Cvv = "123",
                UniqueCode = ""
            },
            Customer = new Customer
            {
                FullName = "FullName",
                Phone = "5336662211",
                Email = "[email protected]",
                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/start3d";
        var response = await client.PostAsync(url, data);

        string result = response.Content.ReadAsStringAsync().Result;
        Console.WriteLine(result);
    }
}

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"`
	Half3D                 bool    `json:"Half3D"`
}

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,
			Half3D:                 false,
		},
		Card: Card{
			OwnerName:   "John Doe",
			Number:      "5528790000000008",
			ExpireMonth: "12",
			ExpireYear:  "2030",
			Cvv:         "123",
			UniqueCode:  "",
		},
		Customer: Customer{
			FullName:       "FullName",
			Phone:          "5336662211",
			Email:          "[email protected]",
			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/start3d", 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)
}

<dependencies>
    <dependency>
        <groupId>com.fasterxml.jackson.core</groupId>
        <artifactId>jackson-databind</artifactId>
        <version>2.12.5</version>
    </dependency>
    <dependency>
        <groupId>com.squareup.okhttp3</groupId>
        <artifactId>okhttp</artifactId>
        <version>4.9.0</version>
    </dependency>
</dependencies>

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("Half3D", 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/start3d")
            .post(body)
            .addHeader("Content-Type", "application/json")
            .addHeader("apikeypublic", "%%")
            .addHeader("apiclientpublic", "%%")
            .build();

        Response response = client.newCall(request).execute();
        System.out.println(response.body().string());
    }
}

<?php
$url = '{{Base Adres}}/api/paywall/payment/start3d';
$data = array(
    "PaymentDetail" => 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,
        "Half3D" => false
    ),
    "Card" => array(
        "OwnerName" => "John Doe",
        "Number" => "5528790000000008",
        "ExpireMonth" => "12",
        "ExpireYear" => "2030",
        "Cvv" => "123",
        "UniqueCode" => ""
    ),
    "Customer" => array(
        "FullName" => "FullName",
        "Phone" => "5336662211",
        "Email" => "[email protected]",
        "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);
?>

import requests
import json

url = '{{Base Adres}}/api/paywall/payment/start3d'

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,
        "Half3D": False
    },
    "Card": {
        "OwnerName": "John Doe",
        "Number": "5528790000000008",
        "ExpireMonth": "12",
        "ExpireYear": "2030",
        "Cvv": "123",
        "UniqueCode": ""
    },
    "Customer": {
        "FullName": "FullName",
        "Phone": "5336662211",
        "Email": "[email protected]",
        "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}')

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

uri = URI.parse("{{Base Adres}}/api/paywall/payment/start3d")
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,
    "Half3D" => false
  },
  "Card" => {
    "OwnerName" => "John Doe",
    "Number" => "5528790000000008",
    "ExpireMonth" => "12",
    "ExpireYear" => "2030",
    "Cvv" => "123",
    "UniqueCode" => ""
  },
  "Customer" => {
    "FullName" => "FullName",
    "Phone" => "5336662211",
    "Email" => "[email protected]",
    "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

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,
    Half3D: false
  },
  Card: {
    OwnerName: "John Doe",
    Number: "5528790000000008",
    ExpireMonth: "12",
    ExpireYear: "2030",
    Cvv: "123",
    UniqueCode: ""
  },
  Customer: {
    FullName: "FullName",
    Phone: "5336662211",
    Email: "[email protected]",
    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/start3d',
  headers: { 
    'Content-Type': 'application/json', 
    'apikeypublic': '%%', 
    'apiclientpublic': '%%'
  },
  data : data
};

axios(config)
.then(function (response: AxiosResponse<ResponseData>) {
  console.log(response.data);
})
.catch(function (error) {
  console.log(error);
});

curl --location --request POST '{{Base Adres}}/api/paywall/payment/start3d' \
--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,
        "Half3D": false
    },
    "Card": {
        "OwnerName": "John Doe",
        "Number": "5528790000000008",
        "ExpireMonth": "12",
        "ExpireYear": "2030",
        "Cvv": "123",
        "UniqueCode": ""
    },
    "Customer": {
        "FullName": "FullName",
        "Phone": "5336662211",
        "Email": "[email protected]",
        "Country": "Country",
        "City": "City",
        "Address": "Address",
        "IdentityNumber": "IdentityNumber",
        "TaxNumber": "TaxNumber"
    },
    "Products": [{
        "ProductId": "ProductId",
        "ProductName": "ProductName",
        "ProductCategory": "ProductCategory",
        "ProductDescription": "ProductDescription",
        "ProductAmount": 9.85
    }]
}'

Main Directory: `PaymentDetail`

Parameter

Type

Compulsory

Description

Amount

decimal

Yes

Payment basket amount.

MerchantUniqueCode

string

Yes

It must be the same value as the MerchantUniqueCode sent in the payment initiation request. This code is a unique value assigned by your side for the transaction. It is used to uniquely identify and track a payment in all operations such as cancel, refund, and payment inquiry. Length: 250 characters

TrackingCode

string

It can be used as a secondary tracking number for the payment on your side. You can send any additional information that needs to be associated with the MerchantUniqueCode parameter under this field.

Important note: It is not unique and can be provided multiple times. If uniqueness is required, it must be managed on your side.

MerchantSuccessBackUrl

string

Yes

The URL to which the 3D screen will be redirected via FormPost for a successful transaction. Length: 250 characters See: İncele

MerchantFailBackUrl

string

Yes

The URL to which the 3D screen will be redirected via FormPost for a failed transaction. Length: 250 characters See: Review

CurrencyId

int

Yes

Currency See: Review

Installment

int

Yes

Installment information; send 1 for a single payment.

Half3D

bool

This parameter enables you to finalize your payments with a custom call. If you send the Half3D parameter as true, the payment will remain in the bank’s authorization (provision) until you complete the payment with a finalization request.

ClientIP

string

Yes

IP address of the party performing the transaction (customer/user/member, etc.). Length: 15 characters

TagId

int?

Used when you want to apply tagging to your payments.

ChannelId

int?

Used when you want to differentiate the channels through which your payments are sent to Paywall.

EndOfTheDay

int?

End-of-day value. If you want your payment to be processed only through providers that support “Next Day” settlement, you must send this parameter with a value. See: Review

RegionId

short?

This parameter allows you to specify which country’s providers should process your payment. If not specified, your payment will be processed as "Global".

ProviderBased

bool

Used when you decide on your side which provider should process the payment.

ProviderKey

string

Yes/No

The provider key through which you want the payment to be processed. See: List

PosBased

bool

Used when you determine on your side which provider should process the payment.

PosId

int

Yes/No

The connection ID of the provider through which you want the payment to be processed. It is available in the connected providers list obtained from the Paywall panel.

PayRouteByPass

bool

Indicates whether the PayRoute configuration set in the Paywall panel should be bypassed. With this parameter, you can override the default setting and change the routing type for a specific payment.

PayRouteType

short

Yes/No

If the PayRouteByPass parameter is sent as true, the PayRouteType parameter must also be provided. You can specify the routing type for the payment using this parameter. See: PayRoute Types

RouteGroupKey

string

Yes/No

If a RouteGroup is configured for PayRoute in the Paywall panel, or if PayRoute is bypassed for the payment and PayRouteType is set to RouteGroup, you must specify with this parameter which RouteGroup the payment will be processed under.

MarketPlace > BasketAmount

decimal

Used within the scope of a marketplace.

Main Directory: Card

Parameter

Type

Compolsory

Description

OwnerName

string

Yes/No

Full name of the cardholder from whom the payment will be taken. Length: 150 characters

Number

string

Yes/No

Card number from which the payment will be taken. Length: 20 characters

ExpireMonth

string

Yes/No

Expiration month of the card from which the payment will be taken.

ExpireYear

string

Yes/No

Expiration year of the card from which the payment will be taken.

Cvv

string

Yes/No

Security code (CVV) of the card from which the payment will be taken.

ForceCvv

bool

Used only for stored cards. With this parameter, you can also collect the CVV from your users for stored cards and send it within the payment request.

If you do not send this parameter as true for stored cards, Paywall will ignore all parameters except the UniqueCode parameter.

UniqueCode

string

Yes/No

Identity information of the stored card. It is returned by Paywall during the save and listing processes.

TempCardToken

string

Yes/No

Parameter to be used when you want to receive a payment using a temporarily stored card (Client-Side Tokenization).

Partner? > PartnerBased

bool?

Yes/No

Parameter to be used when you structure cards on a partner-based model.

Partner? > PartnerIdentity

string

Yes/No

When you structure cards on a partner-based model, this is your company’s partner identification in Paywall. You can obtain this information from the Paywall panel.

CardSave? > Save

bool

Yes/No

During the payment, if you want the card to be saved upon a successful transaction, this parameter should be sent as true. When sent as true, the other parameters under the CardSave object will be taken into account.

CardSave? > Nickname

string

Yes/No

Alias name of the card.

CardSave? > RelationalId1

string

Yes/No

Association value of the card.

CardSave? > RelationalId2

string

Yes/No

Secondary (hierarchical/tree-structured) association value of the card.

CardSave? > RelationalId3

string

Yes/No

Third (hierarchical/tree-structured) association value of the card.

Main Directory: Customer

Parameter

Type

Compolsory

Description

FullName

string

Yes

First name of the recipient on the merchant side.

Phone

string

Yes

GSM (mobile phone) number of the recipient on the merchant side.

string

Yes

Email address of the recipient on the merchant side.

Country

string

Yes

Country information of the recipient on the merchant side.

City

string

Yes

City information of the recipient on the merchant side.

Address

string

Yes

Registered address of the recipient on the merchant side.

IdentityNumber

string

Identification number (TCKN) of the recipient on the merchant side.

TaxNumber

string

Tax identification number of the recipient on the merchant side.

DeviceFingerprint

string

Device fingerprint information of the recipient on the merchant side.

UserAgent

string

User agent information currently used by the recipient on the merchant side.

UserRegisteredAt

datetime

The user's registration date in your system.

Location

The object containing the user’s location information.

Main Directory: Product<Array>

Parameter

Type

Compolsory

Description

ProductId

string

Yes

Product ID

ProductName

string

Yes

Product name

ProductCategory

string

Yes

Product category

ProductDescription

string

Yes

Product description.

ProductAmount

decimal

Yes

Product price information.

MemberId

int?

Yes/No

Required for the Marketplace model. It must be filled with the MemberId information of the sub-merchant in the Paywall system.

MemberEarningCalculated

bool?

Yes/No

Within the scope of the marketplace, if you calculate the sub-merchant’s earnings, you must send this parameter as true.

MemberEarning

decimal?

Yes/No

Within the scope of the marketplace, if you calculate the sub-merchant’s earnings, you must send the earning amount to Paywall using this parameter.

MemberCustomCommission

bool

Yes/No

Within the scope of the marketplace, this parameter is used if you want to define a commission for the sub-merchant for this specific sale.

MemberCommission

decimal?

Yes/No

Within the scope of the marketplace, if you want to define a commission for the sub-merchant for this specific sale, this parameter is used to send the commission amount.

Main Directory: Location

Country

string

The user’s country information.

City

string

The user’s city information.

Region

string

The user’s region information.

Lat

string

The latitude of the user’s location on the map.

Lon

string

The longitude of the user’s location on the map.

Main Directory: FraudParameters

For the parameters in the FraudParameters directory to be valid for fraud checks, the UserFraudParameters field in the Main Directory must be sent as true. Otherwise, fraud checks will be performed using the information in PaymentDetail.

Parameter

Type

Compolsory

Description

BypassFraud

string

Yes

If sent as true, it allows previously configured fraud checks to be bypassed.

OverrideActualParameters

string

Yes

If sent as true, the process will continue and be recorded using the parameters under "FraudParameters" instead of those under "PaymentDetail" for fraud checks.

DeviceFingerprint

string

Device fingerprint information to be used in fraud checks.

Amount

string

Amount information to be used in fraud checks.

ClientIP

string

Customer IP information to be used in fraud checks.

CountryCode

string

Country code information to be used in fraud checks.

UserAgent

string

List of UserAgents to be used in fraud checks.

string

Email address information to be used in fraud checks.

Phone

string

Phone number information to be used in fraud checks.

UserRegisteredAt

datetime

The user's registration date in your system.

Location

The object containing the user’s location information.

Paywall Response

Parameter

Type

Description

ErrorCode

int

Error code. Returns “0” if the operation is successful.

Result

bool

Returns a true or false value. Returns “true” if the operation is successful.

Message

string

If the operation fails, this is the message describing the error; it provides language support based on the locale parameter.

Body

object

If the operation fails, this is the code associated with the error.

{
    "ErrorCodeType": 1,
    "ErrorMessage": null,
    "ErrorCode": 0,
    "Result": true,
    "Message": "Success",
    "Body": {
        "Message": null,
        "RedirectUrl": "https://dev-payment-agent.itspaywall.com/paywall/callback?UniqueNumber=f514466e-8060-47ef-a566-c8bf087644d2",
        "Payment": {
            "PaymentId": 20798344,
            "ActivityId": 54667483,
            "UniqueCode": "f514466e-8060-47ef-a566-c8bf087644d2",
            "MerchantUniqueKey": "8e48b6e9-5b64-4e8d-9c49-c7fc5b63f27e",
            "PaymentGatewayId": 73,
            "PaymentGatewayName": "ConnectedProviderName",
            "PaymentGatewayProviderName": "ProviderName",
            "PaymentGatewayProviderKey": "ProviderKey",
            "Products": [
                {
                    "Id": 22471169,
                    "MemberId": 22408,
                    "ProductId": "product-id-1234567890",
                    "ProductName": "Hizmet",
                    "ProductCategory": "123",
                    "ProductDescription": "Nakliye 123",
                    "ProductAmount": 104.00,
                    "IsMarketPlaceSales": false,
                    "MemberEarningCalculated": false,
                    "MemberEarning": 0
                }
            ]
        },
        "Fraud": {
            "Evaluated": true,
            "Action": "Allow",
            "Score": 0,
            "MatchedRules": "",
            "BlockedByBlacklist": false,
            "BlacklistType": null,
            "ReviewUrl": "",
            "IsAsyncFraudPending": false
        }
    }
}

{
    "ErrorCode": 0,
    "Result": true,
    "Message": "Success",
    "Body": {
        "Message": null,
        "RedirectUrl": "https://dev-payment-agent.itspaywall.com/paywall/callback?UniqueNumber=xxxxxx-xxxxxxx-xxxxxxx-xxxxxx",
        "Payment": {
            "PaymentId": 1918272,
            "ActivityId": 3820721,
            "UniqueCode": "87e30149-817b-42cf-a8a8-81af2af5722b",
            "MerchantUniqueKey": "96aaa33633aaaa3aaaaa3aa2aa2322a2aaaa4a21331a234aas33aaaa3aasa"
        },
        "Fraud":{ 
        "Evaluated": true,
        "Action": "Block",
        "Score": 70,
        "MatchedRules": "Temp email detected "
    }
}

{
    "ErrorCode": 0,
    "Result": true,
    "Message": "Success",
    "Body": {
        "Message": null,
        "RedirectUrl": "https://dev-payment-agent.itspaywall.com/paywall/callback?UniqueNumber=xxxxxx-xxxxxxx-xxxxxxx-xxxxxx",
        "Payment": {
            "PaymentId": 1918272,
            "ActivityId": 3820721,
            "UniqueCode": "87e30149-817b-42cf-a8a8-81af2af5722b",
            "MerchantUniqueKey": "96aaa33633aaaa3aaaaa3aa2aa2322a2aaaa4a21331a234aas33aaaa3aasa"
        },
        "Fraud":{ 
        "Evaluated": true,
        "Action": "Block",
        "Score": 100,
        "MatchedRules": "Temp email detected "
    }
}

{
    "ErrorCode": 0,
    "Result": true,
    "Message": "Success",
    "Body": {
        "Message": null,
        "RedirectUrl": "https://dev-payment-agent.itspaywall.com/paywall/callback?UniqueNumber=xxxxxx-xxxxxxx-xxxxxxx-xxxxxx",
        "Payment": {
            "PaymentId": 1918272,
            "ActivityId": 3820721,
            "UniqueCode": "87e30149-817b-42cf-a8a8-81af2af5722b",
            "MerchantUniqueKey": "96aaa33633aaaa3aaaaa3aa2aa2322a2aaaa4a21331a234aas33aaaa3aasa"
        },
        "Fraud":{ 
        "Evaluated": true,
        "Action": "Review",
        "Score": 0,
        "MatchedRules": "Temp email detected "
    }
}

Previous1. Initiate 3D Pay Next5. Provision Close

Last updated 22 days ago

Main Directory: PaymentDetail

Main Directory: `PaymentDetail`