Zum Inhalt

Integrationen

Rechnung erstellen (Checkout)

Um eine Rechnung zu erstellen, müssen Sie zunächst die Zahlungsmethoden-ID abrufen.

  • Wenn Sie immer dieselbe Zahlungsmethode verwenden, fordern Sie sie beim Support-Team an.
  • Wenn Sie verschiedene Methoden verwenden, senden Sie eine Anfrage an den untenstehenden Endpunkt.

Endpunkt: /v1/payment-method/list
Methode: GET

Beispielantwort:

{
  "data": [
    {
      "id": "11111",
      "title": "Cards International",
      "countries": ["US", "GB", "FR"],
      "currencies": ["USD", "EUR"],
      "icon": "",
      "fields": [
        {
          "name": "cardNumber",
          "title": "card number"
        },
        {
          "name": "holderName",
          "title": "holder name"
        }
      ]
    },
    {
      "id": "11117",
      "title": "Alipay",
      "countries": ["CN"],
      "currencies": ["CNY"],
      "icon": "",
      "fields": []
    }
  ]
}

Verwenden Sie den Wert von id als payment_method, wenn Sie eine Rechnung erstellen.


Rechnung erstellen

Endpunkt: /v1/payment/create
Methode: POST

Anfrage (minimale Parameter):

{
  "amount": "10.03",
  "currency": "USD",
  "payment_method": "11111",
  "save_card": "1",
  "customer": {
    "email": "[email protected]",
    "name": "John Doe",
    "ip": "192.168.1.1"
  },
  "urls": {
    "success": "https://example.com/success",
    "fail": "https://example.com/fail",
    "notification": "https://example.com/notification"
  },
  "reference": "3d7d949e-94fb-4b8b-bc32-7c7f46bcd638",
  "metadata": {
    "key1": "value1",
    "key2": "value2"
  }
}

Anfrage mit gespeicherter Karte:

{
  "amount": "10.03",
  "currency": "USD",
  "payment_method": "11111",
  "customer": {
    "email": "[email protected]",
    "name": "John Doe",
    "ip": "192.168.1.1"
  },
  "urls": {
    "success": "https://example.com/success",
    "fail": "https://example.com/fail",
    "notification": "https://example.com/notification"
  },
  "reference": "3d7d949e-94fb-4b8b-bc32-7c7f46bcd638",
  "card": {
    "cardId": "050159eb-6af3-407c-84c0-ca1680711a77"
  },
  "metadata": {
    "key1": "value1",
    "key2": "value2"
  }
}

Antwort:

{
  "data": {
    "payment_id": "...",
    "amount": "10.03",
    "currency": "USD",
    "status": "pending",
    "reference": "...",
    "url": "https://api.beezyycashier.com/process/...",
    "method": "get"
  }
}

Leiten Sie Ihren Kunden zur url weiter.


Zahlungsinformationen abrufen

Nach Zahlungs-ID

Endpunkt: /v1/payment/{payment_id}
Methode: GET

Nach Referenz

Endpunkt: /v1/payment/by-reference/{reference}
Methode: GET

Beispielantwort

{
  "data": {
    "payment_id": "...",
    "amount": "10.03",
    "status": "success",
    "transactions": [ ... ]
  }
}

Rückerstattungen

Endpunkt: /v1/refund/create
Methode: POST

{
  "reference": "...",
  "payment_id": "...",
  "amount": "10.03",
  "currency": "USD"
}

Antwort:

{
  "data": {
    "refund_id": "...",
    "amount": "10.03",
    "status": "success",
    "message": "Rückerstattung akzeptiert"
  }
}

Karte speichern

Endpunkt: /v1/client/card/save
Methode: POST

{
  "payment_method": "11111",
  "customer": {
    "email": "[email protected]",
    "name": "John Doe",
    "ip": "192.168.1.1"
  },
  "urls": {
    "success": "https://example.com/success",
    "fail": "https://example.com/fail",
    "notification": "https://example.com/notification"
  },
  "reference": "...",
  "metadata": {
    "key1": "value1"
  }
}

Kundeninformationen

Nach E-Mail:

GET: /v1/client/[email protected]

Nach Karten-ID:

GET: /v1/client/card/{card_id}


Kartenaktionen

  • Deaktivieren: GET /v1/client/card/deactivate/{card_id}
  • Aktivieren: GET /v1/client/card/activate/{card_id}

Auszahlungen

Einzelne Auszahlung:

POST: /v1/withdrawal/create

{
  "reference": "...",
  "amount": "10.03",
  "currency": "USD",
  "withdrawal_method_id": "22222",
  "receiver": {
    "cardNumber": "...",
    "name": "John Doe",
    "email": "[email protected]"
  },
  "urls": {
    "notification": "https://example.com/notify"
  }
}

Massen-Auszahlungen:

POST: /v1/withdrawal/create-mass
Body: Array von Auszahlungsobjekten

Nach Stack-ID:

GET: /v1/withdrawal/{stack_id}


Benachrichtigungssignatur

Sie können Benachrichtigungen über den Signatur-Header verifizieren.

  • Algorithmus: HMAC-SHA512
  • Signatur: hash_hmac('sha512', raw_request_body, project_key)
  • Header: signature
  • Verwenden Sie für Auszahlungsbenachrichtigungen den Auszahlungsschlüssel des Projekts anstelle des Zahlungsschlüssels.
  • Hashen Sie den rohen JSON-Body genau so, wie er empfangen wurde — kodieren oder formatieren Sie ihn nicht vor dem Hashing neu.

Beispiele zur Signaturerzeugung

Alle folgenden Snippets liefern bei gleichem raw_body und project_key dieselbe Ausgabe in Kleinbuchstaben-Hex.

PHP

$signature = hash_hmac('sha512', $rawBody, $projectKey);

Python

import hmac
import hashlib

signature = hmac.new(
    project_key.encode('utf-8'),
    raw_body.encode('utf-8'),
    hashlib.sha512
).hexdigest()

Go

import (
    "crypto/hmac"
    "crypto/sha512"
    "encoding/hex"
)

mac := hmac.New(sha512.New, []byte(projectKey))
mac.Write([]byte(rawBody))
signature := hex.EncodeToString(mac.Sum(nil))

Java

import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
import java.nio.charset.StandardCharsets;

Mac mac = Mac.getInstance("HmacSHA512");
mac.init(new SecretKeySpec(
    projectKey.getBytes(StandardCharsets.UTF_8),
    "HmacSHA512"
));
byte[] hash = mac.doFinal(rawBody.getBytes(StandardCharsets.UTF_8));

StringBuilder sb = new StringBuilder();
for (byte b : hash) sb.append(String.format("%02x", b));
String signature = sb.toString();

Wichtig: raw_body muss exakt die Bytes enthalten, die aus dem HTTP-Request-Body gelesen wurden — vor jedem json_decode / json.loads. Wenn das JSON erst geparst und dann erneut serialisiert wird, ändern sich Whitespace und Schlüsselreihenfolge, wodurch die Signaturprüfung fehlschlägt.