Alpipay API-Dokumentation

Integrieren Sie Alpipay nahtlos in Ihre bestehenden Systeme mit unserer leistungsstarken API.

Schnelle Integration

Einfache Integration in Ihre bestehenden Systeme mit wenigen Zeilen Code.

Sichere Transaktionen

Alle API-Anfragen werden über HTTPS mit OAuth 2.0-Authentifizierung gesichert.

Umfassende Berichterstellung

Detaillierte Einblicke in Ihre Transaktionen und Zahlungen über unsere API.

Erste Schritte

1. Registrieren Sie sich für ein Alpipay-Konto

Bevor Sie mit der API-Integration beginnen können, benötigen Sie ein Alpipay-Konto. Falls Sie noch keines haben, können Sie sich hier registrieren.

2. API-Schlüssel generieren

Nach der Registrierung können Sie in Ihrem Dashboard unter "Einstellungen" > "API" Ihre API-Schlüssel generieren.

// Beispiel für API-Schlüssel
API_KEY = "ap_live_xxxxxxxxxxxxxxxxxxx"
API_SECRET = "aps_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

3. Authentifizierung einrichten

Alle API-Anfragen müssen mit Ihrem API-Schlüssel authentifiziert werden. Fügen Sie den Schlüssel im Authorization-Header hinzu.

// Beispiel für Authorization-Header
Authorization: Bearer ap_live_xxxxxxxxxxxxxxxxxxx

API-Endpunkte

GET

/api/v1/transactions

Ruft eine Liste aller Transaktionen ab. Unterstützt Paginierung und Filterung.

Parameter

Name	Typ	Beschreibung
page	Integer	Seitennummer (Standard: 1)
limit	Integer	Anzahl der Ergebnisse pro Seite (Standard: 20, Max: 100)
status	String	Filter nach Status (completed, pending, failed)

Beispielantwort

{
  "data": [
    {
      "id": "txn_123456789",
      "amount": 42.50,
      "currency": "CHF",
      "status": "completed",
      "created_at": "2025-04-10T14:32:15Z",
      "description": "Kaffee und Kuchen"
    },
    // ...
  ],
  "meta": {
    "total": 123,
    "page": 1,
    "limit": 20,
    "pages": 7
  }
}

POST

/api/v1/payments

Erstellt eine neue Zahlung, die von einem Kunden bezahlt werden kann.

Request Body

Name	Typ	Beschreibung
amount	Number	Zahlungsbetrag (z.B. 42.50)
currency	String	Währung (Standard: CHF)
description	String	Beschreibung der Zahlung (optional)

Beispielantwort

{
  "id": "pay_123456789",
  "amount": 42.50,
  "currency": "CHF",
  "status": "pending",
  "created_at": "2025-04-14T15:32:15Z",
  "description": "Kaffee und Kuchen",
  "qr_code": "https://api.alpipay.ch/qr/pay_123456789",
  "expires_at": "2025-04-14T16:32:15Z"
}

Vollständige API-Dokumentation anzeigen

Code-Beispiele

JavaScript

// Zahlung erstellen
const createPayment = async () => {
  const response = await fetch('https://api.alpipay.ch/v1/payments', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'Authorization': 'Bearer ap_live_xxxxxxxxxxxxxxxxxxx'
    },
    body: JSON.stringify({
      amount: 42.50,
      currency: 'CHF',
      description: 'Kaffee und Kuchen'
    })
  });
  
  const payment = await response.json();
  console.log(payment);
};

createPayment();

PHP

<?php
// Zahlung erstellen
$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, 'https://api.alpipay.ch/v1/payments');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
  'amount' => 42.50,
  'currency' => 'CHF',
  'description' => 'Kaffee und Kuchen'
]));

$headers = [
  'Content-Type: application/json',
  'Authorization: Bearer ap_live_xxxxxxxxxxxxxxxxxxx'
];
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
$payment = json_decode($response, true);

curl_close($ch);
print_r($payment);
?>

Python

import requests
import json

# Zahlung erstellen
url = "https://api.alpipay.ch/v1/payments"
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer ap_live_xxxxxxxxxxxxxxxxxxx"
}
payload = {
    "amount": 42.50,
    "currency": "CHF",
    "description": "Kaffee und Kuchen"
}

response = requests.post(url, headers=headers, data=json.dumps(payload))
payment = response.json()
print(payment)

Bereit für die Integration?

Registrieren Sie sich noch heute für ein Alpipay-Konto und beginnen Sie mit der Integration unserer leistungsstarken API in Ihre Anwendungen.

Jetzt registrieren Kontakt aufnehmen