paynkolay

PayNKolay API

PayNKolay sanal POS API entegrasyonu. Authentication All requests require an sx token provided by PayNKolay. Different operations may require different sx…

Payments#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

PayNKolay sanal POS API entegrasyonu.

Authentication

All requests require an sx token provided by PayNKolay. Different operations may require different sx token variants:

  • sx: Standard payment token
  • sx-list: Token with list permission suffix
  • sx-cancel: Token with cancel/refund permission suffix

Hash Verification (hashDatav2)

Most endpoints require a hashDatav2 field for request integrity. The hash is computed as:

hashDatav2 = base64(SHA512(field1 + "|" + field2 + "|" + ... + "|" + merchantSecretKey))

The fields included in the hash vary per endpoint and are documented in each operation's description.

See: https://paynkolay.com.tr/entegrasyon/hash-hazirlama

Response Codes

CodeMeaning
0Error / Failed
2Success

Currency Codes

CodeCurrency
949TRY
840USD
978EUR

Test Cards

Use these cards with the Test server (paynkolaytest.nkolayislem.com.tr).

BankCard NumberExpiryCVV
QNB Finansbank415565010041611101/2030715
Garanti BBVA528939472289501601/2030030
Ziraat Bankası454671123456789412/2026000
Ziraat Bankası444676312581362312/2040000
Denizbank520019000972149501/2030462
Türkiye Finans521848796245975212/2040000
Türkiye Finans606043308729019012/2040000
Türkiye Finans479915089608173412/2040000
Türkiye Finans537719376282330712/2040000
ING Bank455571455571455612/2030000
ING Bank526973732005052112/2040000
Anadolubank425846425846425312/2026000
Akbank540435540435540512/2026001

The live list is maintained on the documentation site and may change; check it if a card stops working.

See: https://paynkolay.com.tr/entegrasyon/07-test-cards.php

Test Credentials

The test environment is shared and these credentials are public. Use them with the Test server only.
Test merchant: 400000273 (client id 118591467). Production credentials are shown in your paynkolay panel.

CredentialValue
sx118591467|W8a1JLU8A5Cw+HfadVcO6HiR/GGGxr0NkWr2OGythr8fo0YWdw70cvnI6oKMqvzra3Qu+Wa5u0NRil9gRdJmjocVNd4XciDwfD9+pkVqDErw7/pVZfpcSO+GePg+ZvcqFbOO5A==
sx-list118591467|W8a1JLU8A5Cw+HfadVcO6HiR/GGGxr0NkWr2OGythr8fo0YWdw70cvnI6oKMqvzra3Qu+Wa5u0NRil9gRdJmjocVNd4XciDwfD9+pkVqDErw7/pVZfpcSO+GePg+ZvcqFbOO5A==|3hJpHVF2cqvcCZ4q6F7rcA==
sx-cancel118591467|W8a1JLU8A5Cw+HfadVcO6HiR/GGGxr0NkWr2OGythr8fo0YWdw70cvnI6oKMqvzra3Qu+Wa5u0NRil9gRdJmjocVNd4XciDwfD9+pkVqDErw7/pVZfpcSO+GePg+ZvcqFbOO5A==|yDUZaCk6rsoHZJWI3d471A/+TJA7C81X
merchantSecretKey_viH5wUS4HiBmmw9uGybN

Insurance payments (/Vpos/v1/InsurancePayment) use separate test merchants (400001647, 400001820);
see https://paynkolay.com.tr/entegrasyon/46-insurance-payment.php

Notifications

There is no server-to-server webhook for API payments. 3D Secure results are POSTed to your
successUrl / failUrl; non-3D results are returned synchronously. Use PaymentList or
PfTransactionReportList to confirm the final state of a transaction.

Endpoints 20

Payment

  • POSTCreate a payment/Vpos/v1/PaymentInitiates a credit card payment. Supports 3D Secure, installments, card storage, and pre-authorization. To keep card data off your servers, prefer the hosted…
  • POSTCreate a payment (with PayNKolay installment data)/Vpos/Payment/PaymentInitiates a payment using installment data retrieved from the PaymentInstallments endpoint. The EncodedValue from the installments response must be included.…
  • POSTComplete a 3D Secure payment/Vpos/v1/CompletePaymentAfter a 3D Secure redirect, call this endpoint to finalize the payment using the reference code.
  • POSTGet installment options for a card/Vpos/Payment/PaymentInstallmentsRetrieves available installment plans for a given card number and amount. The card number can be the full number or just the first 8 digits (BIN).
  • POSTGet merchant installment table/Vpos/Payment/GetMerchandInformationRetrieves the full installment rate table for the merchant. Hash computation: sx + "|" + date + "|" + merchantSecretKey
  • POSTList payments/Vpos/Payment/PaymentListRetrieves payments within a date range (max 1 month), optionally filtered by clientRefCode. Refunds appear as separate rows dated on the refund day; a cancel…

