Skip to content
Documentation

Shopping Loan Overview

What is PaynKolay Shopping Loan?

Section titled “What is PaynKolay Shopping Loan?”

PaynKolay Shopping Loan Gateway allows e-commerce platforms to offer shopping loan payment options to their users at the checkout step. It enables easy and quick shopping loan usage, which can increase sales.

Benefits

Section titled “Benefits”
  • Easy Integration: Quick API-based integration
  • Instant Approval: Your customers can get instant credit approval
  • Flexible Installment Options: Customer satisfaction with different term options
  • Secure Infrastructure: Safe credit processes with bank integration
  • Increased Sales: Boost conversion rates with payment convenience

Key Concepts

Section titled “Key Concepts”

Shopping Loan

Section titled “Shopping Loan”

Shopping loan is a type of consumer credit that allows customers to make installment payments through a bank when purchasing a specific product or service, instead of paying in full. It is offered as an option at the checkout step on e-commerce sites.

Credit Provider (Bank)

Section titled “Credit Provider (Bank)”

The financial institution that PaynKolay has an agreement with and that provides the credit.

API Integration

Section titled “API Integration”

The technical infrastructure that enables data exchange between the e-commerce site and PaynKolay.

Pre-Credit Assessment

Section titled “Pre-Credit Assessment”

A process that quickly checks the customer’s eligibility for credit by sending customer identification information and shopping cart/amount to the bank via API call.

Loan Application

Section titled “Loan Application”

The official application process when the customer decides to use credit.

Cart

Section titled “Cart”

The list of products the customer wants to purchase and the total amount.

Repayment

Section titled “Repayment”

The installment payments the customer will make to the bank.

API Key (Token)

Section titled “API Key (Token)”

The security key used to access the API.

Shopping Loan Flow

Section titled “Shopping Loan Flow”
1. Customer Adds Products to Cart
         ↓
2. Customer Information, Cart Contents and Amount are Transmitted
         ↓
3. Merchant Queries Available Banks
         ↓
4. Customer is Redirected to Approve Credit Usage in Mobile App
         ↓
5. Bank List is Retrieved and Shown to Customer
         ↓
6. Customer Selects Desired Bank and Term to Continue Application
         ↓
7. Pre-Approved Credit Offer is Shown to Customer for Approval
         ↓
8. After Approval is Complete, Customer Returns to Merchant Page
         ↓
9. Customer Completes Purchase with Shopping Loan

Integration Requirements

Section titled “Integration Requirements”

Technical Requirements

Section titled “Technical Requirements”
  • TLS: Minimum version 1.2
  • Encoding: UTF-8
  • Format: JSON
  • Protocol: HTTPS required

Required Information

Section titled “Required Information”

Information to be obtained from PaynKolay:

  • Username: API username
  • Password: API password
  • Merchant No: Merchant number
  • API Secret Key: Unique security key for the merchant

Environment Information

Section titled “Environment Information”

Test Environment

Section titled “Test Environment”

Environment used for testing and developing the API.

Endpoint: https://apitest.paynkolay.com.tr

Production Environment

Section titled “Production Environment”

Environment where the API is used by real users.

Endpoint: https://api.paynkolay.com.tr

Note: It is recommended to test all operations in the test environment before moving to production.

Integration Steps

Section titled “Integration Steps”

1. Authentication

Section titled “1. Authentication”

You need to obtain a Bearer Token to access the API.

Authentication Details →

2. Query Bank List

Section titled “2. Query Bank List”

Get the list of contracted banks and show them to your customer.

Bank Query Details →

3. Start Bank Session

Section titled “3. Start Bank Session”

Start a session for the bank selected by the customer.

Session Management Details →

4. Payment Simulation

Section titled “4. Payment Simulation”

Calculate monthly payment amounts for different term options.

Simulation Details →

5. Pre-Approval Query

Section titled “5. Pre-Approval Query”

Check credit pre-approval with customer information.

Pre-Approval Details →

6. Loan Application

Section titled “6. Loan Application”

Complete the loan application after customer approval.

Application Details →

7. Application Tracking

Section titled “7. Application Tracking”

Query the status of the loan application.

Query Details →

Next Steps

Section titled “Next Steps”