Sign in
Introduktion/Webhook-aviseringar

Webhook-notifieringar

Ta emot uppdateringar om betalnings- och uttagsstatus i realtid via HMAC-signerade webhooks.

2328.io-systemet skickar en webhook till din url_callback när en betalningsstatus ändras. Detta är det rekommenderade sättet att bli notifierad om lyckade betalningar.

Format för förfrågan

  • Metod: POST
  • Content-Type: application/json
  • Signatur: fältet sign i body

Payload

Webhook-bodyn följer formatet för svaret från /v1/payment/info och lägger till tx_explorer_url samt fältet sign för signaturverifiering.

Lyckad betalning

JSON
{
  "uuid": "db17d490-15b6-47b9-9015-91d1d8b119f2",
  "order_id": "ORDER-12345",
  "amount": "180.00000000",
  "currency": "RUB",
  "url": "https://go.2328.io/db17d490-15b6-47b9-9015-91d1d8b119f2",
  "expires_at": "2026-05-09T16:56:58+03:00",
  "created_at": "2026-05-09T15:56:58+03:00",
  "payer_currency": "TON",
  "payer_amount": "0.95256917",
  "network": "TON",
  "address": "UQA0RevhkCQx-EltyNgPPeG8dqtnCz7ZslOzMdNQlLxVaNBb",
  "payment_status": "paid",
  "txid": "41c2a327323480af8e705d05deb09c238a41779928832abef4bb77c862357b11",
  "tx_explorer_url": "https://tonviewer.com/transaction/41c2a327323480af8e705d05deb09c238a41779928832abef4bb77c862357b11",
  "payment_amount": "0.95256917",
  "merchant_amount": "0.949711462490000000",
  "amount_usd": "2.41324380",
  "exchange_rate": "0.01340691",
  "sign": "6f8c15b6e53b506d5bfa38ed3fb3b50697af73434262153c02e412541372f04d"
}

Avbruten / misslyckad betalning

När betalningen inte är i terminalt paid-tillstånd är txid, payment_amount och merchant_amount null:

JSON
{
  "uuid": "48edaf2d-2c49-4638-8f86-88636f661c1f",
  "order_id": "ORDER-12345",
  "amount": "2800.00000000",
  "currency": "RUB",
  "url": "https://go.2328.io/48edaf2d-2c49-4638-8f86-88636f661c1f",
  "expires_at": "2026-05-09T06:19:04+03:00",
  "created_at": "2026-05-09T05:19:04+03:00",
  "payer_currency": "ETH",
  "payer_amount": "0.01620968",
  "network": "ETH-ERC20",
  "address": "0x37c20d6d96d130Bc5B33D832e43b8e16aACe0c59",
  "payment_status": "cancel",
  "txid": null,
  "tx_explorer_url": null,
  "payment_amount": null,
  "merchant_amount": null,
  "amount_usd": "37.53934800",
  "exchange_rate": "0.01340691",
  "sign": "40ce68ad9691ad54e684329d75ab5adaf5b01409a2d18d3e0110b8c1be605342"
}

Fältreferens

FältTypBeskrivning
uuidstringBetalningens UUID
order_idstringDitt order-ID
amountdecimal (8 dp)Fiatbelopp i currency
currencystringFiatvalutan handlaren begärde
urlstringURL till värdbaserad kassa
expires_atstring (ISO 8601)När betalningssessionen löper ut
created_atstring (ISO 8601)När betalningssessionen skapades
payer_currencystringKrypto som betalaren betalar med
payer_amountdecimal (8 dp)Förväntat kryptobelopp
networkstringBlockchain-nätverk
addressstringInbetalningsadress
payment_statusstringEn av: pending, check, paid, underpaid_check, underpaid, overpaid, cancel, aml_lock (se References)
txidstring | nullBlockchain tx-hash, finns endast efter en bekräftad betalning
tx_explorer_urlstring | nullTransaktionens URL i blockkedjeutforskaren. null om txid saknas eller överföringen är intern P2P.
payment_amountdecimal | nullFaktiskt betalat belopp, finns endast efter betalning
merchant_amountdecimal (18 dp) | nullBelopp krediterat handlaren efter avgifter
amount_usddecimal (8 dp)Belopp i USD vid skapandet
exchange_ratedecimalAnvänd växelkurs krypto / fiat
signstring (hex)HMAC-SHA256-signatur av payloaden

Verifiera signaturen

För att verifiera en webhook-signatur:

  1. Extrahera fältet sign från payloaden
  2. Ta bort fältet sign från objektet
  3. Koda återstående fält som JSON
  4. Koda JSON-strängen i Base64
  5. Beräkna HMAC-SHA256 från Base64-strängen med din API_KEY
  6. Jämför den beräknade signaturen med värdet sign med en tidskonstant jämförelse