CancelRefund

  • POSTCancel or refund a payment/Vpos/v1/CancelRefundPaymentCancels (same-day) or refunds (past) a payment by its reference code. type: cancel for same-day cancellation type: refund for refund (past transactions) Hash…

PayByLink

  • POSTCreate a shared payment page link/Vpos/by-link-createCreates a hosted payment page URL. The customer is redirected to this page to complete payment. Hash computation: sx + "|" + clientRefCode + "|" + amount +…
  • POSTDelete a shared payment page link/Vpos/by-link-url-removeRemoves a previously created shared payment page link. Hash computation: sx + "|" + q + "|" + merchantSecretKey
  • POSTCreate and send a payment link via SMS/email/Vpos/pay-by-link-createCreates a payment link and optionally sends it to the customer via SMS and/or email. Hash computation: TOKEN + "|" + FULL_NAME + "|" + EMAIL + "|" + GSM + "|"…

Recurring

  • POSTCreate a recurring payment instruction/Vpos/api/RecurringPaymentCreateCreates a recurring (scheduled) payment instruction for a customer. Hash computation: sx + "|" + Gsm + "|" + Amount + "|" + ClientRefCode + "|" +…
  • POSTCancel a recurring payment instruction/Vpos/api/RecurringPaymentCancelCancels an active recurring payment instruction. Hash computation: sx + "|" + InstructionNumber + "|" + merchantSecretKey
  • POSTList recurring payment instructions/Vpos/api/RecurringPaymentListRetrieves a list of recurring payment instructions, optionally filtered by date range and customer info.

CardStorage

  • POSTList stored cards for a customer/Vpos/Payment/CardStorageCardListRetrieves all stored cards for a given customer key. Cards are stored by calling /Vpos/v1/Payment with csAutoSave=true and csCustomerKey on a successful 3D…
  • POSTDelete a stored card/Vpos/Payment/CardStorageCardDeleteDeletes a stored card by its token (read the token from CardStorageCardList first). Hash computation: sx + "|" + customerKey + "|" + tranId + "|" + token +…

PreAuthorization

  • POSTApprove (capture) a pre-authorized payment/Vpos/Payment/PreAuthorizationAproveCaptures a previously pre-authorized amount. Hash computation: sx + "|" + trxDate + "|" + amount + "|" + referenceCode + "|" + merchantSecretKey
  • POSTList pre-authorized payments/Vpos/Payment/PreAuthorizationListRetrieves pre-authorized payments within a date range (max 30 days). Hash computation: sx + "|" + endDate + "|" + startDate + "|" + merchantSecretKey
  • POSTCancel a pre-authorized payment/Vpos/Payment/PreAuthorizationCancelReleases a previously pre-authorized (blocked) amount. Hash computation: sx + "|" + trxDate + "|" + amount + "|" + referenceCode + "|" + transactionType + "|"…

Reporting

  • POSTTransaction report/Vpos/Payment/PfTransactionReportListPaginated transaction report for a date range, optionally filtered by your clientReferenceCode or the paynkolay referenceCode. Send a unique…

Insurance

  • POSTInsurance payment with national ID (TCKN)/Vpos/v1/InsurancePaymentNon-3D payment flow for insurance companies. Requires MCC 6300 and Non Secure permission on the merchant. In addition to standard payment fields, the card…

API details

Base URL
https://paynkolay.nkolayislem.com.tr
https://paynkolaytest.nkolayislem.com.tr
Authentication
An API key in the X-SX-Token header
Operations
20 operations on 20 pathsPOST 20
Main resources
Payment 6PayByLink 3PreAuthorization 3Recurring 3CardStorage 2CancelRefund 1Insurance 1Reporting 1
Response formats
application/json
Description format
OpenAPI 3.0.3, API version 1.1.0

How to test the PayNKolay API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the PayNKolay API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the X-SX-Token header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Create a payment” (POST /Vpos/v1/Payment), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the PayNKolay API?

PayNKolay sanal POS API entegrasyonu. Authentication All requests require an sx token provided by PayNKolay. Different operations may require different sx… It is listed under Payments and has 20 endpoints.

Who publishes the PayNKolay API?

It is listed from paynkolay's public API description (an OpenAPI document), not published by paynkolay on Swastik Codes. Anyone who controls paynkolay.com.tr can claim the profile by adding a DNS TXT record.

What is the base URL of the PayNKolay API?

Its description lists 2 base URLs: https://paynkolay.nkolayislem.com.tr, https://paynkolaytest.nkolayislem.com.tr. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the PayNKolay API?

With an API key in the X-SX-Token header.

How many endpoints does the PayNKolay API have?

20 operations on 20 paths (20 POST). The largest groups are Payment, PayByLink, PreAuthorization, Recurring.

Is forking the PayNKolay API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.