3. Non-Secure (Insurance)

The Direct Payment service initiates the payment collection process from the card information as soon as you send the request and returns the transaction result within the response.

triangle-exclamation

POST {{Base Adres}}/api/paywall/payment/startdirect/insurance

circle-info

Important: To use the payment service, you must send the parameters apikeypublic and apiclientpublic in the 'Header' field.

PaymentAPI Address

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

Parameter
Type
Compulsory
Description

apikeypublic

string

Yes

The Public Key you obtained from the merchant panel.

apiclientpublic

string

Yes

The Public Client you obtained from the merchant panel.

Paywall Request Payload

{
    "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": "[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"
        }
    },
    "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"
        }
    }
}

Main Directory: PaymentDetail

Parameter
Type
Compulsory
Description

Amount

decimal

Yes

Payment cart amount.

MerchantUniqueCode

string

Yes

It must be the same value as the MerchantUniqueCode in the request sent to initiate the payment. This code is the unique value assigned to the transaction by you. It is used to uniquely identify and track a payment for cancellation, refund, or payment inquiry operations.

Length: 250 characters

CurrencyId

int

Yes

Currency Bkz: Review

Installment

int

Yes

Installment information should be sent as 1 for a single payment.

Half2D

bool

No

It is the parameter that will assist you in finalizing your payments through a special call. If you send the Half2D parameter as true, your payment will remain in provisional status at the bank until you make the payment completion call.

ClientIP

string

Yes

The IP information of the party performing the transaction, such as the customer/user/member, etc. Length: 15 characters

TagId

int?

No

It is used when you want to apply tagging to your payments.

ChannelId

int?

No

It is used when you want to separate the channels through which your payments are sent to Paywall.

EndOfTheDay

int?

No

It is the end-of-day value. You should send this parameter as filled when you want only the "Next Day" payments to pass through the providers among the linked providers. Bkz: Review

RegionId

short?

No

It is the parameter that allows you to specify which country's providers you want your payment to pass through. If not specified, your payment will be processed as 'Global'.

ProviderBased

bool

No

It is used when you have decided on your own which provider should handle your payment.

ProviderKey

string

Yes/No

The provider key through which you want your payment to be processed.

MarketPlace > BasketAmount

decimal

No

It is used within the marketplace scope.

Main Directory: Card

Parameter
Type
Compulsory
Description

OwnerName

string

Yes/No

The full name of the cardholder from whom the payment will be collected. Length: 60 characters

CardNoFirst

string

Yes/No

The first 8 digits of the card number

Length: 20 characters

CardNoLast

string

Yes/No

The last 4 digits of the card number

InquiryValue

string

Yes/No

The user's TCKN number or tax identification number

UniqueCode

string

Yes/No

Identity information associated with the registered card. Returned by Paywall during saving and listing.

TempCardToken

string

Yes/No

It is the parameter to be used when you want to receive payment with a temporary saved card (Client-Side Tokenization).

Partner? > PartnerBased

bool?

Yes/No

It is the parameter to be used when you set up cards based on a partner model.

Partner? > PartnerIdentity

string

Yes/No

When you set up cards based on a partner model, this is your company's partnership ID in Paywall. You can obtain this information from the Paywall panel.

CardSave? > Save

bool

Yes/No

At the time of payment, if the card should be saved upon successful payment, True should be sent. When True is sent, the other parameters under the CardSave object are taken into account.

CardSave? > Nickname

string

Yes/No

It is the nickname for the card.

CardSave? > RelationalId1

string

Yes/No

It is the relationship value of the card.

CardSave? > RelationalId2

string

Yes/No

It is the second (tree structure) relationship value of the card.

CardSave? > RelationalId3

string

Yes/No

It is the third (tree structure) relationship value of the card.

Main Directory: Customer

Parameter
Type
Compulsory
Description

FullName

string

Yes

The name of the recipient on the merchant side.

Phone

string

Yes

The mobile phone number of the recipient on the merchant side.

Email

string

Yes

The email address of the recipient on the merchant side.

Country

string

Yes

The country information of the recipient on the merchant side.

City

string

Yes

The city information of the recipient on the merchant side.

Address

string

Yes

The registered address of the recipient on the merchant side.

IdentityNumber

string

No

The identity (TCKN) number of the recipient on the merchant side.

TaxNumber

string

No

The tax identification number of the recipient on the merchant side.

DeviceFingerprint

string

No

Device fingerprint information of the recipient on the merchant side.

UserAgent

string

No

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

UserRegisteredAt

datetime

No

The user's registration date in your system.

Location

Location

No

The object containing the user’s location information.

Ana Dizin: Location

Parameter
Type
Compulsory
Description

Country

string

No

The user’s country information.

City

string

No

The user’s city information.

Region

string

No

The user’s region information.

Lat

string

No

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

Lon

string

No

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

Main Directory: Product<Array>

circle-info

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
Compulsory
Description

ByPassFraud

string

Yes

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

OverrideActualParameters

string

Yes

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

DeviceFingerprint

string

No

Device fingerprint information to be used in fraud checks.

Amount

string

No

Amount information to be used in fraud checks.

ClientIP

string

No

Customer IP information to be used in fraud checks.

CountryCode

string

No

Country code information to be used in fraud checks.

UserAgent

string

No

List of UserAgents to be used in fraud checks.

Email

string

No

Email address information to be used in fraud checks.

Phone

string

No

Phone number information to be used in fraud checks.

UserRegisteredAt

datetime

No

The user's registration date in your system.

Location

Location

No

The object that contains the user’s location information.

Last updated