PHP
<?php
function verifyWebhookSign(array $data, string $apiKey): bool {
    $receivedSign = $data['sign'] ?? '';
    unset($data['sign']);

    $json = json_encode($data, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES);
    $base64 = base64_encode($json);
    $calculated = hash_hmac('sha256', $base64, $apiKey);

    return hash_equals($calculated, $receivedSign);
}

$apiKey = 'YOUR_API_KEY';
$payload = json_decode(file_get_contents('php://input'), true);

if (!verifyWebhookSign($payload, $apiKey)) {
    http_response_code(401);
    exit;
}

switch ($payload['payment_status']) {
    case 'paid':
    case 'overpaid':
        // Credit the order — check idempotency by order_id first
        break;
    case 'underpaid_check':
    case 'underpaid':
    case 'cancel':
        break;
}

http_response_code(200);

Verifiera alltid signaturen innan du krediterar några medel till en användare. En osignerad eller felaktigt signerad webhook kan vara en förfalskad förfrågan.

Uttags-webhooks

När ett uttags status ändras skickar systemet en POST webhook till den url_callback-URL som angavs när uttaget skapades. Om url_callback inte angavs skickas inga webhooks för det uttaget.

Uttags-webhooks måste verifieras med din Payout API key — inte den vanliga API-nyckeln. Signeringsalgoritmen är identisk med betalnings-webhooks (ta bort sign, JSON-koda, base64, HMAC-SHA256), bara nyckeln skiljer sig.

Payload

JSON
{
  "uuid": "019dff1f-0dbd-7277-8d45-271e7775388f",
  "order_id": "4dfdcc84402b1185b71cbe399321533e",
  "status": "completed",
  "currency": "TRX",
  "network": "TRX-TRC20",
  "amount": "3.00",
  "merchant_amount": "3.00",
  "network_amount": "3.00",
  "amount_usd": "1.04",
  "to_address": "THauRv5tcucQRohXg8NiyGTk16DX1XQG5x",
  "memo": null,
  "txid": "9242e533703704ef3eaba840f70b4a26333e72c943377ee375fea17badb53def",
  "tx_explorer_url": "https://tronscan.org/#/transaction/9242e533703704ef3eaba840f70b4a26333e72c943377ee375fea17badb53def",
  "block_number": null,
  "error_type": null,
  "created_at": "2026-05-07T00:08:38+03:00",
  "updated_at": "2026-05-07T00:08:54+03:00",
  "from_currency": "USDT",
  "debited_amount": "1.050735",
  "debited_currency": "USDT",
  "sign": "925ad7bf3d6841864101f7cc2c7e30652e70a06cdb04dbe07a0129480000ce4a"
}

Fältreferens

FältTypBeskrivning
uuidstringUttagets UUID
order_idstringDin idempotens-/referensidentifierare, om du angav någon
statusstringpending, completed, failed, cancelled (se References)
currencystringUttagsvaluta
networkstringBlockchain-nätverk
amountdecimalUttagsbelopp (i currency)
merchant_amountdecimalBelopp som debiterats från handlarsaldot
network_amountdecimalBelopp som faktiskt skickats on-chain
amount_usddecimalUSD-värde vid uttagets tidpunkt
to_addressstringMottagarens blockchain-adress
memostring | nullMemo / destinationstagg, om använd
txidstring | nullBlockchain-transaktionshash, sätts vid completed
tx_explorer_urlstring | nullTransaktionens URL i blockkedjeutforskaren. null om txid saknas eller överföringen är intern P2P.
block_numberinteger | nullBlockhöjd för on-chain-transaktionen
error_typestring | nullOrsak när status = failed (t.ex. aml_risk, se References)
created_atstring (ISO 8601)När uttaget skapades
updated_atstring (ISO 8601)När statusen senast ändrades
from_currencystringKällsaldo som uttaget debiterades från när automatisk konvertering användes (t.ex. USDT för ett uttag i BTC)
debited_amountdecimalBelopp som debiterats från from_currency-saldot
debited_currencystringValuta för debiteringen
signstring (hex)HMAC-SHA256-signatur av payloaden, signerad med Payout API key

