API Documentation

Integration with Powerful and Flexible API

Quickly build your payment infrastructure with our RESTful API architecture. Get started with comprehensive documentation and code examples.

Get Free Consultation

Quick Start

Complete API integration in 4 steps

1

Get API Key

Register on the developer portal and create your API key.

2

Install SDK

Add the SDK in your preferred programming language.

3

First Request

Make your first API call in the test environment.

4

Go Live

Complete tests and get your production API key.

Core API Endpoints

Discover the most frequently used API calls

Payments API

Create, query and cancel payments

POST/v1/payments

Customers API

Manage customer information

GET/v1/customers

Transactions API

Transaction history and reporting

GET/v1/transactions

Refunds API

Manage refund operations

POST/v1/refunds

Webhooks API

Real-time notifications

POST/v1/webhooks

Subscriptions API

Subscription and recurring payments

POST/v1/subscriptions

Example API Request

JavaScript example for payment creation endpoint:

RESTful Design

Modern, predictable API endpoints

JSON Format

All requests and responses in JSON format

Webhook Support

Real-time event notifications

// Initialize PAYMORE SDK
import { Paymore } from '@paymore/sdk';

const paymore = new Paymore({
  apiKey: 'sk_live_your_api_key',
  environment: 'production'
});

// Create a payment
const payment = await paymore.payments.create({
  amount: 10000, // 100.00 TRY
  currency: 'TRY',
  description: 'Order #12345',
  customer: {
    email: '[email protected]',
    phone: '+905xxxxxxxxx'
  },
  metadata: {
    orderId: '12345'
  }
});

console.log(payment.id, payment.status);

API Authentication

PAYMORE API supports API Key and OAuth 2.0 for secure access.

API Key Method

Send API key with Authorization header for simple integrations.

Authorization: Bearer sk_live_...

OAuth 2.0

Use OAuth 2.0 for applications requiring user authorization.

Authorization: Bearer access_token

API Features

RESTful Design

Modern, predictable API endpoints

JSON Format

All requests and responses in JSON format

Webhook Support

Real-time event notifications

Rate Limiting

Rate limits for fair usage and security

Versioning

Backward compatibility guarantee

Detailed Errors

Clear error messages and codes

Need Help?

Our technical team is ready to help you in your integration process.

Get Free Consultation
Contact us on WhatsApp