Skip to content

Introduction

SecPaid provides a REST API that enables you to programmatically create payment links, track transactions, issue refunds, and receive real-time payment notifications.

What is SecPaid?

SecPaid is a payment link service. You create a link via API, send it to your customer, and SecPaid handles the checkout. When the customer pays, you get notified via webhook.

Core Workflow

sequenceDiagram
    participant Y as Your Server
    participant S as SecPaid API
    participant C as Customer

    Y->>S: 1. POST /api/v2/createLink
    S-->>Y: pay_link + pay_id
    Y->>C: 2. Share pay_link
    C->>S: 3. Opens link & pays
    S->>Y: 4. Webhook → payment_endpoint
    S->>C: 4. Redirect → callback_url
Step What Happens
1. Create Call POST /api/v2/createLink with an amount
2. Share Redirect your customer to the returned pay_link
3. Pay Customer completes payment on SecPaid's hosted checkout
4. Notify SecPaid calls your payment_endpoint and redirects via callback_url

API at a Glance

Property Value
Protocol HTTPS only
Method All endpoints use POST
Auth token header with your API Key
Format JSON request & response
Timezone Server returns CEST / UTC

Base URLs

Environment Base URL Purpose
Production https://app.secpaid.com/api/v2/ Live payments
Development https://app.dev.secpaid.com/api/v2/ Testing & integration

Interactive API

Try endpoints live at api.secpaid.com — our Swagger UI with all v2 endpoints.

Next Steps

  • Authentication

    Set up your API key and understand the token header.

    Auth Guide

  • Quickstart

    Create your first payment link in under 5 minutes.

    Quickstart

  • Response Format

    Understand the standard response envelope and error codes.

    Errors & Responses

  • Dashboard & Settings

    Navigate the platform UI, find your API key, and configure webhooks.

    Dashboard