Integracje
Utwórz fakturę (Checkout)
Aby utworzyć fakturę, najpierw musisz uzyskać ID metody płatności.
- Jeśli zawsze używasz tej samej metody płatności, poproś o nią zespół wsparcia.
- Jeśli używasz różnych metod, wyślij żądanie na poniższy endpoint.
Endpoint: /v1/payment-method/list
Metoda: GET
Przykładowa odpowiedź:
{
"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": []
}
]
}
Użyj wartości id jako payment_method, tworząc fakturę.
Utwórz fakturę
Endpoint: /v1/payment/create
Metoda: POST
Żądanie (minimalne parametry):
{
"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"
}
}
Żądanie z zapisaną kartą:
{
"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"
}
}
Odpowiedź:
{
"data": {
"payment_id": "...",
"amount": "10.03",
"currency": "USD",
"status": "pending",
"reference": "...",
"url": "https://api.beezyycashier.com/process/...",
"method": "get"
}
}
Przekieruj klienta na url.
Aktualizacja informacji o płatności
Po ID płatności
Endpoint: /v1/payment/{payment_id}
Metoda: GET
Po referencji
Endpoint: /v1/payment/by-reference/{reference}
Metoda: GET
Przykładowa odpowiedź
{
"data": {
"payment_id": "...",
"amount": "10.03",
"status": "success",
"transactions": [ ... ]
}
}
Zwroty
Endpoint: /v1/refund/create
Metoda: POST
{
"reference": "...",
"payment_id": "...",
"amount": "10.03",
"currency": "USD"
}
Odpowiedź:
{
"data": {
"refund_id": "...",
"amount": "10.03",
"status": "success",
"message": "Zwrot zaakceptowany"
}
}
Zapisz kartę
Endpoint: /v1/client/card/save
Metoda: 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"
}
}
Informacje o kliencie
Po e-mailu:
GET: /v1/client/[email protected]
Po ID karty:
GET: /v1/client/card/{card_id}
Akcje na kartach
- Dezaktywuj:
GET /v1/client/card/deactivate/{card_id} - Aktywuj:
GET /v1/client/card/activate/{card_id}
Wypłaty
Pojedyncza:
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"
}
}
Masowe:
POST: /v1/withdrawal/create-mass
Body: tablica obiektów wypłat
Po ID stosu:
GET: /v1/withdrawal/{stack_id}
Podpis powiadomienia
Możesz zweryfikować powiadomienia za pomocą nagłówka podpisu.
- Algorytm:
HMAC-SHA512 - Podpis:
hash_hmac('sha512', raw_request_body, project_key) - Nagłówek:
signature - W przypadku powiadomień o wypłacie użyj klucza wypłaty projektu zamiast klucza płatności.
- Hashuj surowe ciało JSON dokładnie w takiej postaci, w jakiej zostało odebrane — nie koduj ani nie formatuj go ponownie przed hashowaniem.
Przykłady generowania podpisu
Wszystkie poniższe fragmenty dają ten sam wynik w hex pisanym małymi literami dla tych samych raw_body i project_key.
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();
Ważne: raw_body musi być dokładnie tymi bajtami, które zostały odczytane z ciała żądania HTTP — przed jakimkolwiek json_decode / json.loads. Jeśli najpierw sparsujesz JSON, a potem zserializujesz go ponownie, zmienią się białe znaki i kolejność kluczy, przez co weryfikacja podpisu nie powiedzie się.