Bästa praxis

  • Idempotens — Kontrollera alltid om betalningen redan har bearbetats (via order_id eller uuid). Webhooks kan komma flera gånger.
  • Snabbt svar — Returnera HTTP 200 så snabbt som möjligt. Lasta av tungt arbete till en bakgrundskö.
  • Återförsök — Om systemet inte tar emot HTTP 200 skickas webhooken igen efter 2 minuter. Maximalt 5 återförsök.
  • Asynkron bearbetning — Hantera webhook-händelser asynkront för att undvika att blockera svaret.
  • Säkerhet — Verifiera ALLTID sign-signaturen innan du litar på payloaden.

Webhooks kan komma i fel ordning. Anta inte att den första webhooken du tar emot är det slutgiltiga tillståndet — hämta alltid på nytt via /v1/payment/info (eller /v1/payout/status/{uuid}) om du behöver vara säker.

Leverans- och bearbetningsavtal

Använd följande ordning i din webhook-endpoint:

  1. Läs begäransens innehåll utan att logga hemligheter eller hela signaturen.
  2. Identifiera om det är en betalnings-/statisk plånbokshändelse eller en utbetalningshändelse så att du kan välja rätt API-nyckel.
  3. Ta bort sign, återskapa de dokumenterade JSON-byten, beräkna HMAC-SHA256 och jämför i konstant tid.
  4. Verifiera obligatoriska identifierare, decimalsträngar och statusvärden.
  5. Infoga atomiskt ett inbox-/idempotensregister. Om det redan finns, returnera HTTP 200 utan att upprepa sid- effekter.
  6. Utför order-/huvudboksmutationen och köa icke-kritiska e-postmeddelanden, analysdata eller aviseringar.
  7. Returnera HTTP 200 snabbt.

Anropa inte långsamma tredjepartstjänster medan idempotens-transaktionen hålls. En timeout efter att du har genomfört men innan du returnerar kan orsaka ett återförsök; dupliceringen måste observera den genomförda inkorgsnyckeln och bli en no-op.

HändelsePrimär identitetAnteckningar
Betalningssessionuuid + status-/versionsbevisSamma faktura kan generera flera legitima statusändringar.
Delbetalning påfyllningfaktura uuid + txidMer än en överföring kan tillhöra samma underbetalda faktura.
Statisk-plånboksinsättningnätverk + txidorder_id återanvänds för varje insättning till den plånboken.
Utbetalningutbetalning uuid + statusSkapa aldrig en andra utbetalning från webhook-återförsökslogik.

Om ditt schema inte har något händelse-ID, lagra den verifierade payload-hashen som ytterligare revisionsbevis, men ersätt inte de ovanstående affärsidentiteterna med en tidsstämpel.

Beställning och avstämning

Leverans är minst-en-gång och statusmeddelanden kan komma i oordning. Implementera monontona affärsregler istället för "senaste begäran vinner":

  • flytta aldrig en uppfylld order tillbaka till check eftersom ett äldre händelsemeddelande anlände sent;
  • tillåt underpaid_check att ta emot ytterligare txids utan att upprepa tidigare krediter;
  • behandla paid och overpaid som framgångsrika uppgörelsestater, samtidigt som deras olika belopp bevaras;
  • behåll underpaid som ett slutgiltigt delbetalningsresultat om inte den auktoritativa API:n senare rapporterar ett annat tillstånd;
  • skicka aml_lock till granskning och låt inte en generell retry-arbetare uppfylla det;
  • fråga betalnings-/utbetalningsinformation när övergången är omöjlig, sammanhang saknas eller ekonomiskt tvetydig.

Kör schemalagd avstämning även när webhook-leverans verkar fungerande. Jämför ditt lokala terminaltillstånd och krediterat belopp med /v1/payment/info, /v1/static-wallet/transactions eller /v1/payout/status/{uuid} och varna vid skillnader istället för att tyst skriva över huvudbokslogg.

Webhook-endpunktsäkerhet

  • Kräv HTTPS och håll callback offentligt nåbar; privata/loopback-callbackmål avvisas under betalningsskapande.
  • Tvinga en liten gräns för förfrågningskropp och JSON-innehållstyp.
  • Begränsa hastighet innan dyrt arbete, men lämna tillräckligt utrymme för legitima spikar och omförsök.
  • Auktorisera aldrig en webhook enbart baserat på käll-IP. Nätverks-tillåtlighetslistor är ett skydd i djupet; HMAC-verifiering är obligatorisk.
  • Redigera sign, API-nycklar, adresser när det krävs enligt policy, och personlig metadata från applikationsloggar.
  • Håll både nuvarande och uttryckligen schemalagda ersättningsnycklar tillgängliga under ett kontrollerat rotationsfönster; gissa aldrig vilken nyckel som signerade en händelse.
  • Returnera en generell felkropp vid ogiltiga signaturer så att slutpunkten inte blir en nyckel- eller kontoorakel.