GELİŞTİRİCİ BELGELERİ

API belgeleri

Faturaları, ödeme sayfasını ve ödeme bildirimlerini entegre et.

Hızlı başlangıç

İlk faturanı oluştur.

  1. Mağaza hazırla

    Ödeme yöntemlerini etkinleştir, sağlayıcıları yapılandır ve proje cüzdanlarını yedekle.

  2. API kimlik bilgisi oluştur

    Konsolunda Ayarlar → API erişimi bölümünde okuma/yazma seç ve projeyi ata.

  3. İsteği gönder

    API sunucunu kullan ve proje ve mağaza kimliklerini kopyala. Ondalık tutarları dize olarak gönder.

  4. Ödeme sayfasını aç

    Şuraya yönlendir: links.checkout yanıttaki değerle. Siparişi yerine getirmeden önce ödemenin tamamlandığını doğrula.

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
# Keep this key and the exact body for retries; use a new key for each new invoice.
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/projects/YOUR_PROJECT_ID/stores/YOUR_STORE_ID/invoices" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Idempotency-Key: order-1042-attempt-1' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "amount": "49.90",
  "currency": "USD",
  "order_id": "order-1042",
  "exchange_rate_spread_percent": "0.5"
}'

Örnekler yer tutucu kullanır ve bu sayfadan istek göndermez. Tüm fatura alanlarını ve yanıt biçimini gör →

Proje ve mağaza kimlikleri

YOUR_PROJECT_ID ve YOUR_STORE_ID nerede bulunur.

Proje veya mağaza adlarını ya da okunabilir tanımlayıcılarını değil, konsolundaki UUID'leri kullan.

Yer tutucuNerede bulunurKullanım amacı
YOUR_PROJECT_IDProje → Ayarlar → API kimlikleri → Proje API kimliği → Kopyala. Mağazanın Temel sekmesinde de gösterilir.Proje ve mağaza düzeyindeki istekler.
YOUR_STORE_IDProje → Mağazalar → bir mağaza seç → Temel → API kimlikleri → Mağaza API kimliği → Kopyala.Fatura oluşturma ve mağaza ödeme yöntemi istekleri.
  • Varsayılan mağaza için bile fatura oluşturmak her iki kimliği gerektirir. Mağaza o projeye ait olmalı ve API kimlik bilgisinin projeye erişimi bulunmalıdır.
  • Fatura oluşturma, listeleme, ayrıntı ve ödeme sayfası invoice_id döndürür: IPN/webhook'larda gönderilen aynı UUID. Fatura yollarında dahili id veya order_id yerine bunu kullan. Merchant 4.0.0'dan itibaren eski public_id yanıt alanı kaldırılmıştır; yükseltmeden önce entegrasyonlarını güncelle.
  • REST API proje/mağaza listeleme rotaları sağlamaz. Kimlikleri konsoldan kopyala veya merchant 5.0.0+'da kapsamı sınırlandırılmış list_projects ve list_stores MCP araçlarını kullan.
  • Mağaza → Temel → Mağaza alan adları etkin satıcı, ödeme ve API ana makine adlarını seçer. Döndürülen ödeme bağlantıları ve yeni geri çağrı bağlantıları önce o mağazayı, sonra varsayılan mağazayı, ardından sistem varsayılanlarını tercih eder. Kullanımdan kaldırılmış veya etkinleştirilmemiş adlar asla seçilmez. SDK'nı tercih edilen API ana makine adıyla yapılandır; tercihi değiştirmek diğer etkin takma adları yönlendirmez.

Kimlik doğrulama ve kapsam

Kimlik bilgilerini sunucunda tut ve yalnızca gereken erişimi ver.

Varsayılan ana makineAmaç
merchant.example.comSatıcı konsolu ve Ayarlar
pay.example.comMüşteri ödeme sayfası
api.example.comSatıcı API istekleri

Değiştir: example.com kendi alan adınla. Mevcut kurulumlar yapılandırılmış adlarını korur; takma adları Ayarlar → Sistem bölümünde yönet.

Authorization: Bearer YOUR_MERCHANT_API_TOKEN
AyarNasıl çalışır
Erişim düzeyiSalt okunur kimlik bilgileri listeleyebilir ve getirebilir. Okuma/yazma kimlik bilgileri ayrıca fatura oluşturabilir ve belgelenmiş varlık politikalarını güncelleyebilir.
ProjelerKimlik bilgisinin erişebileceği projeleri ata. Mağaza ve fatura kimlikleri atanmış bir projeye ait olmalıdır.
IP kısıtlamalarıİstersen Ayarlar → API erişimi bölümünde belirli herkese açık IPv4 veya IPv6 çıkış adreslerine izin ver.
Kimlik bilgilerini saklamaToken'ları arka uç yapılandırmanda tut. Bearer kimlik bilgisini asla tarayıcıya veya ödeme bağlantısına ekleme.

Herkese açık ödeme sayfası rotaları faturanın herkese açık kimliğini kullanır ve yalnızca ödeme sayfasında güvenle gösterilebilen verileri sunar. Konsol oturumları ve yönetim kontrolleri satıcı API kimlik bilgilerinden ayrıdır.

Varlıklar ve cüzdanlar

Ödeme yöntemlerini her mağaza için bağımsız seç.

  1. Oku: proje ödeme varlıkları ve kullanıma hazır olup olmadıkları.
  2. Yerel zinciri etkinleştir, cüzdanını ve sağlayıcılarını yapılandır.
  3. Göz at: token adayları ve sözleşmeyi veya mint'i doğrula token'ı etkinleştirmeden önce.
  4. Mağazanın sıralı ödeme yöntemlerini seç. Yeni faturalar kullanıma hazır seçimlerini kullanır.

Token'lar yerel zincirlerinin cüzdanını paylaşır. Cüzdan bakiyeleri tam atomik tutarları ve bilgi amaçlı itibari para değerlerini döndürür. Hangi yöntemlerin ödeme alabileceğini belirlemek için döndürülen hazırlık alanlarını kullan.

Doğrulanmış ERC-20 token'ları desteklenen EVM ağlarını; doğrulanmış SPL token'ları Solana'yı kullanır. Yerel ödeme yöntemleri entegre 30 ağda kullanılabilir. Monero, projeye bağlı harici ve yalnızca görüntüleme yetkili cüzdan bağlantısı kullanır.

Ödeme alma API'leri ve yerel coin/token kapsamı
Ödeme altyapısıDestekKanıtGereksinimler
Yerel ödeme altyapılarıdestekleniyorİşlem taramalıBTC, SOL, ETH (Ethereum/Base/Arbitrum/OP), BNB, HYPE, AVAX ve POL; Bitcoin çıktıları, kanonik EVM işlemleri/makbuzları ve ayrıştırılmış Solana transferleri fatura kanıtı sağlar.
ERC-20 token ödeme altyapılarıdestekleniyorİşlem taramalıEthereum, Base, BNB Chain, HyperEVM, Avalanche, Polygon, Arbitrum ve Optimism zincir üstü doğrulama gerektirir; indekslenmiş Transfer günlükleri ödemeyi faturaya bağlar.
SPL token ödeme altyapılarıdestekleniyorİşlem taramalıSolana adayları mainnet ve mint doğrulaması gerektirir; ayrıştırılmış işlemlerdeki tam token bakiyesi farkları ödemeyi faturaya bağlar.
Ek UTXO yerel ödeme altyapılarıdestekleniyorİşlem taramalıBCH/LTC/DOGE Esplora kullanır; BCH/DOGE ayrıca Bitcore, LTC/DOGE/DASH BlockCypher, Dash Insight ve şeffaf ZEC zcash-explorer kabul eder. Hepsi eksiksiz saklanan Core uyumlu node-rpc bloklarını da kabul eder. Ham mod mempool tespiti değil, 1–48 onay gerektirir. Korumalı Zcash desteklenmez.
İndekslenmiş hesap tabanlı yerel ödeme altyapılarıdestekleniyorİşlem taramalıTRON tron-indexer veya solidified node-rpc; XRP xrpl-jsonrpc; Stellar stellar-horizon veya saklanmış Stellar node-rpc defterleri; Cosmos Hub cometbft-jsonrpc; Algorand algorand-indexer veya algod node-rpc kullanır; Hedera EVM rölesi değil, hedera-mirror gerektirir.
Yerel defter ödeme altyapılarıdestekleniyorİşlem taramalıAptos aptos-rest; Sui sui-graphql; NEAR near-jsonrpc; Kaspa kaspa-rest kullanır. Polkadot Asset Hub substrate-rest veya meta verileri anlayan kesinleşmiş node-rpc kabul eder; Tezos tezos-tzkt veya tam Octez node-rpc işlemlerini kabul eder. Yalnızca yerel tahsilatlar; eski faturalar için arşiv saklama gerekir.
Cardano ve TON yerel ödeme altyapılarıdestekleniyorİşlem taramalıCardano cardano-koios, TON toncenter-v3 gerektirir. XRP tag'leri, Stellar memo kimlikleri ve TON fatura açıklamaları destination_tag olarak döndürülür ve aynen gönderilmelidir.
Ödeme tamamlanma bütünlüğüdestekleniyorBağımsız doğrulamaVarsayılan olarak nihai tamamlanma, iki bağımsız sağlayıcının tam işlem/olay, tutar, kanonik blok veya slot ve kesinlik üzerinde anlaşmasını gerektirir. Ham ve paylaşılan EVM aralıkları tam kapsamı da doğrular. Yönetici bir zincir için açıkça tek güvenilir sağlayıcı seçebilir; bu, kimlik, eksiksizlik veya kesinlik kontrollerini değil, bağımsız çapraz kontrolü kaldırır.
Monero yerel ödeme altyapısıdestekleniyorProjeye bağlı, yalnızca görüntüleme yetkili cüzdan RPC'siHTTPS yöntem izin listeli geçit arkasında, yalnızca bu işe ayrılmış harici bir salt izleme cüzdan-RPC'si account-0 alt adresleri oluşturur. Yapılandırılmış mainnet daemon eşiği (varsayılan 2 bağımsız kaynak, isteğe bağlı 1) ödeme tamamlanma kanıtı sağlar. Yerel --restricted-rpc, create_address ile uyumsuzdur; cüzdan yedeği ve harcama anahtarı bulunmadığı operatör tarafından açıkça beyan edilir; Wholly Crypto'ya hiçbir anahtar verisi gönderilmez.

Borsa bakiyeleri ve varlık başına cüzdan veya borsa aktarım seçenekleri herkese açık v1 API'de değil, konsolda bulunur. Borsa kurulumuna bak.

Fatura yaşam döngüsü

Ödeme kanıtı, tamamlanma ve siparişin yerine getirilmesi.

DurumAnlamı
newÖdeme bekleniyor
processingÖdeme görüldü; kabul edilen tutar veya kesinleşme bekleniyor
settledFaturanın ödeme tamamlama politikasına göre veya elle kabul edildi
expiredSon tarih geçti; geç ödeme izlemesi devam edebilir
invalidÖdeme otomatik kabul edilemiyor
cancelledİptal edildi; yalnızca açık mutabakat işlemi yeniden açabilir

amount_status kayıtları none, partial, paid veya overpaid. timing_status zamanında ve geç ödemeleri ayırt eder. Mağaza kuralları gereken onayları ve kabul edilen eksik ödeme toleransını belirler.

Faturanın şu alanını kullan: invoice_id şununla birlikte: fatura ayrıntısı rotası. Ödeme sayfası yönlendirmesi tek başına ödemenin tamamlandığının kanıtı değildir. İstisnaları şu yoldan incele: mutabakat.

Güvenli yeniden denemeler

Fatura oluşturmak şunu gerektirir: Idempotency-Key. Zaman aşımından sonra aynı kimlik bilgisi, anahtar ve birebir aynı istek gövdesiyle yeniden dene. Yeni anahtarı yalnızca yeni fatura için kullan.

EVM ödeme taraması

Paylaşılan yerel blok ve ERC-20 keşfi, yeni faturaları eski geçmişi yakalama işlerinden ayrı gruplar. Her fatura kalıcı geçmiş imlecini korur. Token sorguları istek başına en fazla 100 blok kullanır ve daha sıkı sağlayıcı sınırlarına göre küçülür. Varsayılan olarak her aralığı iki bağımsız sağlayıcı doğrular. Ayarlar → Zincir bağlantıları → Ayrıntılar bölümünde bir zincir, bağımsız çapraz kontrol olmadan tek güvenilir kaynağa geçirilebilir; kanonik işlem, tutar ve onay kontrolleri korunur. Bağlantı ayrıntıları tarayıcı gecikmelerini, geçmiş kısıtlamalarını ve kota bekleme sürelerini temel düğüm sağlığından ayırır. Herkese açık RPC kapasitesi garanti edilmez.

IPN ve webhook'lar

Ödeme olaylarını al ve doğrula.

IPN, üretilen her fatura olayını faturanın geçerli ipn_url adresinde alır. Webhook'lar yalnızca her etkin mağaza uç noktası için seçilen olayları alır. İkisi de aynı JSON anlık görüntüsünü POST ile gönderir; bağımsız oldukları için ikisini de etkinleştirmek uygulamana iki kez bildirim gönderebilir.

Ayarlama: ipn_url fatura oluştururken veya mağaza varsayılanını devral. IPN şu sırrı kullanır: Mağaza → IPN sırrı; her Mağaza → Webhook'lar uç noktasının kendi sırrı vardır. Hiçbiri API anahtarın değildir.

Siparişi ne zaman yerine getirmeliyim?

Olay tabanlı işleme için sipariş kontrolünü event_type = invoice.settled ile status = settled birlikte tetiklesin. Güncel faturayı doğrula ve her siparişi yalnızca bir kez yerine getir.

status, olayın oluşturulduğu andaki fatura durumudur. event_type ne olduğunu bildirir. payment.received, processing veya settled taşıyabilir; ikinci bir ödeme anlamına gelmez ve bağımsız sipariş yerine getirme sinyali değildir.

Hangi olaylar ve durumlar gönderilir?

Ayarlar/geçmişteki olayGövde durumuAnlamı
invoice.creatednewFatura oluşturuldu ve ödeme bekliyor. Kontrollü yeniden açma faturayı new durumuna döndürdüğünde de kullanılır.
payment.receivedResulting invoice statusÖdeme kaydedildi veya alınan tutar arttı. Genellikle processing veya settled; bu olay tek başına ödeme tamamlanma kanıtı değildir.
invoice.processingprocessingÖdeme tespit edildi, ancak kabul edilen tutar veya gereken kesinlik henüz sağlanmadı. Kısmi ödemeler dahildir.
invoice.settledsettledÖdeme tamamlama politikası karşılandı veya elle kabul edildi. Siparişi yerine getirmeden önce resolution alanını ve siparişini kontrol et.
invoice.expiredexpiredÖdeme son tarihi geçti. İzleme sürerken geç ödeme durumu yine değiştirebilir.
invoice.invalidinvalidOtomatik kabul edilemiyor, ödeme kanıtı kayboldu veya satıcı reddetti. Faturayı incele.
invoice.cancelledcancelledFatura iptal edildi. Siparişi yerine getirme; iptal, zincir üstü ödemeyi iade etmez.
Ethereum ve Solana neden farklı olay akışları gönderebilir

Onaylar daha sonra gelir (Ethereum örneği)

Sıraevent_typestatus
1invoice.creatednew
2payment.receivedprocessing
2invoice.processingprocessing
3invoice.settledsettled

Tespit edildiğinde zaten kesinleşmiştir (Solana örneği)

Sıraevent_typestatus
1invoice.creatednew
2payment.receivedsettled
2invoice.settledsettled

Bunlar olay oluşumunu gösterir; teslim sırası garanti edilmez. Tespit zamanlamasına ve ödeme tamamlama politikasına bağlı olarak iki akış da başka zincirlerde görülebilir. settled öncesinde processing olayı şartı koyma.

Bir kez yerine getir: alıcı örneği ve yinelenme koruması
YaklaşımNasıl ele alınır
Olay tabanlı alıcıAyrı olayları imzalı event_id ile sakla, ardından status = settled olan invoice.settled olayını seç. Aynı sequence değerindeki payment.received önce geldi diye bu olayı atma.
SDK sipariş durumu gelen kutusuSunulan PHP, Python ve Node alıcı örnekleri proje + invoice_id + sequence değerlerine göre birleştirir. Kaydedilen durumu event_type değerinden bağımsız işle, güncel faturayı getir ve settled ise bir kez yerine getir. Bu birleştirmeden sonra yalnızca invoice.settled filtresi ekleme.

Yeniden deneme event_id ve ilk gövdeyi korur. Farklı olaylar aynı sequence değerini paylaşabilir, ancak event_id değerleri farklıdır. Olay tabanlı işlemede teslimleri imzalı event_id ile tekilleştir; siparişin yerine getirilmesini ayrıca yapılandırılmış kurulum/proje + invoice_id ve siparişine göre koru. Sonradan yeniden tamamlanma siparişe ikinci kez alacak kaydetmemelidir.

HTTP receiver:
  Verify raw-body signature, timestamp and configured project/store scope.
  Save to a durable inbox; deduplicate the signed event_id.
  Return HTTP 2xx only after persistence succeeds.

Event-based background worker:
  Other events go to status/reconciliation handling, not fulfilment.
  Continue here only for event_type = invoice.settled and status = settled.
  Fetch the current invoice from your configured API origin.
  Check settled status, project/store, order, amount, currency and review policy.
  In one database transaction:
    Lock the order and check the scoped invoice has not been fulfilled.
    Credit/complete once and save the fulfilment record.
    Queue any external fulfilment with the same business idempotency key.

SDK order-state worker:
  Use the same current-invoice checks and fulfil-once transaction.
  Do not filter event_type after collapsing events by invoice revision.

Sözde koddur; doğrudan kullanılabilir alıcı değildir.

Tüm fatura durumları ve ödeme istisnaları
AlanDeğerlerAnlamı
statusnew, processing, settled, expired, invalid, cancelledOlay oluşturulduğundaki fatura durumu; teslim anındaki güncel durumu olmak zorunda değildir.
amount_statusnone, partial, paid, overpaidKabul edilen tolerans dahil alınan tutar. paid, onay kesinliği anlamına gelmez.
timing_statuson_time, lateÖdemenin fatura son tarihine yetişip yetişmediği.
resolutionautomatic, manually_settled, manually_invalidatedSonucu normal kuralların mı yoksa elle kabul/ret işleminin mi belirlediği.
requires_reviewfalse, trueİstisna ipucu; başka bir fatura durumu veya otomatik sipariş yerine getirme/iade izni değildir.
Durumİşleme
Eksik ödeme / toleransOtomatik kurallarda partial ödemeyi tamamlamaz. paid kabul edilen eksik tutarı içerebilir, ancak kesinlik yine gereklidir. Yalnızca tutar karşılaştırmasını değil, fatura durumunu kullan.
Fazla ödemeoverpaid, settled ve requires_review = true ile birlikte bulunabilir. Fazla ödeme politikanı uygula; siparişe asla iki kez alacak kaydetme veya doğrulanmamış adrese otomatik iade yapma.
Geç ödemeİzleme sürerken expired daha sonra değişebilir. timing_status = late inceleme gerektiğini belirtir; iptal edilmiş siparişi otomatik yeniden açma veya gönderme.
Elle kabulinvoice.settled, uygun zincir üstü fon olmadan resolution = manually_settled taşıyabilir. Entegrasyonunun bu istisnai kabulü tanıyıp tanımayacağına karar ver; ödeme özeti alanları null olabilir.
Zincir yeniden yapılanması / geçersiz kılmaYeni revizyon önceki ödeme kanıtını geçersiz kılabilir. Güncel durumu yeniden getir ve geri alma işlemini mutabakatla ele al. Sipariş bir kez tamamlanmıştı diye bunu yok sayma.
Sıfır onay / sıfır tutarSıfır onaylı tamamlanma tespit anında gerçekleşebilir ve zincir yeniden yapılanması riski taşır. Açıkça izin verilen sıfır tutarlı fatura ödeme olmadan tamamlanır. İkisi de öncesinde payment.received olayı gerektirmez.

Siparişi yerine getirmek için amount_status = paid veya ödeme sayfası yönlendirmesi değil, status = settled kullan. Gereken onay sayısı sıfırsa tamamlanma tespit anında olabilir; bu, zincir yeniden yapılanması riski taşır.

Eksik ödeme amount_status = partial, fazla ödeme overpaid değeridir. paid, faturanın eksik ödeme toleransı dahil kabul edilen asgari tutarın geldiği anlamına gelir. Bunlar tutar durumlarıdır, fatura durumları değildir. late ayrı bir olay değil, timing_status değeridir.

Tipik akış new → processing → settled şeklindedir, ancak ara durumlar atlanabilir. Açıkça izin verilen sıfır tutarlı fatura ödeme olmadan tamamlanır ve amount_status = none olarak kalır. Elle kabul manually_settled olarak işaretlenir.

Geri çağrılar canlı durum yanıtları değil, değiştirilemez anlık görüntülerdir. Geç, sırasız veya birden fazla kez gelebilirler. Ödeme ve durum olayları aynı fatura sıra numarasını ve fatura durumu alanlarını paylaşabilir; ancak imzalı event_id ve event_type değerleri farklıdır. Onay sayıları her blok için garantili geri çağrı üretmez.

Aldığın bilgiler

{
  "invoice_id": "11111111-2222-4333-8444-555555555555",
  "status": "settled",
  "amount_status": "paid",
  "timing_status": "on_time",
  "resolution": "automatic",
  "sequence": 3,
  "amount": "49.9",
  "currency": "EUR",
  "order_id": "order-1042",
  "payload_version": 2,
  "event_id": "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa",
  "event_type": "invoice.settled",
  "occurred_at": "2026-09-14T12:05:00Z",
  "project_id": "11111111-1111-4111-8111-111111111111",
  "store_id": "22222222-2222-4222-8222-222222222222",
  "description": "Annual plan",
  "email": "ada@example.test",
  "customer": {
    "firstname": "Ada",
    "lastname": "Lovelace",
    "countryiso2": "GB"
  },
  "metadata": {
    "firstname": "Ada",
    "lastname": "Lovelace",
    "countryiso2": "GB",
    "cart_id": "cart-681"
  },
  "created_at": "2026-09-14T12:00:00Z",
  "updated_at": "2026-09-14T12:05:00Z",
  "expires_at": "2026-09-14T12:15:00Z",
  "monitoring_expires_at": "2026-09-21T12:15:00Z",
  "settled_at": "2026-09-14T12:05:00Z",
  "paid_chain": "ethereum",
  "paid_asset": "USDC",
  "paid_asset_amount": "58.17342",
  "paid_asset_amount_received": "58.17342",
  "paid_payment_method_id": "33333333-3333-4333-8333-333333333333",
  "settlement_exchange_rate": {
    "rate": "1.17",
    "units": "asset_per_invoice_currency",
    "currency": "EUR",
    "symbol": "USDC",
    "observed_at": "2026-09-14T12:05:00Z",
    "as_of": "2026-09-14T12:04:30Z",
    "pricing_provider": "kraken",
    "asset_provider": "kraken",
    "pricing_fetched_at": "2026-09-14T12:04:30Z",
    "asset_fetched_at": "2026-09-14T12:04:30Z",
    "stale": false,
    "is_fixed": false,
    "reference_currency": "USD",
    "uses_reference_proxy": false
  },
  "cancelled_at": null,
  "exchange_rate_spread_percent": "0.5",
  "underpayment_tolerance_percent": "1",
  "reason_code": "payment_confirmed",
  "requires_review": false,
  "links": {
    "checkout": "https://pay.example.com/invoice/11111111-2222-4333-8444-555555555555",
    "invoice": "https://api.example.com/v1/projects/11111111-1111-4111-8111-111111111111/invoices/11111111-2222-4333-8444-555555555555",
    "payments": "https://api.example.com/v1/projects/11111111-1111-4111-8111-111111111111/invoices/11111111-2222-4333-8444-555555555555/payments"
  },
  "payment_info": {
    "active_payment_method_id": "33333333-3333-4333-8333-333333333333",
    "method_count": 1,
    "methods_truncated": false,
    "methods": [
      {
        "payment_method_id": "33333333-3333-4333-8333-333333333333",
        "payment_rail": "onchain",
        "chain_slug": "ethereum",
        "network": "mainnet",
        "caip_network_id": "eip155:1",
        "asset_id": "44444444-4444-4444-8444-444444444444",
        "asset_key": "eip155:1/erc20:0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
        "caip_asset_id": "eip155:1/erc20:0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
        "asset_name": "USD Coin",
        "symbol": "USDC",
        "asset_kind": "token",
        "asset_decimals": 6,
        "contract_address": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
        "token_standard": "erc20",
        "destination_address": "0x1111111111111111111111111111111111111111",
        "destination_tag": null,
        "status": "paid",
        "amounts": {
          "expected_amount": "58.17342",
          "expected_amount_atomic": "58173420",
          "received_amount": "58.17342",
          "received_amount_atomic": "58173420",
          "confirmed_amount": "58.17342",
          "confirmed_amount_atomic": "58173420",
          "unconfirmed_amount": "0",
          "unconfirmed_amount_atomic": "0",
          "minimum_payment_amount": "57.591686",
          "minimum_payment_amount_atomic": "57591686",
          "remaining_amount": "0",
          "remaining_amount_atomic": "0",
          "remaining_to_full_amount": "0",
          "remaining_to_full_amount_atomic": "0",
          "overpaid_amount": "0",
          "overpaid_amount_atomic": "0"
        },
        "acceptance": {
          "finality_mode": "confirmations",
          "required_confirmations": 2,
          "observed_confirmations": 2,
          "underpayment_tolerance_percent": "1"
        },
        "quote": {
          "effective_rate": "1.1658",
          "reference_rate": "1.16",
          "units": "asset_per_invoice_currency",
          "currency": "EUR",
          "symbol": "USDC",
          "exchange_rate_spread_percent": "0.5",
          "quote_expires_at": "2026-09-14T12:15:00Z",
          "provenance_available": true,
          "rounding": "up",
          "unrounded_payment_amount": "58.17342",
          "rounding_adjustment": "0",
          "pricing_provider": "kraken",
          "asset_provider": "kraken",
          "pricing_fetched_at": "2026-09-14T11:59:30Z",
          "asset_fetched_at": "2026-09-14T11:59:30Z"
        },
        "market_rate_at_event": {
          "rate": "1.17",
          "units": "asset_per_invoice_currency",
          "currency": "EUR",
          "symbol": "USDC",
          "observed_at": "2026-09-14T12:05:00Z",
          "pricing_provider": "kraken",
          "asset_provider": "kraken",
          "pricing_fetched_at": "2026-09-14T12:04:30Z",
          "asset_fetched_at": "2026-09-14T12:04:30Z",
          "as_of": "2026-09-14T12:04:30Z",
          "stale": false,
          "is_fixed": false,
          "reference_currency": "USD",
          "uses_reference_proxy": false
        },
        "payment_count": 1,
        "payments_truncated": false,
        "payments": [
          {
            "payment_id": "55555555-5555-4555-8555-555555555555",
            "payment_method_id": "33333333-3333-4333-8333-333333333333",
            "transaction_id": "0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
            "payment_hash": null,
            "event_index": 0,
            "payment_rail": "onchain",
            "chain_slug": "ethereum",
            "network": "mainnet",
            "asset_id": "44444444-4444-4444-8444-444444444444",
            "asset_key": "eip155:1/erc20:0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
            "caip_asset_id": "eip155:1/erc20:0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
            "symbol": "USDC",
            "asset_decimals": 6,
            "amount": "58.17342",
            "amount_atomic": "58173420",
            "status": "final",
            "counts_towards_received": true,
            "confirmations": 2,
            "block_height": 26000000,
            "observed_at": "2026-09-14T12:04:30Z",
            "chain_time": "2026-09-14T12:04:20Z",
            "finalized_at": "2026-09-14T12:05:00Z",
            "explorer_name": "Etherscan",
            "explorer_url": "https://etherscan.io/tx/0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
          }
        ],
        "links": {
          "payments": "https://api.example.com/v1/projects/11111111-1111-4111-8111-111111111111/invoices/11111111-2222-4333-8444-555555555555/payments?payment_method_id=33333333-3333-4333-8333-333333333333"
        }
      }
    ]
  }
}

amount faturanın ilk toplamıdır. payment_info gözlenen kripto transferlerini, hâlâ eksik tutarları ve kilitli kurları açıklar. Sürüm 2 ayrıca olay adını, olay kimliğini ve proje/mağaza kapsamını imzalar.

Tüm geri çağrı alanları ve ek fatura verileri
AlanTürAnlamı
invoice_idUUIDKimlik doğrulamalı fatura ayrıntısı rotasında kullanılan herkese açık fatura UUID'si
statusstringAnlık görüntüdeki fatura durumu: new, processing, settled, expired, invalid, cancelled
amount_statusstringnone, partial, paid veya overpaid; paid kabul edilen eksik ödeme toleransını içerir, onay kesinliğini içermez
timing_statusstringon_time veya late
resolutionstringautomatic, manually_settled veya manually_invalidated
sequenceintegerArtan fatura revizyonu; farklı olaylar aynı revizyonu paylaşabilir. Tamsayı hassasiyetini kaybetmeden karşılaştır
amountdecimal stringAlınan kripto tutarı değil, faturanın ilk toplamı; ondalık hassasiyeti koru
currencystringamount alanının para birimi; ör. USDC ile ödenen EUR fatura için EUR
order_idstring | nullSatıcı sipariş referansı
payload_versionintegerYeni üretilen 4.1.0+ olaylar için 2; saklanan eski olaylarda bulunmaz
event_idUUIDYeniden denemelerde ve elle tekrar teslimde değişmeyen imzalı olay kimliği
event_typestringYedi abonelik olayından biri
occurred_attimestampTeslim zamanı değil, bu değiştirilemez olayın oluşturulma zamanı
project_idUUIDSatıcı proje kapsamı; yapılandırılmış alıcıyla eşleştir
store_idUUIDSatıcı mağaza kapsamı; yapılandırılmış alıcıyla eşleştir
descriptionstring | nullİlk fatura açıklaması
emailstring | nullOlay oluşumunda isteğe bağlı müşteri e-postası
customerobjectTanınan isteğe bağlı müşteri meta veri alanları; tahmin edilmiş veya zenginleştirilmiş kişisel veri yok
metadataobjectOlay oluşturulduğu andaki özgün satıcı meta verileri
created_attimestampFatura oluşturulma zamanı
updated_attimestampFatura durumu güncellenme zamanı
expires_attimestampFatura ödeme son tarihi
monitoring_expires_attimestampGeç ödeme izlemesinin son tarihi
settled_attimestamp | nullÖdemenin tamamlanma zamanı
paid_chainstring | null4.1.2+: ödemeyi tamamladığı kanıtlanan yöntemin zincir kısa adı; ör. ethereum; kaydedilmiş uygun tamamlanma yoksa null
paid_assetstring | null4.1.2+: yerel coin veya token sembolü; ör. BTC, ETH veya USDC; benzersiz varlık kimliği değil, görüntüleme etiketi
paid_asset_amountdecimal string | null5.0.1+: tolerans düşülmeden önce paid_asset biriminde istenen kilitli tam tutar; ödeme tamamlanırken kaydedilir
paid_asset_amount_receiveddecimal string | null5.0.1+: kabul edilen eksik/fazla tutarlar dahil, ödeme tamamlanırken sonuç veren yöntemle alınan geçerli toplam; sabittir, canlı bakiye değildir
paid_payment_method_idUUID | null4.1.2+: ödemeyi tamamlayan isteğin kimliği; payment_info.methods[].payment_method_id ve onun tam ağ/sözleşmesiyle eşleşir
settlement_exchange_rateobject | null4.1.2+: açık birimler, para birimi, kaynak zaman damgaları ve kalite işaretleriyle tamamlanma anında kaydedilmiş, fiyat marjı öncesi piyasa görüntüsü; teslimde yeniden fiyatlandırılmaz
cancelled_attimestamp | nullİptal zamanı
exchange_rate_spread_percentdecimal stringGüncel mağaza varsayılanı değil, kilitlenmiş fiyat marjı
underpayment_tolerance_percentdecimal stringKilitlenmiş fatura toleransı; her yöntem ayrıca geçerli toleransını bildirir
reason_codestring | nullMakine tarafından okunabilir durum geçişi nedeni
requires_reviewbooleanÖdeme istisnası ipucu; otomatik sipariş yerine getirme veya iade izni değildir
linksobjectOlay oluşumundaki ödeme sayfası, kimlik doğrulamalı fatura ve ödemeler URL'leri. Önce Mağaza → Temel alan adı tercihleri, ardından varsayılan mağaza, sonra genel birincil adres uygulanır; yalnızca rolle eşleşen etkin alan adları kullanılır. Yeniden denemeler ilk imzalı bağlantıları korur; etkin ana makine kaydı yoksa null olur.
payment_infoobjectGerçekte gözlenen yöntemler, tam tutarlar, kilitli teklif, bilgi amaçlı piyasa görüntüsü ve sınırlandırılmış ödeme gözlemleri; aşağıdaki alan gruplarına bak

Ödeme tamamlanma özeti: settlement_exchange_rate

AlanTürAnlamı
rate / units / currency / symbolstringsFiyat marjı öncesinde, bir fatura para birimi başına varlık birimi. Ondalık sayı dizesidir; ödeme tutarı veya gerçekleşmiş alım satım değildir.
observed_at / as_oftimestampsTamamlanma görüntüsünün alınma zamanı / daha eski kaynak zaman damgası. Önbellek verilerini canlı fiyat hareketi olarak değerlendirme.
pricing_provider / asset_provider / pricing_fetched_at / asset_fetched_atstrings / timestampsÖdeme tamamlanırken kaydedilen itibari para ve varlık fiyat kaynakları ile alınma zamanları.
stale / is_fixed / uses_reference_proxy / reference_currencybooleans / stringmarket_rate_at_event ile aynı kalite işaretleri. Sabit proje fiyatları etiketlenir; referans para birimi USD'dir.
Missing snapshot or pricenullTahmini geçmiş kur yoktur. Tamamlanmadan önce tüm özet alanları null'dur; yalnızca fiyatların eksik olması, kanıtlanmış paid_* tanımlayıcılarının kullanılabilirliğini etkilemez.

Ödeme yöntemleri: payment_info

AlanTürAnlamı
active_payment_method_idUUID | nullSonuç veren veya seçili gözlenen yöntem. Tespitten önce veya geçersiz kılındıktan sonra null; varsayılan yöntem tahmin edilmez.
method_count / methods_truncatedinteger / booleanGözlenen toplam yöntem sayısı ve gömülü yöntem listesinin eksik olup olmadığı.
methods[]object[]En fazla sekiz gözlenen yöntem; etkin yöntem önce gelir. Farklı varlıklar birlikte toplanmaz.
payment_method_id / payment_railUUID / stringFatura ödeme isteği kimliği ve onchain veya lightning aktarım türü.
chain_slug / network / caip_network_idstringAğ kimliği. Token kimliğini her zaman ağıyla eşleştir.
asset_id / asset_key / caip_asset_idUUID / string / nullable stringDoğrulanmış kayıt kimliği; semboller tek başına benzersiz değildir.
asset_name / symbol / asset_kindstringVarlığın görünen adı, sembolü ve yerel coin veya token türü.
contract_address / token_standardstring | nullToken sözleşmesi veya mint'i ve standardı; yerel varlıklarda null.
asset_decimalsintegerAtomik hassasiyet; Lightning BTC için 11 kullanılır.
destination_address / destination_tagstring | nullHerkese açık ödeme alma adresi ve gereken memo/tag. Lightning için adres null'dur; asla özel anahtar değildir.
statusstringYöntem durumu: pending, partial, paid, overpaid, expired veya invalid. paid tek başına faturanın ödemesinin tamamlandığı anlamına gelmez.
payment_count / payments_truncated / payments[]integer / boolean / object[]Toplam gözlem sayısı ve en son beş veya daha az gözlem. Her gözlem aşağıda açıklanır.
links.paymentsHTTPS URL | nullYapılandırılmış API köken adresinde bu yöntem için kimlik doğrulamalı, sayfalanmış geçmiş.

Tam tutarlar: methods[].amounts

AlanTürAnlamı
expected_amountdecimal stringFiyat marjı ve yukarı yuvarlama sonrasındaki kilitli tam teklif.
received_amount / confirmed_amountdecimal stringsTespit edilen geçerli fonlar / bu yöntemin onay veya kesinlik politikasını karşılayan fonlar.
unconfirmed_amountdecimal stringmax(received - confirmed, 0). Gönderilmesi gereken ek tutar değildir.
minimum_payment_amountdecimal stringTolerans sonrası kabul eşiği. Tam teklifin altında olabilir.
remaining_amountdecimal stringmax(minimum accepted - received, 0). Onay ilerlemesi değil, kabul eşiğine ulaşmak için gereken ek fon.
remaining_to_full_amountdecimal stringmax(full quote - received, 0); tolerans dikkate alınmaz.
overpaid_amountdecimal stringmax(received - full quote, 0). Otomatik iade yetkisi vermez.
Every amount's *_atomic companioninteger stringEn küçük birimde tam gösterim. Ondalık veya tamsayı kütüphaneleri kullan; para için asla kayan nokta veya JavaScript Number kullanma.

Onay politikası: methods[].acceptance

AlanTürAnlamı
finality_mode / required_confirmationsstring / integerKilitlenmiş onay sayısı veya finalized politikası. Sıfır onaya satıcı politikası açıkça izin verir; ağ genelinde kesinlik anlamına gelmez.
observed_confirmationsinteger | nullYalnızca en yeni transferin değil, geçerli gözlemler arasındaki asgari değer. Lightning için veya geçerli gözlem yoksa null.
underpayment_tolerance_percentdecimal stringGeçerli yöntem toleransı. Faturanın zincir üstü toleransı sıfırdan farklı olsa bile Lightning sıfır kullanır.

Kurlar: methods[].quote ve market_rate_at_event

AlanTürAnlamı
quote.effective_rate / units / currency / symbolstringsFiyat marjı dahil kilitlenmiş asset_per_invoice_currency kuru; para birimi ve sembol yönü açıkça belirtir.
quote.exchange_rate_spread_percent / quote_expires_atdecimal string / timestampKilitlenmiş fiyat marjı ve teklif son tarihi. Güncel mağaza ayarlarıyla asla değiştirilmez.
quote.reference_rate / unrounded_payment_amount / rounding_adjustmentdecimal string | nullFiyat marjı öncesi referans, yuvarlama öncesi ödeme tutarı ve varlık birimindeki yukarı düzeltme.
quote.pricing_provider / asset_provider / pricing_fetched_at / asset_fetched_atstring or timestamp | nullİlk para birimi ve varlık fiyat kaynakları/zamanları. API anahtarı veya sağlayıcı kimlik bilgisi içermez.
quote.provenance_available / roundingboolean / stringKayıtlı kaynak görüntüsü olmayan eski faturalarda false; yuvarlama yukarı yönlüdür.
market_rate_at_eventobject | nullBu olay oluşturulduğunda önbellekte bulunan bilgi amaçlı piyasa görüntüsü. Eksik veriler null kalır; fatura tutarlarını asla değiştirmez veya ağdan veri almak için beklemez.
market_rate_at_event.rate / units / currency / symbolstringsquote ile aynı açık yönde, fiyat marjı öncesi piyasa kuru.
market_rate_at_event.observed_at / as_of / pricing_fetched_at / asset_fetched_attimestampsOlay görüntüsü zamanı / iki kaynaktan eski olanın zamanı / her kaynağın zamanı.
market_rate_at_event.pricing_provider / asset_providerstringsYapılandırılmış özel token fiyatları dahil, önbellekteki para birimi ve varlık kaynakları.
market_rate_at_event.stale / is_fixed / uses_reference_proxy / reference_currencybooleans / stringÖnbelleğin eski, token fiyatının sabit olup olmadığı veya USD referansının stablecoin vekili kullanıp kullanmadığı. Referans para birimi USD'dir. Eski veri bilgi amaçlıdır; asla güncel teklif değildir.

Transfer kayıtları: methods[].payments[] ve GET …/payments

AlanTürAnlamı
payment_id / payment_method_idUUIDGözlem kimliği / üst ödeme isteği kimliği. Geçmişi tekilleştirmek için payment_id kullan.
transaction_id / payment_hash / event_indexstring | null / integerZincir üstü hash ve transfer/günlük/çıktı indeksi ya da Lightning hash'i. Lightning'de işlem veya gezgin bağlantısı yoktur.
payment_rail / chain_slug / network / asset_id / asset_key / caip_asset_id / symbol / asset_decimalsstrings / UUID / integerİçeren yöntemle aynı varlık ve ağ tanımlayıcıları.
amount / amount_atomicdecimal / integer stringsBu transferin tam değeri; asla itibari para dönüşümü değildir.
status / counts_towards_receivedstring / booleandetected, confirming ve final sayılır; reorged, replaced ve invalid sayılmaz. Mutabakat için geçersiz kılınmış geçmişi koru.
confirmations / block_heightinteger | nullGözlemin blok verileri; Lightning için onaylar null.
observed_at / chain_time / finalized_attimestamp | nullYerelde ilk görülme zamanı, varsa güvenilir zincir zamanı ve ulaşılmışsa politikaya göre kesinleşme zamanı.
explorer_name / explorer_urlstring | nullDesteklenen yerlerde doğrulanmış herkese açık blok gezgini referansı.

Merchant 5.13.3, doğrulanmış dahili gas fonlama transferlerini müşteri ödeme toplamlarından, payment_info alanından, fatura ödemeleri API'sinden, iade sınırlarından ve payment.received olaylarından hariç tutar. Bunların zincir/hazine kayıtları cüzdan muhasebesi için kullanılabilir kalır. Normal transferler ve gerçek fazla ödemeler sayılmaya devam eder. Mevcut imzalı geri çağrı gövdeleri asla yeniden yazılmaz. Geçmiş bir tamamlanma müşteri fonları yerine dahili fonlamaya dayanmışsa mutabakat, reason_code internal_gas_funding_excluded ile invoice.invalid üretir; siparişi yeniden yerine getirmek yerine bunu incele.

Merchant 4.1.0, ilk dokuz alanı taşımadan veya değiştirmeden payload_version 2 ekler. Önceden kuyruğa alınmış olaylar ilk gövdelerini korur ve payload_version içermeyebilir. event_id, event_type ve proje/mağaza kimlikleri artık imzalı gövdededir; aktarım olay/teslim üst bilgileri imzasız kalır.

payment_info, sunulan tüm ödeme seçeneklerini değil, gözlenen ödemeleri açıklar. Tespitten önce active_payment_method_id null ve methods boştur. Zincir yeniden yapılanmasından etkilenen/geçersiz gözlemler, etkin yöntem null olduktan sonra da methods içinde kalabilir. Farklı varlık veya ağların tutarlarını asla bir araya toplama.

Tüm tutarlar, atomik tamsayılar, kurlar ve yüzdeler dizedir. received_amount onay bekleyen geçerli fonları içerir; confirmed_amount o yöntemin kesinlik politikasını karşılar. remaining_amount, max(minimum_payment_amount minus received_amount, 0); remaining_to_full_amount, max(expected_amount minus received_amount, 0) değeridir. Örnek: 100 USDC bekleniyor, 99 alındı ve tolerans %1 ise remaining_amount 0, remaining_to_full_amount 1 olur. Kesinlik yine gereklidir.

quote kilitlenmiş fatura hesabıdır: bir fatura para birimi başına varlık birimi. Fiyat marjı yukarı yuvarlamadan önce uygulanır. Tam ödeme karşılaştırması için expected_amount_atomic kullan; yalnızca gösterilen kur yukarı yuvarlamayı yeniden üretmeyebilir. Kayıtlı kaynak kökeni olmayan eski faturalar null kaynak/referans/yuvarlama alanları ve provenance_available false döndürür; bugünün verileri asla geçmiş teklif gibi sunulmaz.

market_rate_at_event, fiyat marjı öncesi bilgi amaçlı önbellek verisidir ve olay oluşumunda sabitlenir. Kaynak zamanlarını, eski veri ve referans vekili işaretlerini içerir; kullanılabilir önbellek çifti yoksa null olur. Hiçbir canlı kur isteği bildirimi engellemez ve bu piyasa gözlemi borçlu olunan tutarı asla değiştirmez. Sabit özel token'lar is_fixed olarak etiketlenir; DEX token'ları aynı sembollü başka token yerine projelerine özel kaynağı kullanır.

Üst düzey paid_chain, paid_asset, paid_payment_method_id ve settlement_exchange_rate (4.1.2+) alanları, ödeme tamamlandıktan sonra kanıtlanmış sonuç veren yöntemi tanımlar; seçilmiş ödeme seçeneğini veya farklı yöntemlerin toplamını değil. Tamamlanmadan önce, geçersiz kılındıktan sonra, görüntüsü alınmamış eski tamamlanmalarda veya politikaya göre kesinleşmiş uygun fon olmadan elle kabulde özet alanları null olur. Semboller görüntüleme etiketleridir: tam ağ/varlık/sözleşme kimliği için yöntem kimliğini takip et.

Merchant 5.0.1, paid_asset biriminde tam ondalık sayı dizeleri olarak paid_asset_amount ve paid_asset_amount_received ekler; payload_version 2 olarak kalır. paid_asset_amount, fiyat marjı ve yukarı yuvarlama dahil kilitli tam tekliftir; tolerans eşiği veya kalan bakiye değildir. paid_asset_amount_received, onay bekleyen fonlar ve kabul edilen eksik/fazla tutarlar dahil, sonuç veren yöntemin tamamlanma anındaki geçerli toplam tahsilatıdır. Örnek: 100 USDC teklif edildi, 99 alındı ve toleransla kabul edildi ise değerler 99 ve 99 değil, 100 ve 99 olur. İkisi de tamamlanma görüntüsüyle sabitlenir; her olay anındaki tahsilatlar için payment_info.methods[].amounts, güncel kayıtlar için ödemeler API'sini kullan. Uygun görüntü yoksa ve 5.0.1 öncesi görüntülerde null olurlar; eski kuyruk olaylarının gövdeleri değişmez. Muhasebe için tam ondalık sayı dizelerini asla kayan noktaya dönüştürme.

settlement_exchange_rate, ödeme tamamlanırken kaydedilen fiyat marjı öncesi önbellek piyasa gözlemidir; kilitlenmiş fatura teklifi veya gerçekleşmiş borsa işlemi değildir. Yapısı market_rate_at_event ile eşleşir; EUR/USDC ile 1.17 asset_per_invoice_currency, 1 EUR = 1.17 USDC demektir. Kaynak zaman damgaları ve eski/sabit/vekil işaretleri kalitesini açıklar. Eksik çift kuru null bırakır, ancak kanıtlanmış yöntemde paid_* alanları yine bulunur. Borçlu olunan tutarı asla değiştirmez veya canlı sağlayıcı çağrısı beklemez. Aynı yöntemle sonraki ödemeler, yeniden denemeler ve tekrar teslim, kaydedilmiş null kur dahil saklanan görüntünün yerini alamaz. Gerçek yeniden tamamlanma veya tamamlayan yöntemin değişmesi yeni görüntü alır; observed_at bu alımı belirtirken settled_at ilk tamamlanma zamanını koruyabilir. Eski olay gövdeleri değişmez.

Sayılar ve kısaltma işaretleriyle en fazla sekiz gözlenen yöntem ve yöntem başına son beş ödeme gözlemi dahil edilir. Yük boyutu sınırı bu dizileri daha da küçültebilir. Ödeme gözlemi tek bir transfer/günlük/UTXO çıktısıdır; mutlaka benzersiz işlem hash'i değildir. Güncel geçmişin tamamı için payment_method_id, limit ve offset ile GET /v1/projects/YOUR_PROJECT_ID/invoices/{invoice_id}/payments kullan. Fatura ayrıntısı teklif verilen her yöntemi ve quote_details alanını korur. API bağlantıları yapılandırılmış sunucunu ve kimlik bilgilerini gerektirir; bearer token'ını asla geri çağrının sağladığı rastgele URL'ye iletme.

Lightning, transaction_id yerine payment_hash kullanır; ödeme alma adresi, gezgin ve gözlenen onaylar null olur. Tam BTC tutarı 11 ondalık basamak (millisatoshi) kullanır ve geçerli toleransı sıfırdır. BOLT11 ödeme preimage'ı, cüzdan anahtarı, imzalama sırrı veya sağlayıcı kimlik bilgisi dahil edilmez. Müşteri/meta veri alanları yalnızca satıcı yanıtlarına ve imzalı geri çağrılara aittir; herkese açık ödeme sayfasına asla konmaz. Meta verilere kimlik bilgisi yazma.

Sayfalanmış ödeme geçmişi →

Güvenle al

  1. Ayrıştırmadan önce birebir ham gövdeyi eşleşen sırla doğrula. Mağaza → IPN, özel ipn_url teslimleri dahil IPN sırrını sağlar. Her Mağaza → Webhook'lar uç noktasının kendi sırrı vardır. Hiçbiri API token'ın değildir; birini yenilemek diğerlerini yenilemez.
  2. İmzalı zaman damgasını kontrol et (SDK varsayılanı: her iki yönde beş dakika) ve varsa imzalı proje/mağaza kimliklerini alıcı yapılandırmanla eşleştir. HTTP 2xx döndürmeden önce kalıcı kuyruğa kaydet. Olay başına işlemede v2 event_id imzalıdır; üst bilgi kimlikleri tek başına tekrar oynatma koruması değildir, çünkü bu üst bilgiler imzalanmaz. Sipariş durumu gelen kutularında invoice_id ve sequence ile tekilleştir ve tüm v2 gövdesini değil, özgün fatura durumu alanlarını karşılaştır: farklı olay türleri/kimlikleri aynı revizyonu paylaşabilir.
  3. Bir çalışanda güncel faturayı rastgele geri çağrı bağlantısından değil, yapılandırılmış API kökeninden getir. Kayıtlı siparişi, proje/mağazayı, tutarı ve para birimini eşleştir; güncel settled durumu şartını koy ve elle kabul ile istisna politikanı uygula. Olay tekilleştirmesinden bağımsız olarak siparişi kilitle ve veritabanı işlemi içinde bir kez yerine getir.
  4. Eski sequence değerini asla yenisinin üzerine uygulama. Farklı olaylar revizyon paylaşabilir; revizyon düzeyinde tekilleştirmeyi yalnızca invoice.settled filtresiyle birleştirme. Yeniden açma/mutabakat durumu değiştirebilir; güncellemeleri sabit durum sıralaması değil, sequence sıralar. Siparişi yeniden yerine getirmek yerine geri almaları inceleme için kaydet.

Alıcı örnekleri: PHP · Python · Node.js / TypeScript.

İmza doğrulaması ve teslim kuralları
import { createHmac, timingSafeEqual } from "node:crypto";

export function verifyWhollySignature(rawBody, header, signingSecret, toleranceSeconds = 300) {
  const match = /^t=(\d+),v1=([0-9a-f]{64})$/.exec(header || "");
  if (!match) return false;

  const timestamp = Number(match[1]);
  if (!Number.isSafeInteger(timestamp)) return false;
  const now = Math.floor(Date.now() / 1000);
  if (Math.abs(now - timestamp) > toleranceSeconds) return false;

  // rawBody must be the exact request Buffer, before JSON parsing.
  const expected = createHmac("sha256", signingSecret)
    .update(String(timestamp))
    .update(".")
    .update(rawBody)
    .digest();
  const presented = Buffer.from(match[2], "hex");
  return timingSafeEqual(expected, presented);
}
Teslim kuralıAyrıntılar
Üst bilgilerWholly-Signature, Wholly-Event-Id ve Wholly-Delivery-Id; Content-Type application/json'dır.
İmza<unix timestamp>.<exact raw body> üzerinde HMAC-SHA256; üst bilgi biçimi t=<timestamp>,v1=<64 lowercase hex>.
BaşarıHerhangi bir HTTP 2xx yanıtı. Yönlendirmeler izlenmez; 2xx dışındaki yanıtlar başarısızdır.
Zaman aşımları5 saniye bağlantı zaman aşımı ve 10 saniye toplam istek zaman aşımı.
Yeniden deneme takvimiYeniden denenebilir hatalarda en fazla 8 deneme: hemen, ardından önceki deneme bittikten sonra 10 saniye, 1 dakika, 5 dakika, 15 dakika, 1 saat, 6 saat ve 24 saat gecikmeyle. IPN otomatik yeniden dener; webhook otomatik yeniden denemesi uç nokta başına kapatılabilir.
Hedef güvenliğiYalnızca herkese açık HTTPS. Teslim için DNS yeniden doğrulanır ve sabitlenir; yerel/özel/ayrılmış hedefler reddedilir.
Olay saklama süresiBildirim olay yükleri ve teslim kayıtları 90 gün tutulacak şekilde planlanır; saklanan ayrıntılar sınırlı gruplar halinde temizlenir.
Tekilleştirmeİmzalı invoice_id ve sequence değerlerini yapılandırılmış proje kapsamıyla kalıcı sakla. Wholly-Event-Id olayı; Wholly-Delivery-Id teslim kaydını tanımlar (yeniden denemeler aynısını kullanır; elle tekrar teslim yenisini oluşturur). İki kimlik üst bilgisi de imzalı değildir.
Olay adlandırmasıSürüm 2 gövdedeki event_id ve event_type alanlarını imzalar. Kuyruktaki eski olaylarda ikisi de yoktur. Farklı olay türleri aynı fatura sıra numarasını paylaşabilir; fatura durumunun mutabakatını revizyona göre yap veya ayrı olayları imzalı event_id ile tekilleştir.
Sırrı yenilemeYenilemede örtüşme dönemi veya sürüm üst bilgisi yoktur; kuyruktaki, yeniden denenen ve elle yapılan teslimlerin imzaları hemen değişir.
Duraklatılmış teslimlerYetersiz işlem kredisi, yeniden denemeler dahil IPN/webhook'ları duraklatır. Gelen ödemeler devam eder; kuyruğa alınmış bildirimler, yük saklama süresi içinde bakiye yüklendikten sonra devam eder.

Yapay zekâ asistanları · MCP

Satıcı kurulumuna asistan bağla.

Merchant 5.0.0, yapılandırılmış API alan adında isteğe bağlı MCP sunucusu içerir. Paylaşılan Wholly Crypto rölesi üzerinden değil, kendi kurulumunun içinde çalışır.

  1. Ayarlar → API erişimi bölümünü aç. Bu işe özel kimlik bilgisi oluştur, yalnızca asistanın ihtiyaç duyduğu projeleri ata ve salt okunur erişimle başla. Operatörün barındırdığı hesapta önce operatör kurulumun MCP hizmetini açar; sen yalnızca kendi kimlik bilgilerini ve izinlerini yönetirsin.
  2. Yapay zekâ bağlantıları · MCP bölümünde MCP'yi etkinleştir, kimlik bilgisini seç ve MCP erişimini kaydet. Mevcut kimlik bilgileri açıkça etkinleştirilene kadar MCP erişimi kazanmaz.
  3. MCP sunucu URL'sini istemcinin uzak HTTP sunucusu ayarlarına kopyala. OAuth ile satıcı konsoluna giriş yap, istemci adını ve dönüş adresini incele, kimlik bilgisi seç ve onayla. Mevcut Basic Auth ve TOTP korumaların geçerliliğini korur.
  4. Fatura oluşturmak ayrıca okuma/yazma kimlik bilgisi, MCP politikasında Oku ve fatura oluştur seçimi, mcp:invoice:create OAuth kapsamı ve açık onay gerektirir. OAuth bağlantısı, onaydan sonra kimlik bilgisine eklenen projelere asla otomatik erişim kazanmaz.
{
  "mcpServers": {
    "whollycrypto": {
      "url": "https://api.example.com/mcp"
    }
  }
}

MCP kurulum rehberi →

AraçErişimAmaç
list_projectsOku:Bağlantıya atanmış etkin projeler; limit/offset sayfalaması.
list_storesOku:project_id içindeki mağazalar, kimlikler ve etkinlik durumu; limit/offset sayfalaması.
list_payment_methodsOku:project_id + store_id için yapılandırılmış zincir, token ve Lightning yöntemleri.
get_wallet_balancesOku:Güncellik/kullanılabilirlik alanlarıyla ödeme alma adresleri ve önbellekteki bakiyeler; asla cüzdan sırları değil.
list_invoicesOku:Mağaza, durum veya aramaya göre filtrelenen proje faturaları; limit/offset sayfalaması.
get_invoiceOku:project_id + invoice_id ile tam fatura ayrıntıları ve ödeme sayfası bağlantısı.
get_delivery_historyOku:Mağaza IPN/webhook durumları, denemeleri ve HTTP sonuçları. İsteğe bağlı invoice_id/kind filtreleri; sır veya geri çağrı gövdesi yok.
convert_amountOku:from, to ve ondalık sayı dizesi amount ile önbellekteki referans dönüşümü; fatura teklifi değildir.
create_invoiceAçık yazma yetkisiproject_id, store_id, idempotency_key ve invoice (mevcut fatura oluşturma gövdesi). invoice.payment_methods etkin mağaza yöntemlerini filtreler; 5.4.0+ etkin olmayan/kabul edilmeyen seçimleri yok sayar ve eşleşme yoksa mağaza varsayılanlarına döner. Yalnızca zincir seçimi tüm etkin kabul edilen varlıkları seçer. Zincir kapsamlı asset_tickers, 5.3.0'dan itibaren desteklenir. Normal fatura yanıtını döndürür.
Protokol, OAuth ve güvenlik

HTTPS üzerinden Streamable HTTP kullan. Duyurulan protokol sürümlerinden biri üzerinde anlaş ve sonraki POST isteklerine MCP-Protocol-Version ekle. Content-Type: application/json ve Accept: application/json, text/event-stream gönder. Yanıtlar sonlu JSON'dur; yeniden bağlantıda MCP oturum kimliği gerekmez.

OAuth kısa ömürlü erişim token'ları (15 dakika), tek kullanımlık S256 PKCE kodları (5 dakika) ve yenilenen refresh token'ları (bağlantı ömrü 30 gün) kullanır. Kullanılmış yenileme token'ını tekrar kullanmak bağlantıyı iptal eder. Süre dolduğunda, kimlik bilgisi yenilendiğinde, politika veya kanonik API alan adı değiştiğinde yeniden bağlan.

OAuth keşfi yalnızca MCP etkin olduğunda herkese açıktır. resource parametresi, /mcp dahil keşfin döndürdüğü kanonik URL'yle aynı olmalıdır. Dinamik kayıt desteklenir; uzak istemci kimliği meta veri belgeleri ve istemci sırları desteklenmez.

Özel Authorization üst bilgilerini destekleyen istemciler alternatif olarak MCP etkin satıcı API token'ını Bearer olarak kullanabilir. Ayrı REST izinlerini korur; MCP ile sınırlı bağlantı için OAuth'u tercih et. Kimlik bilgilerini asla sohbete, URL'lere, araç argümanlarına veya sürüm kontrolüne yapıştırma.

MCP kimlik bilgisinin dakikalık REST kotasını, tam kaynak IP kısıtlamalarını ve API sunucusu IP kısıtlamalarını paylaşır. OAuth izin listesini aşmaz. Uzak yapay zekâ istemcileri için belgelenmiş çıkış IP'lerine izin ver veya bu kısıtlamayı bilinçli olarak kapalı bırak. MCP/OAuth rotalarına web güvenlik doğrulaması veya önbellekleme uygulanmamalıdır.

HTTP hataları: 401 kimlik doğrulaması ister, 403 köken/IP/izni reddeder, 404 MCP kapalı veya sunucu yanlış demektir, 405 POST kullanmayı belirtir, 413 32 KiB gövde sınırıdır, 429 Retry-After içerir. JSON-RPC hataları error.code kullanır; araç düzeyindeki hatalar HTTP 200 olsa bile result.isError=true kullanır. Başarılı sonuçlar content ve structuredContent içerir.

Listeler varsayılan 25, en fazla 100 satırdır; offset en fazla 1000000 olabilir. Araç yanıtları 2 MiB ile sınırlıdır. Süresi dolan izinler, yetkilendirme istekleri ve istek kotası grupları otomatik temizlenir; ayarlarda en fazla 100 etkin OAuth bağlantısı gösterilir.

Devre dışı proje/mağazalar MCP üzerinden kullanılamaz. Bağlantı mağazanın etkinlik durumunu listeleyebilir; ancak ödeme yöntemlerini veya teslim geçmişini okumak ya da fatura oluşturmak etkin mağaza gerektirir. Normal konsol proje kullanıcıları MCP'yi yönetemez.

Yeni fatura için yeni idempotency_key kullan; zaman aşımından sonra aynı kimlik bilgisi, anahtar ve birebir aynı invoice nesnesiyle yeniden dene. Ondalık tutarlar, fiyat marjı, tolerans, onaylar ve ödeme sayfası görünümü REST fatura sözleşmesine uyar. MCP satıcı ödeme veya kredi politikasını asla atlamaz.

İlk araçlar özel anahtarları/kurtarma ifadelerini gösteremez, fon gönderemez veya aktaramaz, iade yapamaz, geri çağrıları yeniden gönderemez, ödeme yöntemlerini değiştiremez, hesapları/alan adlarını düzenleyemez veya faturalandırmayı yönetemez. Fatura açıklamalarını, müşteri alanlarını ve meta verileri aracı talimatları değil, güvenilmeyen veriler olarak ele al. Bağlı yapay zekâ sağlayıcıları okumalarına izin verdiğin verileri alır.

YöntemYolSözleşme
POST/mcpKimlik doğrulamalı JSON-RPC: initialize, ping, tools/list, tools/call. Bildirim istekleri 202 döndürür; toplu istekler reddedilir.
GET / DELETE/mcpKimlik doğrulamalı 405: sonlu JSON yanıtları; bağımsız SSE akışı ve sunucu tarafı MCP oturumu yok.
GET/.well-known/oauth-protected-resource/mcpKanonik kaynak URL'si ve yetkilendirme sunucusu keşfi; /.well-known/oauth-protected-resource adresinde de bulunur.
GET/.well-known/oauth-authorization-serverOAuth uç noktaları, authorization_code/refresh_token, S256 PKCE ve desteklenen kapsamlar.
POST/mcp/oauth/registerHerkese açık istemci kaydı: client_name ve tam redirect_uris. Yalnızca HTTPS veya geri döngü HTTP. İstemci sırrı veya uzak meta veri alma yok.
GET/mcp/oauth/authorizeclient_id, redirect_uri, response_type=code, resource, code_challenge, code_challenge_method=S256, isteğe bağlı scope/state; konsol onayına yönlendirir.
POST/mcp/oauth/tokenForm kodlamalı authorization_code + code + code_verifier + redirect_uri veya refresh_token + refresh_token. client_id ve resource her zaman eklenmelidir.
POST/mcp/oauth/revokeForm kodlamalı client_id ve token. Eşleşen erişim/yenileme token'ı bağlantısını iptal eder.
Doğrudan araç isteği örneği

Önce MCP istemcin üzerinden başlatma yap ve protokol üzerinde anlaş. Bu örnek sonraki isteği gösterir.

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/mcp" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'MCP-Protocol-Version: 2025-11-25' \
  --header 'Accept: application/json, text/event-stream' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "list_invoices",
    "arguments": {
      "project_id": "YOUR_PROJECT_ID",
      "limit": 10
    }
  }
}'

Operatör API'si

Barındırılan satıcıları ayrı, kapsamı sınırlı sunucu tarafı anahtarlarla oluştur ve yapılandır.

Birden fazla işletme barındır ve kurulumlarını api.example.com/v1/operator üzerinden otomatikleştir. 7.4.0'dan itibaren yalnızca Operatör modunda kullanılabilir. Normal Satıcı API'si değişmez.

  1. Operatör → Ayarlar → Operatör API'si bölümünü aç ve etkinleştir (varsayılan olarak kapalıdır). Yalnızca gereken izinlere ve barındırılan satıcılara sahip ayrı kimlik bilgisi oluştur.
  2. wc_operator_ anahtarını sunucunda tut. Operatör paneli sunucu adını veya satıcı anahtarını değil, API ana makine adını kullan.
  3. Her Operatör POST isteğinden önce Idempotency-Key ve tam istek gövdesini kalıcı sakla. Belirsiz sonuçtan sonra hesabı yeniden oku; yalnızca tekrar denemek için anahtarı değiştirme.
  4. onboarding: direct ve parolayla ya da onboarding: invitation ve parolasız satıcı oluştur. Ardından projeleri/mağazaları oluştur ve ödeme entegrasyonu için proje kapsamlı satıcı anahtarı düzenle.
KapsamErişim
merchants.read / merchants.writeBarındırılan satıcıları listele/oku ve oluştur/güncelle.
users.read / users.write / users.securityKullanıcıları oku/oluştur/güncelle; parolaları değiştirme veya oturumları iptal etme ayrıdır. Asla operatör yöneticisi oluşturmaz.
invitations.read / invitations.writeTek kullanımlık davet/sıfırlama bağlantılarını listele/oku, oluştur, yenile ve iptal et. Yeni kullanıcılar ayrıca users.write; sıfırlamalar ayrıca users.security gerektirir.
credits.read / credits.write / fees.writeBakiyeleri/hesap defterini oku; yerel kredi ver veya düzelt; ileriye dönük ücretleri belirle. Sıfırdan farklı başlangıç kredisi credits.write gerektirir.
topups.read / topups.writeBarındırılan satıcıların kredi ödeme isteklerini oku veya oluştur. Hiçbir API işlemi bunları ödendi olarak işaretleyemez.
projects.read / projects.write / reports.readSatıcı projelerini, mağazalarını, görünümü ve ödeme ayarlarını oluştur/yapılandır; faturaları, cüzdan bakiyelerini ve finansal raporları oku.
merchant_credentials.read / merchant_credentials.writeNormal kapsamlı satıcı anahtarlarını yönet. Güçlü yetkidir: bu anahtarlar oluşturulduktan sonra bağımsız çalışır.
events.read / webhooks.write / audit.read / health.readYaşam döngüsü geçmişini oku; imzalı yaşam döngüsü geri çağrılarını yapılandır; denetim/yetenek/düğüm sağlığı bilgilerini oku.
Katılım, krediler, izinler ve güvenli yeniden denemeler
KonuKural
Kimlik bilgileriİsteğe bağlı sona erme ve tam IPv4/IPv6 izin listesi; varsayılan dakikada 60 istek, 1–600 arasında ayarlanabilir. Her istek, kimlik bilgisini oluşturan yöneticiyi ve güncel kapsamları kontrol eder. HTTP 429 Retry-After içerir.
YalıtımAnahtarlar yalnızca atanmış barındırılan satıcılara erişir. Satıcı oluşturmak ve kurulum genelindeki raporları görmek tüm satıcılara erişim gerektirir. Operatörün kendi işletmesi hariçtir.
İlk girişDoğrudan oluşturulan hesaplar, sunucuyu barındıranın cüzdan anahtarlarına erişebileceğini kabul eder. require_password_change ilk girişte parola değişikliği ekler. Davet kabulü açık saklama onayı, ardından normal giriş gerektirir. Basic Auth ve mevcut TOTP geçerliliğini korur.
DavetlerYeni kullanıcı bağlantıları 48 saat; parola sıfırlama bağlantıları bir saat geçerlidir. Token'lar tek kullanımlıktır. Yeniden oluşturma eski bağlantıyı iptal eder. SMTP kabulü gelen kutusuna teslim garantisi değildir; email_delivery alanını incele.
Güvenli yeniden denemelerHer Operatör POST isteği 16–128 karakterlik anahtar gerektirir (harf, rakam, -, _ veya .). Aynı anahtar ve birebir aynı URL/gövde kayıtlı sonucu döndürür. Farklı baytlar 409 döndürür. Tekrarda sırlar/bağlantılar çıkarılır; gerektiğinde açıkça yeni işlemle yenile veya yeniden oluştur.
Belirsiz sonuçlaroperator_request_in_progress, işlemin sürdüğü veya alındısı kaydedilmeden kesildiği anlamına gelir. Kaynağı ve denetim kaydını incele; körlemesine yeni anahtar gönderme. Tamamlanan alındılar 30 gün sonra sıkıştırılır; eski anahtarlar yine tekrar çalıştırılamaz.
Krediler ve ücretlerEn fazla altı ondalık basamaklı ondalık sayı dizeleri. starting_credit tek seferlik yerel kredi tanımıdır. Düzeltmeler HTTP yeniden deneme anahtarına ek olarak işaretli tutar, not ve request_id gerektirir. fee_bps=100, %1 demektir; düzenlemeler sonraki faturaları etkiler. Kredi tanımlamaları kurulumun kendi ön ödemeli bakiyesini doldurmaz.
Duraklatmaenabled=false barındırılan hesabı devre dışı bırakır ve konsol oturumlarını iptal eder. payments_paused=true yeni faturaları durdurur. Mevcut ödeme izlemesi devam eder. Proje/mağaza oluşturma ve otomasyon kurulumun kredi politikasına bağlı kalır.
Sunulmayan işlemlerCüzdan sırları, imzalama, gönderim, iade, kalıcı silme, TOTP sıfırlama, alan adı değişikliği veya sunucu düzeyi yapılandırma yoktur. Normal fatura istekleri yine satıcı anahtarı ve Satıcı API'si kullanır.

Operatör yaşam döngüsü webhook'ları

OlayVeri
merchant.created / merchant.updatedmerchant_id, enabled, payments_paused, fee_bps.
user.created / user.updatedmerchant_id, user_id, enabled. Güncelleme olayı e-posta, etkinlik durumu ve yönetici rolü değişikliklerini kapsar.
invitation.accepted / password_reset.completedmerchant_id, user_id, invitation_id.
topup.settled / credit.balance_changedmerchant_id, ledger_id, kind, amount ve balance. Mutabakat sırasında satıcı kredi para birimini veya hesap defteri ayrıntısını oku.

Operatör yaşam döngüsü olayları fatura IPN'inden/mağaza webhook'larından ayrıdır. Abonelik, onu oluşturan Operatör kimlik bilgisine aittir; anahtar başına en fazla 10 uç nokta olabilir. Yalnızca gelecekteki eşleşen olaylar kuyruğa alınır; saklanan geçmiş için GET /events kullan.

Gövde event_id, event_type, merchant_id, occurred_at ve data içerir. Uç noktanın bir kez gösterilen signing_secret değeriyle ham gövdenin tamamı üzerinde Wholly-Signature doğrula: HMAC-SHA256(secret, timestamp + '.' + raw_body), üst bilgi t=...,v1=.... Kısa zaman damgası toleransı uygula.

SDK'nın fatura bildirimi ayrıştırıcısını değil, genel imza doğrulayıcısını kullan. Ardından merchant_id ve event_type doğrula, event_id değerini bir veritabanı işlemiyle kaydet/tekilleştir ve yalnızca kalıcı kabulden sonra 2xx döndür. Wholly-Event-Id imzalı gövdeyle eşleşmelidir. İmzasız üst bilgileri iş verisi olarak değerlendirme.

Teslim en az bir kez gerçekleşir, sırasız gelebilir ve en fazla 8 kez denenir. Mutabakat için güncel kaynakları oku; occurred_at tek yönlü artan sıra numarası değildir. Teslim öncesi kapsam ve etkinlik/sona erme ayarları yeniden kontrol edilir. Devre dışı abonelikler kuyruktaki işleri duraklatır, ancak devre dışıyken yeni olayları kuyruğa almaz.

Olaylar ve teslim geçmişi 30 gün tutulur. Kurulum otomasyon politikası teslimi duraklatabilir. GET /webhooks/{id}/deliveries sonucu ve değiştirilemez yükü gösterir; herkese açık API süresi dolmuş kaydı zorla teslim etmez.

{
  "event_id": "55555555-5555-4555-8555-555555555555",
  "event_type": "merchant.created",
  "merchant_id": "11111111-1111-4111-8111-111111111111",
  "occurred_at": "2026-10-01T12:00:00Z",
  "data": {
    "merchant_id": "11111111-1111-4111-8111-111111111111",
    "enabled": true,
    "payments_paused": false,
    "fee_bps": 300
  }
}

Satıcı oluştur → · Davet kabul et →

Pazaryeri API'si

Korunan satıcı payları ve kontrollü ödemelerle tek ödeme sayfası.

Tek müşteri faturası, tam satıcı payları ve aynı varlıkla kontrollü satıcı ödemeleri. Proje başına etkinleştirilir. Sürüm 8.0.0 tüm ödeme alma ağlarını değil, Bitcoin mainnet ile yapılandırılmış desteklenen EVM yerel coin'lerini / standart ERC-20 token'larını destekler.

  1. Projede Pazaryeri'ni etkinleştir, katılan mağazaları seç ve yapılandırırken satıcı ödemelerini duraklatılmış tut.
  2. Satıcıları kaydet ve ödeme adreslerini bağımsız olarak doğrula. Hedef oluşturulduğunda beklemededir; onay destinations.approve gerektirir.
  3. Ayarlar → API erişimi bölümünde ayrı Pazaryeri kimlik bilgisi oluştur. Normal Satıcı, Operatör ve MCP kimlik bilgileri Pazaryeri fonlarını harcayamaz.
  4. Toplamı fatura tutarına tam eşit olan, pozitif ondalık sayı dizeleriyle 1–100 tahsis içeren fatura oluştur. Her satıcının mağazanın desteklediği ortak bir ağda onaylanmış hedefi olmalıdır.
  5. Tahsislerin kullanılabilirliği doğrulanana kadar bekle. Satıcı ödemesini hazırla, değiştirilemez alıcılarını ve maliyet sınırlarını oku, ardından revizyonunu ve tam plan_hash değerini onayla. Ödemeyi sorgula veya imzalı olayları doğrula.
KonuKural
SaklamaMüşteri fonları önce projenin kontrolündeki cüzdanlara girer. Satıcılara ödenene kadar anahtarları pazaryeri/sunucu sahibi kontrol eder. Bu, müşteriden satıcıya doğrudan ödeme, emanet hizmeti veya satıcı giriş sistemi değildir.
Üç satıcıÜç adet 100 USD pay ve %4 komisyon içeren 300 USD faturada, teklif edilen kriptodan her satıcıya 96 USD karşılığı ayrılır ve 12 USD karşılığı brüt komisyon tutulur. Plan gelecekteki itibari para değerini değil, kripto atomik birimlerini garanti eder.
ÜcretlerMevcut işlem ücreti, tamamlanan asıl faturanın tutarına/para birimine bir kez uygulanır. Yapılandırılan oran %1 ise bu 3 USD ön ödemeli kredi demektir ve zincir ücretlerinden önce 9 USD karşılığı komisyon kalır. Satıcı ödemeleri ek müşteri satış ücreti oluşturmaz.
TahsisEn büyük kalan yöntemiyle tahsis her atomik birimi korur. Komisyon aşağı yuvarlanır; satıcı neti kalan tutardır. Tahsis, fatura ve satıcı bazlı özel değerler ile mağaza/proje varsayılanlarının görüntüsü alınır. Satıcıya ödeme sırasında yeni kur uygulanmaz.
Korunan fonlarNormal gönderimler, bakiye aktarımları, borsa yatırmaları ve otomatik kredi yüklemeleri Pazaryeri ödeme alma adreslerini hariç tutar. Ağ ücretleri ve token gas'ı ayrı, serbest yerel coin gerektirir. Önbellekteki cüzdan değerleri bilgi amaçlıdır; imzalamadan önce bağımsız canlı fon karşılığı kontrol edilir.
KesinlikÖdeme sayfası sıfır onay veya tek tarayıcı kabul etse bile Pazaryeri satıcı ödemesi kanıtı, pozitif asgari zincir onayı ve iki bağımsız uyumlu sağlayıcı gerektirir. Sağlayıcı bekleme süreleri ödeme doğrulamasını/satıcı ödemesini erteler; diğer koşulları geçerli olan fatura oluşturmayı ertelemez.
İstisnalarNormal ödeme sayfası toleransıyla kabul edilen eksik ödemeler, karşılıksız tahsis yapılmadan bekletilir. Yetkili serbest bırakma işlemi, fon karşılığı tam olan daha küçük ve kesin bölüşümü onaylayabilir. Fazla ödeme tek başına BTC veya desteklenen EVM yerel/ERC-20 yöntemlerinde teklif edilen satıcı bölüşümünü engellemez. Fazlalık ayrı bekletilir. Bitcoin korunan para üstünü fatura adresine döndürür; ücretleri ve varsa dust alt sınırına tamamlama tutarını ayrı proje fonları karşılar. Karma yöntemler, geç/belirsiz/yeniden yapılanmadan etkilenen ödemeler ve eksik fon karşılığı inceleme gerektirir.
İadelerBelirsizliği olmayan, onaylanmış tek bir ödeme alma yönteminin aynı varlıkla tam iadesini hazırla, ardından bunu ayrı olarak bir ödeme şeklinde onayla. Ödenmemiş tahsisler ve komisyon geri alınır. Tüm satıcılara ödendikten sonra birincil cüzdan adresini ayrıca fonla; satıcıdan geri alma yoktur. Kısmi satıcı grupları ve karma varlık iadeleri önce mutabakat gerektirir. 8.0.0'da kısmi tutar iadeleri ve komisyon çekimleri sunulmaz.
Yeniden denemelerHer POST kalıcı saklanan 16–128 karakterlik Idempotency-Key gerektirir (harf, rakam, -, _ veya .). Zaman aşımından sonra aynı anahtarı ve JSON talimatlarını yeniden kullan. Farklı talimatlar 409 döndürür. Tamamlanmış yanıtlar 30 gün tutulur; eski anahtarlar yeniden kullanılamayan iptal kayıtlarına dönüşür. Belirsiz sonucu aşmak için anahtarı asla değiştirme.
RevizyonlarDeğiştirilebilir kayıtlar güncel revizyonlarını gerektirir. Onay/devam ettirme ayrıca expected_plan_hash ve confirm:true gerektirir. Hazırlık fonları 15 dakika ayırır; onay bir saat tanır. Süresi dolan imzasız işler güvenle serbest bırakılır. İmzalı/belirsiz transferler kimliklerini ve rezervasyonlarını korur.
Otomatik satıcı ödemeleriVarsayılan olarak kapalıdır. Varlık başına politikalar onaylı hedefleri, pozitif asgari tutarı, ödeme başına/kayan 24 saatlik anapara ve yerel ücret/gas sınırlarını, aralığı ve onayları yetkilendirir. Yetkiyi değiştirmek/iptal etmek gönderilmemiş işleri durdurur; izleme sürer. Sınırlar ayrılmış ve belirsiz planları içerir. Faturalandırma nedeniyle duraklatılan politikalar adil biçimde yeniden zamanlanır. Geçersiz fatura, diğer uygun fatura gruplarını engellemeden inceleme için bekletilir.
Duraklatma ve kurtarmaDüşük kredi ve transfer güvenlik kontrolleri harcamayı yine duraklatır. İzleme ve hesap defteri mutabakatı devam eder. Devam ettirme, saklanan aynı planı yeniden inceler. İki bağımsız sağlayıcının kanıtladığı kanonik EVM revert'i, açık onaydan sonra kalan ücret bütçesi içinde yeni işlemle değiştirilebilir; ilk hash'ler ve ücretler kayıtlı kalır. Bilinmeyen sonuçlar veya token teslim uyumsuzlukları bekletilir. Tüm veritabanını ve anahtarları yedekle; geri yüklemeden sonra satıcı ödemelerine izin vermeden önce iletilmiş hash'lerin mutabakatını yap.
Tanımlayıcılar ve sayfalamaProje Ayarları'ndan proje UUID'sini, Mağazalar → Temel → API kimlikleri bölümünden mağaza UUID'sini kullan. Satıcı/ödeme/varlık kimliklerini bu API döndürür. invoice_id herkese açık fatura UUID'sidir. Sayfalanan kaynaklar data ve pagination {page,per_page,total,pages} döndürür; varsayılanlar 1/25, en fazla 100 satırdır. Tam parasal değerler dizedir.
Kimlik bilgisi kapsamıAnahtarların proje listeleri, isteğe bağlı fatura mağazası kısıtlamaları, sona erme zamanı, IP izin listesi ve 1–600/dakika kotası (varsayılan 60) vardır. HTTP 429 Retry-After içerir. Mağazayla sınırlı anahtarlar satıcıları, proje bakiyelerini, hesap defterini, satıcı ödemelerini veya ayarları göremez. Harcama kimlik bilgilerini yalnızca güvenilir sunucularda tut; tarayıcılarda veya dağıtılan mobil uygulamalarda asla bulundurma.

Pazaryeri izinleri

marketplace.read · vendors.write · destinations.write · destinations.approve · invoices.write · policies.write · commissions.override · payouts.write · payouts.approve · webhooks.write · reconciliation.write

Tahsis durumları

pending · held · available · reserved · paid · refunding · refunded · shortfall

Satıcı ödemesi durumları

awaiting_approval · queued · funding_gas · sending · confirming · partially_paid · paid · needs_attention · cancelled · expired

Pazaryeri olayları

Fatura geri çağrılarıyla aynı Wholly imza üst bilgileri ve ham gövde HMAC doğrulama algoritmasını kullanan ayrı Pazaryeri imzalama sırrı. Zaman damgasını/imzayı doğrula, event_id ile tekilleştir ve hızla 2xx döndür. Teslim en az bir kez, en fazla sekiz denemeyle yapılır; geçmişten aynı olay yeniden teslim edilebilir. Uç nokta düzenlemeleri müşteri verilerini yönlendirmek yerine eski gönderilmemiş teslimleri iptal eder. Faturanın tamamlanması satıcıya ödemenin tamamlanması değildir. Yalnızca harici bir geri çağrı söyledi diye asla para gönderme.

  • marketplace.invoice.created
  • marketplace.allocations.available
  • marketplace.allocations.held
  • marketplace.payout.approved
  • marketplace.payout.broadcast
  • marketplace.payout.confirmed
  • marketplace.payout.partial
  • marketplace.payout.failed
  • marketplace.payout.cancelled
  • marketplace.refund.prepared
  • marketplace.refund.confirmed
{
  "event_id": "11111111-1111-4111-8111-111111111111",
  "event_type": "marketplace.payout.confirmed",
  "payload_version": 1,
  "project_id": "YOUR_PROJECT_ID",
  "occurred_at": "2026-10-06T12:00:00Z",
  "data": {
    "payout_id": "YOUR_PAYOUT_ID",
    "asset_id": "YOUR_ASSET_ID",
    "amount_atomic": "28800000",
    "transactions": [
      {
        "transaction_id": "EXAMPLE_TRANSACTION_ID",
        "explorer_url": "https://mempool.space/tx/EXAMPLE_TRANSACTION_ID"
      }
    ]
  }
}

Çok satıcılı ödemeleri ayarla · Pazaryeri faturası oluştur

Hatalar ve sınırlar

Doğrulamayı, kotaları ve yeniden denemeleri öngörülebilir biçimde ele al.

HTTP durumunu ve şunu kontrol et: Content-Type yanıtı ayrıştırmadan önce. Şu durumda: 429, en az şu kadar bekle: Retry-After yeniden denemeden önce belirtilen süre.

SınırAyrıntılar
İstek hızıKimlik bilgisi başına kota: UTC dakikası başına varsayılan 120 istek; Ayarlar → API bölümünde 1 ile 6000 arasında ayarlanabilir. İdempotent yeniden denemeler ve kimlik doğrulama sonrasındaki yetkilendirme/doğrulama hataları dahil, kimlik doğrulamalı tüm v1 okuma ve yazmaları alan adları, projeler ve süreçler genelinde bu hakkı paylaşır. Geçersiz kimlik bilgileri, konsol rotaları ve herkese açık ödeme sayfası kotayı tüketmez.
İstek sınırı üst bilgileriKimlik doğrulamalı v1 yanıtları X-RateLimit-Limit, X-RateLimit-Remaining ve X-RateLimit-Reset içerir (sonraki UTC dakika sınırının Unix saniyesi). Fazla istekler JSON 429 rate_limit_exceeded ve tamsayı saniyeli Retry-After döndürür. En az bu kadar bekle ve yeniden denemeye rastgele zaman payı ekle. Sabit pencereler dakika sınırlarında ani yoğunluğa izin verir; bu saniye başına istek garantisi değildir.
Satıcı istek gövdesiUygulama yönlendiricisinde en fazla 32 KiB. Ağın giriş katmanı, JSON hata zarfı üretilmeden büyük isteği reddedebilir.
Fatura listesilimit varsayılanı 50'dir ve 1–100 kabul eder; offset 0–1.000.000 kabul eder. Arama en fazla 100 karakterdir. Sonuçlar yeniden eskiye sıralanır ve total/has_more meta verilerini içerir.
Mağaza yöntemleriMağaza başına en fazla 64 varlık seçimi; 30 yerel zincirin tamamına ve sınırlı doğrulanmış token kataloğuna yeter. Fatura oluşturmak yine proje politikası, tarayıcı yeteneği ve kullanıma hazır, yedeklenmiş zincir cüzdanına bağlıdır.
Token keşfiAday limiti varsayılan 50'dir ve 1–100 kabul eder. Keşif sonuçları, zincir üstü doğrulama başarılı olana kadar ödeme varlığı sayılmaz.
Kayıtlı proje token'larıProje başına en fazla 20 kalıcı token varlığı. Zaten kayıtlı varlıklar başka yuva tüketmeden yeniden kullanılabilir.
İdempotent işlemFatura oluşturmak için gereklidir. Boşluksuz 1–128 görünür ASCII karakteri; anahtarlar mağaza başına benzersizdir ve tekrarda ilk kimlik bilgisi ile birebir ham gövde kullanılmalıdır.
Meta verilerYalnızca JSON nesnesi; kodlanmış boyut en fazla 4.096 bayt ve iç içe geçme en fazla beş düzey.
Geri çağrılarEn fazla 2.048 baytlık herkese açık HTTPS URL'si. Bildirim istek gövdeleri 256 KiB ile; saklanan fatura olay yükleri, sınırlı ödeme geçmişiyle 64 KiB ile sınırlandırılır.
Ödeme sayfası görselleriEksik ödeme kalan tam tutarı değiştirdiği için QR SVG yanıtları private ve no-store'dur. Revizyonlu PNG logoları bir yıl herkese açık önbelleğe alınır ve değiştirilemezdir.
API giriş katmanıYönetilen API üst sunucu isteklerinde 30 saniyelik okuma zaman aşımı vardır. Çağıranları, iş süresi bütçelerinden kısa ve açık zaman aşımlarıyla tasarla.
JSON olmayan hatalarHatalı UUID/sorgu çıkarımı, yanlış yöntemler ve 32 KiB uzunluk koruması çerçeve metni/boş yanıt döndürebilir. Bilinmeyen /v1 yolları şu anda 404 konsol HTML'i döndürür; ayrıştırmadan önce durumu ve Content-Type değerini doğrula.

Hata başvuru kaynağı

HTTPHata koduAnlamı
400invalid_reconciliation_actionİstisna durumu, neden, arama veya geçmiş sayfası filtresi geçersiz.
500reconciliation_unavailableİstisna kuyruğu veya kanıt yüklenemedi. Okumayı artan beklemeyle yeniden dene.
402billing_requiredHer yeni fatura doğrulanmış eşleştirilmiş kredi hesabı ve canlı yetkilendirme gerektirir. Yetersiz ön ödemeli kredi oluşturmayı veya gelen ödemeleri engellemez: bunun yerine IPN, webhook'lar ve Bakiye Aktarımı duraklar; ücretler işlemeye devam eder. Askıya alınmış hesaplarda, süresi dolmuş/geçersiz faturalandırma doğrulamasında, erişilemeyen kredi hizmetinde veya yetkilendirilmemiş fatura itibari para temelinde oluşturma engelli kalır. Ücretler alınan kriptoyu, fiyat marjını, fazla ödemeyi veya ağ ücretini değil, ilk fatura itibari para tutarını kullanır. Bu tutar ve bağımsız dönüşüm, ödeme sayfası oluşturulmadan önce kaydedilir. Kesintilerde mevcut izleme ve fatura getirme devam eder. Bakiye yüklemesinden sonra kuyruktaki bildirimler normal yük saklama süresi içinde, etkin bakiye aktarım kuralları da yeniden çalışır. Ayarlar → Ücretler bölümünü kontrol et ve başarısız oluşturmayı aynı Idempotency-Key ile yeniden dene.
400invalid_jsonHatalı JSON, bilinmeyen alan veya belgelenen istekle eşleşmeyen gövde.
400idempotency_key_requiredFatura oluşturma isteğinde Idempotency-Key eksik.
400invalid_idempotency_keyAnahtar boş, 128 bayttan uzun, ASCII dışında, boşluk içeriyor veya kontrol baytı barındırıyor.
400invalid_payment_requestDoğrulanan alan veya seçili etkin yöntem başarısız oldu. Tam engeli öğrenmek için error.message ve error.details.payment_methods (PaymentMethodIssue[]) oku. SDK 2.4.0+ güvenli, işlem yapılabilir istisna özetleri ve sorun yardımcıları ekler; eski PHP SDK'ları getApiMessage() sunar.
400invalid_invoice_statusListe durumu belgelenen altı fatura durumunun dışında.
400invalid_callback_urlGeçerli IPN hedefi HTTPS, herkese açık adres, DNS veya SSRF doğrulamasını geçemedi.
400invalid_wallet_requestCüzdan/adres hazırlama girdisi geçersiz.
400invalid_token_assetToken zinciri, aday sorgusu, CoinGecko kimliği, katalog meta verileri veya sözleşme/mint girdisi geçersiz.
401authentication_requiredBearer token'ı eksik, hatalı, devre dışı, yenilenmiş veya bilinmiyor.
403source_ip_deniedKimlik bilgisinin IP kısıtlaması, isteğin tam herkese açık kaynak adresini içermiyor.
403source_ip_not_allowedAna makine adının kaynak IP kısıtlaması bu istemciyi dışarıda bırakıyor. Yönetici canlı ana makine izin listelerini Ayarlar → Sistem bölümünde yönetebilir; bunlar kimlik bilgisi IP kısıtlamalarına ek uygulanır.
503source_access_unavailableAna makine erişim doğrulaması geçici olarak kullanılamıyor. Daha sonra yeniden dene; doğrulama yapılamadığında erişim kapalı kalır.
403 / 409 / 500merchant_api_access_deniedYetkilendirme başarısız: izin/proje kapsamı 403, devre dışı proje/mağaza 409 ve yetkilendirme arka uç hatası 500 olabilir. Operatör ödeme alma cüzdanları Operatör paneline ayrılmıştır; eski açık proje izni olsa bile satıcı API kimlik bilgileri veya MCP için kullanılamaz.
403project_access_deniedOluşturma anındaki veritabanı işlemi içinde yeniden kontrol, kimlik bilgisinin artık projeye erişemediğini tespit etti.
404invoice_not_foundYetkili projede bu herkese açık kimliğe sahip fatura yok veya ödeme sayfası onu gösteremiyor.
404payment_resource_not_foundFatura hazırlanırken gereken proje, mağaza, varlık veya cüzdan artık mevcut değil.
404token_candidate_not_foundProje kullanılamıyor veya token güncel eşleşen keşif kataloğunda artık bulunmuyor.
409idempotency_conflictMağaza kapsamlı anahtar zaten var; kimlik bilgisi veya ham isteğin birebir baytları farklı.
409store_unavailableProje/mağaza devre dışı veya kullanılamıyor.
409no_ready_payment_methodsHiçbir mağaza yöntemi hazır değil. chain_slug, asset_ticker ve reason_code için error.message ve error.details.payment_methods oku. Cüzdan yedeği/etkinleştirmesi, kurulu adaptör ve fiyatlandırma geçerli olmalıdır. 6.0.6'dan itibaren tarayıcı bekleme süreleri, başarısız veya eski sağlık kontrolleri ve eksik sağlayıcı yeter sayısı oluşturmayı engellemez.
409payment_method_unavailableSeçilen yöntem, oluşturma anındaki atomik yeniden kontrol sırasında kullanılamaz hale geldi.
409store_payment_method_not_selectedMağazanın şu anda seçmediği varlık için mağaza onay ayarı geçersiz kılma istendi.
409wallet_unavailableÖdeme cüzdanı, oluşturma anındaki atomik yeniden kontrol sırasında kullanılamaz hale geldi.
409ipn_secret_requiredGeçerli IPN URL'si var, ancak mağazanın IPN imzalama sırrı yok.
409payment_resource_not_readyGereken ödeme varlığı veya cüzdan devre dışı, yedeklenmemiş, ortak hesap etkinleştirme kanıtını bekliyor, kapasitesi tükenmiş veya başka nedenle hazır değil.
409account_activation_unverifiedXRP Ledger veya Stellar hesap etkinliği yapılandırılmış sayıdaki sağlıklı mainnet uç noktasında (varsayılan 2, isteğe bağlı 1) kanıtlanamadı; tam olarak o hesaba fon gönder ve doğrulamayı yeniden dene.
400invalid_monero_wallet_rpcHTTPS uç noktası, tam mainnet birincil adresi, etiket veya eksiksiz Digest/Basic/üst bilgi kimlik doğrulama girdisi geçersiz.
404monero_wallet_rpc_not_foundProje kapsamlı Monero wallet-RPC bağlantısı mevcut değil.
409monero_wallet_rpc_not_readyMonero varlığı, iki daemon yeter sayısı, değiştirilemez bağlantı veya açık yedek/yalnızca görüntüleme beyanı hazır değil.
409monero_wallet_rpc_unavailableFatura oluşturmak, geçerli sunucu tarafı kimlik bilgisine sahip etkin, doğrulanmış ve beyanları tamamlanmış proje Monero wallet-RPC bağlantısı gerektirir.
503lightning_unavailableMağazanın tek hazır yöntemi Lightning ve cüzdanı veya teklifi doğrulanamadı. Aynı idempotency anahtarıyla yeniden dene. Başka hazır zincir üstü yöntem varsa kullanılamayan Lightning yöntemi bunun yerine dışarıda bırakılır.
422monero_wallet_rpc_verification_failedTam cüzdan, HTTPS sabitleme, eşzamanlama, mainnet daemon yeter sayısı veya geçidin yöntem reddi kanıtı başarısız oldu.
503monero_wallet_rpc_failedHarici salt izleme wallet-RPC'si fatura alt adresini güvenle oluşturup yeniden okuyamadı; yedek adres uydurulmaz.
409token_chain_not_readyYerel zincir varlığı devre dışı, keşif eşlemesi doğrulama sırasında değişti veya proje mevcut üst sınır olan 20 kayıtlı token varlığına ulaştı.
503dex_price_unavailableDEX sağlayıcısı kullanılamıyor, meşgul, istek sınırına takıldı ya da eski yanıt veya hatalı veri döndürdü. Bir dakika sonra yeniden dene; sabit fiyatlandırma kullanılabilir kalır.
422invalid_dex_priceGeçersiz fiyat modu birleşimi veya seçilen havuz tam sözleşme için uygun fiyat sağlayamıyor. Başka havuz veya sabit USD fiyatlandırması seç.
422token_verification_failedUygun tüm düğümler zincir kimliği, sözleşme kodu, ondalık basamak, bakiye sorgusu veya mint doğrulamasını geçemedi.
422invalid_store_confirmation_policyMağaza özel onay ayarı bu kesinlik modunda kullanılamıyor, döndürülen zincire uygun sınırların dışında veya desteklenmeyen sıfır onaylı kabul istiyor.
409invoice_not_payableÖdeme sayfası faturası son durumda veya ödeme son tarihi geçti.
409invoice_payment_method_lockedGeçerli ödeme zaten farklı bir varlık seçti; active_payment_method_id ile devam et.
409payment_method_not_payableSeçilen yöntem tamamlandı veya artık başka ödeme kabul etmiyor.
422payment_qr_unavailableÖdeme sayfası ödeme isteği SVG QR görseline kodlanamayacak kadar büyük.
503payment_rates_unavailableHazır ödeme yöntemlerinin hiçbiri için güncel ve güvenilir teklif yok.
500authentication_unavailableBearer kimlik doğrulaması kayıtlı kimlik bilgisini güvenle okuyamadı veya doğrulayamadı.
429rate_limit_exceededBu kimlik bilgisi mevcut UTC dakikası hakkını tüketti. En az Retry-After saniye bekle; fatura oluşturmayı aynı idempotency anahtarıyla yeniden dene.
500database_error / internal_errorGeçici sunucu tarafı hata; aynı idempotency anahtarıyla güvenle yeniden dene.

API'ye genel bakış

Alanları, örnekleri ve yanıtını görmek için uç nokta seç.

Faturalar

POSTFatura oluştur/v1/projects/{project_id}/stores/{store_id}/invoicesGETFaturaları listele/v1/projects/{project_id}/invoicesGETFaturayı getir/v1/projects/{project_id}/invoices/{invoice_id}GETFatura ödemelerini listele/v1/projects/{project_id}/invoices/{invoice_id}/payments

Ödeme yöntemleri

GETProje ödeme varlıklarını listele/v1/projects/{project_id}/payment-assetsPUTProje varlık politikasını güncelle/v1/projects/{project_id}/payment-assets/{asset_id}GETÖdeme token'ı adaylarına göz at/v1/projects/{project_id}/payment-token-candidatesPOSTToken doğrula ve kaydet/v1/projects/{project_id}/payment-token-assetsGETÖzel token DEX havuzlarını bul/v1/projects/{project_id}/payment-token-dex-poolsPOSTÖzel token ekle veya yeniden fiyatlandır/v1/projects/{project_id}/payment-token-assets/customGETMağaza ödeme yöntemlerini listele/v1/projects/{project_id}/stores/{store_id}/payment-assetsPUTMağaza ödeme yöntemlerini değiştir/v1/projects/{project_id}/stores/{store_id}/payment-assetsPUTMağaza onay politikası belirle/v1/projects/{project_id}/stores/{store_id}/payment-assets/{asset_id}/confirmation-policy

Cüzdanlar

GETProje cüzdanlarını ve bakiyelerini listele/v1/projects/{project_id}/wallets

Mutabakat

GETÖdeme istisnalarını listele/v1/projects/{project_id}/reconciliationGETMutabakat kanıtlarını oku/v1/projects/{project_id}/reconciliation/{invoice_id}

Pazaryeri API'si

GETYetenekler/v1/marketplace/capabilitiesGETPazaryeri raporu/v1/marketplace/overviewGETProje ayarları/v1/marketplace/settingsPOSTProje ayarlarını kaydet/v1/marketplace/settingsGETSatıcıları listele/v1/marketplace/vendorsPOSTSatıcı oluştur/v1/marketplace/vendorsGETSatıcıyı getir/v1/marketplace/vendors/{vendor_id}POSTSatıcıyı güncelle/v1/marketplace/vendors/{vendor_id}/updatePOSTSatıcıyı arşivle/v1/marketplace/vendors/{vendor_id}/archiveGETSatıcı hedefleri/v1/marketplace/vendors/{vendor_id}/destinationsPOSTÖdeme hedefi ekle/v1/marketplace/vendors/{vendor_id}/destinationsPOSTHedefi onayla/v1/marketplace/vendors/{vendor_id}/destinations/{destination_id}/approvePOSTHedefi devre dışı bırak/v1/marketplace/vendors/{vendor_id}/destinations/{destination_id}/disableGETSatıcı bakiyeleri/v1/marketplace/vendors/{vendor_id}/balancesGETPazaryeri faturaları/v1/marketplace/invoicesPOSTÇok satıcılı fatura oluştur/v1/marketplace/invoicesGETFatura ve tahsisler/v1/marketplace/invoices/{invoice_id}GETFatura ödeme kanıtları/v1/marketplace/invoices/{invoice_id}/paymentsGETFatura tahsisleri/v1/marketplace/invoices/{invoice_id}/allocationsPOSTÖdenmemiş faturayı iptal et/v1/marketplace/invoices/{invoice_id}/cancelPOSTTahsisleri beklet/v1/marketplace/invoices/{invoice_id}/allocations/holdPOSTTahsisleri incele ve serbest bırak/v1/marketplace/invoices/{invoice_id}/allocations/releasePOSTÖdenmemiş hedefi yeniden bağla/v1/marketplace/invoices/{invoice_id}/allocations/{allocation_id}/destinationPOSTTam iade hazırla/v1/marketplace/invoices/{invoice_id}/refundGETÖdeme tahsislerini bul/v1/marketplace/allocationsGETProje hesap defteri bakiyeleri/v1/marketplace/balancesGETDeğiştirilemez yevmiye/v1/marketplace/ledgerGETSatıcı ödemesi geçmişi/v1/marketplace/payoutsPOSTTahsis planını önizle/v1/marketplace/payouts/previewPOSTSatıcı ödemesi hazırla/v1/marketplace/payoutsGETSatıcı ödemesi ayrıntıları/v1/marketplace/payouts/{payout_id}POSTOnayla ve gönder/v1/marketplace/payouts/{payout_id}/approvePOSTSatıcı ödemesini incele ve devam ettir/v1/marketplace/payouts/{payout_id}/resumePOSTİmzalanmamış işi iptal et/v1/marketplace/payouts/{payout_id}/cancelGETOtomatik satıcı ödemesi politikaları/v1/marketplace/policiesPOSTSatıcı ödemesi politikasını yetkilendir/v1/marketplace/policiesGETPazaryeri webhook'ları/v1/marketplace/webhooksPOSTPazaryeri webhook'u oluştur/v1/marketplace/webhooksPOSTPazaryeri webhook'unu güncelle/v1/marketplace/webhooks/{webhook_id}/updatePOSTPazaryeri webhook'unu devre dışı bırak/v1/marketplace/webhooks/{webhook_id}/disableGETPazaryeri olayları/v1/marketplace/eventsGETSaklanan olayı oku/v1/marketplace/events/{event_id}GETPazaryeri teslim geçmişi/v1/marketplace/webhook-deliveriesGETTeslim ayrıntıları/v1/marketplace/webhook-deliveries/{delivery_id}POSTAynı olayı yeniden teslim et/v1/marketplace/webhook-deliveries/{delivery_id}/resend

Operatör API'si

GETYetenekler/v1/operator/capabilitiesGETSağlık/v1/operator/healthGETSatıcıları Listele/v1/operator/merchantsPOSTSatıcı Oluştur/v1/operator/merchantsGETSatıcıyı Getir/v1/operator/merchants/{merchant_id}POSTSatıcıyı Güncelle/v1/operator/merchants/{merchant_id}GETKullanıcıları Listele/v1/operator/merchants/{merchant_id}/usersPOSTKullanıcı Oluştur/v1/operator/merchants/{merchant_id}/usersGETKullanıcıyı Getir/v1/operator/merchants/{merchant_id}/users/{user_id}POSTKullanıcıyı Güncelle/v1/operator/merchants/{merchant_id}/users/{user_id}POSTKullanıcı Parolasını Belirle/v1/operator/merchants/{merchant_id}/users/{user_id}/passwordPOSTKullanıcı Oturumlarını İptal Et/v1/operator/merchants/{merchant_id}/users/{user_id}/revoke-sessionsGETDavetleri Listele/v1/operator/merchants/{merchant_id}/invitationsPOSTDavet Oluştur/v1/operator/merchants/{merchant_id}/invitationsGETDaveti Getir/v1/operator/invitations/{invitation_id}POSTDaveti Yeniden Gönder/v1/operator/invitations/{invitation_id}/resendPOSTDaveti İptal Et/v1/operator/invitations/{invitation_id}/revokeGETKredileri Getir/v1/operator/merchants/{merchant_id}/creditsGETKredi Defterini Listele/v1/operator/merchants/{merchant_id}/credits/ledgerPOSTKredileri Düzelt/v1/operator/merchants/{merchant_id}/credits/adjustmentsGETBakiye Yüklemelerini Listele/v1/operator/merchants/{merchant_id}/topupsPOSTBakiye Yüklemesi Oluştur/v1/operator/merchants/{merchant_id}/topupsGETBakiye Yüklemesini Getir/v1/operator/merchants/{merchant_id}/topups/{topup_id}GETRaporlar/v1/operator/reportsGETDenetim Kayıtlarını Listele/v1/operator/auditGETOlayları Listele/v1/operator/eventsGETWebhook'ları Listele/v1/operator/webhooksPOSTWebhook Oluştur/v1/operator/webhooksPOSTWebhook'u Güncelle/v1/operator/webhooks/{webhook_id}POSTWebhook Sırrını Yenile/v1/operator/webhooks/{webhook_id}/rotateGETWebhook Teslimlerini Listele/v1/operator/webhooks/{webhook_id}/deliveriesGETProjeleri Listele/v1/operator/merchants/{merchant_id}/projectsPOSTProje Oluştur/v1/operator/merchants/{merchant_id}/projectsGETProjeyi Getir/v1/operator/merchants/{merchant_id}/projects/{project_id}POSTProjeyi Güncelle/v1/operator/merchants/{merchant_id}/projects/{project_id}GETMağazaları Listele/v1/operator/merchants/{merchant_id}/projects/{project_id}/storesPOSTMağaza Oluştur/v1/operator/merchants/{merchant_id}/projects/{project_id}/storesGETMağazayı Getir/v1/operator/merchants/{merchant_id}/projects/{project_id}/stores/{store_id}POSTMağazayı Güncelle/v1/operator/merchants/{merchant_id}/projects/{project_id}/stores/{store_id}GETMağaza Görünümünü Getir/v1/operator/merchants/{merchant_id}/projects/{project_id}/stores/{store_id}/checkout-appearancePOSTMağaza Görünümünü Güncelle/v1/operator/merchants/{merchant_id}/projects/{project_id}/stores/{store_id}/checkout-appearanceGETMağaza Ödeme Varlıklarını Listele/v1/operator/merchants/{merchant_id}/projects/{project_id}/stores/{store_id}/payment-assetsPOSTMağaza Ödeme Varlıklarını Güncelle/v1/operator/merchants/{merchant_id}/projects/{project_id}/stores/{store_id}/payment-assetsGETMağaza Webhook'larını Listele/v1/operator/merchants/{merchant_id}/projects/{project_id}/stores/{store_id}/webhooksPOSTMağaza Webhook'u Oluştur/v1/operator/merchants/{merchant_id}/projects/{project_id}/stores/{store_id}/webhooksPOSTMağaza Webhook'unu Güncelle/v1/operator/merchants/{merchant_id}/projects/{project_id}/stores/{store_id}/webhooks/{webhook_id}GETFaturaları Listele/v1/operator/merchants/{merchant_id}/projects/{project_id}/invoicesGETFaturayı Getir/v1/operator/merchants/{merchant_id}/projects/{project_id}/invoices/{invoice_id}GETCüzdanları Listele/v1/operator/merchants/{merchant_id}/projects/{project_id}/walletsGETCüzdan Adreslerini Listele/v1/operator/merchants/{merchant_id}/projects/{project_id}/wallets/{wallet_id}/addressesGETSatıcı Kimlik Bilgilerini Listele/v1/operator/merchants/{merchant_id}/api-credentialsPOSTSatıcı Kimlik Bilgisi Oluştur/v1/operator/merchants/{merchant_id}/api-credentialsPOSTSatıcı Kimlik Bilgisini Güncelle/v1/operator/merchants/{merchant_id}/api-credentials/{credential_id}POSTSatıcı Kimlik Bilgisini Yenile/v1/operator/merchants/{merchant_id}/api-credentials/{credential_id}/rotatePOSTSatıcı Kimlik Bilgisini İptal Et/v1/operator/merchants/{merchant_id}/api-credentials/{credential_id}/revokePOSTDavet token'ını kontrol et/v1/onboarding/invitations/checkPOSTDaveti veya parola sıfırlamasını kabul et/v1/onboarding/invitations/accept

Ödeme sayfası

GETÖdeme sayfası kabuğu/GETBarındırılan ödeme sayfası/invoice/{invoice_id}GETÖdeme sayfasında güvenle gösterilebilen fatura/checkout-api/invoices/{invoice_id}GETMağaza ödeme sayfası önizlemesi/invoice/preview/{project_id}GETÖdeme sayfası önizleme verileri/checkout-api/previews/{project_id}GETMağaza ödeme sayfası görseli/checkout-api/invoices/{invoice_id}/appearance-images/{kind}/{revision}/image.pngGETMağaza önizleme görseli/checkout-api/previews/{project_id}/stores/{store_id}/appearance-images/{kind}/{revision}/image.pngGETRevizyonlu önizleme logosu/checkout-api/previews/{project_id}/logo/{revision}/image.pngGETÖdeme QR görseli/checkout-api/invoices/{invoice_id}/payment-methods/{intent_id}/qr.svgGETRevizyonlu ödeme sayfası logosu/checkout-api/invoices/{invoice_id}/logo/{revision}/image.png

Hizmet

GETAPI hizmet keşfi/GETHizmet sağlığı/healthz
GETYetenekler/v1/operator/capabilitiesSalt okunur

Belirtilen barındırılan satıcı kaynağını ayrı Operatör kimlik bilgisiyle yönet veya incele.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/operator/capabilities" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "api_version": "v1",
  "operator_version": "7.4.0",
  "scopes": [
    "health.read"
  ],
  "all_merchants": false,
  "merchant_ids": [
    "11111111-1111-4111-8111-111111111111"
  ],
  "onboarding": [
    "direct",
    "invitation"
  ],
  "write_methods": [
    "POST"
  ],
  "idempotency_required": true
}

Yanıt alanları

api_versionstring
operator_versionstring
scopes[]array
all_merchantsboolean
merchant_ids[]array
onboarding[]array
write_methods[]array
idempotency_requiredboolean
Kullanım notları
  • health.read gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETSağlık/v1/operator/healthSalt okunur

Belirtilen barındırılan satıcı kaynağını ayrı Operatör kimlik bilgisiyle yönet veya incele.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/operator/health" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "version": "7.4.0",
  "nodes": []
}

Yanıt alanları

versionstring
nodes[]array
Kullanım notları
  • health.read gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETSatıcıları Listele/v1/operator/merchantsSalt okunur

Belirtilen barındırılan satıcı kaynağını ayrı Operatör kimlik bilgisiyle yönet veya incele.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN

Sorgu parametreleri

pageisteğe bağlı
Sayfa numarası 1'den başlar; sayfa başına 25 öğe. Satıcılar, kullanıcılar, projeler, mağazalar, cüzdanlar, kimlik bilgileri ve webhook'larda arama desteklenir; yerel olay listeleri kendi özel filtrelerini kullanır.Ayrıntılar

Sayfa numarası 1'den başlar; sayfa başına 25 öğe. Satıcılar, kullanıcılar, projeler, mağazalar, cüzdanlar, kimlik bilgileri ve webhook'larda arama desteklenir; yerel olay listeleri kendi özel filtrelerini kullanır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/operator/merchants" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "data": [],
  "page": 1,
  "page_size": 25,
  "total": 0
}

Yanıt alanları

data[]array
pageinteger
page_sizeinteger
totalinteger
Kullanım notları
  • merchants.read gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTSatıcı Oluştur/v1/operator/merchantsOkuma ve yazma

Barındırılan satıcıyı ve ilk yöneticiyi atomik olarak, doğrudan parolayla veya davetle oluştur.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN
Idempotency-Keyzorunlu16–128 harf, rakam, -, _ veya .; bu işlem için kalıcı saklanır

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
# Keep this key and the exact body for retries; use a new key for each new operation.
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/operator/merchants" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Idempotency-Key: operator-request-1042' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "name": "Example shop",
  "email": "admin@example.test",
  "onboarding": "direct",
  "password": "REPLACE_WITH_A_UNIQUE_TEMPORARY_PASSWORD",
  "require_password_change": true,
  "currency": "EUR",
  "starting_credit": "0",
  "external_id": "customer-1042"
}'

İstek gövdesi

namestringzorunlu

Satıcı adı ve kurulum genelinde benzersiz ilk yönetici e-postası.

emailstringzorunlu

Satıcı adı ve kurulum genelinde benzersiz ilk yönetici e-postası.

onboardingdirect | invitationzorunlu

direct, password gerektirir ve davet e-postası göndermez. invitation, password içermez.

passwordstring · direct only

12–128 karakter (en fazla 512 UTF-8 baytı); asla döndürülmez veya e-postalanmaz. Geçici parolalarda require_password_change kullan.

require_password_changebooleanisteğe bağlı

İlk girişte yeni parola gerektirir. Doğrudan oluşturulan her hesap barındırılan cüzdan saklama modelini kabul etmelidir.

currencyfiat codeisteğe bağlı

Ön ödemeli hesap para birimi; varsayılan bölgesel para birimidir ve sonradan değiştirilemez.

fee_bpsintegeristeğe bağlı

0–10000; 100, %1 demektir. Atlanırsa operatör varsayılanını kullanır. fees.write gerektirir.

starting_creditdecimal stringisteğe bağlı

Tam tek seferlik yerel kredi tanımı. Sıfırdan farklıysa credits.write gerektirir. Operatörün kurulum bakiyesini doldurmaz.

external_idstringisteğe bağlı

Benzersiz entegrasyon referansı; 1–120 karakter.

default_timezoneIANA timezoneisteğe bağlı

Varsayılan kurulumun bölgesel saat dilimidir.

send_invitation_emailbooleanisteğe bağlı

Yalnızca davet için. Yapılandırılmış SMTP gerekir; yanıt röle kabulünü hesap oluşturulmasından ayırır.

Yanıt 201 or 200 application/json

Örnek yanıt
{
  "merchant_id": "11111111-1111-4111-8111-111111111111",
  "user_id": "22222222-2222-4222-8222-222222222222",
  "merchant": {
    "id": "11111111-1111-4111-8111-111111111111",
    "name": "Example shop",
    "currency": "EUR",
    "balance": "0"
  },
  "onboarding": "direct",
  "access_link": null,
  "email_delivery": {
    "status": "not_requested"
  },
  "custody_acceptance_required": true
}

Yanıt alanları

merchant_idstring
user_idstring
merchantobject
idstring
namestring
currencystring
balancestring
onboardingstring
email_deliveryobject
statusstring
custody_acceptance_requiredboolean
Kullanım notları
  • merchants.write gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Göndermeden önce benzersiz Idempotency-Key ve tam gövdeyi kalıcı sakla. Yeniden denemeler tamamlanmış işlemi asla tekrarlamaz. Tekrarda gizli alanlar çıkarılır; gizli yanıt kaybolduysa oluşturulan kaynağı incele ve açıkça yenile/yeniden oluştur. 409 operator_request_in_progress, sonucu bilinmeyen kesintiye uğramış istek anlamına gelebilir: kaynağı/denetimi incele; körlemesine yeni anahtarla deneme.
  • Tüm satıcılara erişim gerekir. Açık ücret değişiklikleri ayrıca fees.write; sıfırdan farklı starting_credit, credits.write gerektirir. Davetle katılım ayrıca invitations.write gerektirir. Otomatik giriş, Basic Auth atlama veya yeniden denemede geriye dönük kredi yoktur.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETSatıcıyı Getir/v1/operator/merchants/{merchant_id}Salt okunur

Belirtilen barındırılan satıcı kaynağını ayrı Operatör kimlik bilgisiyle yönet veya incele.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN

Yol parametreleri

merchant_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/operator/merchants/YOUR_MERCHANT_ID" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "id": "11111111-1111-4111-8111-111111111111",
  "name": "Example shop",
  "currency": "EUR",
  "balance": "10",
  "fee_bps": 300,
  "enabled": true,
  "payments_paused": false,
  "external_id": "customer-1042"
}

Yanıt alanları

idstring
namestring
currencystring
balancestring
fee_bpsinteger
enabledboolean
payments_pausedboolean
external_idstring
Kullanım notları
  • merchants.read gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTSatıcıyı Güncelle/v1/operator/merchants/{merchant_id}Okuma ve yazma

Belirtilen barındırılan satıcı kaynağını ayrı Operatör kimlik bilgisiyle yönet veya incele.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN
Idempotency-Keyzorunlu16–128 harf, rakam, -, _ veya .; bu işlem için kalıcı saklanır

Yol parametreleri

merchant_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
# Keep this key and the exact body for retries; use a new key for each new operation.
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/operator/merchants/YOUR_MERCHANT_ID" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Idempotency-Key: operator-request-1042' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "payments_paused": true
}'

İstek gövdesi

namefieldsisteğe bağlı
Devre dışı bırakmak oturumları iptal eder. payments_paused, mevcut ödeme taramasını değil, yeni faturaları engeller. Ücret değişiklikleri fees.write gerektirir ve sonraki faturaları etkiler; hesap para birimi değiştirilemez.Ayrıntılar

Devre dışı bırakmak oturumları iptal eder. payments_paused, mevcut ödeme taramasını değil, yeni faturaları engeller. Ücret değişiklikleri fees.write gerektirir ve sonraki faturaları etkiler; hesap para birimi değiştirilemez.

enabledfieldsisteğe bağlı
Devre dışı bırakmak oturumları iptal eder. payments_paused, mevcut ödeme taramasını değil, yeni faturaları engeller. Ücret değişiklikleri fees.write gerektirir ve sonraki faturaları etkiler; hesap para birimi değiştirilemez.Ayrıntılar

Devre dışı bırakmak oturumları iptal eder. payments_paused, mevcut ödeme taramasını değil, yeni faturaları engeller. Ücret değişiklikleri fees.write gerektirir ve sonraki faturaları etkiler; hesap para birimi değiştirilemez.

payments_pausedfieldsisteğe bağlı
Devre dışı bırakmak oturumları iptal eder. payments_paused, mevcut ödeme taramasını değil, yeni faturaları engeller. Ücret değişiklikleri fees.write gerektirir ve sonraki faturaları etkiler; hesap para birimi değiştirilemez.Ayrıntılar

Devre dışı bırakmak oturumları iptal eder. payments_paused, mevcut ödeme taramasını değil, yeni faturaları engeller. Ücret değişiklikleri fees.write gerektirir ve sonraki faturaları etkiler; hesap para birimi değiştirilemez.

fee_bpsfieldsisteğe bağlı
Devre dışı bırakmak oturumları iptal eder. payments_paused, mevcut ödeme taramasını değil, yeni faturaları engeller. Ücret değişiklikleri fees.write gerektirir ve sonraki faturaları etkiler; hesap para birimi değiştirilemez.Ayrıntılar

Devre dışı bırakmak oturumları iptal eder. payments_paused, mevcut ödeme taramasını değil, yeni faturaları engeller. Ücret değişiklikleri fees.write gerektirir ve sonraki faturaları etkiler; hesap para birimi değiştirilemez.

external_idfieldsisteğe bağlı
Devre dışı bırakmak oturumları iptal eder. payments_paused, mevcut ödeme taramasını değil, yeni faturaları engeller. Ücret değişiklikleri fees.write gerektirir ve sonraki faturaları etkiler; hesap para birimi değiştirilemez.Ayrıntılar

Devre dışı bırakmak oturumları iptal eder. payments_paused, mevcut ödeme taramasını değil, yeni faturaları engeller. Ücret değişiklikleri fees.write gerektirir ve sonraki faturaları etkiler; hesap para birimi değiştirilemez.

Yanıt 200 application/json

Örnek yanıt
{
  "id": "11111111-1111-4111-8111-111111111111",
  "name": "Example shop",
  "currency": "EUR",
  "balance": "10",
  "fee_bps": 300,
  "enabled": true,
  "payments_paused": false
}

Yanıt alanları

idstring
namestring
currencystring
balancestring
fee_bpsinteger
enabledboolean
payments_pausedboolean
Kullanım notları
  • merchants.write gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Göndermeden önce benzersiz Idempotency-Key ve tam gövdeyi kalıcı sakla. Yeniden denemeler tamamlanmış işlemi asla tekrarlamaz. Tekrarda gizli alanlar çıkarılır; gizli yanıt kaybolduysa oluşturulan kaynağı incele ve açıkça yenile/yeniden oluştur. 409 operator_request_in_progress, sonucu bilinmeyen kesintiye uğramış istek anlamına gelebilir: kaynağı/denetimi incele; körlemesine yeni anahtarla deneme.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETKullanıcıları Listele/v1/operator/merchants/{merchant_id}/usersSalt okunur

Belirtilen barındırılan satıcı kaynağını ayrı Operatör kimlik bilgisiyle yönet veya incele.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN

Yol parametreleri

merchant_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

Sorgu parametreleri

pageisteğe bağlı
Sayfa numarası 1'den başlar; sayfa başına 25 öğe. Satıcılar, kullanıcılar, projeler, mağazalar, cüzdanlar, kimlik bilgileri ve webhook'larda arama desteklenir; yerel olay listeleri kendi özel filtrelerini kullanır.Ayrıntılar

Sayfa numarası 1'den başlar; sayfa başına 25 öğe. Satıcılar, kullanıcılar, projeler, mağazalar, cüzdanlar, kimlik bilgileri ve webhook'larda arama desteklenir; yerel olay listeleri kendi özel filtrelerini kullanır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/operator/merchants/YOUR_MERCHANT_ID/users" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "data": [],
  "page": 1,
  "page_size": 25,
  "total": 0
}

Yanıt alanları

data[]array
pageinteger
page_sizeinteger
totalinteger
Kullanım notları
  • users.read gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTKullanıcı Oluştur/v1/operator/merchants/{merchant_id}/usersOkuma ve yazma

Satıcı yöneticisi veya seçili projelerle sınırlı kullanıcı ekle.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN
Idempotency-Keyzorunlu16–128 harf, rakam, -, _ veya .; bu işlem için kalıcı saklanır

Yol parametreleri

merchant_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
# Keep this key and the exact body for retries; use a new key for each new operation.
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/operator/merchants/YOUR_MERCHANT_ID/users" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Idempotency-Key: operator-request-1042' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "email": "staff@example.test",
  "display_name": "Store team",
  "onboarding": "invitation",
  "access_level": "projects",
  "project_ids": [
    "11111111-1111-4111-8111-111111111111"
  ],
  "send_invitation_email": false
}'

İstek gövdesi

emailstringszorunlu

E-posta kurulum genelinde benzersizdir.

display_namestringszorunlu

E-posta kurulum genelinde benzersizdir.

onboardingsame as merchant creation

Davet oluşturmak ayrıca invitations.write gerektirir.

passwordsame as merchant creation

Davet oluşturmak ayrıca invitations.write gerektirir.

require_password_changesame as merchant creation

Davet oluşturmak ayrıca invitations.write gerektirir.

send_invitation_emailsame as merchant creation

Davet oluşturmak ayrıca invitations.write gerektirir.

access_leveladmin | projectsisteğe bağlı

admin yalnızca bu satıcının yöneticisidir; asla kurulum/operatör yöneticisi değildir.

project_ids[]UUID[]

Yalnızca satıcıya ait projeler. Projeyle sınırlı erişimde seçimler zorunludur; farklı kiracılar arasında erişim yoktur.

default_timezoneIANA timezoneisteğe bağlı

Atlanırsa bölgesel varsayılan kullanılır.

Yanıt 201 or 200 application/json

Örnek yanıt
{
  "user": {
    "id": "22222222-2222-4222-8222-222222222222",
    "merchant_id": "11111111-1111-4111-8111-111111111111",
    "email": "admin@example.test",
    "display_name": "Shop administrator",
    "access_level": "admin",
    "project_ids": [],
    "enabled": true,
    "password_setup_required": false,
    "custody_acceptance_required": true,
    "password_change_required": true
  },
  "user_id": "22222222-2222-4222-8222-222222222222",
  "access_link": null,
  "email_delivery": {
    "status": "not_requested"
  },
  "merchant_id": "11111111-1111-4111-8111-111111111111"
}

Yanıt alanları

userobject
idstring
merchant_idstring
emailstring
display_namestring
access_levelstring
project_ids[]array
enabledboolean
password_setup_requiredboolean
custody_acceptance_requiredboolean
password_change_requiredboolean
user_idstring
email_deliveryobject
statusstring
merchant_idstring
Kullanım notları
  • users.write gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Göndermeden önce benzersiz Idempotency-Key ve tam gövdeyi kalıcı sakla. Yeniden denemeler tamamlanmış işlemi asla tekrarlamaz. Tekrarda gizli alanlar çıkarılır; gizli yanıt kaybolduysa oluşturulan kaynağı incele ve açıkça yenile/yeniden oluştur. 409 operator_request_in_progress, sonucu bilinmeyen kesintiye uğramış istek anlamına gelebilir: kaynağı/denetimi incele; körlemesine yeni anahtarla deneme.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETKullanıcıyı Getir/v1/operator/merchants/{merchant_id}/users/{user_id}Salt okunur

Belirtilen barındırılan satıcı kaynağını ayrı Operatör kimlik bilgisiyle yönet veya incele.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN

Yol parametreleri

merchant_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

user_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/operator/merchants/YOUR_MERCHANT_ID/users/YOUR_USER_ID" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "id": "22222222-2222-4222-8222-222222222222",
  "merchant_id": "11111111-1111-4111-8111-111111111111",
  "email": "admin@example.test",
  "display_name": "Shop administrator",
  "access_level": "admin",
  "project_ids": [],
  "enabled": true,
  "password_setup_required": false,
  "custody_acceptance_required": true,
  "password_change_required": true
}

Yanıt alanları

idstring
merchant_idstring
emailstring
display_namestring
access_levelstring
project_ids[]array
enabledboolean
password_setup_requiredboolean
custody_acceptance_requiredboolean
password_change_requiredboolean
Kullanım notları
  • users.read gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTKullanıcıyı Güncelle/v1/operator/merchants/{merchant_id}/users/{user_id}Okuma ve yazma

Belirtilen barındırılan satıcı kaynağını ayrı Operatör kimlik bilgisiyle yönet veya incele.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN
Idempotency-Keyzorunlu16–128 harf, rakam, -, _ veya .; bu işlem için kalıcı saklanır

Yol parametreleri

merchant_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

user_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
# Keep this key and the exact body for retries; use a new key for each new operation.
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/operator/merchants/YOUR_MERCHANT_ID/users/YOUR_USER_ID" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Idempotency-Key: operator-request-1042' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "display_name": "Store manager"
}'

İstek gövdesi

emailfieldsisteğe bağlı

Gönderilen alanları günceller; son yönetici koruması sürer. Parolalar için ayrı users.security işlemi vardır.

display_namefieldsisteğe bağlı

Gönderilen alanları günceller; son yönetici koruması sürer. Parolalar için ayrı users.security işlemi vardır.

enabledfieldsisteğe bağlı

Gönderilen alanları günceller; son yönetici koruması sürer. Parolalar için ayrı users.security işlemi vardır.

access_levelfieldsisteğe bağlı

Gönderilen alanları günceller; son yönetici koruması sürer. Parolalar için ayrı users.security işlemi vardır.

project_idsfieldsisteğe bağlı

Gönderilen alanları günceller; son yönetici koruması sürer. Parolalar için ayrı users.security işlemi vardır.

default_timezonefieldsisteğe bağlı

Gönderilen alanları günceller; son yönetici koruması sürer. Parolalar için ayrı users.security işlemi vardır.

Yanıt 200 application/json

Örnek yanıt
{
  "id": "22222222-2222-4222-8222-222222222222",
  "merchant_id": "11111111-1111-4111-8111-111111111111",
  "email": "admin@example.test",
  "display_name": "Shop administrator",
  "access_level": "admin",
  "project_ids": [],
  "enabled": true,
  "password_setup_required": false,
  "custody_acceptance_required": true,
  "password_change_required": true
}

Yanıt alanları

idstring
merchant_idstring
emailstring
display_namestring
access_levelstring
project_ids[]array
enabledboolean
password_setup_requiredboolean
custody_acceptance_requiredboolean
password_change_requiredboolean
Kullanım notları
  • users.write gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Göndermeden önce benzersiz Idempotency-Key ve tam gövdeyi kalıcı sakla. Yeniden denemeler tamamlanmış işlemi asla tekrarlamaz. Tekrarda gizli alanlar çıkarılır; gizli yanıt kaybolduysa oluşturulan kaynağı incele ve açıkça yenile/yeniden oluştur. 409 operator_request_in_progress, sonucu bilinmeyen kesintiye uğramış istek anlamına gelebilir: kaynağı/denetimi incele; körlemesine yeni anahtarla deneme.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTKullanıcı Parolasını Belirle/v1/operator/merchants/{merchant_id}/users/{user_id}/passwordOkuma ve yazma

Barındırılan hesap parolasını belirle ve oturumları iptal et. Mevcut TOTP korunur.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN
Idempotency-Keyzorunlu16–128 harf, rakam, -, _ veya .; bu işlem için kalıcı saklanır

Yol parametreleri

merchant_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

user_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
# Keep this key and the exact body for retries; use a new key for each new operation.
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/operator/merchants/YOUR_MERCHANT_ID/users/YOUR_USER_ID/password" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Idempotency-Key: operator-request-1042' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "password": "REPLACE_WITH_A_NEW_UNIQUE_PASSWORD",
  "require_password_change": true
}'

İstek gövdesi

passwordstringzorunlu

TOTP'yi koruyarak parolayı değiştirir ve oturumları iptal eder. users.security gerektirir.

require_password_changebooleanisteğe bağlı

Kullanıcı sonraki başarılı girişte kendi parolasını belirlemelidir.

Yanıt 200 application/json

Örnek yanıt
{
  "user_id": "11111111-1111-4111-8111-111111111111",
  "sessions_revoked": true,
  "totp_preserved": true
}

Yanıt alanları

user_idstring
sessions_revokedboolean
totp_preservedboolean
Kullanım notları
  • users.security gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Göndermeden önce benzersiz Idempotency-Key ve tam gövdeyi kalıcı sakla. Yeniden denemeler tamamlanmış işlemi asla tekrarlamaz. Tekrarda gizli alanlar çıkarılır; gizli yanıt kaybolduysa oluşturulan kaynağı incele ve açıkça yenile/yeniden oluştur. 409 operator_request_in_progress, sonucu bilinmeyen kesintiye uğramış istek anlamına gelebilir: kaynağı/denetimi incele; körlemesine yeni anahtarla deneme.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTKullanıcı Oturumlarını İptal Et/v1/operator/merchants/{merchant_id}/users/{user_id}/revoke-sessionsOkuma ve yazma

Belirtilen barındırılan satıcı kaynağını ayrı Operatör kimlik bilgisiyle yönet veya incele.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN
Idempotency-Keyzorunlu16–128 harf, rakam, -, _ veya .; bu işlem için kalıcı saklanır

Yol parametreleri

merchant_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

user_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
# Keep this key and the exact body for retries; use a new key for each new operation.
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/operator/merchants/YOUR_MERCHANT_ID/users/YOUR_USER_ID/revoke-sessions" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Idempotency-Key: operator-request-1042' \
  --header 'Content-Type: application/json' \
  --data-raw '{}'

Yanıt 200 application/json

Örnek yanıt
{
  "user_id": "11111111-1111-4111-8111-111111111111",
  "sessions_revoked": true,
  "totp_preserved": true
}

Yanıt alanları

user_idstring
sessions_revokedboolean
totp_preservedboolean
Kullanım notları
  • users.security gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Göndermeden önce benzersiz Idempotency-Key ve tam gövdeyi kalıcı sakla. Yeniden denemeler tamamlanmış işlemi asla tekrarlamaz. Tekrarda gizli alanlar çıkarılır; gizli yanıt kaybolduysa oluşturulan kaynağı incele ve açıkça yenile/yeniden oluştur. 409 operator_request_in_progress, sonucu bilinmeyen kesintiye uğramış istek anlamına gelebilir: kaynağı/denetimi incele; körlemesine yeni anahtarla deneme.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETDavetleri Listele/v1/operator/merchants/{merchant_id}/invitationsSalt okunur

Belirtilen barındırılan satıcı kaynağını ayrı Operatör kimlik bilgisiyle yönet veya incele.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN

Yol parametreleri

merchant_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

Sorgu parametreleri

pageisteğe bağlı
Sayfa numarası 1'den başlar; sayfa başına 25 öğe. Satıcılar, kullanıcılar, projeler, mağazalar, cüzdanlar, kimlik bilgileri ve webhook'larda arama desteklenir; yerel olay listeleri kendi özel filtrelerini kullanır.Ayrıntılar

Sayfa numarası 1'den başlar; sayfa başına 25 öğe. Satıcılar, kullanıcılar, projeler, mağazalar, cüzdanlar, kimlik bilgileri ve webhook'larda arama desteklenir; yerel olay listeleri kendi özel filtrelerini kullanır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/operator/merchants/YOUR_MERCHANT_ID/invitations" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "data": [],
  "page": 1,
  "page_size": 25,
  "total": 0
}

Yanıt alanları

data[]array
pageinteger
page_sizeinteger
totalinteger
Kullanım notları
  • invitations.read gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTDavet Oluştur/v1/operator/merchants/{merchant_id}/invitationsOkuma ve yazma

Tek kullanımlık davet veya parola sıfırlama bağlantısı oluştur ya da yenile.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN
Idempotency-Keyzorunlu16–128 harf, rakam, -, _ veya .; bu işlem için kalıcı saklanır

Yol parametreleri

merchant_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
# Keep this key and the exact body for retries; use a new key for each new operation.
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/operator/merchants/YOUR_MERCHANT_ID/invitations" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Idempotency-Key: operator-request-1042' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "user_id": "11111111-1111-4111-8111-111111111111",
  "send_email": false
}'

İstek gövdesi

user_idUUID, boolean

Mevcut hesap için tek kullanımlık bağlantı oluştur/yenile. Etkinleştirilmiş kullanıcılar bir saatlik sıfırlama bağlantısı alır ve users.security gerekir.

send_emailUUID, boolean

Mevcut hesap için tek kullanımlık bağlantı oluştur/yenile. Etkinleştirilmiş kullanıcılar bir saatlik sıfırlama bağlantısı alır ve users.security gerekir.

new user fieldsalternative to user_id

Davet edilen kullanıcıyı oluşturmak için email, display_name, access_level ve project_ids kullan; users.write gerektirir.

Yanıt 201 or 200 application/json

Örnek yanıt
{
  "user_id": "22222222-2222-4222-8222-222222222222",
  "email": "admin@example.test",
  "kind": "invitation",
  "expires_at": "2026-10-03T12:00:00Z",
  "url": "https://merchant.example.com/account-access.html#token=YOUR_PRIVATE_INVITATION_TOKEN"
}

Yanıt alanları

user_idstring
emailstring
kindstring
expires_atstring
urlstring
Kullanım notları
  • invitations.write gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Göndermeden önce benzersiz Idempotency-Key ve tam gövdeyi kalıcı sakla. Yeniden denemeler tamamlanmış işlemi asla tekrarlamaz. Tekrarda gizli alanlar çıkarılır; gizli yanıt kaybolduysa oluşturulan kaynağı incele ve açıkça yenile/yeniden oluştur. 409 operator_request_in_progress, sonucu bilinmeyen kesintiye uğramış istek anlamına gelebilir: kaynağı/denetimi incele; körlemesine yeni anahtarla deneme.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETDaveti Getir/v1/operator/invitations/{invitation_id}Salt okunur

Belirtilen barındırılan satıcı kaynağını ayrı Operatör kimlik bilgisiyle yönet veya incele.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN

Yol parametreleri

invitation_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/operator/invitations/YOUR_INVITATION_ID" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "id": "44444444-4444-4444-8444-444444444444",
  "user_id": "22222222-2222-4222-8222-222222222222",
  "merchant_id": "11111111-1111-4111-8111-111111111111",
  "kind": "invitation",
  "status": "pending",
  "created_at": "2026-10-01T12:00:00Z",
  "expires_at": "2026-10-03T12:00:00Z"
}

Yanıt alanları

idstring
user_idstring
merchant_idstring
kindstring
statusstring
created_atstring
expires_atstring
Kullanım notları
  • invitations.read gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTDaveti Yeniden Gönder/v1/operator/invitations/{invitation_id}/resendOkuma ve yazma

Belirtilen barındırılan satıcı kaynağını ayrı Operatör kimlik bilgisiyle yönet veya incele.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN
Idempotency-Keyzorunlu16–128 harf, rakam, -, _ veya .; bu işlem için kalıcı saklanır

Yol parametreleri

invitation_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
# Keep this key and the exact body for retries; use a new key for each new operation.
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/operator/invitations/YOUR_INVITATION_ID/resend" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Idempotency-Key: operator-request-1042' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "send_email": false
}'

İstek gövdesi

send_emailbooleanisteğe bağlı

Önceki token'ın yerini alır; asla kredi eklemez. Yeni üretilen bağlantıyı bir kez döndürür. Zaten etkinleştirilmiş hesap için users.security gerekir.

Yanıt 200 application/json

Örnek yanıt
{
  "user_id": "22222222-2222-4222-8222-222222222222",
  "email": "admin@example.test",
  "kind": "invitation",
  "expires_at": "2026-10-03T12:00:00Z",
  "url": "https://merchant.example.com/account-access.html#token=YOUR_PRIVATE_INVITATION_TOKEN"
}

Yanıt alanları

user_idstring
emailstring
kindstring
expires_atstring
urlstring
Kullanım notları
  • invitations.write gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Göndermeden önce benzersiz Idempotency-Key ve tam gövdeyi kalıcı sakla. Yeniden denemeler tamamlanmış işlemi asla tekrarlamaz. Tekrarda gizli alanlar çıkarılır; gizli yanıt kaybolduysa oluşturulan kaynağı incele ve açıkça yenile/yeniden oluştur. 409 operator_request_in_progress, sonucu bilinmeyen kesintiye uğramış istek anlamına gelebilir: kaynağı/denetimi incele; körlemesine yeni anahtarla deneme.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTDaveti İptal Et/v1/operator/invitations/{invitation_id}/revokeOkuma ve yazma

Belirtilen barındırılan satıcı kaynağını ayrı Operatör kimlik bilgisiyle yönet veya incele.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN
Idempotency-Keyzorunlu16–128 harf, rakam, -, _ veya .; bu işlem için kalıcı saklanır

Yol parametreleri

invitation_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
# Keep this key and the exact body for retries; use a new key for each new operation.
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/operator/invitations/YOUR_INVITATION_ID/revoke" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Idempotency-Key: operator-request-1042' \
  --header 'Content-Type: application/json' \
  --data-raw '{}'

Yanıt 200 application/json

Örnek yanıt
{
  "revoked": true,
  "invitation_id": "44444444-4444-4444-8444-444444444444"
}

Yanıt alanları

revokedboolean
invitation_idstring
Kullanım notları
  • invitations.write gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Göndermeden önce benzersiz Idempotency-Key ve tam gövdeyi kalıcı sakla. Yeniden denemeler tamamlanmış işlemi asla tekrarlamaz. Tekrarda gizli alanlar çıkarılır; gizli yanıt kaybolduysa oluşturulan kaynağı incele ve açıkça yenile/yeniden oluştur. 409 operator_request_in_progress, sonucu bilinmeyen kesintiye uğramış istek anlamına gelebilir: kaynağı/denetimi incele; körlemesine yeni anahtarla deneme.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETKredileri Getir/v1/operator/merchants/{merchant_id}/creditsSalt okunur

Belirtilen barındırılan satıcı kaynağını ayrı Operatör kimlik bilgisiyle yönet veya incele.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN

Yol parametreleri

merchant_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/operator/merchants/YOUR_MERCHANT_ID/credits" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "id": "11111111-1111-4111-8111-111111111111",
  "name": "Example shop",
  "currency": "EUR",
  "balance": "10",
  "fee_bps": 300,
  "enabled": true,
  "payments_paused": false,
  "external_id": "customer-1042"
}

Yanıt alanları

idstring
namestring
currencystring
balancestring
fee_bpsinteger
enabledboolean
payments_pausedboolean
external_idstring
Kullanım notları
  • credits.read gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETKredi Defterini Listele/v1/operator/merchants/{merchant_id}/credits/ledgerSalt okunur

Belirtilen barındırılan satıcı kaynağını ayrı Operatör kimlik bilgisiyle yönet veya incele.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN

Yol parametreleri

merchant_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

Sorgu parametreleri

pageisteğe bağlı
Sayfa numarası 1'den başlar; sayfa başına 25 öğe. Satıcılar, kullanıcılar, projeler, mağazalar, cüzdanlar, kimlik bilgileri ve webhook'larda arama desteklenir; yerel olay listeleri kendi özel filtrelerini kullanır.Ayrıntılar

Sayfa numarası 1'den başlar; sayfa başına 25 öğe. Satıcılar, kullanıcılar, projeler, mağazalar, cüzdanlar, kimlik bilgileri ve webhook'larda arama desteklenir; yerel olay listeleri kendi özel filtrelerini kullanır.

qisteğe bağlı
Sayfa numarası 1'den başlar; sayfa başına 25 öğe. Satıcılar, kullanıcılar, projeler, mağazalar, cüzdanlar, kimlik bilgileri ve webhook'larda arama desteklenir; yerel olay listeleri kendi özel filtrelerini kullanır.Ayrıntılar

Sayfa numarası 1'den başlar; sayfa başına 25 öğe. Satıcılar, kullanıcılar, projeler, mağazalar, cüzdanlar, kimlik bilgileri ve webhook'larda arama desteklenir; yerel olay listeleri kendi özel filtrelerini kullanır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/operator/merchants/YOUR_MERCHANT_ID/credits/ledger" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "data": [],
  "page": 1,
  "page_size": 25,
  "total": 0
}

Yanıt alanları

data[]array
pageinteger
page_sizeinteger
totalinteger
Kullanım notları
  • credits.read gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTKredileri Düzelt/v1/operator/merchants/{merchant_id}/credits/adjustmentsOkuma ve yazma

Bu satıcının ön ödemeli hesap defterine gerekçeli kredi tanımı veya düzeltme ekle.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN
Idempotency-Keyzorunlu16–128 harf, rakam, -, _ veya .; bu işlem için kalıcı saklanır

Yol parametreleri

merchant_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
# Keep this key and the exact body for retries; use a new key for each new operation.
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/operator/merchants/YOUR_MERCHANT_ID/credits/adjustments" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Idempotency-Key: operator-request-1042' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "amount": "10.00",
  "note": "Promotional credit",
  "request_id": "11111111-1111-4111-8111-111111111111"
}'

İstek gövdesi

amountsigned decimal stringzorunlu

Satıcı kredi para biriminde en fazla altı ondalık basamakla pozitif kredi tanımı veya negatif düzeltme. Zincir üstü transfer değildir.

notestringzorunlu

Gerekçe yalnızca ekleme yapılabilen hesap defterinde tutulur.

request_idUUIDzorunlu

HTTP Idempotency-Key'e ek olarak tutar ve gerekçeyle birlikte kalıcı sakla.

Yanıt 200 application/json

Örnek yanıt
{
  "balance": "25"
}

Yanıt alanları

balancestring
Kullanım notları
  • credits.write gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Göndermeden önce benzersiz Idempotency-Key ve tam gövdeyi kalıcı sakla. Yeniden denemeler tamamlanmış işlemi asla tekrarlamaz. Tekrarda gizli alanlar çıkarılır; gizli yanıt kaybolduysa oluşturulan kaynağı incele ve açıkça yenile/yeniden oluştur. 409 operator_request_in_progress, sonucu bilinmeyen kesintiye uğramış istek anlamına gelebilir: kaynağı/denetimi incele; körlemesine yeni anahtarla deneme.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETBakiye Yüklemelerini Listele/v1/operator/merchants/{merchant_id}/topupsSalt okunur

Belirtilen barındırılan satıcı kaynağını ayrı Operatör kimlik bilgisiyle yönet veya incele.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN

Yol parametreleri

merchant_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

Sorgu parametreleri

pageisteğe bağlı
Sayfa numarası 1'den başlar; sayfa başına 25 öğe. Satıcılar, kullanıcılar, projeler, mağazalar, cüzdanlar, kimlik bilgileri ve webhook'larda arama desteklenir; yerel olay listeleri kendi özel filtrelerini kullanır.Ayrıntılar

Sayfa numarası 1'den başlar; sayfa başına 25 öğe. Satıcılar, kullanıcılar, projeler, mağazalar, cüzdanlar, kimlik bilgileri ve webhook'larda arama desteklenir; yerel olay listeleri kendi özel filtrelerini kullanır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/operator/merchants/YOUR_MERCHANT_ID/topups" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "data": [],
  "page": 1,
  "page_size": 25,
  "total": 0
}

Yanıt alanları

data[]array
pageinteger
page_sizeinteger
totalinteger
Kullanım notları
  • topups.read gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTBakiye Yüklemesi Oluştur/v1/operator/merchants/{merchant_id}/topupsOkuma ve yazma

Ön ödemeli kredi için ödeme sayfası oluştur; asla elle ödendi işaretleme.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN
Idempotency-Keyzorunlu16–128 harf, rakam, -, _ veya .; bu işlem için kalıcı saklanır

Yol parametreleri

merchant_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
# Keep this key and the exact body for retries; use a new key for each new operation.
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/operator/merchants/YOUR_MERCHANT_ID/topups" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Idempotency-Key: operator-request-1042' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "amount": "25.00",
  "request_id": "11111111-1111-4111-8111-111111111111"
}'

İstek gövdesi

amountdecimal stringzorunlu

Satıcı kredi para biriminde en az bir birim. Kullanıma hazır Operatör ödeme alma mağazası gerekir.

request_idUUIDzorunlu

Yeniden denemeler boyunca sakla. Zaten oluşturulduysa mevcut faturayı döndürür. Kredi yalnızca ödeme tamamlandığı gözlendikten sonra uygulanır.

Yanıt 201 or 200 application/json

Örnek yanıt
{
  "id": "44444444-4444-4444-8444-444444444444",
  "invoice_id": "33333333-3333-4333-8333-333333333333",
  "checkout_url": "https://pay.example.com/invoice/33333333-3333-4333-8333-333333333333"
}

Yanıt alanları

idstring
invoice_idstring
checkout_urlstring
Kullanım notları
  • topups.write gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Göndermeden önce benzersiz Idempotency-Key ve tam gövdeyi kalıcı sakla. Yeniden denemeler tamamlanmış işlemi asla tekrarlamaz. Tekrarda gizli alanlar çıkarılır; gizli yanıt kaybolduysa oluşturulan kaynağı incele ve açıkça yenile/yeniden oluştur. 409 operator_request_in_progress, sonucu bilinmeyen kesintiye uğramış istek anlamına gelebilir: kaynağı/denetimi incele; körlemesine yeni anahtarla deneme.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETBakiye Yüklemesini Getir/v1/operator/merchants/{merchant_id}/topups/{topup_id}Salt okunur

Belirtilen barındırılan satıcı kaynağını ayrı Operatör kimlik bilgisiyle yönet veya incele.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN

Yol parametreleri

merchant_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

topup_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/operator/merchants/YOUR_MERCHANT_ID/topups/YOUR_TOPUP_ID" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "id": "44444444-4444-4444-8444-444444444444",
  "merchant_id": "11111111-1111-4111-8111-111111111111",
  "invoice_id": "33333333-3333-4333-8333-333333333333",
  "amount": "25",
  "currency": "EUR",
  "status": "pending",
  "invoice_status": "new",
  "checkout_url": "https://pay.example.com/invoice/33333333-3333-4333-8333-333333333333"
}

Yanıt alanları

idstring
merchant_idstring
invoice_idstring
amountstring
currencystring
statusstring
invoice_statusstring
checkout_urlstring
Kullanım notları
  • topups.read gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETRaporlar/v1/operator/reportsSalt okunur

Operatör finansal genel bakışını oku. Barındırılan tüm satıcılara erişim gerektirir.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN

Sorgu parametreleri

periodisteğe bağlı

Finans filtreleri. period varsayılanı last30; YYYY-MM-DD start/end ile custom kullan. Yalnızca tüm satıcılara erişen kimlik bilgileri.

startisteğe bağlı

Finans filtreleri. period varsayılanı last30; YYYY-MM-DD start/end ile custom kullan. Yalnızca tüm satıcılara erişen kimlik bilgileri.

endisteğe bağlı

Finans filtreleri. period varsayılanı last30; YYYY-MM-DD start/end ile custom kullan. Yalnızca tüm satıcılara erişen kimlik bilgileri.

currencyisteğe bağlı

Finans filtreleri. period varsayılanı last30; YYYY-MM-DD start/end ile custom kullan. Yalnızca tüm satıcılara erişen kimlik bilgileri.

merchant_idisteğe bağlı

Finans filtreleri. period varsayılanı last30; YYYY-MM-DD start/end ile custom kullan. Yalnızca tüm satıcılara erişen kimlik bilgileri.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/operator/reports" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "summary": {
    "fees": "10",
    "costs": "3",
    "margin": "7",
    "credits": "25",
    "pending": 0,
    "missing_rates": 0
  },
  "merchants": [],
  "filters": {
    "period": "last30",
    "currency": "EUR",
    "timezone": "UTC"
  },
  "basis": "first_settlement_latest_net_fees"
}

Yanıt alanları

summaryobject
feesstring
costsstring
marginstring
creditsstring
pendinginteger
missing_ratesinteger
merchants[]array
filtersobject
periodstring
currencystring
timezonestring
basisstring
Kullanım notları
  • reports.read gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Toplamlar hesaplanmadan önce kendi işletmesine ait satırlar, maliyetler ve sayılar hariç tutulur. Kendi işletmesine ait merchant_id filtresi 404 döndürür. Raporlama kurulum saat dilimini kullanır.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETDenetim Kayıtlarını Listele/v1/operator/auditSalt okunur

Belirtilen barındırılan satıcı kaynağını ayrı Operatör kimlik bilgisiyle yönet veya incele.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN

Sorgu parametreleri

merchant_idisteğe bağlı

İzin verilen satıcıyı, tam olay türünü (events) veya eylem metnini (audit) filtrele. Olay saklama: 30 gün.

pageisteğe bağlı
Sayfa numarası 1'den başlar; sayfa başına 25 öğe. Satıcılar, kullanıcılar, projeler, mağazalar, cüzdanlar, kimlik bilgileri ve webhook'larda arama desteklenir; yerel olay listeleri kendi özel filtrelerini kullanır.Ayrıntılar

Sayfa numarası 1'den başlar; sayfa başına 25 öğe. Satıcılar, kullanıcılar, projeler, mağazalar, cüzdanlar, kimlik bilgileri ve webhook'larda arama desteklenir; yerel olay listeleri kendi özel filtrelerini kullanır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/operator/audit" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "data": [],
  "page": 1,
  "page_size": 25,
  "total": 0
}

Yanıt alanları

data[]array
pageinteger
page_sizeinteger
totalinteger
Kullanım notları
  • audit.read gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETOlayları Listele/v1/operator/eventsSalt okunur

Belirtilen barındırılan satıcı kaynağını ayrı Operatör kimlik bilgisiyle yönet veya incele.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN

Sorgu parametreleri

merchant_idisteğe bağlı

İzin verilen satıcıyı, tam olay türünü (events) veya eylem metnini (audit) filtrele. Olay saklama: 30 gün.

event_typeisteğe bağlı

İzin verilen satıcıyı, tam olay türünü (events) veya eylem metnini (audit) filtrele. Olay saklama: 30 gün.

pageisteğe bağlı
Sayfa numarası 1'den başlar; sayfa başına 25 öğe. Satıcılar, kullanıcılar, projeler, mağazalar, cüzdanlar, kimlik bilgileri ve webhook'larda arama desteklenir; yerel olay listeleri kendi özel filtrelerini kullanır.Ayrıntılar

Sayfa numarası 1'den başlar; sayfa başına 25 öğe. Satıcılar, kullanıcılar, projeler, mağazalar, cüzdanlar, kimlik bilgileri ve webhook'larda arama desteklenir; yerel olay listeleri kendi özel filtrelerini kullanır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/operator/events" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "data": [],
  "page": 1,
  "page_size": 25,
  "total": 0
}

Yanıt alanları

data[]array
pageinteger
page_sizeinteger
totalinteger
Kullanım notları
  • events.read gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETWebhook'ları Listele/v1/operator/webhooksSalt okunur

Belirtilen barındırılan satıcı kaynağını ayrı Operatör kimlik bilgisiyle yönet veya incele.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN

Sorgu parametreleri

pageisteğe bağlı
Sayfa numarası 1'den başlar; sayfa başına 25 öğe. Satıcılar, kullanıcılar, projeler, mağazalar, cüzdanlar, kimlik bilgileri ve webhook'larda arama desteklenir; yerel olay listeleri kendi özel filtrelerini kullanır.Ayrıntılar

Sayfa numarası 1'den başlar; sayfa başına 25 öğe. Satıcılar, kullanıcılar, projeler, mağazalar, cüzdanlar, kimlik bilgileri ve webhook'larda arama desteklenir; yerel olay listeleri kendi özel filtrelerini kullanır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/operator/webhooks" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "data": [],
  "page": 1,
  "page_size": 25,
  "total": 0
}

Yanıt alanları

data[]array
pageinteger
page_sizeinteger
totalinteger
Kullanım notları
  • events.read gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTWebhook Oluştur/v1/operator/webhooksOkuma ve yazma

Gelecekteki Operatör yaşam döngüsü olaylarına abone ol. Mağaza ödeme webhook'u değildir.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN
Idempotency-Keyzorunlu16–128 harf, rakam, -, _ veya .; bu işlem için kalıcı saklanır

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
# Keep this key and the exact body for retries; use a new key for each new operation.
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/operator/webhooks" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Idempotency-Key: operator-request-1042' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "url": "https://shop.example.test/operator-events",
  "events": [
    "merchant.created",
    "topup.settled"
  ],
  "merchant_ids": [],
  "enabled": true
}'

İstek gövdesi

urlpublic HTTPS URLzorunlu

Kimlik bilgisi, özel IP veya yönlendirme yok. Teslimde DNS/IP yeniden kontrol edilir.

events[]string[]zorunlu

Fatura geri çağrıları yerine Operatör rehberindeki yaşam döngüsü olaylarını seç.

merchant_ids[]UUID[]isteğe bağlı

Boş olması bu kimlik bilgisinin izin verdiği tüm satıcılar demektir. Güncel kapsam kısıtlamaları yeniden kontrol edilir.

enabledbooleanisteğe bağlı

Duraklatılan uç noktalar kuyruktaki teslimleri korur; yeniden etkinleştirme geçerli saklanan işleri devam ettirir.

Yanıt 201 or 200 application/json

Örnek yanıt
{
  "id": "11111111-1111-4111-8111-111111111111",
  "signing_secret": "wco_whsec_EXAMPLE_ONLY_SAVE_ONCE"
}

Yanıt alanları

idstring
signing_secretstring
Kullanım notları
  • webhooks.write + events.read gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Göndermeden önce benzersiz Idempotency-Key ve tam gövdeyi kalıcı sakla. Yeniden denemeler tamamlanmış işlemi asla tekrarlamaz. Tekrarda gizli alanlar çıkarılır; gizli yanıt kaybolduysa oluşturulan kaynağı incele ve açıkça yenile/yeniden oluştur. 409 operator_request_in_progress, sonucu bilinmeyen kesintiye uğramış istek anlamına gelebilir: kaynağı/denetimi incele; körlemesine yeni anahtarla deneme.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTWebhook'u Güncelle/v1/operator/webhooks/{webhook_id}Okuma ve yazma

Belirtilen barındırılan satıcı kaynağını ayrı Operatör kimlik bilgisiyle yönet veya incele.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN
Idempotency-Keyzorunlu16–128 harf, rakam, -, _ veya .; bu işlem için kalıcı saklanır

Yol parametreleri

webhook_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
# Keep this key and the exact body for retries; use a new key for each new operation.
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/operator/webhooks/YOUR_WEBHOOK_ID" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Idempotency-Key: operator-request-1042' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "url": "https://shop.example.test/operator-events",
  "events": [
    "topup.settled"
  ],
  "merchant_ids": [],
  "enabled": false
}'

İstek gövdesi

urlpublic HTTPS URLzorunlu

Kimlik bilgisi, özel IP veya yönlendirme yok. Teslimde DNS/IP yeniden kontrol edilir.

events[]string[]zorunlu

Fatura geri çağrıları yerine Operatör rehberindeki yaşam döngüsü olaylarını seç.

merchant_ids[]UUID[]isteğe bağlı

Boş olması bu kimlik bilgisinin izin verdiği tüm satıcılar demektir. Güncel kapsam kısıtlamaları yeniden kontrol edilir.

enabledbooleanisteğe bağlı

Duraklatılan uç noktalar kuyruktaki teslimleri korur; yeniden etkinleştirme geçerli saklanan işleri devam ettirir.

Yanıt 200 application/json

Örnek yanıt
{
  "id": "44444444-4444-4444-8444-444444444444",
  "signing_secret": null
}

Yanıt alanları

idstring
signing_secretJSON | null
Kullanım notları
  • webhooks.write + events.read gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Göndermeden önce benzersiz Idempotency-Key ve tam gövdeyi kalıcı sakla. Yeniden denemeler tamamlanmış işlemi asla tekrarlamaz. Tekrarda gizli alanlar çıkarılır; gizli yanıt kaybolduysa oluşturulan kaynağı incele ve açıkça yenile/yeniden oluştur. 409 operator_request_in_progress, sonucu bilinmeyen kesintiye uğramış istek anlamına gelebilir: kaynağı/denetimi incele; körlemesine yeni anahtarla deneme.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTWebhook Sırrını Yenile/v1/operator/webhooks/{webhook_id}/rotateOkuma ve yazma

Belirtilen barındırılan satıcı kaynağını ayrı Operatör kimlik bilgisiyle yönet veya incele.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN
Idempotency-Keyzorunlu16–128 harf, rakam, -, _ veya .; bu işlem için kalıcı saklanır

Yol parametreleri

webhook_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
# Keep this key and the exact body for retries; use a new key for each new operation.
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/operator/webhooks/YOUR_WEBHOOK_ID/rotate" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Idempotency-Key: operator-request-1042' \
  --header 'Content-Type: application/json' \
  --data-raw '{}'

Yanıt 200 application/json

Örnek yanıt
{
  "id": "11111111-1111-4111-8111-111111111111",
  "signing_secret": "wco_whsec_EXAMPLE_ONLY_SAVE_ONCE"
}

Yanıt alanları

idstring
signing_secretstring
Kullanım notları
  • webhooks.write + events.read gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Göndermeden önce benzersiz Idempotency-Key ve tam gövdeyi kalıcı sakla. Yeniden denemeler tamamlanmış işlemi asla tekrarlamaz. Tekrarda gizli alanlar çıkarılır; gizli yanıt kaybolduysa oluşturulan kaynağı incele ve açıkça yenile/yeniden oluştur. 409 operator_request_in_progress, sonucu bilinmeyen kesintiye uğramış istek anlamına gelebilir: kaynağı/denetimi incele; körlemesine yeni anahtarla deneme.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETWebhook Teslimlerini Listele/v1/operator/webhooks/{webhook_id}/deliveriesSalt okunur

Belirtilen barındırılan satıcı kaynağını ayrı Operatör kimlik bilgisiyle yönet veya incele.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN

Yol parametreleri

webhook_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

Sorgu parametreleri

pageisteğe bağlı
Sayfa numarası 1'den başlar; sayfa başına 25 öğe. Satıcılar, kullanıcılar, projeler, mağazalar, cüzdanlar, kimlik bilgileri ve webhook'larda arama desteklenir; yerel olay listeleri kendi özel filtrelerini kullanır.Ayrıntılar

Sayfa numarası 1'den başlar; sayfa başına 25 öğe. Satıcılar, kullanıcılar, projeler, mağazalar, cüzdanlar, kimlik bilgileri ve webhook'larda arama desteklenir; yerel olay listeleri kendi özel filtrelerini kullanır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/operator/webhooks/YOUR_WEBHOOK_ID/deliveries" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "data": [],
  "page": 1,
  "page_size": 25,
  "total": 0
}

Yanıt alanları

data[]array
pageinteger
page_sizeinteger
totalinteger
Kullanım notları
  • events.read gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETProjeleri Listele/v1/operator/merchants/{merchant_id}/projectsSalt okunur

Belirtilen barındırılan satıcı kaynağını ayrı Operatör kimlik bilgisiyle yönet veya incele.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN

Yol parametreleri

merchant_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

Sorgu parametreleri

pageisteğe bağlı
Sayfa numarası 1'den başlar; sayfa başına 25 öğe. Satıcılar, kullanıcılar, projeler, mağazalar, cüzdanlar, kimlik bilgileri ve webhook'larda arama desteklenir; yerel olay listeleri kendi özel filtrelerini kullanır.Ayrıntılar

Sayfa numarası 1'den başlar; sayfa başına 25 öğe. Satıcılar, kullanıcılar, projeler, mağazalar, cüzdanlar, kimlik bilgileri ve webhook'larda arama desteklenir; yerel olay listeleri kendi özel filtrelerini kullanır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/operator/merchants/YOUR_MERCHANT_ID/projects" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "data": [],
  "page": 1,
  "page_size": 25,
  "total": 0
}

Yanıt alanları

data[]array
pageinteger
page_sizeinteger
totalinteger
Kullanım notları
  • projects.read gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTProje Oluştur/v1/operator/merchants/{merchant_id}/projectsOkuma ve yazma

Belirtilen barındırılan satıcı kaynağını ayrı Operatör kimlik bilgisiyle yönet veya incele.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN
Idempotency-Keyzorunlu16–128 harf, rakam, -, _ veya .; bu işlem için kalıcı saklanır

Yol parametreleri

merchant_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
# Keep this key and the exact body for retries; use a new key for each new operation.
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/operator/merchants/YOUR_MERCHANT_ID/projects" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Idempotency-Key: operator-request-1042' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "name": "Online shop",
  "slug": "online-shop",
  "enabled": false
}'

İstek gövdesi

namestringszorunlu

Ad ve benzersiz sabit proje tanımlayıcısı. Mevcut proje başlangıç sürecini kullanarak yerel cüzdanlar oluşturur; asla fon transfer etmez.

slugstringszorunlu

Ad ve benzersiz sabit proje tanımlayıcısı. Mevcut proje başlangıç sürecini kullanarak yerel cüzdanlar oluşturur; asla fon transfer etmez.

enabledisteğe bağlı

enabled varsayılanı true; duraklatılmış oluşturup önce mağazayı yapılandırmak önerilir.

reporting_timezoneisteğe bağlı

enabled varsayılanı true; duraklatılmış oluşturup önce mağazayı yapılandırmak önerilir.

checkout_titleisteğe bağlı

enabled varsayılanı true; duraklatılmış oluşturup önce mağazayı yapılandırmak önerilir.

checkout_descriptionisteğe bağlı

enabled varsayılanı true; duraklatılmış oluşturup önce mağazayı yapılandırmak önerilir.

checkout_themeisteğe bağlı

enabled varsayılanı true; duraklatılmış oluşturup önce mağazayı yapılandırmak önerilir.

checkout_accent_coloristeğe bağlı

enabled varsayılanı true; duraklatılmış oluşturup önce mağazayı yapılandırmak önerilir.

Yanıt 201 or 200 application/json

Örnek yanıt
{
  "id": "33333333-3333-4333-8333-333333333333",
  "slug": "example-shop",
  "name": "Example shop",
  "enabled": false,
  "reporting_currency": "EUR",
  "reporting_timezone": "Europe/Berlin",
  "stores": []
}

Yanıt alanları

idstring
slugstring
namestring
enabledboolean
reporting_currencystring
reporting_timezonestring
stores[]array
Kullanım notları
  • projects.write gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Göndermeden önce benzersiz Idempotency-Key ve tam gövdeyi kalıcı sakla. Yeniden denemeler tamamlanmış işlemi asla tekrarlamaz. Tekrarda gizli alanlar çıkarılır; gizli yanıt kaybolduysa oluşturulan kaynağı incele ve açıkça yenile/yeniden oluştur. 409 operator_request_in_progress, sonucu bilinmeyen kesintiye uğramış istek anlamına gelebilir: kaynağı/denetimi incele; körlemesine yeni anahtarla deneme.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETProjeyi Getir/v1/operator/merchants/{merchant_id}/projects/{project_id}Salt okunur

Belirtilen barındırılan satıcı kaynağını ayrı Operatör kimlik bilgisiyle yönet veya incele.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN

Yol parametreleri

merchant_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

project_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/operator/merchants/YOUR_MERCHANT_ID/projects/YOUR_PROJECT_ID" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "id": "33333333-3333-4333-8333-333333333333",
  "slug": "example-shop",
  "name": "Example shop",
  "enabled": false,
  "reporting_currency": "EUR",
  "reporting_timezone": "Europe/Berlin",
  "stores": []
}

Yanıt alanları

idstring
slugstring
namestring
enabledboolean
reporting_currencystring
reporting_timezonestring
stores[]array
Kullanım notları
  • projects.read gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTProjeyi Güncelle/v1/operator/merchants/{merchant_id}/projects/{project_id}Okuma ve yazma

Belirtilen barındırılan satıcı kaynağını ayrı Operatör kimlik bilgisiyle yönet veya incele.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN
Idempotency-Keyzorunlu16–128 harf, rakam, -, _ veya .; bu işlem için kalıcı saklanır

Yol parametreleri

merchant_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

project_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
# Keep this key and the exact body for retries; use a new key for each new operation.
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/operator/merchants/YOUR_MERCHANT_ID/projects/YOUR_PROJECT_ID" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Idempotency-Key: operator-request-1042' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "enabled": true
}'

İstek gövdesi

nameisteğe bağlı

Kısmi güncelleme. Tanımlayıcı ve satıcı sahipliği değiştirilemez.

enabledisteğe bağlı

Kısmi güncelleme. Tanımlayıcı ve satıcı sahipliği değiştirilemez.

reporting_currencyisteğe bağlı

Kısmi güncelleme. Tanımlayıcı ve satıcı sahipliği değiştirilemez.

reporting_timezoneisteğe bağlı

Kısmi güncelleme. Tanımlayıcı ve satıcı sahipliği değiştirilemez.

checkout_titleisteğe bağlı

Kısmi güncelleme. Tanımlayıcı ve satıcı sahipliği değiştirilemez.

checkout_descriptionisteğe bağlı

Kısmi güncelleme. Tanımlayıcı ve satıcı sahipliği değiştirilemez.

checkout_themeisteğe bağlı

Kısmi güncelleme. Tanımlayıcı ve satıcı sahipliği değiştirilemez.

checkout_accent_coloristeğe bağlı

Kısmi güncelleme. Tanımlayıcı ve satıcı sahipliği değiştirilemez.

Yanıt 200 application/json

Örnek yanıt
{
  "id": "33333333-3333-4333-8333-333333333333",
  "slug": "example-shop",
  "name": "Example shop",
  "enabled": false,
  "reporting_currency": "EUR",
  "reporting_timezone": "Europe/Berlin",
  "stores": []
}

Yanıt alanları

idstring
slugstring
namestring
enabledboolean
reporting_currencystring
reporting_timezonestring
stores[]array
Kullanım notları
  • projects.write gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Göndermeden önce benzersiz Idempotency-Key ve tam gövdeyi kalıcı sakla. Yeniden denemeler tamamlanmış işlemi asla tekrarlamaz. Tekrarda gizli alanlar çıkarılır; gizli yanıt kaybolduysa oluşturulan kaynağı incele ve açıkça yenile/yeniden oluştur. 409 operator_request_in_progress, sonucu bilinmeyen kesintiye uğramış istek anlamına gelebilir: kaynağı/denetimi incele; körlemesine yeni anahtarla deneme.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETMağazaları Listele/v1/operator/merchants/{merchant_id}/projects/{project_id}/storesSalt okunur

Belirtilen barındırılan satıcı kaynağını ayrı Operatör kimlik bilgisiyle yönet veya incele.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN

Yol parametreleri

merchant_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

project_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

Sorgu parametreleri

pageisteğe bağlı
Sayfa numarası 1'den başlar; sayfa başına 25 öğe. Satıcılar, kullanıcılar, projeler, mağazalar, cüzdanlar, kimlik bilgileri ve webhook'larda arama desteklenir; yerel olay listeleri kendi özel filtrelerini kullanır.Ayrıntılar

Sayfa numarası 1'den başlar; sayfa başına 25 öğe. Satıcılar, kullanıcılar, projeler, mağazalar, cüzdanlar, kimlik bilgileri ve webhook'larda arama desteklenir; yerel olay listeleri kendi özel filtrelerini kullanır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/operator/merchants/YOUR_MERCHANT_ID/projects/YOUR_PROJECT_ID/stores" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "data": [],
  "page": 1,
  "page_size": 25,
  "total": 0
}

Yanıt alanları

data[]array
pageinteger
page_sizeinteger
totalinteger
Kullanım notları
  • projects.read gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTMağaza Oluştur/v1/operator/merchants/{merchant_id}/projects/{project_id}/storesOkuma ve yazma

Belirtilen barındırılan satıcı kaynağını ayrı Operatör kimlik bilgisiyle yönet veya incele.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN
Idempotency-Keyzorunlu16–128 harf, rakam, -, _ veya .; bu işlem için kalıcı saklanır

Yol parametreleri

merchant_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

project_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
# Keep this key and the exact body for retries; use a new key for each new operation.
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/operator/merchants/YOUR_MERCHANT_ID/projects/YOUR_PROJECT_ID/stores" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Idempotency-Key: operator-request-1042' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "name": "Web checkout",
  "slug": "web-checkout",
  "default_currency": "EUR",
  "enabled": false
}'

İstek gövdesi

namestringszorunlu

Mağaza adı ve sabit tanımlayıcı.

slugstringszorunlu

Mağaza adı ve sabit tanımlayıcı.

default_currencyisteğe bağlı

Yüzdeler için ondalık sayı dizeleri kullan. Yeni mağazalar projenin varsayılan mağaza görünümünü devralır.

invoice_expiry_minutesisteğe bağlı

Yüzdeler için ondalık sayı dizeleri kullan. Yeni mağazalar projenin varsayılan mağaza görünümünü devralır.

exchange_rate_spread_percentisteğe bağlı

Yüzdeler için ondalık sayı dizeleri kullan. Yeni mağazalar projenin varsayılan mağaza görünümünü devralır.

underpayment_tolerance_percentisteğe bağlı

Yüzdeler için ondalık sayı dizeleri kullan. Yeni mağazalar projenin varsayılan mağaza görünümünü devralır.

enabledisteğe bağlı

Kabul edilen varlıkları payment-assets ile yapılandır; sıfır tutarlı faturalar varsayılan olarak kapalıdır.

is_defaultisteğe bağlı

Kabul edilen varlıkları payment-assets ile yapılandır; sıfır tutarlı faturalar varsayılan olarak kapalıdır.

allow_zero_amount_invoicesisteğe bağlı

Kabul edilen varlıkları payment-assets ile yapılandır; sıfır tutarlı faturalar varsayılan olarak kapalıdır.

allow_underpaymentsisteğe bağlı

Kabul edilen varlıkları payment-assets ile yapılandır; sıfır tutarlı faturalar varsayılan olarak kapalıdır.

allow_overpaymentsisteğe bağlı

Kabul edilen varlıkları payment-assets ile yapılandır; sıfır tutarlı faturalar varsayılan olarak kapalıdır.

allowed_chain_slugsisteğe bağlı

Kabul edilen varlıkları payment-assets ile yapılandır; sıfır tutarlı faturalar varsayılan olarak kapalıdır.

ipn_enabledisteğe bağlı

IPN ve dönüş URL'leri mevcut URL doğrulamasına uyar. Serbest HTML/JavaScript yoktur.

default_ipn_urlisteğe bağlı

IPN ve dönüş URL'leri mevcut URL doğrulamasına uyar. Serbest HTML/JavaScript yoktur.

default_redirect_urlisteğe bağlı

IPN ve dönüş URL'leri mevcut URL doğrulamasına uyar. Serbest HTML/JavaScript yoktur.

default_cancel_urlisteğe bağlı

IPN ve dönüş URL'leri mevcut URL doğrulamasına uyar. Serbest HTML/JavaScript yoktur.

redirect_automaticallyisteğe bağlı

IPN ve dönüş URL'leri mevcut URL doğrulamasına uyar. Serbest HTML/JavaScript yoktur.

checkout_languageisteğe bağlı

Desteklenen dil ve etkin rol alan adları kullan; gömme kökenlerini açıkça yapılandır.

embed_enabledisteğe bağlı

Desteklenen dil ve etkin rol alan adları kullan; gömme kökenlerini açıkça yapılandır.

allowed_embed_originsisteğe bağlı

Desteklenen dil ve etkin rol alan adları kullan; gömme kökenlerini açıkça yapılandır.

domainsisteğe bağlı

Desteklenen dil ve etkin rol alan adları kullan; gömme kökenlerini açıkça yapılandır.

Yanıt 201 or 200 application/json

Örnek yanıt
{
  "id": "44444444-4444-4444-8444-444444444444",
  "project_id": "33333333-3333-4333-8333-333333333333",
  "slug": "online",
  "name": "Online shop",
  "enabled": false,
  "default_currency": "EUR",
  "invoice_expiry_minutes": 60
}

Yanıt alanları

idstring
project_idstring
slugstring
namestring
enabledboolean
default_currencystring
invoice_expiry_minutesinteger
Kullanım notları
  • projects.write gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Göndermeden önce benzersiz Idempotency-Key ve tam gövdeyi kalıcı sakla. Yeniden denemeler tamamlanmış işlemi asla tekrarlamaz. Tekrarda gizli alanlar çıkarılır; gizli yanıt kaybolduysa oluşturulan kaynağı incele ve açıkça yenile/yeniden oluştur. 409 operator_request_in_progress, sonucu bilinmeyen kesintiye uğramış istek anlamına gelebilir: kaynağı/denetimi incele; körlemesine yeni anahtarla deneme.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETMağazayı Getir/v1/operator/merchants/{merchant_id}/projects/{project_id}/stores/{store_id}Salt okunur

Belirtilen barındırılan satıcı kaynağını ayrı Operatör kimlik bilgisiyle yönet veya incele.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN

Yol parametreleri

merchant_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

project_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

store_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/operator/merchants/YOUR_MERCHANT_ID/projects/YOUR_PROJECT_ID/stores/YOUR_STORE_ID" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "id": "44444444-4444-4444-8444-444444444444",
  "project_id": "33333333-3333-4333-8333-333333333333",
  "slug": "online",
  "name": "Online shop",
  "enabled": false,
  "default_currency": "EUR",
  "invoice_expiry_minutes": 60
}

Yanıt alanları

idstring
project_idstring
slugstring
namestring
enabledboolean
default_currencystring
invoice_expiry_minutesinteger
Kullanım notları
  • projects.read gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTMağazayı Güncelle/v1/operator/merchants/{merchant_id}/projects/{project_id}/stores/{store_id}Okuma ve yazma

Belirtilen barındırılan satıcı kaynağını ayrı Operatör kimlik bilgisiyle yönet veya incele.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN
Idempotency-Keyzorunlu16–128 harf, rakam, -, _ veya .; bu işlem için kalıcı saklanır

Yol parametreleri

merchant_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

project_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

store_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
# Keep this key and the exact body for retries; use a new key for each new operation.
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/operator/merchants/YOUR_MERCHANT_ID/projects/YOUR_PROJECT_ID/stores/YOUR_STORE_ID" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Idempotency-Key: operator-request-1042' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "enabled": true
}'

İstek gövdesi

store fieldsisteğe bağlı

slug dışında mağaza oluşturmayla aynı değiştirilebilir ayarlar. Yalnızca gönderilen alanlar değişir.

enabledboolean

Yanıt 200 application/json

Örnek yanıt
{
  "id": "44444444-4444-4444-8444-444444444444",
  "project_id": "33333333-3333-4333-8333-333333333333",
  "slug": "online",
  "name": "Online shop",
  "enabled": false,
  "default_currency": "EUR",
  "invoice_expiry_minutes": 60
}

Yanıt alanları

idstring
project_idstring
slugstring
namestring
enabledboolean
default_currencystring
invoice_expiry_minutesinteger
Kullanım notları
  • projects.write gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Göndermeden önce benzersiz Idempotency-Key ve tam gövdeyi kalıcı sakla. Yeniden denemeler tamamlanmış işlemi asla tekrarlamaz. Tekrarda gizli alanlar çıkarılır; gizli yanıt kaybolduysa oluşturulan kaynağı incele ve açıkça yenile/yeniden oluştur. 409 operator_request_in_progress, sonucu bilinmeyen kesintiye uğramış istek anlamına gelebilir: kaynağı/denetimi incele; körlemesine yeni anahtarla deneme.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETMağaza Görünümünü Getir/v1/operator/merchants/{merchant_id}/projects/{project_id}/stores/{store_id}/checkout-appearanceSalt okunur

Belirtilen barındırılan satıcı kaynağını ayrı Operatör kimlik bilgisiyle yönet veya incele.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN

Yol parametreleri

merchant_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

project_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

store_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/operator/merchants/YOUR_MERCHANT_ID/projects/YOUR_PROJECT_ID/stores/YOUR_STORE_ID/checkout-appearance" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "revision": 1,
  "settings": {
    "inherit_default_store": true
  },
  "effective": {
    "title": "Pay securely"
  }
}

Yanıt alanları

revisioninteger
settingsobject
inherit_default_storeboolean
effectiveobject
titlestring
Kullanım notları
  • projects.read gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTMağaza Görünümünü Güncelle/v1/operator/merchants/{merchant_id}/projects/{project_id}/stores/{store_id}/checkout-appearanceOkuma ve yazma

Doğrulanmış, revizyon korumalı mağaza tasarımını kaydet.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN
Idempotency-Keyzorunlu16–128 harf, rakam, -, _ veya .; bu işlem için kalıcı saklanır

Yol parametreleri

merchant_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

project_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

store_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
# Keep this key and the exact body for retries; use a new key for each new operation.
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/operator/merchants/YOUR_MERCHANT_ID/projects/YOUR_PROJECT_ID/stores/YOUR_STORE_ID/checkout-appearance" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Idempotency-Key: operator-request-1042' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "revision": 1,
  "settings": {
    "inherit_default_store": false,
    "title": "Pay securely",
    "theme": "light"
  }
}'

İstek gövdesi

revisionintegerzorunlu

Önce GET ile güncel revizyonu oku. Eski revizyon, başka düzenleyenin çalışmasının üzerine yazmadan başarısız olur.

settingsobjectzorunlu
inherit_default_store, markalama, giriş/çıkış metinleri, yazı boyutları ve görünürlük dahil doğrulanmış ödeme sayfası görünümü. Serbest HTML/JavaScript yoktur. Görsel baytlarını yüklemek yalnızca konsoldan mümkündür.Ayrıntılar

inherit_default_store, markalama, giriş/çıkış metinleri, yazı boyutları ve görünürlük dahil doğrulanmış ödeme sayfası görünümü. Serbest HTML/JavaScript yoktur. Görsel baytlarını yüklemek yalnızca konsoldan mümkündür.

inherit_default_storeboolean
titlestring
themestring

Yanıt 200 application/json

Örnek yanıt
{
  "settings": {
    "inherit_default_store": false,
    "title": "Pay securely",
    "theme": "light"
  },
  "revision": 2
}

Yanıt alanları

settingsobject
inherit_default_storeboolean
titlestring
themestring
revisioninteger
Kullanım notları
  • projects.write gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Göndermeden önce benzersiz Idempotency-Key ve tam gövdeyi kalıcı sakla. Yeniden denemeler tamamlanmış işlemi asla tekrarlamaz. Tekrarda gizli alanlar çıkarılır; gizli yanıt kaybolduysa oluşturulan kaynağı incele ve açıkça yenile/yeniden oluştur. 409 operator_request_in_progress, sonucu bilinmeyen kesintiye uğramış istek anlamına gelebilir: kaynağı/denetimi incele; körlemesine yeni anahtarla deneme.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETMağaza Ödeme Varlıklarını Listele/v1/operator/merchants/{merchant_id}/projects/{project_id}/stores/{store_id}/payment-assetsSalt okunur

Belirtilen barındırılan satıcı kaynağını ayrı Operatör kimlik bilgisiyle yönet veya incele.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN

Yol parametreleri

merchant_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

project_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

store_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/operator/merchants/YOUR_MERCHANT_ID/projects/YOUR_PROJECT_ID/stores/YOUR_STORE_ID/payment-assets" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "data": []
}

Yanıt alanları

data[]array
Kullanım notları
  • projects.read gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTMağaza Ödeme Varlıklarını Güncelle/v1/operator/merchants/{merchant_id}/projects/{project_id}/stores/{store_id}/payment-assetsOkuma ve yazma

Belirtilen barındırılan satıcı kaynağını ayrı Operatör kimlik bilgisiyle yönet veya incele.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN
Idempotency-Keyzorunlu16–128 harf, rakam, -, _ veya .; bu işlem için kalıcı saklanır

Yol parametreleri

merchant_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

project_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

store_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
# Keep this key and the exact body for retries; use a new key for each new operation.
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/operator/merchants/YOUR_MERCHANT_ID/projects/YOUR_PROJECT_ID/stores/YOUR_STORE_ID/payment-assets" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Idempotency-Key: operator-request-1042' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "assets": [
    {
      "asset_id": "11111111-1111-4111-8111-111111111111",
      "display_order": 0
    }
  ]
}'

İstek gövdesi

assets[]object[]zorunlu
Zincir üstü yöntemleri tamamen değiştirir: asset_id UUID ve display_order. [] kabul edilen zincir üstü varlıkları temizler. Yalnızca doğrulanmış proje varlıkları; Lightning'i yapılandırmaz.Ayrıntılar

Zincir üstü yöntemleri tamamen değiştirir: asset_id UUID ve display_order. [] kabul edilen zincir üstü varlıkları temizler. Yalnızca doğrulanmış proje varlıkları; Lightning'i yapılandırmaz.

asset_idstring
display_orderinteger

Yanıt 200 application/json

Örnek yanıt
{
  "data": []
}

Yanıt alanları

data[]array
Kullanım notları
  • projects.write gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Göndermeden önce benzersiz Idempotency-Key ve tam gövdeyi kalıcı sakla. Yeniden denemeler tamamlanmış işlemi asla tekrarlamaz. Tekrarda gizli alanlar çıkarılır; gizli yanıt kaybolduysa oluşturulan kaynağı incele ve açıkça yenile/yeniden oluştur. 409 operator_request_in_progress, sonucu bilinmeyen kesintiye uğramış istek anlamına gelebilir: kaynağı/denetimi incele; körlemesine yeni anahtarla deneme.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETMağaza Webhook'larını Listele/v1/operator/merchants/{merchant_id}/projects/{project_id}/stores/{store_id}/webhooksSalt okunur

Belirtilen barındırılan satıcı kaynağını ayrı Operatör kimlik bilgisiyle yönet veya incele.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN

Yol parametreleri

merchant_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

project_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

store_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

Sorgu parametreleri

pageisteğe bağlı
Sayfa numarası 1'den başlar; sayfa başına 25 öğe. Satıcılar, kullanıcılar, projeler, mağazalar, cüzdanlar, kimlik bilgileri ve webhook'larda arama desteklenir; yerel olay listeleri kendi özel filtrelerini kullanır.Ayrıntılar

Sayfa numarası 1'den başlar; sayfa başına 25 öğe. Satıcılar, kullanıcılar, projeler, mağazalar, cüzdanlar, kimlik bilgileri ve webhook'larda arama desteklenir; yerel olay listeleri kendi özel filtrelerini kullanır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/operator/merchants/YOUR_MERCHANT_ID/projects/YOUR_PROJECT_ID/stores/YOUR_STORE_ID/webhooks" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "data": [],
  "page": 1,
  "page_size": 25,
  "total": 0
}

Yanıt alanları

data[]array
pageinteger
page_sizeinteger
totalinteger
Kullanım notları
  • projects.read gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTMağaza Webhook'u Oluştur/v1/operator/merchants/{merchant_id}/projects/{project_id}/stores/{store_id}/webhooksOkuma ve yazma

Belirtilen barındırılan satıcı kaynağını ayrı Operatör kimlik bilgisiyle yönet veya incele.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN
Idempotency-Keyzorunlu16–128 harf, rakam, -, _ veya .; bu işlem için kalıcı saklanır

Yol parametreleri

merchant_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

project_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

store_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
# Keep this key and the exact body for retries; use a new key for each new operation.
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/operator/merchants/YOUR_MERCHANT_ID/projects/YOUR_PROJECT_ID/stores/YOUR_STORE_ID/webhooks" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Idempotency-Key: operator-request-1042' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "name": "Orders",
  "url": "https://shop.example.test/payments",
  "event_types": [
    "invoice.settled"
  ],
  "enabled": true,
  "automatic_redelivery": true
}'

İstek gövdesi

namestrings / arrayzorunlu

Herkese açık HTTPS alıcısı ve IPN/webhook belgelerindeki fatura olay adları.

urlstrings / arrayzorunlu

Herkese açık HTTPS alıcısı ve IPN/webhook belgelerindeki fatura olay adları.

event_types[]strings / arrayzorunlu

Herkese açık HTTPS alıcısı ve IPN/webhook belgelerindeki fatura olay adları.

enabledbooleansisteğe bağlı

Oluşturma imzalama sırrını bir kez döndürür. Bunlar Operatör yaşam döngüsü olayları değil, mağaza ödeme geri çağrılarıdır.

automatic_redeliverybooleansisteğe bağlı

Oluşturma imzalama sırrını bir kez döndürür. Bunlar Operatör yaşam döngüsü olayları değil, mağaza ödeme geri çağrılarıdır.

Yanıt 201 or 200 application/json

Örnek yanıt
{
  "signing_secret": "EXAMPLE_ONLY_SAVE_ONCE",
  "endpoint": {
    "id": "44444444-4444-4444-8444-444444444444",
    "name": "Orders",
    "enabled": true
  },
  "secret_visible_once": true
}

Yanıt alanları

signing_secretstring
endpointobject
idstring
namestring
enabledboolean
secret_visible_onceboolean
Kullanım notları
  • projects.write gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Göndermeden önce benzersiz Idempotency-Key ve tam gövdeyi kalıcı sakla. Yeniden denemeler tamamlanmış işlemi asla tekrarlamaz. Tekrarda gizli alanlar çıkarılır; gizli yanıt kaybolduysa oluşturulan kaynağı incele ve açıkça yenile/yeniden oluştur. 409 operator_request_in_progress, sonucu bilinmeyen kesintiye uğramış istek anlamına gelebilir: kaynağı/denetimi incele; körlemesine yeni anahtarla deneme.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTMağaza Webhook'unu Güncelle/v1/operator/merchants/{merchant_id}/projects/{project_id}/stores/{store_id}/webhooks/{webhook_id}Okuma ve yazma

Belirtilen barındırılan satıcı kaynağını ayrı Operatör kimlik bilgisiyle yönet veya incele.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN
Idempotency-Keyzorunlu16–128 harf, rakam, -, _ veya .; bu işlem için kalıcı saklanır

Yol parametreleri

merchant_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

project_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

store_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

webhook_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
# Keep this key and the exact body for retries; use a new key for each new operation.
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/operator/merchants/YOUR_MERCHANT_ID/projects/YOUR_PROJECT_ID/stores/YOUR_STORE_ID/webhooks/YOUR_WEBHOOK_ID" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Idempotency-Key: operator-request-1042' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "name": "Orders",
  "url": "https://shop.example.test/payments",
  "event_types": [
    "invoice.settled"
  ],
  "enabled": false,
  "automatic_redelivery": true
}'

İstek gövdesi

namestrings / arrayzorunlu

Herkese açık HTTPS alıcısı ve IPN/webhook belgelerindeki fatura olay adları.

urlstrings / arrayzorunlu

Herkese açık HTTPS alıcısı ve IPN/webhook belgelerindeki fatura olay adları.

event_types[]strings / arrayzorunlu

Herkese açık HTTPS alıcısı ve IPN/webhook belgelerindeki fatura olay adları.

enabledbooleansisteğe bağlı

Oluşturma imzalama sırrını bir kez döndürür. Bunlar Operatör yaşam döngüsü olayları değil, mağaza ödeme geri çağrılarıdır.

automatic_redeliverybooleansisteğe bağlı

Oluşturma imzalama sırrını bir kez döndürür. Bunlar Operatör yaşam döngüsü olayları değil, mağaza ödeme geri çağrılarıdır.

Yanıt 200 application/json

Örnek yanıt
{
  "id": "44444444-4444-4444-8444-444444444444",
  "name": "Orders",
  "enabled": true
}

Yanıt alanları

idstring
namestring
enabledboolean
Kullanım notları
  • projects.write gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Göndermeden önce benzersiz Idempotency-Key ve tam gövdeyi kalıcı sakla. Yeniden denemeler tamamlanmış işlemi asla tekrarlamaz. Tekrarda gizli alanlar çıkarılır; gizli yanıt kaybolduysa oluşturulan kaynağı incele ve açıkça yenile/yeniden oluştur. 409 operator_request_in_progress, sonucu bilinmeyen kesintiye uğramış istek anlamına gelebilir: kaynağı/denetimi incele; körlemesine yeni anahtarla deneme.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETFaturaları Listele/v1/operator/merchants/{merchant_id}/projects/{project_id}/invoicesSalt okunur

Belirtilen barındırılan satıcı kaynağını ayrı Operatör kimlik bilgisiyle yönet veya incele.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN

Yol parametreleri

merchant_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

project_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

Sorgu parametreleri

limitisteğe bağlı

Proje fatura listesiyle aynı fatura sayfalaması ve filtreleri.

offsetisteğe bağlı

Proje fatura listesiyle aynı fatura sayfalaması ve filtreleri.

statusisteğe bağlı

Proje fatura listesiyle aynı fatura sayfalaması ve filtreleri.

store_idisteğe bağlı

Proje fatura listesiyle aynı fatura sayfalaması ve filtreleri.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/operator/merchants/YOUR_MERCHANT_ID/projects/YOUR_PROJECT_ID/invoices" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "data": [],
  "pagination": {
    "limit": 25,
    "offset": 0,
    "total": 0,
    "has_more": false
  }
}

Yanıt alanları

data[]array
paginationobject
limitinteger
offsetinteger
totalinteger
has_moreboolean
Kullanım notları
  • reports.read gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETFaturayı Getir/v1/operator/merchants/{merchant_id}/projects/{project_id}/invoices/{invoice_id}Salt okunur

Belirtilen barındırılan satıcı kaynağını ayrı Operatör kimlik bilgisiyle yönet veya incele.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN

Yol parametreleri

merchant_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

project_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

invoice_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/operator/merchants/YOUR_MERCHANT_ID/projects/YOUR_PROJECT_ID/invoices/YOUR_INVOICE_ID" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "invoice_id": "44444444-4444-4444-8444-444444444444",
  "project_id": "33333333-3333-4333-8333-333333333333",
  "amount": "25",
  "currency": "EUR",
  "status": "new",
  "metadata": {},
  "payment_intents": []
}

Yanıt alanları

invoice_idstring
project_idstring
amountstring
currencystring
statusstring
metadataobject
payment_intents[]array
Kullanım notları
  • reports.read gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.
  • invoice_id, dahili id değil, oluşturulurken ve geri çağrılarda döndürülen herkese açık fatura kimliğidir.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETCüzdanları Listele/v1/operator/merchants/{merchant_id}/projects/{project_id}/walletsSalt okunur

Önbellekteki herkese açık cüzdan bakiyelerini oku; özel anahtar veya kurtarma ifadelerini asla değil.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN

Yol parametreleri

merchant_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

project_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

Sorgu parametreleri

pageisteğe bağlı
Sayfa numarası 1'den başlar; sayfa başına 25 öğe. Satıcılar, kullanıcılar, projeler, mağazalar, cüzdanlar, kimlik bilgileri ve webhook'larda arama desteklenir; yerel olay listeleri kendi özel filtrelerini kullanır.Ayrıntılar

Sayfa numarası 1'den başlar; sayfa başına 25 öğe. Satıcılar, kullanıcılar, projeler, mağazalar, cüzdanlar, kimlik bilgileri ve webhook'larda arama desteklenir; yerel olay listeleri kendi özel filtrelerini kullanır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/operator/merchants/YOUR_MERCHANT_ID/projects/YOUR_PROJECT_ID/wallets" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "data": [],
  "page": 1,
  "page_size": 25,
  "total": 0
}

Yanıt alanları

data[]array
pageinteger
page_sizeinteger
totalinteger
Kullanım notları
  • reports.read gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Bakiyeler güncellik alanları içeren önbellek gözlemleridir; harcanabilir bakiye garantisi değildir. Gönderim ve anahtar dışa aktarma bu API'de sunulmaz.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETCüzdan Adreslerini Listele/v1/operator/merchants/{merchant_id}/projects/{project_id}/wallets/{wallet_id}/addressesSalt okunur

Belirtilen barındırılan satıcı kaynağını ayrı Operatör kimlik bilgisiyle yönet veya incele.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN

Yol parametreleri

merchant_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

project_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

wallet_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

Sorgu parametreleri

limitisteğe bağlı
Limit 1–50, varsayılan 25. Sonraki sayfa için next_cursor değerini before olarak gönder. İlk sayfada before kullanma. has_balance=false ve hide_small_balances=false boş/küçük bakiyeleri dahil eder.Ayrıntılar

Limit 1–50, varsayılan 25. Sonraki sayfa için next_cursor değerini before olarak gönder. İlk sayfada before kullanma. has_balance=false ve hide_small_balances=false boş/küçük bakiyeleri dahil eder.

beforeisteğe bağlı
Limit 1–50, varsayılan 25. Sonraki sayfa için next_cursor değerini before olarak gönder. İlk sayfada before kullanma. has_balance=false ve hide_small_balances=false boş/küçük bakiyeleri dahil eder.Ayrıntılar

Limit 1–50, varsayılan 25. Sonraki sayfa için next_cursor değerini before olarak gönder. İlk sayfada before kullanma. has_balance=false ve hide_small_balances=false boş/küçük bakiyeleri dahil eder.

has_balanceisteğe bağlı
Limit 1–50, varsayılan 25. Sonraki sayfa için next_cursor değerini before olarak gönder. İlk sayfada before kullanma. has_balance=false ve hide_small_balances=false boş/küçük bakiyeleri dahil eder.Ayrıntılar

Limit 1–50, varsayılan 25. Sonraki sayfa için next_cursor değerini before olarak gönder. İlk sayfada before kullanma. has_balance=false ve hide_small_balances=false boş/küçük bakiyeleri dahil eder.

hide_small_balancesisteğe bağlı
Limit 1–50, varsayılan 25. Sonraki sayfa için next_cursor değerini before olarak gönder. İlk sayfada before kullanma. has_balance=false ve hide_small_balances=false boş/küçük bakiyeleri dahil eder.Ayrıntılar

Limit 1–50, varsayılan 25. Sonraki sayfa için next_cursor değerini before olarak gönder. İlk sayfada before kullanma. has_balance=false ve hide_small_balances=false boş/küçük bakiyeleri dahil eder.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/operator/merchants/YOUR_MERCHANT_ID/projects/YOUR_PROJECT_ID/wallets/YOUR_WALLET_ID/addresses" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "wallet": {
    "id": "22222222-2222-4222-8222-222222222222",
    "chain_slug": "ethereum"
  },
  "items": [],
  "total": 0,
  "total_pages": 1,
  "next_cursor": null,
  "reporting_currency": "EUR",
  "has_balance": true,
  "hide_small_balances": true,
  "small_balance_threshold": {
    "amount": "0.20",
    "currency": "EUR"
  }
}

Yanıt alanları

walletobject
idstring
chain_slugstring
items[]array
totalinteger
total_pagesinteger
next_cursorJSON | null
reporting_currencystring
has_balanceboolean
hide_small_balancesboolean
small_balance_thresholdobject
amountstring
currencystring
Kullanım notları
  • reports.read gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETSatıcı Kimlik Bilgilerini Listele/v1/operator/merchants/{merchant_id}/api-credentialsSalt okunur

Belirtilen barındırılan satıcı kaynağını ayrı Operatör kimlik bilgisiyle yönet veya incele.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN

Yol parametreleri

merchant_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

Sorgu parametreleri

pageisteğe bağlı
Sayfa numarası 1'den başlar; sayfa başına 25 öğe. Satıcılar, kullanıcılar, projeler, mağazalar, cüzdanlar, kimlik bilgileri ve webhook'larda arama desteklenir; yerel olay listeleri kendi özel filtrelerini kullanır.Ayrıntılar

Sayfa numarası 1'den başlar; sayfa başına 25 öğe. Satıcılar, kullanıcılar, projeler, mağazalar, cüzdanlar, kimlik bilgileri ve webhook'larda arama desteklenir; yerel olay listeleri kendi özel filtrelerini kullanır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/operator/merchants/YOUR_MERCHANT_ID/api-credentials" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "data": [],
  "page": 1,
  "page_size": 25,
  "total": 0
}

Yanıt alanları

data[]array
pageinteger
page_sizeinteger
totalinteger
Kullanım notları
  • merchant_credentials.read gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTSatıcı Kimlik Bilgisi Oluştur/v1/operator/merchants/{merchant_id}/api-credentialsOkuma ve yazma

Belirtilen barındırılan satıcı kaynağını ayrı Operatör kimlik bilgisiyle yönet veya incele.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN
Idempotency-Keyzorunlu16–128 harf, rakam, -, _ veya .; bu işlem için kalıcı saklanır

Yol parametreleri

merchant_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
# Keep this key and the exact body for retries; use a new key for each new operation.
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/operator/merchants/YOUR_MERCHANT_ID/api-credentials" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Idempotency-Key: operator-request-1042' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "name": "Store integration",
  "access_level": "read_only",
  "enabled": true,
  "ip_restriction_enabled": false,
  "allowed_ips": [],
  "project_ids": [
    "11111111-1111-4111-8111-111111111111"
  ]
}'

İstek gövdesi

namestringzorunlu

Operatör anahtarı değil, yeni normal satıcı anahtarı için etiket.

access_levelread_only | read_writeisteğe bağlı

Okuma/yazma, mevcut satıcı API sözleşmesini etkinleştirir.

project_ids[]UUID[]

Yalnızca seçili satıcıya ait projeler; boş liste mevcut tüm satıcı projeleri politikasına uyar.

enabledisteğe bağlı

Mevcut satıcı anahtarı kontrolleri. Sır yalnızca bir kez döndürülür; merchant_credentials.write gerektirir.

ip_restriction_enabledisteğe bağlı

Mevcut satıcı anahtarı kontrolleri. Sır yalnızca bir kez döndürülür; merchant_credentials.write gerektirir.

allowed_ips[]isteğe bağlı

Mevcut satıcı anahtarı kontrolleri. Sır yalnızca bir kez döndürülür; merchant_credentials.write gerektirir.

requests_per_minuteisteğe bağlı

Mevcut satıcı anahtarı kontrolleri. Sır yalnızca bir kez döndürülür; merchant_credentials.write gerektirir.

Yanıt 201 or 200 application/json

Örnek yanıt
{
  "credential": {
    "id": "22222222-2222-4222-8222-222222222222",
    "name": "Checkout",
    "access_level": "read_only",
    "project_ids": [
      "33333333-3333-4333-8333-333333333333"
    ],
    "enabled": true
  },
  "token": "wc_live_EXAMPLE_ONLY_SAVE_ONCE"
}

Yanıt alanları

credentialobject
idstring
namestring
access_levelstring
project_ids[]array
enabledboolean
tokenstring
Kullanım notları
  • merchant_credentials.write gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Göndermeden önce benzersiz Idempotency-Key ve tam gövdeyi kalıcı sakla. Yeniden denemeler tamamlanmış işlemi asla tekrarlamaz. Tekrarda gizli alanlar çıkarılır; gizli yanıt kaybolduysa oluşturulan kaynağı incele ve açıkça yenile/yeniden oluştur. 409 operator_request_in_progress, sonucu bilinmeyen kesintiye uğramış istek anlamına gelebilir: kaynağı/denetimi incele; körlemesine yeni anahtarla deneme.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTSatıcı Kimlik Bilgisini Güncelle/v1/operator/merchants/{merchant_id}/api-credentials/{credential_id}Okuma ve yazma

Belirtilen barındırılan satıcı kaynağını ayrı Operatör kimlik bilgisiyle yönet veya incele.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN
Idempotency-Keyzorunlu16–128 harf, rakam, -, _ veya .; bu işlem için kalıcı saklanır

Yol parametreleri

merchant_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

credential_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
# Keep this key and the exact body for retries; use a new key for each new operation.
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/operator/merchants/YOUR_MERCHANT_ID/api-credentials/YOUR_CREDENTIAL_ID" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Idempotency-Key: operator-request-1042' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "name": "Checkout",
  "access_level": "read_only",
  "enabled": true,
  "ip_restriction_enabled": false,
  "allowed_ips": [],
  "project_ids": [
    "33333333-3333-4333-8333-333333333333"
  ]
}'

İstek gövdesi

namefieldszorunlu

Değişikliklerle birlikte güncel kimlik bilgisi yapılandırmasının tamamını gönder. project_ids varsayılanı []; requests_per_minute varsayılanı satıcı API kotasıdır.

access_levelfieldszorunlu

Değişikliklerle birlikte güncel kimlik bilgisi yapılandırmasının tamamını gönder. project_ids varsayılanı []; requests_per_minute varsayılanı satıcı API kotasıdır.

enabledfieldszorunlu

Değişikliklerle birlikte güncel kimlik bilgisi yapılandırmasının tamamını gönder. project_ids varsayılanı []; requests_per_minute varsayılanı satıcı API kotasıdır.

ip_restriction_enabledfieldszorunlu

Değişikliklerle birlikte güncel kimlik bilgisi yapılandırmasının tamamını gönder. project_ids varsayılanı []; requests_per_minute varsayılanı satıcı API kotasıdır.

allowed_ips[]fieldszorunlu

Değişikliklerle birlikte güncel kimlik bilgisi yapılandırmasının tamamını gönder. project_ids varsayılanı []; requests_per_minute varsayılanı satıcı API kotasıdır.

project_ids[]array

Yanıt 200 application/json

Örnek yanıt
{
  "id": "22222222-2222-4222-8222-222222222222",
  "name": "Checkout",
  "access_level": "read_only",
  "project_ids": [
    "33333333-3333-4333-8333-333333333333"
  ],
  "enabled": true
}

Yanıt alanları

idstring
namestring
access_levelstring
project_ids[]array
enabledboolean
Kullanım notları
  • merchant_credentials.write gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Göndermeden önce benzersiz Idempotency-Key ve tam gövdeyi kalıcı sakla. Yeniden denemeler tamamlanmış işlemi asla tekrarlamaz. Tekrarda gizli alanlar çıkarılır; gizli yanıt kaybolduysa oluşturulan kaynağı incele ve açıkça yenile/yeniden oluştur. 409 operator_request_in_progress, sonucu bilinmeyen kesintiye uğramış istek anlamına gelebilir: kaynağı/denetimi incele; körlemesine yeni anahtarla deneme.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTSatıcı Kimlik Bilgisini Yenile/v1/operator/merchants/{merchant_id}/api-credentials/{credential_id}/rotateOkuma ve yazma

Belirtilen barındırılan satıcı kaynağını ayrı Operatör kimlik bilgisiyle yönet veya incele.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN
Idempotency-Keyzorunlu16–128 harf, rakam, -, _ veya .; bu işlem için kalıcı saklanır

Yol parametreleri

merchant_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

credential_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
# Keep this key and the exact body for retries; use a new key for each new operation.
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/operator/merchants/YOUR_MERCHANT_ID/api-credentials/YOUR_CREDENTIAL_ID/rotate" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Idempotency-Key: operator-request-1042' \
  --header 'Content-Type: application/json' \
  --data-raw '{}'

Yanıt 200 application/json

Örnek yanıt
{
  "credential": {
    "id": "22222222-2222-4222-8222-222222222222",
    "name": "Checkout",
    "access_level": "read_only",
    "project_ids": [
      "33333333-3333-4333-8333-333333333333"
    ],
    "enabled": true
  },
  "token": "wc_live_EXAMPLE_ONLY_SAVE_ONCE"
}

Yanıt alanları

credentialobject
idstring
namestring
access_levelstring
project_ids[]array
enabledboolean
tokenstring
Kullanım notları
  • merchant_credentials.write gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Göndermeden önce benzersiz Idempotency-Key ve tam gövdeyi kalıcı sakla. Yeniden denemeler tamamlanmış işlemi asla tekrarlamaz. Tekrarda gizli alanlar çıkarılır; gizli yanıt kaybolduysa oluşturulan kaynağı incele ve açıkça yenile/yeniden oluştur. 409 operator_request_in_progress, sonucu bilinmeyen kesintiye uğramış istek anlamına gelebilir: kaynağı/denetimi incele; körlemesine yeni anahtarla deneme.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTSatıcı Kimlik Bilgisini İptal Et/v1/operator/merchants/{merchant_id}/api-credentials/{credential_id}/revokeOkuma ve yazma

Belirtilen barındırılan satıcı kaynağını ayrı Operatör kimlik bilgisiyle yönet veya incele.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_OPERATOR_API_TOKEN
Idempotency-Keyzorunlu16–128 harf, rakam, -, _ veya .; bu işlem için kalıcı saklanır

Yol parametreleri

merchant_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

credential_idUUIDzorunlu

Kanonik küçük harfli kaynak UUID'si; kimlik bilgisinin satıcı kapsamına ait olmalıdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
# Keep this key and the exact body for retries; use a new key for each new operation.
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/operator/merchants/YOUR_MERCHANT_ID/api-credentials/YOUR_CREDENTIAL_ID/revoke" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Idempotency-Key: operator-request-1042' \
  --header 'Content-Type: application/json' \
  --data-raw '{}'

Yanıt 200 application/json

Örnek yanıt
{
  "revoked": true
}

Yanıt alanları

revokedboolean
Kullanım notları
  • merchant_credentials.write gerektirir; yalnızca izin verilen barındırılan satıcılar. Operatör anahtarları sahibin kendi işletme çalışma alanına erişemez.
  • Göndermeden önce benzersiz Idempotency-Key ve tam gövdeyi kalıcı sakla. Yeniden denemeler tamamlanmış işlemi asla tekrarlamaz. Tekrarda gizli alanlar çıkarılır; gizli yanıt kaybolduysa oluşturulan kaynağı incele ve açıkça yenile/yeniden oluştur. 409 operator_request_in_progress, sonucu bilinmeyen kesintiye uğramış istek anlamına gelebilir: kaynağı/denetimi incele; körlemesine yeni anahtarla deneme.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTDavet token'ını kontrol et/v1/onboarding/invitations/checkHerkese açık

Yalnızca token ile katılım. Operatör anahtarı kabul etmez veya otomatik giriş yapmaz. Konsol girişi yine sitenin Basic Auth ve mevcut TOTP korumalarını gerektirir.

Kimlik doğrulama ve üst bilgiler

Herkese açık

İstek

curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/onboarding/invitations/check" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "token": "YOUR_PRIVATE_INVITATION_TOKEN"
}'

İstek gövdesi

tokenstringzorunlu

Davet URL'sinin fragment bölümündeki sır. Asla günlüğe yazma.

Yanıt 200 application/json

Örnek yanıt
{
  "kind": "invitation",
  "email": "admin@example.test",
  "merchant_name": "Example shop"
}

Yanıt alanları

kindstring
emailstring
merchant_namestring
Kullanım notları
  • 48 saatlik davet; bir saatlik parola sıfırlama bağlantısı. Tek kullanımlık hash'lenmiş token'lar. Yeniden düzenleme eski bağlantıyı iptal eder. Kabul, TOTP'yi korur ve eski oturumları iptal eder.
  • Otomatik yeniden deneme yok. Kabul zaman aşımına uğrarsa bağlantı durumunu kontrol et ve giriş yapmayı dene; başarısız olduğunu varsayma. Gözlenen kaynak IP'ye göre istek sınırı uygulanır. Alıcı saklama onayını kendisi vermelidir.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTDaveti veya parola sıfırlamasını kabul et/v1/onboarding/invitations/acceptHerkese açık

Yalnızca token ile katılım. Operatör anahtarı kabul etmez veya otomatik giriş yapmaz. Konsol girişi yine sitenin Basic Auth ve mevcut TOTP korumalarını gerektirir.

Kimlik doğrulama ve üst bilgiler

Herkese açık

İstek

curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/onboarding/invitations/accept" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "token": "YOUR_PRIVATE_INVITATION_TOKEN",
  "password": "REPLACE_WITH_YOUR_OWN_UNIQUE_PASSWORD",
  "custody_acknowledged": true
}'

İstek gövdesi

tokenstringzorunlu

Davet URL'sinin fragment bölümündeki sır. Asla günlüğe yazma.

passwordstringzorunlu

Yeni parola; 12–128 karakter (en fazla 512 UTF-8 baytı).

custody_acknowledgedboolean

Yeni barındırılan cüzdan davetini kabul ederken true olmalıdır.

Yanıt 200 application/json

Örnek yanıt
{
  "password_set": true
}

Yanıt alanları

password_setboolean
Kullanım notları
  • 48 saatlik davet; bir saatlik parola sıfırlama bağlantısı. Tek kullanımlık hash'lenmiş token'lar. Yeniden düzenleme eski bağlantıyı iptal eder. Kabul, TOTP'yi korur ve eski oturumları iptal eder.
  • Otomatik yeniden deneme yok. Kabul zaman aşımına uğrarsa bağlantı durumunu kontrol et ve giriş yapmayı dene; başarısız olduğunu varsayma. Gözlenen kaynak IP'ye göre istek sınırı uygulanır. Alıcı saklama onayını kendisi vermelidir.
  • Yanıt örnekleri seçili alanları gösterir. Ek yanıt alanlarını mevcut yapıya eklenen alanlar olarak ele al.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETYetenekler/v1/marketplace/capabilitiesSalt okunur

Katılan mağazalar, yapılandırılmış varlıklar, desteklenen satıcı ödeme altyapıları, yerel ücret varlığı ve hazırlık nedenleri. Geçici tarayıcı kullanılabilirliği izin verilen varlık kümesini genişletmez.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MARKETPLACE_API_TOKEN
ParametreTür / konumKural
permissioncredential scopemarketplace.read

Sorgu parametreleri

project_idUUIDzorunlu

Yetkili proje. Öğe URL'leri dahil her istekte zorunludur.

pageisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

per_pageisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

qisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

statusisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

store_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

vendor_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

asset_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

fromisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

toisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/marketplace/capabilities?project_id=YOUR_PROJECT_ID" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "data": {}
}

Yanıt alanları

dataobject
Kullanım notları
  • marketplace.read gerektirir. Yanıt örnekleri seçili alanları gösterir; saklanan kanıtların tamamı için kaynağı GET ile al.
  • Her POST kalıcı saklanan 16–128 karakterlik Idempotency-Key gerektirir (harf, rakam, -, _ veya .). Zaman aşımından sonra aynı anahtarı ve JSON talimatlarını yeniden kullan. Farklı talimatlar 409 döndürür. Tamamlanmış yanıtlar 30 gün tutulur; eski anahtarlar yeniden kullanılamayan iptal kayıtlarına dönüşür. Belirsiz sonucu aşmak için anahtarı asla değiştirme.
  • Anahtarların proje listeleri, isteğe bağlı fatura mağazası kısıtlamaları, sona erme zamanı, IP izin listesi ve 1–600/dakika kotası (varsayılan 60) vardır. HTTP 429 Retry-After içerir. Mağazayla sınırlı anahtarlar satıcıları, proje bakiyelerini, hesap defterini, satıcı ödemelerini veya ayarları göremez. Harcama kimlik bilgilerini yalnızca güvenilir sunucularda tut; tarayıcılarda veya dağıtılan mobil uygulamalarda asla bulundurma.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETPazaryeri raporu/v1/marketplace/overviewSalt okunur

store_id, asset_id, from ve to filtreleri (dahil YYYY-MM-DD, UTC; varsayılan son 30 gün; en fazla on yıl). Bitiş tarihi itibarıyla tam hesap bakiyeleri ve dönem içi değişiklikler. Tahmini itibari para kazancı yok. Mağaza filtresi faturası olmayan proje geneli ücretleri dışarıda bırakır.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MARKETPLACE_API_TOKEN
ParametreTür / konumKural
permissioncredential scopemarketplace.read

Sorgu parametreleri

project_idUUIDzorunlu

Yetkili proje. Öğe URL'leri dahil her istekte zorunludur.

pageisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

per_pageisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

qisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

statusisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

store_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

vendor_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

asset_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

fromisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

toisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/marketplace/overview?project_id=YOUR_PROJECT_ID" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "data": {}
}

Yanıt alanları

dataobject
Kullanım notları
  • marketplace.read gerektirir. Yanıt örnekleri seçili alanları gösterir; saklanan kanıtların tamamı için kaynağı GET ile al.
  • Her POST kalıcı saklanan 16–128 karakterlik Idempotency-Key gerektirir (harf, rakam, -, _ veya .). Zaman aşımından sonra aynı anahtarı ve JSON talimatlarını yeniden kullan. Farklı talimatlar 409 döndürür. Tamamlanmış yanıtlar 30 gün tutulur; eski anahtarlar yeniden kullanılamayan iptal kayıtlarına dönüşür. Belirsiz sonucu aşmak için anahtarı asla değiştirme.
  • Anahtarların proje listeleri, isteğe bağlı fatura mağazası kısıtlamaları, sona erme zamanı, IP izin listesi ve 1–600/dakika kotası (varsayılan 60) vardır. HTTP 429 Retry-After içerir. Mağazayla sınırlı anahtarlar satıcıları, proje bakiyelerini, hesap defterini, satıcı ödemelerini veya ayarları göremez. Harcama kimlik bilgilerini yalnızca güvenilir sunucularda tut; tarayıcılarda veya dağıtılan mobil uygulamalarda asla bulundurma.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETProje ayarları/v1/marketplace/settingsSalt okunur

enabled, payouts_paused, commission_percent, revision ve katılan mağazaları döndürür.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MARKETPLACE_API_TOKEN
ParametreTür / konumKural
permissioncredential scopemarketplace.read

Sorgu parametreleri

project_idUUIDzorunlu

Yetkili proje. Öğe URL'leri dahil her istekte zorunludur.

pageisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

per_pageisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

qisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

statusisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

store_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

vendor_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

asset_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

fromisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

toisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/marketplace/settings?project_id=YOUR_PROJECT_ID" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "data": {}
}

Yanıt alanları

dataobject
Kullanım notları
  • marketplace.read gerektirir. Yanıt örnekleri seçili alanları gösterir; saklanan kanıtların tamamı için kaynağı GET ile al.
  • Her POST kalıcı saklanan 16–128 karakterlik Idempotency-Key gerektirir (harf, rakam, -, _ veya .). Zaman aşımından sonra aynı anahtarı ve JSON talimatlarını yeniden kullan. Farklı talimatlar 409 döndürür. Tamamlanmış yanıtlar 30 gün tutulur; eski anahtarlar yeniden kullanılamayan iptal kayıtlarına dönüşür. Belirsiz sonucu aşmak için anahtarı asla değiştirme.
  • Anahtarların proje listeleri, isteğe bağlı fatura mağazası kısıtlamaları, sona erme zamanı, IP izin listesi ve 1–600/dakika kotası (varsayılan 60) vardır. HTTP 429 Retry-After içerir. Mağazayla sınırlı anahtarlar satıcıları, proje bakiyelerini, hesap defterini, satıcı ödemelerini veya ayarları göremez. Harcama kimlik bilgilerini yalnızca güvenilir sunucularda tut; tarayıcılarda veya dağıtılan mobil uygulamalarda asla bulundurma.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTProje ayarlarını kaydet/v1/marketplace/settingsOkuma ve yazma

Katılan mağaza seçimini değiştir. revision 0 ayarları başlatır; sonraki düzenlemeler döndürülen revision değerini gerektirir. Komisyon 0–100 arası, en fazla iki ondalık basamaklı yüzdedir.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MARKETPLACE_API_TOKEN
Idempotency-Keyzorunlu16–128 harf, rakam, -, _ veya .; bu tam istekle birlikte sakla
ParametreTür / konumKural
permissioncredential scopepolicies.write

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
# Keep this key and the exact body for retries; use a new key for each new operation.
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/marketplace/settings" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Idempotency-Key: marketplace-request-1042' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "project_id": "YOUR_PROJECT_ID",
  "revision": 0,
  "enabled": true,
  "payouts_paused": true,
  "commission_percent": "4",
  "stores": [
    {
      "store_id": "YOUR_STORE_ID",
      "enabled": true,
      "commission_percent": null
    }
  ]
}'

İstek gövdesi

project_idUUIDzorunlu

Yetkili proje. Öğe URL'leri dahil her istekte zorunludur.

revision

0

enabled

true

payouts_paused

true

commission_percent

"4"

stores[]object[]

[{"store_id":"YOUR_STORE_ID","enabled":true,"commission_percent":null}]

store_idstring
enabledboolean
commission_percentJSON | null

Yanıt 200 application/json

Örnek yanıt
{
  "data": {}
}

Yanıt alanları

dataobject
Kullanım notları
  • policies.write gerektirir. Yanıt örnekleri seçili alanları gösterir; saklanan kanıtların tamamı için kaynağı GET ile al.
  • Her POST kalıcı saklanan 16–128 karakterlik Idempotency-Key gerektirir (harf, rakam, -, _ veya .). Zaman aşımından sonra aynı anahtarı ve JSON talimatlarını yeniden kullan. Farklı talimatlar 409 döndürür. Tamamlanmış yanıtlar 30 gün tutulur; eski anahtarlar yeniden kullanılamayan iptal kayıtlarına dönüşür. Belirsiz sonucu aşmak için anahtarı asla değiştirme.
  • Anahtarların proje listeleri, isteğe bağlı fatura mağazası kısıtlamaları, sona erme zamanı, IP izin listesi ve 1–600/dakika kotası (varsayılan 60) vardır. HTTP 429 Retry-After içerir. Mağazayla sınırlı anahtarlar satıcıları, proje bakiyelerini, hesap defterini, satıcı ödemelerini veya ayarları göremez. Harcama kimlik bilgilerini yalnızca güvenilir sunucularda tut; tarayıcılarda veya dağıtılan mobil uygulamalarda asla bulundurma.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETSatıcıları listele/v1/marketplace/vendorsSalt okunur

Sayfalanmış satıcılar. q ile ad, harici kimlik veya e-posta ara; status active, suspended veya archived olabilir.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MARKETPLACE_API_TOKEN
ParametreTür / konumKural
permissioncredential scopemarketplace.read

Sorgu parametreleri

project_idUUIDzorunlu

Yetkili proje. Öğe URL'leri dahil her istekte zorunludur.

pageisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

per_pageisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

qisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

statusisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

store_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

vendor_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

asset_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

fromisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

toisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/marketplace/vendors?project_id=YOUR_PROJECT_ID" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "data": [],
  "pagination": {
    "page": 1,
    "per_page": 25,
    "total": 0,
    "pages": 1
  }
}

Yanıt alanları

data[]array
paginationobject
pageinteger
per_pageinteger
totalinteger
pagesinteger
Kullanım notları
  • marketplace.read gerektirir. Yanıt örnekleri seçili alanları gösterir; saklanan kanıtların tamamı için kaynağı GET ile al.
  • Her POST kalıcı saklanan 16–128 karakterlik Idempotency-Key gerektirir (harf, rakam, -, _ veya .). Zaman aşımından sonra aynı anahtarı ve JSON talimatlarını yeniden kullan. Farklı talimatlar 409 döndürür. Tamamlanmış yanıtlar 30 gün tutulur; eski anahtarlar yeniden kullanılamayan iptal kayıtlarına dönüşür. Belirsiz sonucu aşmak için anahtarı asla değiştirme.
  • Anahtarların proje listeleri, isteğe bağlı fatura mağazası kısıtlamaları, sona erme zamanı, IP izin listesi ve 1–600/dakika kotası (varsayılan 60) vardır. HTTP 429 Retry-After içerir. Mağazayla sınırlı anahtarlar satıcıları, proje bakiyelerini, hesap defterini, satıcı ödemelerini veya ayarları göremez. Harcama kimlik bilgilerini yalnızca güvenilir sunucularda tut; tarayıcılarda veya dağıtılan mobil uygulamalarda asla bulundurma.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTSatıcı oluştur/v1/marketplace/vendorsOkuma ve yazma

Ad zorunlu (160 karakter); external_id isteğe bağlı ve proje içinde benzersiz (128); e-posta isteğe bağlı (254); açıklama en fazla 2000. commission_percent null ise mağazayı devralır. Null olmayan özel değer ayrıca commissions.override gerektirir. Satıcılar barındırılan merchant hesapları değildir.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MARKETPLACE_API_TOKEN
Idempotency-Keyzorunlu16–128 harf, rakam, -, _ veya .; bu tam istekle birlikte sakla
ParametreTür / konumKural
permissioncredential scopevendors.write

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
# Keep this key and the exact body for retries; use a new key for each new operation.
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/marketplace/vendors" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Idempotency-Key: marketplace-request-1042' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "project_id": "YOUR_PROJECT_ID",
  "name": "Example vendor",
  "external_id": "vendor-1042",
  "email": "vendor@example.com",
  "description": "",
  "status": "active",
  "commission_percent": null
}'

İstek gövdesi

project_idUUIDzorunlu

Yetkili proje. Öğe URL'leri dahil her istekte zorunludur.

name

"Example vendor"

external_id

"vendor-1042"

email

"vendor@example.com"

description

""

status

"active"

commission_percent

null

Yanıt 200 application/json

Örnek yanıt
{
  "data": {}
}

Yanıt alanları

dataobject
Kullanım notları
  • vendors.write gerektirir. Yanıt örnekleri seçili alanları gösterir; saklanan kanıtların tamamı için kaynağı GET ile al.
  • Her POST kalıcı saklanan 16–128 karakterlik Idempotency-Key gerektirir (harf, rakam, -, _ veya .). Zaman aşımından sonra aynı anahtarı ve JSON talimatlarını yeniden kullan. Farklı talimatlar 409 döndürür. Tamamlanmış yanıtlar 30 gün tutulur; eski anahtarlar yeniden kullanılamayan iptal kayıtlarına dönüşür. Belirsiz sonucu aşmak için anahtarı asla değiştirme.
  • Anahtarların proje listeleri, isteğe bağlı fatura mağazası kısıtlamaları, sona erme zamanı, IP izin listesi ve 1–600/dakika kotası (varsayılan 60) vardır. HTTP 429 Retry-After içerir. Mağazayla sınırlı anahtarlar satıcıları, proje bakiyelerini, hesap defterini, satıcı ödemelerini veya ayarları göremez. Harcama kimlik bilgilerini yalnızca güvenilir sunucularda tut; tarayıcılarda veya dağıtılan mobil uygulamalarda asla bulundurma.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETSatıcıyı getir/v1/marketplace/vendors/{vendor_id}Salt okunur

Bir satıcıyı, revizyonu ve özel komisyon ayarını döndürür.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MARKETPLACE_API_TOKEN
ParametreTür / konumKural
permissioncredential scopemarketplace.read

Sorgu parametreleri

project_idUUIDzorunlu

Yetkili proje. Öğe URL'leri dahil her istekte zorunludur.

pageisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

per_pageisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

qisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

statusisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

store_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

vendor_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

asset_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

fromisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

toisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/marketplace/vendors/YOUR_VENDOR_ID?project_id=YOUR_PROJECT_ID" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "data": {}
}

Yanıt alanları

dataobject
Kullanım notları
  • marketplace.read gerektirir. Yanıt örnekleri seçili alanları gösterir; saklanan kanıtların tamamı için kaynağı GET ile al.
  • Her POST kalıcı saklanan 16–128 karakterlik Idempotency-Key gerektirir (harf, rakam, -, _ veya .). Zaman aşımından sonra aynı anahtarı ve JSON talimatlarını yeniden kullan. Farklı talimatlar 409 döndürür. Tamamlanmış yanıtlar 30 gün tutulur; eski anahtarlar yeniden kullanılamayan iptal kayıtlarına dönüşür. Belirsiz sonucu aşmak için anahtarı asla değiştirme.
  • Anahtarların proje listeleri, isteğe bağlı fatura mağazası kısıtlamaları, sona erme zamanı, IP izin listesi ve 1–600/dakika kotası (varsayılan 60) vardır. HTTP 429 Retry-After içerir. Mağazayla sınırlı anahtarlar satıcıları, proje bakiyelerini, hesap defterini, satıcı ödemelerini veya ayarları göremez. Harcama kimlik bilgilerini yalnızca güvenilir sunucularda tut; tarayıcılarda veya dağıtılan mobil uygulamalarda asla bulundurma.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTSatıcıyı güncelle/v1/marketplace/vendors/{vendor_id}/updateOkuma ve yazma

Satıcı ayrıntılarını güncelle; status active veya suspended. commission_percent değiştirmek veya kaldırmak ayrıca commissions.override gerektirir; değişmeyen değerler yalnızca vendors.write ister. Arşivlenmiş satıcıyı geri getirmek ayrıca reconciliation.write gerektirir. Konsoldaki finansal düzenlemelerde hesapla yeniden kimlik doğrulaması gerekir. Mevcut tahsisler ilk komisyonlarını ve hedeflerini korur.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MARKETPLACE_API_TOKEN
Idempotency-Keyzorunlu16–128 harf, rakam, -, _ veya .; bu tam istekle birlikte sakla
ParametreTür / konumKural
permissioncredential scopevendors.write

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
# Keep this key and the exact body for retries; use a new key for each new operation.
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/marketplace/vendors/YOUR_VENDOR_ID/update" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Idempotency-Key: marketplace-request-1042' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "project_id": "YOUR_PROJECT_ID",
  "name": "Example vendor",
  "external_id": "vendor-1042",
  "email": "vendor@example.com",
  "description": "",
  "status": "active",
  "commission_percent": null,
  "revision": 1
}'

İstek gövdesi

project_idUUIDzorunlu

Yetkili proje. Öğe URL'leri dahil her istekte zorunludur.

name

"Example vendor"

external_id

"vendor-1042"

email

"vendor@example.com"

description

""

status

"active"

commission_percent

null

revision

1

Yanıt 200 application/json

Örnek yanıt
{
  "data": {}
}

Yanıt alanları

dataobject
Kullanım notları
  • vendors.write gerektirir. Yanıt örnekleri seçili alanları gösterir; saklanan kanıtların tamamı için kaynağı GET ile al.
  • Her POST kalıcı saklanan 16–128 karakterlik Idempotency-Key gerektirir (harf, rakam, -, _ veya .). Zaman aşımından sonra aynı anahtarı ve JSON talimatlarını yeniden kullan. Farklı talimatlar 409 döndürür. Tamamlanmış yanıtlar 30 gün tutulur; eski anahtarlar yeniden kullanılamayan iptal kayıtlarına dönüşür. Belirsiz sonucu aşmak için anahtarı asla değiştirme.
  • Anahtarların proje listeleri, isteğe bağlı fatura mağazası kısıtlamaları, sona erme zamanı, IP izin listesi ve 1–600/dakika kotası (varsayılan 60) vardır. HTTP 429 Retry-After içerir. Mağazayla sınırlı anahtarlar satıcıları, proje bakiyelerini, hesap defterini, satıcı ödemelerini veya ayarları göremez. Harcama kimlik bilgilerini yalnızca güvenilir sunucularda tut; tarayıcılarda veya dağıtılan mobil uygulamalarda asla bulundurma.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTSatıcıyı arşivle/v1/marketplace/vendors/{vendor_id}/archiveOkuma ve yazma

Yalnızca ödenmemiş ve açık fatura yükümlülükleri çözüldükten sonra arşivle; aksi halde 409 vendor_has_obligations döner. Geçmiş korunur. Geçici olarak suspended kullan veya eski arşivlenmiş satıcıyı güncelleme rotası ve reconciliation.write ile geri getir.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MARKETPLACE_API_TOKEN
Idempotency-Keyzorunlu16–128 harf, rakam, -, _ veya .; bu tam istekle birlikte sakla
ParametreTür / konumKural
permissioncredential scopevendors.write

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
# Keep this key and the exact body for retries; use a new key for each new operation.
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/marketplace/vendors/YOUR_VENDOR_ID/archive" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Idempotency-Key: marketplace-request-1042' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "project_id": "YOUR_PROJECT_ID",
  "revision": 1
}'

İstek gövdesi

project_idUUIDzorunlu

Yetkili proje. Öğe URL'leri dahil her istekte zorunludur.

revision

1

Yanıt 200 application/json

Örnek yanıt
{
  "data": {}
}

Yanıt alanları

dataobject
Kullanım notları
  • vendors.write gerektirir. Yanıt örnekleri seçili alanları gösterir; saklanan kanıtların tamamı için kaynağı GET ile al.
  • Her POST kalıcı saklanan 16–128 karakterlik Idempotency-Key gerektirir (harf, rakam, -, _ veya .). Zaman aşımından sonra aynı anahtarı ve JSON talimatlarını yeniden kullan. Farklı talimatlar 409 döndürür. Tamamlanmış yanıtlar 30 gün tutulur; eski anahtarlar yeniden kullanılamayan iptal kayıtlarına dönüşür. Belirsiz sonucu aşmak için anahtarı asla değiştirme.
  • Anahtarların proje listeleri, isteğe bağlı fatura mağazası kısıtlamaları, sona erme zamanı, IP izin listesi ve 1–600/dakika kotası (varsayılan 60) vardır. HTTP 429 Retry-After içerir. Mağazayla sınırlı anahtarlar satıcıları, proje bakiyelerini, hesap defterini, satıcı ödemelerini veya ayarları göremez. Harcama kimlik bilgilerini yalnızca güvenilir sunucularda tut; tarayıcılarda veya dağıtılan mobil uygulamalarda asla bulundurma.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETSatıcı hedefleri/v1/marketplace/vendors/{vendor_id}/destinationsSalt okunur

Sürümlenmiş hedefler ve pending/approved/disabled durumları. Onay, sahipliği kanıtlamaz.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MARKETPLACE_API_TOKEN
ParametreTür / konumKural
permissioncredential scopemarketplace.read

Sorgu parametreleri

project_idUUIDzorunlu

Yetkili proje. Öğe URL'leri dahil her istekte zorunludur.

pageisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

per_pageisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

qisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

statusisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

store_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

vendor_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

asset_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

fromisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

toisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/marketplace/vendors/YOUR_VENDOR_ID/destinations?project_id=YOUR_PROJECT_ID" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "data": [],
  "pagination": {
    "page": 1,
    "per_page": 25,
    "total": 0,
    "pages": 1
  }
}

Yanıt alanları

data[]array
paginationobject
pageinteger
per_pageinteger
totalinteger
pagesinteger
Kullanım notları
  • marketplace.read gerektirir. Yanıt örnekleri seçili alanları gösterir; saklanan kanıtların tamamı için kaynağı GET ile al.
  • Her POST kalıcı saklanan 16–128 karakterlik Idempotency-Key gerektirir (harf, rakam, -, _ veya .). Zaman aşımından sonra aynı anahtarı ve JSON talimatlarını yeniden kullan. Farklı talimatlar 409 döndürür. Tamamlanmış yanıtlar 30 gün tutulur; eski anahtarlar yeniden kullanılamayan iptal kayıtlarına dönüşür. Belirsiz sonucu aşmak için anahtarı asla değiştirme.
  • Anahtarların proje listeleri, isteğe bağlı fatura mağazası kısıtlamaları, sona erme zamanı, IP izin listesi ve 1–600/dakika kotası (varsayılan 60) vardır. HTTP 429 Retry-After içerir. Mağazayla sınırlı anahtarlar satıcıları, proje bakiyelerini, hesap defterini, satıcı ödemelerini veya ayarları göremez. Harcama kimlik bilgilerini yalnızca güvenilir sunucularda tut; tarayıcılarda veya dağıtılan mobil uygulamalarda asla bulundurma.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTÖdeme hedefi ekle/v1/marketplace/vendors/{vendor_id}/destinationsOkuma ve yazma

Onay beklemek üzere geçerli mainnet BTC veya desteklenen EVM adresi kaydet. Projeye ait adresler, yanlış ağ ve sıfır EVM adresleri reddedilir.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MARKETPLACE_API_TOKEN
Idempotency-Keyzorunlu16–128 harf, rakam, -, _ veya .; bu tam istekle birlikte sakla
ParametreTür / konumKural
permissioncredential scopedestinations.write

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
# Keep this key and the exact body for retries; use a new key for each new operation.
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/marketplace/vendors/YOUR_VENDOR_ID/destinations" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Idempotency-Key: marketplace-request-1042' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "project_id": "YOUR_PROJECT_ID",
  "chain_slug": "bitcoin",
  "network": "mainnet",
  "address": "VERIFIED_VENDOR_BTC_ADDRESS",
  "label": "Vendor BTC"
}'

İstek gövdesi

project_idUUIDzorunlu

Yetkili proje. Öğe URL'leri dahil her istekte zorunludur.

chain_slug

"bitcoin"

network

"mainnet"

address

"VERIFIED_VENDOR_BTC_ADDRESS"

label

"Vendor BTC"

Yanıt 200 application/json

Örnek yanıt
{
  "data": {}
}

Yanıt alanları

dataobject
Kullanım notları
  • destinations.write gerektirir. Yanıt örnekleri seçili alanları gösterir; saklanan kanıtların tamamı için kaynağı GET ile al.
  • Her POST kalıcı saklanan 16–128 karakterlik Idempotency-Key gerektirir (harf, rakam, -, _ veya .). Zaman aşımından sonra aynı anahtarı ve JSON talimatlarını yeniden kullan. Farklı talimatlar 409 döndürür. Tamamlanmış yanıtlar 30 gün tutulur; eski anahtarlar yeniden kullanılamayan iptal kayıtlarına dönüşür. Belirsiz sonucu aşmak için anahtarı asla değiştirme.
  • Anahtarların proje listeleri, isteğe bağlı fatura mağazası kısıtlamaları, sona erme zamanı, IP izin listesi ve 1–600/dakika kotası (varsayılan 60) vardır. HTTP 429 Retry-After içerir. Mağazayla sınırlı anahtarlar satıcıları, proje bakiyelerini, hesap defterini, satıcı ödemelerini veya ayarları göremez. Harcama kimlik bilgilerini yalnızca güvenilir sunucularda tut; tarayıcılarda veya dağıtılan mobil uygulamalarda asla bulundurma.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTHedefi onayla/v1/marketplace/vendors/{vendor_id}/destinations/{destination_id}/approveOkuma ve yazma

Önce sahipliği bağımsız doğrula. Bu satıcı/ağdaki mevcut onaylı hedefi önce devre dışı bırak; eski görüntüler yeniden yönlendirilmez.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MARKETPLACE_API_TOKEN
Idempotency-Keyzorunlu16–128 harf, rakam, -, _ veya .; bu tam istekle birlikte sakla
ParametreTür / konumKural
permissioncredential scopedestinations.approve

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
# Keep this key and the exact body for retries; use a new key for each new operation.
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/marketplace/vendors/YOUR_VENDOR_ID/destinations/YOUR_DESTINATION_ID/approve" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Idempotency-Key: marketplace-request-1042' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "project_id": "YOUR_PROJECT_ID",
  "revision": 1
}'

İstek gövdesi

project_idUUIDzorunlu

Yetkili proje. Öğe URL'leri dahil her istekte zorunludur.

revision

1

Yanıt 200 application/json

Örnek yanıt
{
  "data": {}
}

Yanıt alanları

dataobject
Kullanım notları
  • destinations.approve gerektirir. Yanıt örnekleri seçili alanları gösterir; saklanan kanıtların tamamı için kaynağı GET ile al.
  • Her POST kalıcı saklanan 16–128 karakterlik Idempotency-Key gerektirir (harf, rakam, -, _ veya .). Zaman aşımından sonra aynı anahtarı ve JSON talimatlarını yeniden kullan. Farklı talimatlar 409 döndürür. Tamamlanmış yanıtlar 30 gün tutulur; eski anahtarlar yeniden kullanılamayan iptal kayıtlarına dönüşür. Belirsiz sonucu aşmak için anahtarı asla değiştirme.
  • Anahtarların proje listeleri, isteğe bağlı fatura mağazası kısıtlamaları, sona erme zamanı, IP izin listesi ve 1–600/dakika kotası (varsayılan 60) vardır. HTTP 429 Retry-After içerir. Mağazayla sınırlı anahtarlar satıcıları, proje bakiyelerini, hesap defterini, satıcı ödemelerini veya ayarları göremez. Harcama kimlik bilgilerini yalnızca güvenilir sunucularda tut; tarayıcılarda veya dağıtılan mobil uygulamalarda asla bulundurma.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTHedefi devre dışı bırak/v1/marketplace/vendors/{vendor_id}/destinations/{destination_id}/disableOkuma ve yazma

Bu sürümü kullanan yeni/gönderilmemiş işleri durdur. İmzalı işlem iptal edilemez.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MARKETPLACE_API_TOKEN
Idempotency-Keyzorunlu16–128 harf, rakam, -, _ veya .; bu tam istekle birlikte sakla
ParametreTür / konumKural
permissioncredential scopedestinations.approve

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
# Keep this key and the exact body for retries; use a new key for each new operation.
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/marketplace/vendors/YOUR_VENDOR_ID/destinations/YOUR_DESTINATION_ID/disable" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Idempotency-Key: marketplace-request-1042' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "project_id": "YOUR_PROJECT_ID",
  "revision": 1
}'

İstek gövdesi

project_idUUIDzorunlu

Yetkili proje. Öğe URL'leri dahil her istekte zorunludur.

revision

1

Yanıt 200 application/json

Örnek yanıt
{
  "data": {}
}

Yanıt alanları

dataobject
Kullanım notları
  • destinations.approve gerektirir. Yanıt örnekleri seçili alanları gösterir; saklanan kanıtların tamamı için kaynağı GET ile al.
  • Her POST kalıcı saklanan 16–128 karakterlik Idempotency-Key gerektirir (harf, rakam, -, _ veya .). Zaman aşımından sonra aynı anahtarı ve JSON talimatlarını yeniden kullan. Farklı talimatlar 409 döndürür. Tamamlanmış yanıtlar 30 gün tutulur; eski anahtarlar yeniden kullanılamayan iptal kayıtlarına dönüşür. Belirsiz sonucu aşmak için anahtarı asla değiştirme.
  • Anahtarların proje listeleri, isteğe bağlı fatura mağazası kısıtlamaları, sona erme zamanı, IP izin listesi ve 1–600/dakika kotası (varsayılan 60) vardır. HTTP 429 Retry-After içerir. Mağazayla sınırlı anahtarlar satıcıları, proje bakiyelerini, hesap defterini, satıcı ödemelerini veya ayarları göremez. Harcama kimlik bilgilerini yalnızca güvenilir sunucularda tut; tarayıcılarda veya dağıtılan mobil uygulamalarda asla bulundurma.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETSatıcı bakiyeleri/v1/marketplace/vendors/{vendor_id}/balancesSalt okunur

Değiştirilemez varlık kimliği ve hesap türüne göre gruplanmış, saklanan tam hesap defteri tutarları; canlı harcanabilir cüzdan bakiyeleri değildir.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MARKETPLACE_API_TOKEN
ParametreTür / konumKural
permissioncredential scopemarketplace.read

Sorgu parametreleri

project_idUUIDzorunlu

Yetkili proje. Öğe URL'leri dahil her istekte zorunludur.

pageisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

per_pageisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

qisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

statusisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

store_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

vendor_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

asset_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

fromisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

toisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/marketplace/vendors/YOUR_VENDOR_ID/balances?project_id=YOUR_PROJECT_ID" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "data": {}
}

Yanıt alanları

dataobject
Kullanım notları
  • marketplace.read gerektirir. Yanıt örnekleri seçili alanları gösterir; saklanan kanıtların tamamı için kaynağı GET ile al.
  • Her POST kalıcı saklanan 16–128 karakterlik Idempotency-Key gerektirir (harf, rakam, -, _ veya .). Zaman aşımından sonra aynı anahtarı ve JSON talimatlarını yeniden kullan. Farklı talimatlar 409 döndürür. Tamamlanmış yanıtlar 30 gün tutulur; eski anahtarlar yeniden kullanılamayan iptal kayıtlarına dönüşür. Belirsiz sonucu aşmak için anahtarı asla değiştirme.
  • Anahtarların proje listeleri, isteğe bağlı fatura mağazası kısıtlamaları, sona erme zamanı, IP izin listesi ve 1–600/dakika kotası (varsayılan 60) vardır. HTTP 429 Retry-After içerir. Mağazayla sınırlı anahtarlar satıcıları, proje bakiyelerini, hesap defterini, satıcı ödemelerini veya ayarları göremez. Harcama kimlik bilgilerini yalnızca güvenilir sunucularda tut; tarayıcılarda veya dağıtılan mobil uygulamalarda asla bulundurma.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETPazaryeri faturaları/v1/marketplace/invoicesSalt okunur

Sayfalanmış faturalar; q sipariş, e-posta, açıklama, meta veri ve fatura UUID'sinde arar. store_id, vendor_id ve Pazaryeri durumuyla filtrele. Normal faturalar hariçtir.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MARKETPLACE_API_TOKEN
ParametreTür / konumKural
permissioncredential scopemarketplace.read

Sorgu parametreleri

project_idUUIDzorunlu

Yetkili proje. Öğe URL'leri dahil her istekte zorunludur.

pageisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

per_pageisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

qisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

statusisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

store_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

vendor_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

asset_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

fromisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

toisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/marketplace/invoices?project_id=YOUR_PROJECT_ID" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "data": [],
  "pagination": {
    "page": 1,
    "per_page": 25,
    "total": 0,
    "pages": 1
  }
}

Yanıt alanları

data[]array
paginationobject
pageinteger
per_pageinteger
totalinteger
pagesinteger
Kullanım notları
  • marketplace.read gerektirir. Yanıt örnekleri seçili alanları gösterir; saklanan kanıtların tamamı için kaynağı GET ile al.
  • Her POST kalıcı saklanan 16–128 karakterlik Idempotency-Key gerektirir (harf, rakam, -, _ veya .). Zaman aşımından sonra aynı anahtarı ve JSON talimatlarını yeniden kullan. Farklı talimatlar 409 döndürür. Tamamlanmış yanıtlar 30 gün tutulur; eski anahtarlar yeniden kullanılamayan iptal kayıtlarına dönüşür. Belirsiz sonucu aşmak için anahtarı asla değiştirme.
  • Anahtarların proje listeleri, isteğe bağlı fatura mağazası kısıtlamaları, sona erme zamanı, IP izin listesi ve 1–600/dakika kotası (varsayılan 60) vardır. HTTP 429 Retry-After içerir. Mağazayla sınırlı anahtarlar satıcıları, proje bakiyelerini, hesap defterini, satıcı ödemelerini veya ayarları göremez. Harcama kimlik bilgilerini yalnızca güvenilir sunucularda tut; tarayıcılarda veya dağıtılan mobil uygulamalarda asla bulundurma.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTÇok satıcılı fatura oluştur/v1/marketplace/invoicesOkuma ve yazma

Normal InvoiceCreateInput alanlarını, store_id ve allocations ile birlikte kullan. Her satıcı bir kez yer alır; 1–100 pozitif payın toplamı amount değerine tam eşit olmalıdır. İsteğe bağlı fatura/tahsis commission_percent değeri commissions.override ve oturum isteklerinde konsolda yeniden kimlik doğrulaması gerektirir. data.invoice_id ve links.checkout döndürür. Uyumlu ortak yöntem yoksa ayrıntılı hata döner; uyumsuz varlığa geçilmez.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MARKETPLACE_API_TOKEN
Idempotency-Keyzorunlu16–128 harf, rakam, -, _ veya .; bu tam istekle birlikte sakla
ParametreTür / konumKural
permissioncredential scopeinvoices.write

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
# Keep this key and the exact body for retries; use a new key for each new operation.
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/marketplace/invoices" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Idempotency-Key: marketplace-request-1042' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "project_id": "YOUR_PROJECT_ID",
  "store_id": "YOUR_STORE_ID",
  "amount": "300.00",
  "currency": "USD",
  "order_id": "cart-1042",
  "allocations": [
    {
      "vendor_id": "VENDOR_A_UUID",
      "gross_amount": "100.00"
    },
    {
      "vendor_id": "VENDOR_B_UUID",
      "gross_amount": "100.00"
    },
    {
      "vendor_id": "VENDOR_C_UUID",
      "gross_amount": "100.00"
    }
  ]
}'

İstek gövdesi

amountstringzorunlu
İşaretsiz düz ondalık sayı dizesi; işaret veya üs yok, en fazla 48 tamsayı ve 30 ondalık basamak. Varsayılan olarak pozitif olmalıdır. Mağaza, Mağazalar → Fatura bölümünde sıfır tutarlı faturalara izin verebilir; sıfır toplamlar fon almadan, adres ayırmadan veya işlem ücreti olmadan tamamlanır.Ayrıntılar

İşaretsiz düz ondalık sayı dizesi; işaret veya üs yok, en fazla 48 tamsayı ve 30 ondalık basamak. Varsayılan olarak pozitif olmalıdır. Mağaza, Mağazalar → Fatura bölümünde sıfır tutarlı faturalara izin verebilir; sıfır toplamlar fon almadan, adres ayırmadan veya işlem ücreti olmadan tamamlanır.

currencystring | nullisteğe bağlı
Desteklenen üç harfli itibari para birimi; büyük harfe normalleştirilir. Atlanırsa veya null ise mağazanın fatura para birimini devralır. Oluşturma ayrıca bağımsız olarak kullanılabilir faturalandırma dönüşüm kuru gerektirir.Ayrıntılar

Desteklenen üç harfli itibari para birimi; büyük harfe normalleştirilir. Atlanırsa veya null ise mağazanın fatura para birimini devralır. Oluşturma ayrıca bağımsız olarak kullanılabilir faturalandırma dönüşüm kuru gerektirir.

payment_methods[]object[] | nullisteğe bağlı
Bu fatura için mağazada etkin yöntemleri seç. Merchant 5.4.0+: bilinmeyen/etkin olmayan/kabul edilmeyen seçimler yok sayılır; hiçbiri eşleşmezse mağaza varsayılanları kullanılır. Atlanması/null da mağaza varsayılanını kullanır; [] geçersizdir. Yöntemi asla etkinleştirmez veya mağaza ayarını değiştirmez. Aşağıdaki seçim şemasına bak.Ayrıntılar

Bu fatura için mağazada etkin yöntemleri seç. Merchant 5.4.0+: bilinmeyen/etkin olmayan/kabul edilmeyen seçimler yok sayılır; hiçbiri eşleşmezse mağaza varsayılanları kullanılır. Atlanması/null da mağaza varsayılanını kullanır; [] geçersizdir. Yöntemi asla etkinleştirmez veya mağaza ayarını değiştirmez. Aşağıdaki seçim şemasına bak.

chain_slugstringzorunlu
chain_slug değerini Proje → Mağazalar → Ödeme yöntemleri bölümünden kopyala veya GET /v1/projects/{project_id}/stores/{store_id}/payment-assets yanıtından oku; ör. ethereum, base veya bitcoin. Zincir/ödeme altyapısı çifti yalnızca bir kez bulunabilir.Ayrıntılar

chain_slug değerini Proje → Mağazalar → Ödeme yöntemleri bölümünden kopyala veya GET /v1/projects/{project_id}/stores/{store_id}/payment-assets yanıtından oku; ör. ethereum, base veya bitcoin. Zincir/ödeme altyapısı çifti yalnızca bir kez bulunabilir.

asset_ids[]UUID[] | nullisteğe bağlı
Sözleşme adresleri veya fatura ödeme yöntemi kimlikleri değil, zincir üstü asset.id UUID'leri. Bunu VEYA asset_tickers kullan. Bu zincirde etkin kabul edilen tüm varlıklar için iki seçiciyi de atla. [] ve yinelenen/nil kimlikler geçersizdir. 5.4.0+'da bu mağazada bu zincir için etkin/kabul edilen olmayan kimlikler yok sayılır; tamamen eşleşmeyen seçim mağaza varsayılanını kullanır.Ayrıntılar

Sözleşme adresleri veya fatura ödeme yöntemi kimlikleri değil, zincir üstü asset.id UUID'leri. Bunu VEYA asset_tickers kullan. Bu zincirde etkin kabul edilen tüm varlıklar için iki seçiciyi de atla. [] ve yinelenen/nil kimlikler geçersizdir. 5.4.0+'da bu mağazada bu zincir için etkin/kabul edilen olmayan kimlikler yok sayılır; tamamen eşleşmeyen seçim mağaza varsayılanını kullanır.

asset_tickers[]string[] | nullisteğe bağlı
Merchant 5.3.0+. chain_slug ve bu mağaza kapsamındaki BTC, USDC veya PEPE gibi semboller. 1–64 benzersiz sembol; kenar boşlukları temizlenir ve büyük/küçük harf duyarsızdır; 1–40 ASCII harf/rakam/nokta/alt çizgi/tire. Bunu VEYA asset_ids kullan. 5.4.0+'da bilinmeyen/etkin olmayan/kabul edilmeyen semboller yok sayılır. Belirsiz kabul edilen semboller yine hata verir: asset_ids kullan. Seçili etkin yöntemler geçerli cüzdan ve fiyatlandırma gerektirir; geçici zincir üstü tarayıcı kesintileri 6.0.6'dan itibaren oluşturmayı engellemez. Lightning isteğe bağlı olarak yalnızca BTC kabul eder.Ayrıntılar

Merchant 5.3.0+. chain_slug ve bu mağaza kapsamındaki BTC, USDC veya PEPE gibi semboller. 1–64 benzersiz sembol; kenar boşlukları temizlenir ve büyük/küçük harf duyarsızdır; 1–40 ASCII harf/rakam/nokta/alt çizgi/tire. Bunu VEYA asset_ids kullan. 5.4.0+'da bilinmeyen/etkin olmayan/kabul edilmeyen semboller yok sayılır. Belirsiz kabul edilen semboller yine hata verir: asset_ids kullan. Seçili etkin yöntemler geçerli cüzdan ve fiyatlandırma gerektirir; geçici zincir üstü tarayıcı kesintileri 6.0.6'dan itibaren oluşturmayı engellemez. Lightning isteğe bağlı olarak yalnızca BTC kabul eder.

payment_railonchain | lightningisteğe bağlı
Varsayılan onchain. Bitcoin Lightning seçmek için asset_ids olmadan {chain_slug: bitcoin, payment_rail: lightning} kullan; asset_tickers isteğe bağlı [BTC] olabilir. Zincir üstü Bitcoin, Lightning'i içermez. Mağazanın Lightning bağlantısı zaten etkin ve hazır olmalıdır.Ayrıntılar

Varsayılan onchain. Bitcoin Lightning seçmek için asset_ids olmadan {chain_slug: bitcoin, payment_rail: lightning} kullan; asset_tickers isteğe bağlı [BTC] olabilir. Zincir üstü Bitcoin, Lightning'i içermez. Mağazanın Lightning bağlantısı zaten etkin ve hazır olmalıdır.

order_idstring | nullisteğe bağlı

Satıcı sipariş referansı; kenar boşlukları temizlendikten sonra 1–128 karakter; kontrol karakterleri reddedilir.

emailstring | nullisteğe bağlı

Yalnızca satıcıya açık müşteri e-postası; en fazla 254 karakterli pratik ASCII adrese normalleştirilir. Atlanırsa veya null ise e-posta saklanmaz.

descriptionstring | nullisteğe bağlı

Müşteriye görünen açıklama; 1–500 karakter; satır sonları ve sekmeler kabul edilir.

expires_in_secondsinteger | nullisteğe bağlı

Fatura teklif süresi 300 ile 86.400 saniye arası; atlanırsa veya null ise mağaza politikasını devralır.

exchange_rate_spread_percentdecimal string | nullisteğe bağlı
0–100 arası, en fazla iki ondalık basamaklı teklif fiyat marjı. Atlanırsa veya null ise mağaza varsayılanını devralır; "0" bu fatura için kapatır. Yukarı yuvarlamadan önce uygulanır ve sonra kilitlenir. Faturanın itibari para tutarını veya işlem ücreti temelini değiştirmez.Ayrıntılar

0–100 arası, en fazla iki ondalık basamaklı teklif fiyat marjı. Atlanırsa veya null ise mağaza varsayılanını devralır; "0" bu fatura için kapatır. Yukarı yuvarlamadan önce uygulanır ve sonra kilitlenir. Faturanın itibari para tutarını veya işlem ücreti temelini değiştirmez.

underpayment_tolerance_percentdecimal string | nullisteğe bağlı

0–99.99 arası, en fazla iki ondalık basamaklı kabul edilen eksik ödeme oranı. Atlanırsa veya null ise mağaza varsayılanını devralır.

ipn_urlstring | nullisteğe bağlı

En fazla 2.048 bayt, kimlik bilgisi veya fragment içermeyen herkese açık HTTPS geri çağrısı. Mağaza varsayılanını geçersiz kılar; null/atlanması varsayılanı devralır.

redirect_urlstring | nullisteğe bağlı

Ödeme tamamlandıktan sonra kullanılan, en fazla 2.048 bayt ve gömülü kimlik bilgisi içermeyen HTTPS başarı URL'si. Atlanırsa veya null ise mağaza varsayılanını devralır; onu temizleyemez.

cancel_urlstring | nullisteğe bağlı

Ödeme sayfası başarılı ödeme olmadan sona erdiğinde kullanılan HTTPS dönüş URL'si. Atlanırsa veya null ise mağaza varsayılanını devralır; onu temizleyemez.

redirect_automaticallyboolean | nullisteğe bağlı

Atlanırsa veya null ise mağaza politikasını devralır. true, geçerli redirect_url gerektirir.

languagestring | nullisteğe bağlı
Müşteri dili: en, de, es, pt-BR, it, ru, zh-CN, fr, ko veya ja. pt Brezilya Portekizcesi, zh Basitleştirilmiş Çince demektir. de-DE gibi desteklenen bölgesel etiketler listelenen dile normalleştirilir. Atlanırsa veya null ise mağaza dilini devralır. Konsol dili ayrıdır.Ayrıntılar

Müşteri dili: en, de, es, pt-BR, it, ru, zh-CN, fr, ko veya ja. pt Brezilya Portekizcesi, zh Basitleştirilmiş Çince demektir. de-DE gibi desteklenen bölgesel etiketler listelenen dile normalleştirilir. Atlanırsa veya null ise mağaza dilini devralır. Konsol dili ayrıdır.

checkout_appearanceobject | nullisteğe bağlı
Bu fatura için kısmi görünüm ayarları. Atlanması/null mağazanın güncel tasarımını izler. {} dahil bir nesne, çözümlenen tasarımı ve görselleri oluşturma anında sabitler. Aşağıdaki özel ayar şemasına bak; finansal ayar, HTML, CSS, JavaScript veya uzak görsel URL'si yok.Ayrıntılar

Bu fatura için kısmi görünüm ayarları. Atlanması/null mağazanın güncel tasarımını izler. {} dahil bir nesne, çözümlenen tasarımı ve görselleri oluşturma anında sabitler. Aşağıdaki özel ayar şemasına bak; finansal ayar, HTML, CSS, JavaScript veya uzak görsel URL'si yok.

inherit_default_storebooleanisteğe bağlı
true, temel olarak projenin varsayılan mağaza tasarımını seçer; aksi halde hedef mağazanın geçerli tasarımı kullanılır. Özel ayarlar ardından uygulanıp bağımsız kaydedilir; çözümlenmiş fatura işareti false olur.Ayrıntılar

true, temel olarak projenin varsayılan mağaza tasarımını seçer; aksi halde hedef mağazanın geçerli tasarımı kullanılır. Özel ayarlar ardından uygulanıp bağımsız kaydedilir; çözümlenmiş fatura işareti false olur.

titlestringisteğe bağlı

Ödeme sayfası başlığı; en fazla 120 karakter. Boşsa standart başlık kullanılır.

introstringisteğe bağlı
Düz metin; her biri en fazla 2.000 karakter. Giriş her durumda üstte, Çıkış altta görünür. Satır sonları korunur; güvenli metin URL'leri bağlantıya dönüşür. Boş dize temizler. Eski customer_message, intro takma adı olarak kabul edilir; ikisini birlikte gönderme.Ayrıntılar

Düz metin; her biri en fazla 2.000 karakter. Giriş her durumda üstte, Çıkış altta görünür. Satır sonları korunur; güvenli metin URL'leri bağlantıya dönüşür. Boş dize temizler. Eski customer_message, intro takma adı olarak kabul edilir; ikisini birlikte gönderme.

outrostringisteğe bağlı
Düz metin; her biri en fazla 2.000 karakter. Giriş her durumda üstte, Çıkış altta görünür. Satır sonları korunur; güvenli metin URL'leri bağlantıya dönüşür. Boş dize temizler. Eski customer_message, intro takma adı olarak kabul edilir; ikisini birlikte gönderme.Ayrıntılar

Düz metin; her biri en fazla 2.000 karakter. Giriş her durumda üstte, Çıkış altta görünür. Satır sonları korunur; güvenli metin URL'leri bağlantıya dönüşür. Boş dize temizler. Eski customer_message, intro takma adı olarak kabul edilir; ikisini birlikte gönderme.

intro_font_sizeintegeristeğe bağlı

Piksel: 12, 14, 16, 18, 20 veya 24. Farklı devralınmadıkça varsayılan 16.

outro_font_sizeintegeristeğe bağlı

Piksel: 12, 14, 16, 18, 20 veya 24. Farklı devralınmadıkça varsayılan 16.

themesystem | light | dim | darkisteğe bağlı

Müşteri cihazını izle veya sabit tema kullan.

accent_colorstringisteğe bağlı

#RRGGBB. Otomatik renkler için arka plan, kart ve düğme boş olabilir. Metin kontrastı otomatiktir.

background_colorstringisteğe bağlı

#RRGGBB. Otomatik renkler için arka plan, kart ve düğme boş olabilir. Metin kontrastı otomatiktir.

card_colorstringisteğe bağlı

#RRGGBB. Otomatik renkler için arka plan, kart ve düğme boş olabilir. Metin kontrastı otomatiktir.

button_colorstringisteğe bağlı

#RRGGBB. Otomatik renkler için arka plan, kart ve düğme boş olabilir. Metin kontrastı otomatiktir.

logo_sizestringisteğe bağlı

small, medium veya large; left veya center.

logo_alignmentstringisteğe bağlı

small, medium veya large; left veya center.

imagesobjectisteğe bağlı
Anahtarlar: logo_light, logo_dark, favicon. Atlanan anahtar temel görseli korur; null kaldırır. {store_id: UUID, kind?: logo_light|logo_dark|favicon} nesnesi AYNI projedeki o mağazanın geçerli yüklenmiş görselini kullanır. kind varsayılanı hedef anahtardır. Önce Mağaza → Ödeme sayfası bölümünde yükle; Mağaza API kimliğini Temel → API kimlikleri bölümünden kopyala. Eksik görseller veya farklı proje kimlikleri 400 döndürür. Harici URL veya görsel verisi kabul edilmez.Ayrıntılar

Anahtarlar: logo_light, logo_dark, favicon. Atlanan anahtar temel görseli korur; null kaldırır. {store_id: UUID, kind?: logo_light|logo_dark|favicon} nesnesi AYNI projedeki o mağazanın geçerli yüklenmiş görselini kullanır. kind varsayılanı hedef anahtardır. Önce Mağaza → Ödeme sayfası bölümünde yükle; Mağaza API kimliğini Temel → API kimlikleri bölümünden kopyala. Eksik görseller veya farklı proje kimlikleri 400 döndürür. Harici URL veya görsel verisi kabul edilmez.

logo_lightobject | nullisteğe bağlı
store_idUUIDzorunlu
kindlogo_light | logo_dark | faviconisteğe bağlı
logo_darkobject | nullisteğe bağlı
store_idUUIDzorunlu
kindlogo_light | logo_dark | faviconisteğe bağlı
faviconobject | nullisteğe bağlı
store_idUUIDzorunlu
kindlogo_light | logo_dark | faviconisteğe bağlı
show_order_idbooleanisteğe bağlı

Başlığın altında sipariş kimliği ayrıntılarını ve düz metin açıklamayı göster. details_expanded başlangıçta sipariş kimliği ayrıntılarını açar. Yalnızca görünümü etkiler; verileri gizlemez.

show_descriptionbooleanisteğe bağlı

Başlığın altında sipariş kimliği ayrıntılarını ve düz metin açıklamayı göster. details_expanded başlangıçta sipariş kimliği ayrıntılarını açar. Yalnızca görünümü etkiler; verileri gizlemez.

details_expandedbooleanisteğe bağlı

Başlığın altında sipariş kimliği ayrıntılarını ve düz metin açıklamayı göster. details_expanded başlangıçta sipariş kimliği ayrıntılarını açar. Yalnızca görünümü etkiler; verileri gizlemez.

show_project_namebooleanisteğe bağlı
Merchant 5.6.0+: müşteri ödeme sayfası başlığındaki her adı göster veya gizle. İkisi de varsayılan true. Mağaza → Ödeme sayfası bölümünde de bulunur; diğer görünüm ayarları gibi devralınır ve fatura görüntüsüne kaydedilir. Yalnızca görünümü etkiler; verileri gizlemez.Ayrıntılar

Merchant 5.6.0+: müşteri ödeme sayfası başlığındaki her adı göster veya gizle. İkisi de varsayılan true. Mağaza → Ödeme sayfası bölümünde de bulunur; diğer görünüm ayarları gibi devralınır ve fatura görüntüsüne kaydedilir. Yalnızca görünümü etkiler; verileri gizlemez.

show_store_namebooleanisteğe bağlı
Merchant 5.6.0+: müşteri ödeme sayfası başlığındaki her adı göster veya gizle. İkisi de varsayılan true. Mağaza → Ödeme sayfası bölümünde de bulunur; diğer görünüm ayarları gibi devralınır ve fatura görüntüsüne kaydedilir. Yalnızca görünümü etkiler; verileri gizlemez.Ayrıntılar

Merchant 5.6.0+: müşteri ödeme sayfası başlığındaki her adı göster veya gizle. İkisi de varsayılan true. Mağaza → Ödeme sayfası bölümünde de bulunur; diğer görünüm ayarları gibi devralınır ve fatura görüntüsüne kaydedilir. Yalnızca görünümü etkiler; verileri gizlemez.

featured_chains[]string[]isteğe bağlı
Sıralı zincir kısa adları; en fazla 60 benzersiz değer (küçük harf, rakam, tire; en fazla 64 karakter). [] temizler. Yalnızca kullanılabilir fatura yöntemleri yeniden sıralanır.Ayrıntılar

Sıralı zincir kısa adları; en fazla 60 benzersiz değer (küçük harf, rakam, tire; en fazla 64 karakter). [] temizler. Yalnızca kullanılabilir fatura yöntemleri yeniden sıralanır.

featured_asset_ids[]UUID[]isteğe bağlı
En fazla 100 benzersiz sıralı varlık kimliği; [] temizler. Varsayılan varlık null olabilir. Kimlikler payment-intent kimliklerinden değil, payment-assets'ten gelir. Bunlar yöntemleri asla etkinleştirmez; alınan ödemeler ve geçerli müşteri tercihleri önceliklidir.Ayrıntılar

En fazla 100 benzersiz sıralı varlık kimliği; [] temizler. Varsayılan varlık null olabilir. Kimlikler payment-intent kimliklerinden değil, payment-assets'ten gelir. Bunlar yöntemleri asla etkinleştirmez; alınan ödemeler ve geçerli müşteri tercihleri önceliklidir.

default_asset_idUUID|nullisteğe bağlı
En fazla 100 benzersiz sıralı varlık kimliği; [] temizler. Varsayılan varlık null olabilir. Kimlikler payment-intent kimliklerinden değil, payment-assets'ten gelir. Bunlar yöntemleri asla etkinleştirmez; alınan ödemeler ve geçerli müşteri tercihleri önceliklidir.Ayrıntılar

En fazla 100 benzersiz sıralı varlık kimliği; [] temizler. Varsayılan varlık null olabilir. Kimlikler payment-intent kimliklerinden değil, payment-assets'ten gelir. Bunlar yöntemleri asla etkinleştirmez; alınan ödemeler ve geçerli müşteri tercihleri önceliklidir.

messagesobjectisteğe bağlı
en, de, es, pt-BR, it, ru, zh-CN, fr, ko veya ja anahtarlı dil nesneleri; waiting, confirming, paid, underpaid, expired düz dizeleri içerir (her biri 500 karakter). Yalnızca gönderilen diller/durumlar değişir; {} tüm mesajları, {en:{}} İngilizceyi, boş durum dizesi o durumu temizler. Yedek dil İngilizcedir. Gerçek durumun yerini almaz.Ayrıntılar

en, de, es, pt-BR, it, ru, zh-CN, fr, ko veya ja anahtarlı dil nesneleri; waiting, confirming, paid, underpaid, expired düz dizeleri içerir (her biri 500 karakter). Yalnızca gönderilen diller/durumlar değişir; {} tüm mesajları, {en:{}} İngilizceyi, boş durum dizesi o durumu temizler. Yedek dil İngilizcedir. Gerçek durumun yerini almaz.

enobjectisteğe bağlı
waitingstringisteğe bağlı
confirmingstringisteğe bağlı
paidstringisteğe bağlı
underpaidstringisteğe bağlı
expiredstringisteğe bağlı
deobjectisteğe bağlı
waitingstringisteğe bağlı
confirmingstringisteğe bağlı
paidstringisteğe bağlı
underpaidstringisteğe bağlı
expiredstringisteğe bağlı
esobjectisteğe bağlı
waitingstringisteğe bağlı
confirmingstringisteğe bağlı
paidstringisteğe bağlı
underpaidstringisteğe bağlı
expiredstringisteğe bağlı
pt-BRobjectisteğe bağlı
waitingstringisteğe bağlı
confirmingstringisteğe bağlı
paidstringisteğe bağlı
underpaidstringisteğe bağlı
expiredstringisteğe bağlı
itobjectisteğe bağlı
waitingstringisteğe bağlı
confirmingstringisteğe bağlı
paidstringisteğe bağlı
underpaidstringisteğe bağlı
expiredstringisteğe bağlı
ruobjectisteğe bağlı
waitingstringisteğe bağlı
confirmingstringisteğe bağlı
paidstringisteğe bağlı
underpaidstringisteğe bağlı
expiredstringisteğe bağlı
zh-CNobjectisteğe bağlı
waitingstringisteğe bağlı
confirmingstringisteğe bağlı
paidstringisteğe bağlı
underpaidstringisteğe bağlı
expiredstringisteğe bağlı
frobjectisteğe bağlı
waitingstringisteğe bağlı
confirmingstringisteğe bağlı
paidstringisteğe bağlı
underpaidstringisteğe bağlı
expiredstringisteğe bağlı
koobjectisteğe bağlı
waitingstringisteğe bağlı
confirmingstringisteğe bağlı
paidstringisteğe bağlı
underpaidstringisteğe bağlı
expiredstringisteğe bağlı
jaobjectisteğe bağlı
waitingstringisteğe bağlı
confirmingstringisteğe bağlı
paidstringisteğe bağlı
underpaidstringisteğe bağlı
expiredstringisteğe bağlı
support_emailstringisteğe bağlı

ASCII e-posta; en fazla 254 karakter. Boşsa temizler.

support_urlstringisteğe bağlı

Kimlik bilgisi içermeyen en fazla 2.048 karakterli HTTPS URL'leri. Boşsa temizler. Bağlantılar yeni pencerede açılır.

terms_urlstringisteğe bağlı

Kimlik bilgisi içermeyen en fazla 2.048 karakterli HTTPS URL'leri. Boşsa temizler. Bağlantılar yeni pencerede açılır.

privacy_urlstringisteğe bağlı

Kimlik bilgisi içermeyen en fazla 2.048 karakterli HTTPS URL'leri. Boşsa temizler. Bağlantılar yeni pencerede açılır.

return_button_textstringisteğe bağlı

Etiket en fazla 60 karakter. Fatura davranışı için üst düzey redirect_url/cancel_url/redirect_automatically/language kullan.

show_return_buttonbooleanisteğe bağlı
Son durumlar dahil ödeme sayfasında elle kullanılan Satıcıya dön/iptal düğmesini göster. Mağaza görünümünü devralmak için atla (varsayılan true); false gizler. Faturayı iptal etmez, JSON'daki URL'leri gizlemez veya otomatik başarı yönlendirmelerini kapatmaz. Gerekirse üst düzey redirect_automatically değerini ayrıca false yap. Merchant 8.1.4 veya yenisini gerektirir.Ayrıntılar

Son durumlar dahil ödeme sayfasında elle kullanılan Satıcıya dön/iptal düğmesini göster. Mağaza görünümünü devralmak için atla (varsayılan true); false gizler. Faturayı iptal etmez, JSON'daki URL'leri gizlemez veya otomatik başarı yönlendirmelerini kapatmaz. Gerekirse üst düzey redirect_automatically değerini ayrıca false yap. Merchant 8.1.4 veya yenisini gerektirir.

metadataobject | nullisteğe bağlı
Yalnızca satıcıya açık JSON nesnesi; atlanması veya null, {} olur; en fazla 4.096 kodlanmış bayt ve beş iç içe düzey. firstname, lastname, street, street2, zip, city, country, countryiso2, company ve vatid doğrulanır, normalleştirilir ve müşteri özeti alanlarına aktarılır.Ayrıntılar

Yalnızca satıcıya açık JSON nesnesi; atlanması veya null, {} olur; en fazla 4.096 kodlanmış bayt ve beş iç içe düzey. firstname, lastname, street, street2, zip, city, country, countryiso2, company ve vatid doğrulanır, normalleştirilir ve müşteri özeti alanlarına aktarılır.

firstnamestringisteğe bağlı
lastnamestringisteğe bağlı
streetstringisteğe bağlı
street2stringisteğe bağlı
zipstringisteğe bağlı
citystringisteğe bağlı
countrystringisteğe bağlı
countryiso2stringisteğe bağlı
companystringisteğe bağlı
vatidstringisteğe bağlı
project_idUUIDzorunlu

Yetkili proje. Öğe URL'leri dahil her istekte zorunludur.

store_id

"YOUR_STORE_ID"

allocations[]object[]
[{"vendor_id":"VENDOR_A_UUID","gross_amount":"100.00"},{"vendor_id":"VENDOR_B_UUID","gross_amount":"100.00"},{"vendor_id":"VENDOR_C_UUID","gross_amount":"100.00"}]Ayrıntılar

[{"vendor_id":"VENDOR_A_UUID","gross_amount":"100.00"},{"vendor_id":"VENDOR_B_UUID","gross_amount":"100.00"},{"vendor_id":"VENDOR_C_UUID","gross_amount":"100.00"}]

vendor_idstring
gross_amountstring

Yanıt 200 application/json

Örnek yanıt
{
  "data": {
    "invoice_id": "YOUR_INVOICE_ID",
    "status": "new",
    "marketplace": {
      "state": "pending",
      "allocations": []
    }
  },
  "links": {
    "checkout": "https://pay.example.com/invoice/YOUR_INVOICE_ID"
  }
}

Yanıt alanları

dataobject
invoice_idstring
statusstring
marketplaceobject
statestring
allocations[]array
Kullanım notları
  • invoices.write gerektirir. Yanıt örnekleri seçili alanları gösterir; saklanan kanıtların tamamı için kaynağı GET ile al.
  • Her POST kalıcı saklanan 16–128 karakterlik Idempotency-Key gerektirir (harf, rakam, -, _ veya .). Zaman aşımından sonra aynı anahtarı ve JSON talimatlarını yeniden kullan. Farklı talimatlar 409 döndürür. Tamamlanmış yanıtlar 30 gün tutulur; eski anahtarlar yeniden kullanılamayan iptal kayıtlarına dönüşür. Belirsiz sonucu aşmak için anahtarı asla değiştirme.
  • Anahtarların proje listeleri, isteğe bağlı fatura mağazası kısıtlamaları, sona erme zamanı, IP izin listesi ve 1–600/dakika kotası (varsayılan 60) vardır. HTTP 429 Retry-After içerir. Mağazayla sınırlı anahtarlar satıcıları, proje bakiyelerini, hesap defterini, satıcı ödemelerini veya ayarları göremez. Harcama kimlik bilgilerini yalnızca güvenilir sunucularda tut; tarayıcılarda veya dağıtılan mobil uygulamalarda asla bulundurma.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETFatura ve tahsisler/v1/marketplace/invoices/{invoice_id}Salt okunur

Normal fatura ayrıntılarına ek olarak pazaryeri durumu, revision, hold_reason, sabit tahsisler, politika görüntüsü, son 200 ödeme ve kısaltma işaretleriyle ilişkili son 100 satıcı ödemesi. Herkese açık ödeme sayfası satıcı verilerini göstermez.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MARKETPLACE_API_TOKEN
ParametreTür / konumKural
permissioncredential scopemarketplace.read

Sorgu parametreleri

project_idUUIDzorunlu

Yetkili proje. Öğe URL'leri dahil her istekte zorunludur.

pageisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

per_pageisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

qisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

statusisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

store_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

vendor_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

asset_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

fromisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

toisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/marketplace/invoices/YOUR_INVOICE_ID?project_id=YOUR_PROJECT_ID" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "data": {}
}

Yanıt alanları

dataobject
Kullanım notları
  • marketplace.read gerektirir. Yanıt örnekleri seçili alanları gösterir; saklanan kanıtların tamamı için kaynağı GET ile al.
  • Her POST kalıcı saklanan 16–128 karakterlik Idempotency-Key gerektirir (harf, rakam, -, _ veya .). Zaman aşımından sonra aynı anahtarı ve JSON talimatlarını yeniden kullan. Farklı talimatlar 409 döndürür. Tamamlanmış yanıtlar 30 gün tutulur; eski anahtarlar yeniden kullanılamayan iptal kayıtlarına dönüşür. Belirsiz sonucu aşmak için anahtarı asla değiştirme.
  • Anahtarların proje listeleri, isteğe bağlı fatura mağazası kısıtlamaları, sona erme zamanı, IP izin listesi ve 1–600/dakika kotası (varsayılan 60) vardır. HTTP 429 Retry-After içerir. Mağazayla sınırlı anahtarlar satıcıları, proje bakiyelerini, hesap defterini, satıcı ödemelerini veya ayarları göremez. Harcama kimlik bilgilerini yalnızca güvenilir sunucularda tut; tarayıcılarda veya dağıtılan mobil uygulamalarda asla bulundurma.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETFatura ödeme kanıtları/v1/marketplace/invoices/{invoice_id}/paymentsSalt okunur

page/per_page ile normal ödeme kanıtları. Gözlemler satıcı ödemesi değildir.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MARKETPLACE_API_TOKEN
ParametreTür / konumKural
permissioncredential scopemarketplace.read

Sorgu parametreleri

project_idUUIDzorunlu

Yetkili proje. Öğe URL'leri dahil her istekte zorunludur.

pageisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

per_pageisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

qisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

statusisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

store_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

vendor_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

asset_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

fromisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

toisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/marketplace/invoices/YOUR_INVOICE_ID/payments?project_id=YOUR_PROJECT_ID" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "data": {}
}

Yanıt alanları

dataobject
Kullanım notları
  • marketplace.read gerektirir. Yanıt örnekleri seçili alanları gösterir; saklanan kanıtların tamamı için kaynağı GET ile al.
  • Her POST kalıcı saklanan 16–128 karakterlik Idempotency-Key gerektirir (harf, rakam, -, _ veya .). Zaman aşımından sonra aynı anahtarı ve JSON talimatlarını yeniden kullan. Farklı talimatlar 409 döndürür. Tamamlanmış yanıtlar 30 gün tutulur; eski anahtarlar yeniden kullanılamayan iptal kayıtlarına dönüşür. Belirsiz sonucu aşmak için anahtarı asla değiştirme.
  • Anahtarların proje listeleri, isteğe bağlı fatura mağazası kısıtlamaları, sona erme zamanı, IP izin listesi ve 1–600/dakika kotası (varsayılan 60) vardır. HTTP 429 Retry-After içerir. Mağazayla sınırlı anahtarlar satıcıları, proje bakiyelerini, hesap defterini, satıcı ödemelerini veya ayarları göremez. Harcama kimlik bilgilerini yalnızca güvenilir sunucularda tut; tarayıcılarda veya dağıtılan mobil uygulamalarda asla bulundurma.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETFatura tahsisleri/v1/marketplace/invoices/{invoice_id}/allocationsSalt okunur

Uygun tamamlanmadan sonra değiştirilemez pay/komisyon/hedef görüntüleri ve tam brüt, komisyon ve net atomik değerler.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MARKETPLACE_API_TOKEN
ParametreTür / konumKural
permissioncredential scopemarketplace.read

Sorgu parametreleri

project_idUUIDzorunlu

Yetkili proje. Öğe URL'leri dahil her istekte zorunludur.

pageisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

per_pageisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

qisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

statusisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

store_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

vendor_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

asset_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

fromisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

toisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/marketplace/invoices/YOUR_INVOICE_ID/allocations?project_id=YOUR_PROJECT_ID" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "data": {}
}

Yanıt alanları

dataobject
Kullanım notları
  • marketplace.read gerektirir. Yanıt örnekleri seçili alanları gösterir; saklanan kanıtların tamamı için kaynağı GET ile al.
  • Her POST kalıcı saklanan 16–128 karakterlik Idempotency-Key gerektirir (harf, rakam, -, _ veya .). Zaman aşımından sonra aynı anahtarı ve JSON talimatlarını yeniden kullan. Farklı talimatlar 409 döndürür. Tamamlanmış yanıtlar 30 gün tutulur; eski anahtarlar yeniden kullanılamayan iptal kayıtlarına dönüşür. Belirsiz sonucu aşmak için anahtarı asla değiştirme.
  • Anahtarların proje listeleri, isteğe bağlı fatura mağazası kısıtlamaları, sona erme zamanı, IP izin listesi ve 1–600/dakika kotası (varsayılan 60) vardır. HTTP 429 Retry-After içerir. Mağazayla sınırlı anahtarlar satıcıları, proje bakiyelerini, hesap defterini, satıcı ödemelerini veya ayarları göremez. Harcama kimlik bilgilerini yalnızca güvenilir sunucularda tut; tarayıcılarda veya dağıtılan mobil uygulamalarda asla bulundurma.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTÖdenmemiş faturayı iptal et/v1/marketplace/invoices/{invoice_id}/cancelOkuma ve yazma

Yalnızca ödenmemiş new veya expired fatura. Geç tahsilatlar inceleme için bekletilir. Revizyon, Pazaryeri fatura revizyonudur.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MARKETPLACE_API_TOKEN
Idempotency-Keyzorunlu16–128 harf, rakam, -, _ veya .; bu tam istekle birlikte sakla
ParametreTür / konumKural
permissioncredential scopeinvoices.write

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
# Keep this key and the exact body for retries; use a new key for each new operation.
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/marketplace/invoices/YOUR_INVOICE_ID/cancel" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Idempotency-Key: marketplace-request-1042' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "project_id": "YOUR_PROJECT_ID",
  "revision": 1
}'

İstek gövdesi

project_idUUIDzorunlu

Yetkili proje. Öğe URL'leri dahil her istekte zorunludur.

revision

1

Yanıt 200 application/json

Örnek yanıt
{
  "data": {}
}

Yanıt alanları

dataobject
Kullanım notları
  • invoices.write gerektirir. Yanıt örnekleri seçili alanları gösterir; saklanan kanıtların tamamı için kaynağı GET ile al.
  • Her POST kalıcı saklanan 16–128 karakterlik Idempotency-Key gerektirir (harf, rakam, -, _ veya .). Zaman aşımından sonra aynı anahtarı ve JSON talimatlarını yeniden kullan. Farklı talimatlar 409 döndürür. Tamamlanmış yanıtlar 30 gün tutulur; eski anahtarlar yeniden kullanılamayan iptal kayıtlarına dönüşür. Belirsiz sonucu aşmak için anahtarı asla değiştirme.
  • Anahtarların proje listeleri, isteğe bağlı fatura mağazası kısıtlamaları, sona erme zamanı, IP izin listesi ve 1–600/dakika kotası (varsayılan 60) vardır. HTTP 429 Retry-After içerir. Mağazayla sınırlı anahtarlar satıcıları, proje bakiyelerini, hesap defterini, satıcı ödemelerini veya ayarları göremez. Harcama kimlik bilgilerini yalnızca güvenilir sunucularda tut; tarayıcılarda veya dağıtılan mobil uygulamalarda asla bulundurma.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTTahsisleri beklet/v1/marketplace/invoices/{invoice_id}/allocations/holdOkuma ve yazma

Yükümlülükleri silmeden imzalanmamış tahsisleri beklet. İmzalı veya belirsiz satıcı ödemeleri izlenmeye devam eder.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MARKETPLACE_API_TOKEN
Idempotency-Keyzorunlu16–128 harf, rakam, -, _ veya .; bu tam istekle birlikte sakla
ParametreTür / konumKural
permissioncredential scopereconciliation.write

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
# Keep this key and the exact body for retries; use a new key for each new operation.
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/marketplace/invoices/YOUR_INVOICE_ID/allocations/hold" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Idempotency-Key: marketplace-request-1042' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "project_id": "YOUR_PROJECT_ID",
  "revision": 1,
  "reason": "Verify customer request"
}'

İstek gövdesi

project_idUUIDzorunlu

Yetkili proje. Öğe URL'leri dahil her istekte zorunludur.

revision

1

reason

"Verify customer request"

Yanıt 200 application/json

Örnek yanıt
{
  "data": {}
}

Yanıt alanları

dataobject
Kullanım notları
  • reconciliation.write gerektirir. Yanıt örnekleri seçili alanları gösterir; saklanan kanıtların tamamı için kaynağı GET ile al.
  • Her POST kalıcı saklanan 16–128 karakterlik Idempotency-Key gerektirir (harf, rakam, -, _ veya .). Zaman aşımından sonra aynı anahtarı ve JSON talimatlarını yeniden kullan. Farklı talimatlar 409 döndürür. Tamamlanmış yanıtlar 30 gün tutulur; eski anahtarlar yeniden kullanılamayan iptal kayıtlarına dönüşür. Belirsiz sonucu aşmak için anahtarı asla değiştirme.
  • Anahtarların proje listeleri, isteğe bağlı fatura mağazası kısıtlamaları, sona erme zamanı, IP izin listesi ve 1–600/dakika kotası (varsayılan 60) vardır. HTTP 429 Retry-After içerir. Mağazayla sınırlı anahtarlar satıcıları, proje bakiyelerini, hesap defterini, satıcı ödemelerini veya ayarları göremez. Harcama kimlik bilgilerini yalnızca güvenilir sunucularda tut; tarayıcılarda veya dağıtılan mobil uygulamalarda asla bulundurma.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTTahsisleri incele ve serbest bırak/v1/marketplace/invoices/{invoice_id}/allocations/releaseOkuma ve yazma

Fon karşılığını/kesinliği yeniden kontrol et. İsteğe bağlı approved_amount_atomic, tahsis sabitlenmeden önce daha küçük ve karşılığı tam bölüşümü açıkça kabul eder; alınmış fonları asla uydurmaz.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MARKETPLACE_API_TOKEN
Idempotency-Keyzorunlu16–128 harf, rakam, -, _ veya .; bu tam istekle birlikte sakla
ParametreTür / konumKural
permissioncredential scopereconciliation.write

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
# Keep this key and the exact body for retries; use a new key for each new operation.
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/marketplace/invoices/YOUR_INVOICE_ID/allocations/release" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Idempotency-Key: marketplace-request-1042' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "project_id": "YOUR_PROJECT_ID",
  "revision": 1,
  "reason": "Verified payment evidence"
}'

İstek gövdesi

project_idUUIDzorunlu

Yetkili proje. Öğe URL'leri dahil her istekte zorunludur.

revision

1

reason

"Verified payment evidence"

Yanıt 200 application/json

Örnek yanıt
{
  "data": {}
}

Yanıt alanları

dataobject
Kullanım notları
  • reconciliation.write gerektirir. Yanıt örnekleri seçili alanları gösterir; saklanan kanıtların tamamı için kaynağı GET ile al.
  • Her POST kalıcı saklanan 16–128 karakterlik Idempotency-Key gerektirir (harf, rakam, -, _ veya .). Zaman aşımından sonra aynı anahtarı ve JSON talimatlarını yeniden kullan. Farklı talimatlar 409 döndürür. Tamamlanmış yanıtlar 30 gün tutulur; eski anahtarlar yeniden kullanılamayan iptal kayıtlarına dönüşür. Belirsiz sonucu aşmak için anahtarı asla değiştirme.
  • Anahtarların proje listeleri, isteğe bağlı fatura mağazası kısıtlamaları, sona erme zamanı, IP izin listesi ve 1–600/dakika kotası (varsayılan 60) vardır. HTTP 429 Retry-After içerir. Mağazayla sınırlı anahtarlar satıcıları, proje bakiyelerini, hesap defterini, satıcı ödemelerini veya ayarları göremez. Harcama kimlik bilgilerini yalnızca güvenilir sunucularda tut; tarayıcılarda veya dağıtılan mobil uygulamalarda asla bulundurma.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTÖdenmemiş hedefi yeniden bağla/v1/marketplace/invoices/{invoice_id}/allocations/{allocation_id}/destinationOkuma ve yazma

Tahsis revizyonu gerekir. Yalnızca ayrılmamış/imzalanmamış iş ve ilk ağda aynı satıcı için ayrı onaylanmış sürüm. Denetlenir; imzalı iş değiştirilemez.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MARKETPLACE_API_TOKEN
Idempotency-Keyzorunlu16–128 harf, rakam, -, _ veya .; bu tam istekle birlikte sakla
ParametreTür / konumKural
permissioncredential scopereconciliation.write

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
# Keep this key and the exact body for retries; use a new key for each new operation.
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/marketplace/invoices/YOUR_INVOICE_ID/allocations/YOUR_ALLOCATION_ID/destination" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Idempotency-Key: marketplace-request-1042' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "project_id": "YOUR_PROJECT_ID",
  "revision": 1,
  "destination_id": "YOUR_DESTINATION_ID",
  "reason": "Vendor verified replacement address"
}'

İstek gövdesi

project_idUUIDzorunlu

Yetkili proje. Öğe URL'leri dahil her istekte zorunludur.

revision

1

destination_id

"YOUR_DESTINATION_ID"

reason

"Vendor verified replacement address"

Yanıt 200 application/json

Örnek yanıt
{
  "data": {}
}

Yanıt alanları

dataobject
Kullanım notları
  • reconciliation.write gerektirir. Yanıt örnekleri seçili alanları gösterir; saklanan kanıtların tamamı için kaynağı GET ile al.
  • Her POST kalıcı saklanan 16–128 karakterlik Idempotency-Key gerektirir (harf, rakam, -, _ veya .). Zaman aşımından sonra aynı anahtarı ve JSON talimatlarını yeniden kullan. Farklı talimatlar 409 döndürür. Tamamlanmış yanıtlar 30 gün tutulur; eski anahtarlar yeniden kullanılamayan iptal kayıtlarına dönüşür. Belirsiz sonucu aşmak için anahtarı asla değiştirme.
  • Anahtarların proje listeleri, isteğe bağlı fatura mağazası kısıtlamaları, sona erme zamanı, IP izin listesi ve 1–600/dakika kotası (varsayılan 60) vardır. HTTP 429 Retry-After içerir. Mağazayla sınırlı anahtarlar satıcıları, proje bakiyelerini, hesap defterini, satıcı ödemelerini veya ayarları göremez. Harcama kimlik bilgilerini yalnızca güvenilir sunucularda tut; tarayıcılarda veya dağıtılan mobil uygulamalarda asla bulundurma.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTTam iade hazırla/v1/marketplace/invoices/{invoice_id}/refundOkuma ve yazma

Alınan tutarın aynı varlıkla, ayrı onaylanacak tam iadesini hazırla. Satıcı ödemesinden önce ödenmemiş fonları ayır ve onayda komisyonu geri al. Tüm satıcı ödemelerinden sonra ayrı serbest birincil adres fonlarını kullan. Müşteri iade adresini asla gönderen adresinden çıkarma.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MARKETPLACE_API_TOKEN
Idempotency-Keyzorunlu16–128 harf, rakam, -, _ veya .; bu tam istekle birlikte sakla
ParametreTür / konumKural
permissioncredential scopereconciliation.write

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
# Keep this key and the exact body for retries; use a new key for each new operation.
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/marketplace/invoices/YOUR_INVOICE_ID/refund" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Idempotency-Key: marketplace-request-1042' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "project_id": "YOUR_PROJECT_ID",
  "revision": 1,
  "payment_method_id": "YOUR_PAYMENT_METHOD_ID",
  "destination_address": "VERIFIED_CUSTOMER_REFUND_ADDRESS",
  "reason": "Customer cancellation",
  "maximum_network_fee_atomic": "10000",
  "maximum_gas_funding_atomic": "0",
  "fee_tier": "medium"
}'

İstek gövdesi

project_idUUIDzorunlu

Yetkili proje. Öğe URL'leri dahil her istekte zorunludur.

revision

1

payment_method_id

"YOUR_PAYMENT_METHOD_ID"

destination_address

"VERIFIED_CUSTOMER_REFUND_ADDRESS"

reason

"Customer cancellation"

maximum_network_fee_atomic

"10000"

maximum_gas_funding_atomic

"0"

fee_tier

"medium"

Yanıt 200 application/json

Örnek yanıt
{
  "data": {}
}

Yanıt alanları

dataobject
Kullanım notları
  • reconciliation.write gerektirir. Yanıt örnekleri seçili alanları gösterir; saklanan kanıtların tamamı için kaynağı GET ile al.
  • Her POST kalıcı saklanan 16–128 karakterlik Idempotency-Key gerektirir (harf, rakam, -, _ veya .). Zaman aşımından sonra aynı anahtarı ve JSON talimatlarını yeniden kullan. Farklı talimatlar 409 döndürür. Tamamlanmış yanıtlar 30 gün tutulur; eski anahtarlar yeniden kullanılamayan iptal kayıtlarına dönüşür. Belirsiz sonucu aşmak için anahtarı asla değiştirme.
  • Anahtarların proje listeleri, isteğe bağlı fatura mağazası kısıtlamaları, sona erme zamanı, IP izin listesi ve 1–600/dakika kotası (varsayılan 60) vardır. HTTP 429 Retry-After içerir. Mağazayla sınırlı anahtarlar satıcıları, proje bakiyelerini, hesap defterini, satıcı ödemelerini veya ayarları göremez. Harcama kimlik bilgilerini yalnızca güvenilir sunucularda tut; tarayıcılarda veya dağıtılan mobil uygulamalarda asla bulundurma.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETÖdeme tahsislerini bul/v1/marketplace/allocationsSalt okunur

Sayfalanmış adaylar; status (available vb.), asset_id, vendor_id, store_id ve q (satıcı/sipariş/fatura) ile filtrele.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MARKETPLACE_API_TOKEN
ParametreTür / konumKural
permissioncredential scopemarketplace.read

Sorgu parametreleri

project_idUUIDzorunlu

Yetkili proje. Öğe URL'leri dahil her istekte zorunludur.

pageisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

per_pageisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

qisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

statusisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

store_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

vendor_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

asset_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

fromisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

toisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/marketplace/allocations?project_id=YOUR_PROJECT_ID" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "data": [],
  "pagination": {
    "page": 1,
    "per_page": 25,
    "total": 0,
    "pages": 1
  }
}

Yanıt alanları

data[]array
paginationobject
pageinteger
per_pageinteger
totalinteger
pagesinteger
Kullanım notları
  • marketplace.read gerektirir. Yanıt örnekleri seçili alanları gösterir; saklanan kanıtların tamamı için kaynağı GET ile al.
  • Her POST kalıcı saklanan 16–128 karakterlik Idempotency-Key gerektirir (harf, rakam, -, _ veya .). Zaman aşımından sonra aynı anahtarı ve JSON talimatlarını yeniden kullan. Farklı talimatlar 409 döndürür. Tamamlanmış yanıtlar 30 gün tutulur; eski anahtarlar yeniden kullanılamayan iptal kayıtlarına dönüşür. Belirsiz sonucu aşmak için anahtarı asla değiştirme.
  • Anahtarların proje listeleri, isteğe bağlı fatura mağazası kısıtlamaları, sona erme zamanı, IP izin listesi ve 1–600/dakika kotası (varsayılan 60) vardır. HTTP 429 Retry-After içerir. Mağazayla sınırlı anahtarlar satıcıları, proje bakiyelerini, hesap defterini, satıcı ödemelerini veya ayarları göremez. Harcama kimlik bilgilerini yalnızca güvenilir sunucularda tut; tarayıcılarda veya dağıtılan mobil uygulamalarda asla bulundurma.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETProje hesap defteri bakiyeleri/v1/marketplace/balancesSalt okunur

Bekletilen, kullanılabilir, ayrılmış, ödenmiş tutarlar, komisyon, iadeler ve ağ ücretleri dahil tam gruplanmış varlık/hesap toplamları. Harici dengeleme hesabı hariçtir.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MARKETPLACE_API_TOKEN
ParametreTür / konumKural
permissioncredential scopemarketplace.read

Sorgu parametreleri

project_idUUIDzorunlu

Yetkili proje. Öğe URL'leri dahil her istekte zorunludur.

pageisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

per_pageisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

qisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

statusisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

store_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

vendor_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

asset_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

fromisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

toisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/marketplace/balances?project_id=YOUR_PROJECT_ID" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "data": {}
}

Yanıt alanları

dataobject
Kullanım notları
  • marketplace.read gerektirir. Yanıt örnekleri seçili alanları gösterir; saklanan kanıtların tamamı için kaynağı GET ile al.
  • Her POST kalıcı saklanan 16–128 karakterlik Idempotency-Key gerektirir (harf, rakam, -, _ veya .). Zaman aşımından sonra aynı anahtarı ve JSON talimatlarını yeniden kullan. Farklı talimatlar 409 döndürür. Tamamlanmış yanıtlar 30 gün tutulur; eski anahtarlar yeniden kullanılamayan iptal kayıtlarına dönüşür. Belirsiz sonucu aşmak için anahtarı asla değiştirme.
  • Anahtarların proje listeleri, isteğe bağlı fatura mağazası kısıtlamaları, sona erme zamanı, IP izin listesi ve 1–600/dakika kotası (varsayılan 60) vardır. HTTP 429 Retry-After içerir. Mağazayla sınırlı anahtarlar satıcıları, proje bakiyelerini, hesap defterini, satıcı ödemelerini veya ayarları göremez. Harcama kimlik bilgilerini yalnızca güvenilir sunucularda tut; tarayıcılarda veya dağıtılan mobil uygulamalarda asla bulundurma.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETDeğiştirilemez yevmiye/v1/marketplace/ledgerSalt okunur

Yalnızca eklenebilen sayfalanmış hareketler; q referans/hesap, asset_id ve vendor_id filtreleri. Tutarlar atomik dizeler kullanır; hiçbir kayıt düzenlenemez veya elle ödendi olarak işaretlenemez.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MARKETPLACE_API_TOKEN
ParametreTür / konumKural
permissioncredential scopemarketplace.read

Sorgu parametreleri

project_idUUIDzorunlu

Yetkili proje. Öğe URL'leri dahil her istekte zorunludur.

pageisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

per_pageisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

qisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

statusisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

store_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

vendor_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

asset_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

fromisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

toisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/marketplace/ledger?project_id=YOUR_PROJECT_ID" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "data": [],
  "pagination": {
    "page": 1,
    "per_page": 25,
    "total": 0,
    "pages": 1
  }
}

Yanıt alanları

data[]array
paginationobject
pageinteger
per_pageinteger
totalinteger
pagesinteger
Kullanım notları
  • marketplace.read gerektirir. Yanıt örnekleri seçili alanları gösterir; saklanan kanıtların tamamı için kaynağı GET ile al.
  • Her POST kalıcı saklanan 16–128 karakterlik Idempotency-Key gerektirir (harf, rakam, -, _ veya .). Zaman aşımından sonra aynı anahtarı ve JSON talimatlarını yeniden kullan. Farklı talimatlar 409 döndürür. Tamamlanmış yanıtlar 30 gün tutulur; eski anahtarlar yeniden kullanılamayan iptal kayıtlarına dönüşür. Belirsiz sonucu aşmak için anahtarı asla değiştirme.
  • Anahtarların proje listeleri, isteğe bağlı fatura mağazası kısıtlamaları, sona erme zamanı, IP izin listesi ve 1–600/dakika kotası (varsayılan 60) vardır. HTTP 429 Retry-After içerir. Mağazayla sınırlı anahtarlar satıcıları, proje bakiyelerini, hesap defterini, satıcı ödemelerini veya ayarları göremez. Harcama kimlik bilgilerini yalnızca güvenilir sunucularda tut; tarayıcılarda veya dağıtılan mobil uygulamalarda asla bulundurma.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETSatıcı ödemesi geçmişi/v1/marketplace/payoutsSalt okunur

Sayfalanmış üst kayıtlar; state, asset_id, vendor_id veya q kimlik/sembol ile filtrele. Ödendi, yalnızca ağa yayınlanmayı değil, bağımsız onayı ifade eder.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MARKETPLACE_API_TOKEN
ParametreTür / konumKural
permissioncredential scopemarketplace.read

Sorgu parametreleri

project_idUUIDzorunlu

Yetkili proje. Öğe URL'leri dahil her istekte zorunludur.

pageisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

per_pageisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

qisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

statusisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

store_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

vendor_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

asset_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

fromisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

toisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/marketplace/payouts?project_id=YOUR_PROJECT_ID" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "data": [],
  "pagination": {
    "page": 1,
    "per_page": 25,
    "total": 0,
    "pages": 1
  }
}

Yanıt alanları

data[]array
paginationobject
pageinteger
per_pageinteger
totalinteger
pagesinteger
Kullanım notları
  • marketplace.read gerektirir. Yanıt örnekleri seçili alanları gösterir; saklanan kanıtların tamamı için kaynağı GET ile al.
  • Her POST kalıcı saklanan 16–128 karakterlik Idempotency-Key gerektirir (harf, rakam, -, _ veya .). Zaman aşımından sonra aynı anahtarı ve JSON talimatlarını yeniden kullan. Farklı talimatlar 409 döndürür. Tamamlanmış yanıtlar 30 gün tutulur; eski anahtarlar yeniden kullanılamayan iptal kayıtlarına dönüşür. Belirsiz sonucu aşmak için anahtarı asla değiştirme.
  • Anahtarların proje listeleri, isteğe bağlı fatura mağazası kısıtlamaları, sona erme zamanı, IP izin listesi ve 1–600/dakika kotası (varsayılan 60) vardır. HTTP 429 Retry-After içerir. Mağazayla sınırlı anahtarlar satıcıları, proje bakiyelerini, hesap defterini, satıcı ödemelerini veya ayarları göremez. Harcama kimlik bilgilerini yalnızca güvenilir sunucularda tut; tarayıcılarda veya dağıtılan mobil uygulamalarda asla bulundurma.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTTahsis planını önizle/v1/marketplace/payouts/previewOkuma ve yazma

Salt okunur muhasebe planı; fon ayırma veya harcama yetkisi vermez. Azami ücret tahmini gerçek ücret değil, kullanıcı sınırıdır. Hazırlık sonradan canlı kontroller yapar.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MARKETPLACE_API_TOKEN
Idempotency-Keyzorunlu16–128 harf, rakam, -, _ veya .; bu tam istekle birlikte sakla
ParametreTür / konumKural
permissioncredential scopepayouts.write

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
# Keep this key and the exact body for retries; use a new key for each new operation.
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/marketplace/payouts/preview" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Idempotency-Key: marketplace-request-1042' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "project_id": "YOUR_PROJECT_ID",
  "allocation_ids": [
    "YOUR_ALLOCATION_ID"
  ],
  "maximum_network_fee_atomic": "10000",
  "maximum_gas_funding_atomic": "0",
  "fee_tier": "medium"
}'

İstek gövdesi

project_idUUIDzorunlu

Yetkili proje. Öğe URL'leri dahil her istekte zorunludur.

allocation_ids[]

["YOUR_ALLOCATION_ID"]

maximum_network_fee_atomic

"10000"

maximum_gas_funding_atomic

"0"

fee_tier

"medium"

Yanıt 200 application/json

Örnek yanıt
{
  "data": {}
}

Yanıt alanları

dataobject
Kullanım notları
  • payouts.write gerektirir. Yanıt örnekleri seçili alanları gösterir; saklanan kanıtların tamamı için kaynağı GET ile al.
  • Her POST kalıcı saklanan 16–128 karakterlik Idempotency-Key gerektirir (harf, rakam, -, _ veya .). Zaman aşımından sonra aynı anahtarı ve JSON talimatlarını yeniden kullan. Farklı talimatlar 409 döndürür. Tamamlanmış yanıtlar 30 gün tutulur; eski anahtarlar yeniden kullanılamayan iptal kayıtlarına dönüşür. Belirsiz sonucu aşmak için anahtarı asla değiştirme.
  • Anahtarların proje listeleri, isteğe bağlı fatura mağazası kısıtlamaları, sona erme zamanı, IP izin listesi ve 1–600/dakika kotası (varsayılan 60) vardır. HTTP 429 Retry-After içerir. Mağazayla sınırlı anahtarlar satıcıları, proje bakiyelerini, hesap defterini, satıcı ödemelerini veya ayarları göremez. Harcama kimlik bilgilerini yalnızca güvenilir sunucularda tut; tarayıcılarda veya dağıtılan mobil uygulamalarda asla bulundurma.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTSatıcı ödemesi hazırla/v1/marketplace/payoutsOkuma ve yazma

Tek varlık/cüzdanda kullanılabilir 1–100 tahsis kimliğini ayır. BTC, seçilen her faturanın tüm ödenmemiş paylarını tek çok çıktılı grupta gerektirir. Bütçeler yerel ücret varlığında atomik dizelerdir. awaiting_approval planı oluşturur; ağa yayınlamaz.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MARKETPLACE_API_TOKEN
Idempotency-Keyzorunlu16–128 harf, rakam, -, _ veya .; bu tam istekle birlikte sakla
ParametreTür / konumKural
permissioncredential scopepayouts.write

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
# Keep this key and the exact body for retries; use a new key for each new operation.
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/marketplace/payouts" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Idempotency-Key: marketplace-request-1042' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "project_id": "YOUR_PROJECT_ID",
  "allocation_ids": [
    "YOUR_ALLOCATION_ID"
  ],
  "maximum_network_fee_atomic": "10000",
  "maximum_gas_funding_atomic": "0",
  "fee_tier": "medium"
}'

İstek gövdesi

project_idUUIDzorunlu

Yetkili proje. Öğe URL'leri dahil her istekte zorunludur.

allocation_ids[]

["YOUR_ALLOCATION_ID"]

maximum_network_fee_atomic

"10000"

maximum_gas_funding_atomic

"0"

fee_tier

"medium"

Yanıt 200 application/json

Örnek yanıt
{
  "data": {
    "id": "YOUR_PAYOUT_ID",
    "state": "awaiting_approval",
    "revision": 1,
    "plan_hash": "RETAINED_PLAN_HASH",
    "plan": {
      "amount_atomic": "28800000",
      "maximum_network_fee_atomic": "10000",
      "maximum_gas_funding_atomic": "0",
      "items": []
    },
    "transactions": []
  }
}

Yanıt alanları

dataobject
idstring
statestring
revisioninteger
plan_hashstring
planobject
amount_atomicstring
maximum_network_fee_atomicstring
maximum_gas_funding_atomicstring
items[]array
transactions[]array
Kullanım notları
  • payouts.write gerektirir. Yanıt örnekleri seçili alanları gösterir; saklanan kanıtların tamamı için kaynağı GET ile al.
  • Her POST kalıcı saklanan 16–128 karakterlik Idempotency-Key gerektirir (harf, rakam, -, _ veya .). Zaman aşımından sonra aynı anahtarı ve JSON talimatlarını yeniden kullan. Farklı talimatlar 409 döndürür. Tamamlanmış yanıtlar 30 gün tutulur; eski anahtarlar yeniden kullanılamayan iptal kayıtlarına dönüşür. Belirsiz sonucu aşmak için anahtarı asla değiştirme.
  • Anahtarların proje listeleri, isteğe bağlı fatura mağazası kısıtlamaları, sona erme zamanı, IP izin listesi ve 1–600/dakika kotası (varsayılan 60) vardır. HTTP 429 Retry-After içerir. Mağazayla sınırlı anahtarlar satıcıları, proje bakiyelerini, hesap defterini, satıcı ödemelerini veya ayarları göremez. Harcama kimlik bilgilerini yalnızca güvenilir sunucularda tut; tarayıcılarda veya dağıtılan mobil uygulamalarda asla bulundurma.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETSatıcı ödemesi ayrıntıları/v1/marketplace/payouts/{payout_id}Salt okunur

Değiştirilemez plan/hash, revizyon, sona erme, alıcı öğeleri, korunan alt denemeler, ilerleme, tam ücretler ve gezgin bağlantıları. Asla özel anahtar veya imzalı bayt içermez.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MARKETPLACE_API_TOKEN
ParametreTür / konumKural
permissioncredential scopemarketplace.read

Sorgu parametreleri

project_idUUIDzorunlu

Yetkili proje. Öğe URL'leri dahil her istekte zorunludur.

pageisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

per_pageisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

qisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

statusisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

store_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

vendor_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

asset_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

fromisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

toisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/marketplace/payouts/YOUR_PAYOUT_ID?project_id=YOUR_PROJECT_ID" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "data": {
    "id": "YOUR_PAYOUT_ID",
    "state": "awaiting_approval",
    "revision": 1,
    "plan_hash": "RETAINED_PLAN_HASH",
    "plan": {
      "amount_atomic": "28800000",
      "maximum_network_fee_atomic": "10000",
      "maximum_gas_funding_atomic": "0",
      "items": []
    },
    "transactions": []
  }
}

Yanıt alanları

dataobject
idstring
statestring
revisioninteger
plan_hashstring
planobject
amount_atomicstring
maximum_network_fee_atomicstring
maximum_gas_funding_atomicstring
items[]array
transactions[]array
Kullanım notları
  • marketplace.read gerektirir. Yanıt örnekleri seçili alanları gösterir; saklanan kanıtların tamamı için kaynağı GET ile al.
  • Her POST kalıcı saklanan 16–128 karakterlik Idempotency-Key gerektirir (harf, rakam, -, _ veya .). Zaman aşımından sonra aynı anahtarı ve JSON talimatlarını yeniden kullan. Farklı talimatlar 409 döndürür. Tamamlanmış yanıtlar 30 gün tutulur; eski anahtarlar yeniden kullanılamayan iptal kayıtlarına dönüşür. Belirsiz sonucu aşmak için anahtarı asla değiştirme.
  • Anahtarların proje listeleri, isteğe bağlı fatura mağazası kısıtlamaları, sona erme zamanı, IP izin listesi ve 1–600/dakika kotası (varsayılan 60) vardır. HTTP 429 Retry-After içerir. Mağazayla sınırlı anahtarlar satıcıları, proje bakiyelerini, hesap defterini, satıcı ödemelerini veya ayarları göremez. Harcama kimlik bilgilerini yalnızca güvenilir sunucularda tut; tarayıcılarda veya dağıtılan mobil uygulamalarda asla bulundurma.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTOnayla ve gönder/v1/marketplace/payouts/{payout_id}/approveOkuma ve yazma

Saklanan tam plana süresi içinde açıkça yetki ver. Sınırlandırılmış gas fonlaması ve satıcı işlemlerini arka planda kuyruğa al.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MARKETPLACE_API_TOKEN
Idempotency-Keyzorunlu16–128 harf, rakam, -, _ veya .; bu tam istekle birlikte sakla
ParametreTür / konumKural
permissioncredential scopepayouts.approve

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
# Keep this key and the exact body for retries; use a new key for each new operation.
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/marketplace/payouts/YOUR_PAYOUT_ID/approve" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Idempotency-Key: marketplace-request-1042' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "project_id": "YOUR_PROJECT_ID",
  "revision": 1,
  "expected_plan_hash": "COPY_EXACT_PLAN_HASH_FROM_PREPARE",
  "confirm": true
}'

İstek gövdesi

project_idUUIDzorunlu

Yetkili proje. Öğe URL'leri dahil her istekte zorunludur.

revision

1

expected_plan_hash

"COPY_EXACT_PLAN_HASH_FROM_PREPARE"

confirm

true

Yanıt 200 application/json

Örnek yanıt
{
  "data": {}
}

Yanıt alanları

dataobject
Kullanım notları
  • payouts.approve gerektirir. Yanıt örnekleri seçili alanları gösterir; saklanan kanıtların tamamı için kaynağı GET ile al.
  • Her POST kalıcı saklanan 16–128 karakterlik Idempotency-Key gerektirir (harf, rakam, -, _ veya .). Zaman aşımından sonra aynı anahtarı ve JSON talimatlarını yeniden kullan. Farklı talimatlar 409 döndürür. Tamamlanmış yanıtlar 30 gün tutulur; eski anahtarlar yeniden kullanılamayan iptal kayıtlarına dönüşür. Belirsiz sonucu aşmak için anahtarı asla değiştirme.
  • Anahtarların proje listeleri, isteğe bağlı fatura mağazası kısıtlamaları, sona erme zamanı, IP izin listesi ve 1–600/dakika kotası (varsayılan 60) vardır. HTTP 429 Retry-After içerir. Mağazayla sınırlı anahtarlar satıcıları, proje bakiyelerini, hesap defterini, satıcı ödemelerini veya ayarları göremez. Harcama kimlik bilgilerini yalnızca güvenilir sunucularda tut; tarayıcılarda veya dağıtılan mobil uygulamalarda asla bulundurma.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTSatıcı ödemesini incele ve devam ettir/v1/marketplace/payouts/{payout_id}/resumeOkuma ve yazma

Yalnızca needs_attention. Saklanan plan/hash'i yeniden kullan; onaylanmış alıcılara asla tekrar gönderilmez. Başarısız alt işlem değiştirilmeden önce iki bağımsız sağlayıcı, kanonik ve yeterince onaylanmış EVM revert'ini kanıtlamalıdır. Önceki ücretler onaylı bütçeden sayılmaya devam eder ve tüm hash'ler geçmişte kalır. Bilinmeyen/kısmi token teslimi payout_recovery_unverified döndürür; rezervasyonlar tutulur.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MARKETPLACE_API_TOKEN
Idempotency-Keyzorunlu16–128 harf, rakam, -, _ veya .; bu tam istekle birlikte sakla
ParametreTür / konumKural
permissioncredential scopepayouts.approve

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
# Keep this key and the exact body for retries; use a new key for each new operation.
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/marketplace/payouts/YOUR_PAYOUT_ID/resume" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Idempotency-Key: marketplace-request-1042' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "project_id": "YOUR_PROJECT_ID",
  "revision": 1,
  "expected_plan_hash": "COPY_EXACT_PLAN_HASH_FROM_PREPARE",
  "confirm": true
}'

İstek gövdesi

project_idUUIDzorunlu

Yetkili proje. Öğe URL'leri dahil her istekte zorunludur.

revision

1

expected_plan_hash

"COPY_EXACT_PLAN_HASH_FROM_PREPARE"

confirm

true

Yanıt 200 application/json

Örnek yanıt
{
  "data": {}
}

Yanıt alanları

dataobject
Kullanım notları
  • payouts.approve gerektirir. Yanıt örnekleri seçili alanları gösterir; saklanan kanıtların tamamı için kaynağı GET ile al.
  • Her POST kalıcı saklanan 16–128 karakterlik Idempotency-Key gerektirir (harf, rakam, -, _ veya .). Zaman aşımından sonra aynı anahtarı ve JSON talimatlarını yeniden kullan. Farklı talimatlar 409 döndürür. Tamamlanmış yanıtlar 30 gün tutulur; eski anahtarlar yeniden kullanılamayan iptal kayıtlarına dönüşür. Belirsiz sonucu aşmak için anahtarı asla değiştirme.
  • Anahtarların proje listeleri, isteğe bağlı fatura mağazası kısıtlamaları, sona erme zamanı, IP izin listesi ve 1–600/dakika kotası (varsayılan 60) vardır. HTTP 429 Retry-After içerir. Mağazayla sınırlı anahtarlar satıcıları, proje bakiyelerini, hesap defterini, satıcı ödemelerini veya ayarları göremez. Harcama kimlik bilgilerini yalnızca güvenilir sunucularda tut; tarayıcılarda veya dağıtılan mobil uygulamalarda asla bulundurma.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTİmzalanmamış işi iptal et/v1/marketplace/payouts/{payout_id}/cancelOkuma ve yazma

Yalnızca güvenle imzasız/iletilmemiş olduğu bilinen rezervasyonları serbest bırak. Onaylanmış alıcılar ve denetim kaydı kalır. İmzalı/belirsiz iş iptal edilemez. Açık kurtarma işlemiyle doğrulanmış revert, kalan imzasız işin iptalini artık engellemez.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MARKETPLACE_API_TOKEN
Idempotency-Keyzorunlu16–128 harf, rakam, -, _ veya .; bu tam istekle birlikte sakla
ParametreTür / konumKural
permissioncredential scopepayouts.write

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
# Keep this key and the exact body for retries; use a new key for each new operation.
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/marketplace/payouts/YOUR_PAYOUT_ID/cancel" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Idempotency-Key: marketplace-request-1042' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "project_id": "YOUR_PROJECT_ID",
  "revision": 1
}'

İstek gövdesi

project_idUUIDzorunlu

Yetkili proje. Öğe URL'leri dahil her istekte zorunludur.

revision

1

Yanıt 200 application/json

Örnek yanıt
{
  "data": {}
}

Yanıt alanları

dataobject
Kullanım notları
  • payouts.write gerektirir. Yanıt örnekleri seçili alanları gösterir; saklanan kanıtların tamamı için kaynağı GET ile al.
  • Her POST kalıcı saklanan 16–128 karakterlik Idempotency-Key gerektirir (harf, rakam, -, _ veya .). Zaman aşımından sonra aynı anahtarı ve JSON talimatlarını yeniden kullan. Farklı talimatlar 409 döndürür. Tamamlanmış yanıtlar 30 gün tutulur; eski anahtarlar yeniden kullanılamayan iptal kayıtlarına dönüşür. Belirsiz sonucu aşmak için anahtarı asla değiştirme.
  • Anahtarların proje listeleri, isteğe bağlı fatura mağazası kısıtlamaları, sona erme zamanı, IP izin listesi ve 1–600/dakika kotası (varsayılan 60) vardır. HTTP 429 Retry-After içerir. Mağazayla sınırlı anahtarlar satıcıları, proje bakiyelerini, hesap defterini, satıcı ödemelerini veya ayarları göremez. Harcama kimlik bilgilerini yalnızca güvenilir sunucularda tut; tarayıcılarda veya dağıtılan mobil uygulamalarda asla bulundurma.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETOtomatik satıcı ödemesi politikaları/v1/marketplace/policiesSalt okunur

Hazırlık veya yetkilendirme ilgilenme gerektiriyorsa varlık başına politikaları, revision, next_attempt_at, last_checked_at ve güvenli last_error alanını oku.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MARKETPLACE_API_TOKEN
ParametreTür / konumKural
permissioncredential scopemarketplace.read

Sorgu parametreleri

project_idUUIDzorunlu

Yetkili proje. Öğe URL'leri dahil her istekte zorunludur.

pageisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

per_pageisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

qisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

statusisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

store_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

vendor_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

asset_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

fromisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

toisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/marketplace/policies?project_id=YOUR_PROJECT_ID" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "data": []
}

Yanıt alanları

data[]array
Kullanım notları
  • marketplace.read gerektirir. Yanıt örnekleri seçili alanları gösterir; saklanan kanıtların tamamı için kaynağı GET ile al.
  • Her POST kalıcı saklanan 16–128 karakterlik Idempotency-Key gerektirir (harf, rakam, -, _ veya .). Zaman aşımından sonra aynı anahtarı ve JSON talimatlarını yeniden kullan. Farklı talimatlar 409 döndürür. Tamamlanmış yanıtlar 30 gün tutulur; eski anahtarlar yeniden kullanılamayan iptal kayıtlarına dönüşür. Belirsiz sonucu aşmak için anahtarı asla değiştirme.
  • Anahtarların proje listeleri, isteğe bağlı fatura mağazası kısıtlamaları, sona erme zamanı, IP izin listesi ve 1–600/dakika kotası (varsayılan 60) vardır. HTTP 429 Retry-After içerir. Mağazayla sınırlı anahtarlar satıcıları, proje bakiyelerini, hesap defterini, satıcı ödemelerini veya ayarları göremez. Harcama kimlik bilgilerini yalnızca güvenilir sunucularda tut; tarayıcılarda veya dağıtılan mobil uygulamalarda asla bulundurma.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTSatıcı ödemesi politikasını yetkilendir/v1/marketplace/policiesOkuma ve yazma

Tam atomik dizeler; minimum <= transfer <= günlük anapara, ücret/gas sınırları <= ilgili günlük bütçeleri. interval_seconds 60–604800; minimum_confirmations zincir alt sınırına tabi 1–100000. Revision 0 oluşturur. Etkin politikalar başka tıklama olmadan gönderim yapabilir; incelenene kadar false tut.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MARKETPLACE_API_TOKEN
Idempotency-Keyzorunlu16–128 harf, rakam, -, _ veya .; bu tam istekle birlikte sakla
ParametreTür / konumKural
permissioncredential scopepolicies.write

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
# Keep this key and the exact body for retries; use a new key for each new operation.
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/marketplace/policies" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Idempotency-Key: marketplace-request-1042' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "project_id": "YOUR_PROJECT_ID",
  "asset_id": "YOUR_ASSET_ID",
  "revision": 0,
  "enabled": false,
  "minimum_atomic": "100000",
  "transfer_limit_atomic": "10000000",
  "daily_limit_atomic": "30000000",
  "fee_limit_atomic": "10000",
  "daily_fee_limit_atomic": "30000",
  "gas_limit_atomic": "0",
  "daily_gas_limit_atomic": "0",
  "interval_seconds": 3600,
  "minimum_confirmations": 2
}'

İstek gövdesi

project_idUUIDzorunlu

Yetkili proje. Öğe URL'leri dahil her istekte zorunludur.

asset_id

"YOUR_ASSET_ID"

revision

0

enabled

false

minimum_atomic

"100000"

transfer_limit_atomic

"10000000"

daily_limit_atomic

"30000000"

fee_limit_atomic

"10000"

daily_fee_limit_atomic

"30000"

gas_limit_atomic

"0"

daily_gas_limit_atomic

"0"

interval_seconds

3600

minimum_confirmations

2

Yanıt 200 application/json

Örnek yanıt
{
  "data": {}
}

Yanıt alanları

dataobject
Kullanım notları
  • policies.write gerektirir. Yanıt örnekleri seçili alanları gösterir; saklanan kanıtların tamamı için kaynağı GET ile al.
  • Her POST kalıcı saklanan 16–128 karakterlik Idempotency-Key gerektirir (harf, rakam, -, _ veya .). Zaman aşımından sonra aynı anahtarı ve JSON talimatlarını yeniden kullan. Farklı talimatlar 409 döndürür. Tamamlanmış yanıtlar 30 gün tutulur; eski anahtarlar yeniden kullanılamayan iptal kayıtlarına dönüşür. Belirsiz sonucu aşmak için anahtarı asla değiştirme.
  • Anahtarların proje listeleri, isteğe bağlı fatura mağazası kısıtlamaları, sona erme zamanı, IP izin listesi ve 1–600/dakika kotası (varsayılan 60) vardır. HTTP 429 Retry-After içerir. Mağazayla sınırlı anahtarlar satıcıları, proje bakiyelerini, hesap defterini, satıcı ödemelerini veya ayarları göremez. Harcama kimlik bilgilerini yalnızca güvenilir sunucularda tut; tarayıcılarda veya dağıtılan mobil uygulamalarda asla bulundurma.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETPazaryeri webhook'ları/v1/marketplace/webhooksSalt okunur

En fazla 20 uç nokta ve desteklenen event_types. Şifrelenmiş veya düz metin imzalama sırlarını asla döndürmez.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MARKETPLACE_API_TOKEN
ParametreTür / konumKural
permissioncredential scopemarketplace.read

Sorgu parametreleri

project_idUUIDzorunlu

Yetkili proje. Öğe URL'leri dahil her istekte zorunludur.

pageisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

per_pageisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

qisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

statusisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

store_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

vendor_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

asset_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

fromisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

toisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/marketplace/webhooks?project_id=YOUR_PROJECT_ID" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "data": {
    "endpoints": [],
    "event_types": [
      "marketplace.invoice.created",
      "marketplace.allocations.available",
      "marketplace.allocations.held",
      "marketplace.payout.approved",
      "marketplace.payout.broadcast",
      "marketplace.payout.confirmed",
      "marketplace.payout.partial",
      "marketplace.payout.failed",
      "marketplace.payout.cancelled",
      "marketplace.refund.prepared",
      "marketplace.refund.confirmed"
    ]
  }
}

Yanıt alanları

dataobject
endpoints[]array
event_types[]array
Kullanım notları
  • marketplace.read gerektirir. Yanıt örnekleri seçili alanları gösterir; saklanan kanıtların tamamı için kaynağı GET ile al.
  • Her POST kalıcı saklanan 16–128 karakterlik Idempotency-Key gerektirir (harf, rakam, -, _ veya .). Zaman aşımından sonra aynı anahtarı ve JSON talimatlarını yeniden kullan. Farklı talimatlar 409 döndürür. Tamamlanmış yanıtlar 30 gün tutulur; eski anahtarlar yeniden kullanılamayan iptal kayıtlarına dönüşür. Belirsiz sonucu aşmak için anahtarı asla değiştirme.
  • Anahtarların proje listeleri, isteğe bağlı fatura mağazası kısıtlamaları, sona erme zamanı, IP izin listesi ve 1–600/dakika kotası (varsayılan 60) vardır. HTTP 429 Retry-After içerir. Mağazayla sınırlı anahtarlar satıcıları, proje bakiyelerini, hesap defterini, satıcı ödemelerini veya ayarları göremez. Harcama kimlik bilgilerini yalnızca güvenilir sunucularda tut; tarayıcılarda veya dağıtılan mobil uygulamalarda asla bulundurma.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTPazaryeri webhook'u oluştur/v1/marketplace/webhooksOkuma ve yazma

Yalnızca herkese açık HTTPS; kimlik bilgisi, özel hedef veya yönlendirme yok. Saklanan idempotent oluşturma yanıtı başına signing_secret bir kez döndürülür; güvenle sakla. Mağaza IPN sırrından ayrıdır.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MARKETPLACE_API_TOKEN
Idempotency-Keyzorunlu16–128 harf, rakam, -, _ veya .; bu tam istekle birlikte sakla
ParametreTür / konumKural
permissioncredential scopewebhooks.write

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
# Keep this key and the exact body for retries; use a new key for each new operation.
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/marketplace/webhooks" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Idempotency-Key: marketplace-request-1042' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "project_id": "YOUR_PROJECT_ID",
  "url": "https://shop.example.com/marketplace-events",
  "enabled": true,
  "events": [
    "marketplace.payout.confirmed",
    "marketplace.payout.failed"
  ]
}'

İstek gövdesi

project_idUUIDzorunlu

Yetkili proje. Öğe URL'leri dahil her istekte zorunludur.

url

"https://shop.example.com/marketplace-events"

enabled

true

events[]

["marketplace.payout.confirmed","marketplace.payout.failed"]

Yanıt 200 application/json

Örnek yanıt
{
  "data": {}
}

Yanıt alanları

dataobject
Kullanım notları
  • webhooks.write gerektirir. Yanıt örnekleri seçili alanları gösterir; saklanan kanıtların tamamı için kaynağı GET ile al.
  • Her POST kalıcı saklanan 16–128 karakterlik Idempotency-Key gerektirir (harf, rakam, -, _ veya .). Zaman aşımından sonra aynı anahtarı ve JSON talimatlarını yeniden kullan. Farklı talimatlar 409 döndürür. Tamamlanmış yanıtlar 30 gün tutulur; eski anahtarlar yeniden kullanılamayan iptal kayıtlarına dönüşür. Belirsiz sonucu aşmak için anahtarı asla değiştirme.
  • Anahtarların proje listeleri, isteğe bağlı fatura mağazası kısıtlamaları, sona erme zamanı, IP izin listesi ve 1–600/dakika kotası (varsayılan 60) vardır. HTTP 429 Retry-After içerir. Mağazayla sınırlı anahtarlar satıcıları, proje bakiyelerini, hesap defterini, satıcı ödemelerini veya ayarları göremez. Harcama kimlik bilgilerini yalnızca güvenilir sunucularda tut; tarayıcılarda veya dağıtılan mobil uygulamalarda asla bulundurma.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTPazaryeri webhook'unu güncelle/v1/marketplace/webhooks/{webhook_id}/updateOkuma ve yazma

Değişiklikler eski gönderilmemiş teslimleri iptal eder. Sır değişmez; eski değiştirilemez yükler yeni URL'ye asla yönlendirilmez.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MARKETPLACE_API_TOKEN
Idempotency-Keyzorunlu16–128 harf, rakam, -, _ veya .; bu tam istekle birlikte sakla
ParametreTür / konumKural
permissioncredential scopewebhooks.write

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
# Keep this key and the exact body for retries; use a new key for each new operation.
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/marketplace/webhooks/YOUR_WEBHOOK_ID/update" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Idempotency-Key: marketplace-request-1042' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "project_id": "YOUR_PROJECT_ID",
  "revision": 1,
  "url": "https://shop.example.com/marketplace-events",
  "enabled": true,
  "events": [
    "marketplace.payout.confirmed"
  ]
}'

İstek gövdesi

project_idUUIDzorunlu

Yetkili proje. Öğe URL'leri dahil her istekte zorunludur.

revision

1

url

"https://shop.example.com/marketplace-events"

enabled

true

events[]

["marketplace.payout.confirmed"]

Yanıt 200 application/json

Örnek yanıt
{
  "data": {}
}

Yanıt alanları

dataobject
Kullanım notları
  • webhooks.write gerektirir. Yanıt örnekleri seçili alanları gösterir; saklanan kanıtların tamamı için kaynağı GET ile al.
  • Her POST kalıcı saklanan 16–128 karakterlik Idempotency-Key gerektirir (harf, rakam, -, _ veya .). Zaman aşımından sonra aynı anahtarı ve JSON talimatlarını yeniden kullan. Farklı talimatlar 409 döndürür. Tamamlanmış yanıtlar 30 gün tutulur; eski anahtarlar yeniden kullanılamayan iptal kayıtlarına dönüşür. Belirsiz sonucu aşmak için anahtarı asla değiştirme.
  • Anahtarların proje listeleri, isteğe bağlı fatura mağazası kısıtlamaları, sona erme zamanı, IP izin listesi ve 1–600/dakika kotası (varsayılan 60) vardır. HTTP 429 Retry-After içerir. Mağazayla sınırlı anahtarlar satıcıları, proje bakiyelerini, hesap defterini, satıcı ödemelerini veya ayarları göremez. Harcama kimlik bilgilerini yalnızca güvenilir sunucularda tut; tarayıcılarda veya dağıtılan mobil uygulamalarda asla bulundurma.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTPazaryeri webhook'unu devre dışı bırak/v1/marketplace/webhooks/{webhook_id}/disableOkuma ve yazma

Yeni teslimleri durdur; saklanan olay geçmişi kalır.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MARKETPLACE_API_TOKEN
Idempotency-Keyzorunlu16–128 harf, rakam, -, _ veya .; bu tam istekle birlikte sakla
ParametreTür / konumKural
permissioncredential scopewebhooks.write

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
# Keep this key and the exact body for retries; use a new key for each new operation.
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/marketplace/webhooks/YOUR_WEBHOOK_ID/disable" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Idempotency-Key: marketplace-request-1042' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "project_id": "YOUR_PROJECT_ID",
  "revision": 1
}'

İstek gövdesi

project_idUUIDzorunlu

Yetkili proje. Öğe URL'leri dahil her istekte zorunludur.

revision

1

Yanıt 200 application/json

Örnek yanıt
{
  "data": {}
}

Yanıt alanları

dataobject
Kullanım notları
  • webhooks.write gerektirir. Yanıt örnekleri seçili alanları gösterir; saklanan kanıtların tamamı için kaynağı GET ile al.
  • Her POST kalıcı saklanan 16–128 karakterlik Idempotency-Key gerektirir (harf, rakam, -, _ veya .). Zaman aşımından sonra aynı anahtarı ve JSON talimatlarını yeniden kullan. Farklı talimatlar 409 döndürür. Tamamlanmış yanıtlar 30 gün tutulur; eski anahtarlar yeniden kullanılamayan iptal kayıtlarına dönüşür. Belirsiz sonucu aşmak için anahtarı asla değiştirme.
  • Anahtarların proje listeleri, isteğe bağlı fatura mağazası kısıtlamaları, sona erme zamanı, IP izin listesi ve 1–600/dakika kotası (varsayılan 60) vardır. HTTP 429 Retry-After içerir. Mağazayla sınırlı anahtarlar satıcıları, proje bakiyelerini, hesap defterini, satıcı ödemelerini veya ayarları göremez. Harcama kimlik bilgilerini yalnızca güvenilir sunucularda tut; tarayıcılarda veya dağıtılan mobil uygulamalarda asla bulundurma.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETPazaryeri olayları/v1/marketplace/eventsSalt okunur

Sayfalanmış değiştirilemez olay referansları. q tür/referans arar; status event_type değerini filtreler.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MARKETPLACE_API_TOKEN
ParametreTür / konumKural
permissioncredential scopemarketplace.read

Sorgu parametreleri

project_idUUIDzorunlu

Yetkili proje. Öğe URL'leri dahil her istekte zorunludur.

pageisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

per_pageisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

qisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

statusisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

store_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

vendor_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

asset_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

fromisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

toisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/marketplace/events?project_id=YOUR_PROJECT_ID" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "data": [],
  "pagination": {
    "page": 1,
    "per_page": 25,
    "total": 0,
    "pages": 1
  }
}

Yanıt alanları

data[]array
paginationobject
pageinteger
per_pageinteger
totalinteger
pagesinteger
Kullanım notları
  • marketplace.read gerektirir. Yanıt örnekleri seçili alanları gösterir; saklanan kanıtların tamamı için kaynağı GET ile al.
  • Her POST kalıcı saklanan 16–128 karakterlik Idempotency-Key gerektirir (harf, rakam, -, _ veya .). Zaman aşımından sonra aynı anahtarı ve JSON talimatlarını yeniden kullan. Farklı talimatlar 409 döndürür. Tamamlanmış yanıtlar 30 gün tutulur; eski anahtarlar yeniden kullanılamayan iptal kayıtlarına dönüşür. Belirsiz sonucu aşmak için anahtarı asla değiştirme.
  • Anahtarların proje listeleri, isteğe bağlı fatura mağazası kısıtlamaları, sona erme zamanı, IP izin listesi ve 1–600/dakika kotası (varsayılan 60) vardır. HTTP 429 Retry-After içerir. Mağazayla sınırlı anahtarlar satıcıları, proje bakiyelerini, hesap defterini, satıcı ödemelerini veya ayarları göremez. Harcama kimlik bilgilerini yalnızca güvenilir sunucularda tut; tarayıcılarda veya dağıtılan mobil uygulamalarda asla bulundurma.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETSaklanan olayı oku/v1/marketplace/events/{event_id}Salt okunur

Güncel bakiyelerden yeniden oluşturulan veri değil, değiştirilemez ilk olay yükünü döndürür.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MARKETPLACE_API_TOKEN
ParametreTür / konumKural
permissioncredential scopemarketplace.read

Sorgu parametreleri

project_idUUIDzorunlu

Yetkili proje. Öğe URL'leri dahil her istekte zorunludur.

pageisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

per_pageisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

qisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

statusisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

store_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

vendor_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

asset_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

fromisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

toisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/marketplace/events/YOUR_EVENT_ID?project_id=YOUR_PROJECT_ID" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "data": {
    "event_id": "11111111-1111-4111-8111-111111111111",
    "event_type": "marketplace.payout.confirmed",
    "payload_version": 1,
    "project_id": "YOUR_PROJECT_ID",
    "occurred_at": "2026-10-06T12:00:00Z",
    "data": {
      "payout_id": "YOUR_PAYOUT_ID",
      "asset_id": "YOUR_ASSET_ID",
      "amount_atomic": "28800000",
      "transactions": [
        {
          "transaction_id": "EXAMPLE_TRANSACTION_ID",
          "explorer_url": "https://mempool.space/tx/EXAMPLE_TRANSACTION_ID"
        }
      ]
    }
  }
}

Yanıt alanları

dataobject
event_idstring
event_typestring
payload_versioninteger
project_idstring
occurred_atstring
dataobject
payout_idstring
asset_idstring
amount_atomicstring
transactions[]object[]
transaction_idstring
explorer_urlstring
Kullanım notları
  • marketplace.read gerektirir. Yanıt örnekleri seçili alanları gösterir; saklanan kanıtların tamamı için kaynağı GET ile al.
  • Her POST kalıcı saklanan 16–128 karakterlik Idempotency-Key gerektirir (harf, rakam, -, _ veya .). Zaman aşımından sonra aynı anahtarı ve JSON talimatlarını yeniden kullan. Farklı talimatlar 409 döndürür. Tamamlanmış yanıtlar 30 gün tutulur; eski anahtarlar yeniden kullanılamayan iptal kayıtlarına dönüşür. Belirsiz sonucu aşmak için anahtarı asla değiştirme.
  • Anahtarların proje listeleri, isteğe bağlı fatura mağazası kısıtlamaları, sona erme zamanı, IP izin listesi ve 1–600/dakika kotası (varsayılan 60) vardır. HTTP 429 Retry-After içerir. Mağazayla sınırlı anahtarlar satıcıları, proje bakiyelerini, hesap defterini, satıcı ödemelerini veya ayarları göremez. Harcama kimlik bilgilerini yalnızca güvenilir sunucularda tut; tarayıcılarda veya dağıtılan mobil uygulamalarda asla bulundurma.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETPazaryeri teslim geçmişi/v1/marketplace/webhook-deliveriesSalt okunur

Sayfalanmış teslimler, olay türü, denemeler ve son sonuç. status için pending/sending/succeeded/failed/cancelled; q için olay türü filtresi.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MARKETPLACE_API_TOKEN
ParametreTür / konumKural
permissioncredential scopemarketplace.read

Sorgu parametreleri

project_idUUIDzorunlu

Yetkili proje. Öğe URL'leri dahil her istekte zorunludur.

pageisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

per_pageisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

qisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

statusisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

store_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

vendor_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

asset_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

fromisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

toisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/marketplace/webhook-deliveries?project_id=YOUR_PROJECT_ID" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "data": [],
  "pagination": {
    "page": 1,
    "per_page": 25,
    "total": 0,
    "pages": 1
  }
}

Yanıt alanları

data[]array
paginationobject
pageinteger
per_pageinteger
totalinteger
pagesinteger
Kullanım notları
  • marketplace.read gerektirir. Yanıt örnekleri seçili alanları gösterir; saklanan kanıtların tamamı için kaynağı GET ile al.
  • Her POST kalıcı saklanan 16–128 karakterlik Idempotency-Key gerektirir (harf, rakam, -, _ veya .). Zaman aşımından sonra aynı anahtarı ve JSON talimatlarını yeniden kullan. Farklı talimatlar 409 döndürür. Tamamlanmış yanıtlar 30 gün tutulur; eski anahtarlar yeniden kullanılamayan iptal kayıtlarına dönüşür. Belirsiz sonucu aşmak için anahtarı asla değiştirme.
  • Anahtarların proje listeleri, isteğe bağlı fatura mağazası kısıtlamaları, sona erme zamanı, IP izin listesi ve 1–600/dakika kotası (varsayılan 60) vardır. HTTP 429 Retry-After içerir. Mağazayla sınırlı anahtarlar satıcıları, proje bakiyelerini, hesap defterini, satıcı ödemelerini veya ayarları göremez. Harcama kimlik bilgilerini yalnızca güvenilir sunucularda tut; tarayıcılarda veya dağıtılan mobil uygulamalarda asla bulundurma.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETTeslim ayrıntıları/v1/marketplace/webhook-deliveries/{delivery_id}Salt okunur

İlk URL, saklanan yük, HTTP sonucu ve güvenli hata; imzalama sırrı yok.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MARKETPLACE_API_TOKEN
ParametreTür / konumKural
permissioncredential scopemarketplace.read

Sorgu parametreleri

project_idUUIDzorunlu

Yetkili proje. Öğe URL'leri dahil her istekte zorunludur.

pageisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

per_pageisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

qisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

statusisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

store_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

vendor_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

asset_idisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

fromisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

toisteğe bağlı

Yalnızca bu kaynak için belgelenen filtreleri kullan. Sayfalanmış listeler varsayılan 25, en fazla 100 satırdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/marketplace/webhook-deliveries/YOUR_DELIVERY_ID?project_id=YOUR_PROJECT_ID" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "data": {}
}

Yanıt alanları

dataobject
Kullanım notları
  • marketplace.read gerektirir. Yanıt örnekleri seçili alanları gösterir; saklanan kanıtların tamamı için kaynağı GET ile al.
  • Her POST kalıcı saklanan 16–128 karakterlik Idempotency-Key gerektirir (harf, rakam, -, _ veya .). Zaman aşımından sonra aynı anahtarı ve JSON talimatlarını yeniden kullan. Farklı talimatlar 409 döndürür. Tamamlanmış yanıtlar 30 gün tutulur; eski anahtarlar yeniden kullanılamayan iptal kayıtlarına dönüşür. Belirsiz sonucu aşmak için anahtarı asla değiştirme.
  • Anahtarların proje listeleri, isteğe bağlı fatura mağazası kısıtlamaları, sona erme zamanı, IP izin listesi ve 1–600/dakika kotası (varsayılan 60) vardır. HTTP 429 Retry-After içerir. Mağazayla sınırlı anahtarlar satıcıları, proje bakiyelerini, hesap defterini, satıcı ödemelerini veya ayarları göremez. Harcama kimlik bilgilerini yalnızca güvenilir sunucularda tut; tarayıcılarda veya dağıtılan mobil uygulamalarda asla bulundurma.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTAynı olayı yeniden teslim et/v1/marketplace/webhook-deliveries/{delivery_id}/resendOkuma ve yazma

Yalnızca tamamlanmış teslimler ve değişmemiş etkin uç nokta; en fazla 20 elle yeniden deneme. event_id yeniden kullanılır. Başarısız bildirim ikinci ödeme yetkisi asla vermez.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MARKETPLACE_API_TOKEN
Idempotency-Keyzorunlu16–128 harf, rakam, -, _ veya .; bu tam istekle birlikte sakla
ParametreTür / konumKural
permissioncredential scopewebhooks.write

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
# Keep this key and the exact body for retries; use a new key for each new operation.
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/marketplace/webhook-deliveries/YOUR_DELIVERY_ID/resend" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Idempotency-Key: marketplace-request-1042' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "project_id": "YOUR_PROJECT_ID",
  "confirm": true
}'

İstek gövdesi

project_idUUIDzorunlu

Yetkili proje. Öğe URL'leri dahil her istekte zorunludur.

confirm

true

Yanıt 200 application/json

Örnek yanıt
{
  "data": {}
}

Yanıt alanları

dataobject
Kullanım notları
  • webhooks.write gerektirir. Yanıt örnekleri seçili alanları gösterir; saklanan kanıtların tamamı için kaynağı GET ile al.
  • Her POST kalıcı saklanan 16–128 karakterlik Idempotency-Key gerektirir (harf, rakam, -, _ veya .). Zaman aşımından sonra aynı anahtarı ve JSON talimatlarını yeniden kullan. Farklı talimatlar 409 döndürür. Tamamlanmış yanıtlar 30 gün tutulur; eski anahtarlar yeniden kullanılamayan iptal kayıtlarına dönüşür. Belirsiz sonucu aşmak için anahtarı asla değiştirme.
  • Anahtarların proje listeleri, isteğe bağlı fatura mağazası kısıtlamaları, sona erme zamanı, IP izin listesi ve 1–600/dakika kotası (varsayılan 60) vardır. HTTP 429 Retry-After içerir. Mağazayla sınırlı anahtarlar satıcıları, proje bakiyelerini, hesap defterini, satıcı ödemelerini veya ayarları göremez. Harcama kimlik bilgilerini yalnızca güvenilir sunucularda tut; tarayıcılarda veya dağıtılan mobil uygulamalarda asla bulundurma.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETÖdeme istisnalarını listele/v1/projects/{project_id}/reconciliationSalt okunur

Eksik, fazla, geç, zincir yeniden yapılanmasından etkilenen veya belirsiz ödemeler, başarısız teslimler ve devre dışı/süresi dolmuş yöntemler için tek sayfalanmış inceleme kuyruğu. Operatörün incelendi olarak işaretlediği vakalar yeni kanıt gelince yeniden açılır.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MERCHANT_API_TOKEN

Yol parametreleri

project_idUUIDzorunlu

Bu kimlik bilgisine atanmış proje.

Sorgu parametreleri

statusstring

open (varsayılan), resolved veya all.

reasonstring

underpaid, overpaid, late, reorged, ambiguous, delivery_failed, disabled_method veya expired_method.

store_idUUID

İsteğe bağlı mağaza filtresi.

pageinteger

1–40001. Sayfa başına sabit 25 vaka.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/projects/YOUR_PROJECT_ID/reconciliation?status=open&page=1" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{"data":[],"pagination":{"page":1,"per_page":25,"total":0,"has_more":false},"counts":{"open":0,"resolved":0}}

Yanıt alanları

data[]object[]her zaman

En son güncellenen vakalar önce gelir. Satıcı ayrıntı URL'lerinde dahili id değil, invoice_id kullan.

idUUIDher zaman

Dahili kayıt kimliği / müşteriye görünen fatura UUID'si. invoice_id geri çağrı yükleriyle eşleşir.

invoice_idUUIDher zaman

Dahili kayıt kimliği / müşteriye görünen fatura UUID'si. invoice_id geri çağrı yükleriyle eşleşir.

store_idUUIDher zaman

Sahibi olan mağaza.

store_namestringher zaman

Sahibi olan mağaza.

order_idstring | nullher zaman

Özel satıcı sipariş referansı ve müşteri e-postası.

emailstring | nullher zaman

Özel satıcı sipariş referansı ve müşteri e-postası.

amountdecimal stringher zaman

Faturanın ilk itibari para tutarı ve para birimi.

currencystringher zaman

Faturanın ilk itibari para tutarı ve para birimi.

invoice_statusinvoice statusher zaman

Güncel ödeme yaşam döngüsü durumu.

statusopen|resolvedher zaman

Vaka durumu ve neden filtresinde listelenen istisna türleri.

reasons[]string[]her zaman

Vaka durumu ve neden filtresinde listelenen istisna türleri.

revisionintegerher zaman

Güncel inceleme revizyonu ve güncelleme zamanı.

updated_attimestampher zaman

Güncel inceleme revizyonu ve güncelleme zamanı.

paginationobjecther zaman

page (1–40001), per_page (25), eşleşen toplam satır sayısı, has_more.

pageinteger
per_pageinteger
totalinteger
has_moreboolean
countsobjecther zaman

Mevcut filtrelerden bağımsız, tüm proje için open ve resolved toplamları.

openinteger
resolvedinteger
Kullanım notları
  • Salt okunur, proje kapsamlı ve kimlik bilgisi kotasına tabidir. Finansal kararlar ve iadeler yalnızca konsolda kalır.
  • Satırlar id (dahili UUID), invoice_id (herkese açık UUID, geri çağrılarla aynı), mağaza bilgisi, ilk itibari para tutarı/para birimi, invoice_status, vaka durumu, nedenler, revision ve updated_at içerir. Satıcı ayrıntısı uç noktasında invoice_id kullan.
  • Otomatik tespit ilk fatura izleme aralığına uyar; Yeniden tara ödeme sayfasını etkinleştirmeden gözlemi bir saat uzatır. Tamamlanmış/iptal edilmiş yöntemler bu aralık içinde izlenmeye devam eder.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETMutabakat kanıtlarını oku/v1/projects/{project_id}/reconciliation/{invoice_id}Salt okunur

Faturayı, vakayı, tam yöntem toplamlarını ve kullanılabilir iade tutarlarını, gözlenen işlemleri, teslim geçmişini, satıcı kararlarını ve bağlantılı iade transferlerini döndürür. İmzalama anahtarlarını veya geri çağrı sırlarını asla göstermez.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MERCHANT_API_TOKEN

Yol parametreleri

project_idUUIDzorunlu

Atanmış proje.

invoice_idUUIDzorunlu

Dahili id değil, herkese açık fatura UUID'si.

Sorgu parametreleri

pageinteger

Karar geçmişi sayfası; 1'den başlar, sayfa başına 25 karar.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/projects/YOUR_PROJECT_ID/reconciliation/YOUR_PUBLIC_INVOICE_ID" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{"invoice":{"invoice_id":"YOUR_PUBLIC_INVOICE_ID","status":"processing"},"case":{"status":"open","reasons":["underpaid"],"revision":1},"methods":[],"history":[],"history_pagination":{"page":1,"per_page":25,"total":0},"refunds":[],"observations":[],"deliveries":[]}

Yanıt alanları

invoiceobjecther zaman

Tam satıcı faturası: özet alanları, özel meta veriler ve payment_intents. data içine sarılmaz.

idUUIDher zaman

Dahili fatura UUID'si. Satıcı ayrıntısı veya ödeme sayfası yollarında kullanma.

invoice_idUUIDher zaman

Satıcı ayrıntısı ve ödeme sayfası yollarında kullanılan herkese açık fatura UUID'si.

project_idUUIDher zaman

Sahibi olan proje.

store_idUUIDher zaman

Sahibi olan mağaza.

sourcemanual | apiher zaman

Faturanın nasıl oluşturulduğu.

order_idstring | nullher zaman

Satıcı sipariş referansı.

emailstring | nullher zaman

Yalnızca satıcıya açık müşteri e-postası. Herkese açık ödeme sayfası asla döndürmez.

customer_namestring | nullher zaman

Özel firstname, lastname ve company meta verilerinden türetilen görünen ad.

customer_addressstring | nullher zaman

Özel company, street, street2, zip, city, country, countryiso2 ve vatid meta verilerinden türetilen tek satırlık satıcı adresi.

descriptionstring | nullher zaman

Müşteriye görünen açıklama.

amountdecimal stringher zaman

Kanonik fatura tutarı.

currencystringher zaman

Normalleştirilmiş fatura para birimi/varlık kodu.

exchange_rate_spread_percentdecimal stringher zaman

Kilitlenmiş teklif fiyat marjı: oluşturmadaki özel değer veya atlandığında mağaza varsayılanı. Yukarı yuvarlamadan önce uygulanır; bu faturada asla değişmez.

underpayment_tolerance_percentdecimal stringher zaman

Fatura oluşturulurken görüntüsü alınmış, değiştirilemez kabul edilen eksik ödeme yüzdesi.

statusinvoice statusher zaman

new, processing, settled, expired, invalid veya cancelled.

amount_statusamount statusher zaman

none, partial, paid veya overpaid. Açıkça izin verilen sıfır tutarlı fatura none ile ve ödeme yöntemi olmadan tamamlanır.

timing_statustiming statusher zaman

on_time veya late.

resolutionresolutionher zaman

automatic, manually_settled veya manually_invalidated.

sequenceintegerher zaman

1'den başlayan, tek yönlü artan fatura durumu sıra numarası.

winning_payment_intent_idUUID | nullher zaman

Seçildiğinde faturayı sonuçlandıran ödeme yöntemi.

expires_atRFC 3339 timestampher zaman

Teklif/ödeme son tarihi.

monitoring_expires_atRFC 3339 timestampher zaman

Ödeme yöntemleri genelinde yapılandırılmış en geç geç ödeme izleme bitişi.

settled_attimestamp | nullher zaman

Ödeme tamamlandıysa tamamlanma zamanı.

cancelled_attimestamp | nullher zaman

İptal edildiyse iptal zamanı.

archived_attimestamp | nullher zaman

Arşivlendiyse arşivleme zamanı.

created_atRFC 3339 timestampher zaman

Oluşturulma zamanı.

updated_atRFC 3339 timestampher zaman

Son durum güncelleme zamanı.

ipn_urlstring | nullher zaman

Faturaya özel geçerli IPN hedefi. Yalnızca satıcı yanıtında bulunur; herkese açık ödeme sayfasından çıkarılır.

redirect_urlstring | nullher zaman

Tamamlanmadan sonra kullanılan geçerli başarı URL'si.

cancel_urlstring | nullher zaman

Ödeme sayfası başarılı ödeme olmadan sona erdiğinde kullanılan geçerli dönüş URL'si.

redirect_automaticallybooleanher zaman

Ödeme sayfasının başarıdan sonra otomatik yönlenip yönlenmeyeceği.

checkout_languagestringher zaman

Geçerli ödeme sayfası dil etiketi.

metadataobjecther zaman
Satıcı meta verileri. Herkese açık ödeme sayfası asla döndürmez. Konsol ödeme araçları payment_tool köken bilgisini ekler (id, kind, title, pricing, requested_amount, request_id); bu ödeme kanıtı değildir. Geri çağrıları doğrula ve invoice.settled için invoice_id başına bir kez siparişi yerine getir.Ayrıntılar

Satıcı meta verileri. Herkese açık ödeme sayfası asla döndürmez. Konsol ödeme araçları payment_tool köken bilgisini ekler (id, kind, title, pricing, requested_amount, request_id); bu ödeme kanıtı değildir. Geri çağrıları doğrula ve invoice.settled için invoice_id başına bir kez siparişi yerine getir.

payment_intents[]object[]her zaman

Teklif verilen ödeme yöntemleri ve izleme durumu.

idUUIDher zaman

Ödeme isteği tanımlayıcısı; ödeme sayfası QR intent_id olarak da kullanılır.

payment_railonchain | lightningher zaman
Fatura aktarım türü. Zincir üstü Bitcoin ve Lightning aynı asset_id paylaşabilir; yalnızca sembol yerine isteğin id değerini ve bu alanı kullan. Bu, varlık kataloğundaki tarayıcı payment_rail alanından farklıdır.Ayrıntılar

Fatura aktarım türü. Zincir üstü Bitcoin ve Lightning aynı asset_id paylaşabilir; yalnızca sembol yerine isteğin id değerini ve bu alanı kullan. Bu, varlık kataloğundaki tarayıcı payment_rail alanından farklıdır.

bolt11string | nullher zaman

Lightning ödeme isteği; diğer durumlarda null. Bunu Lightning cüzdanıyla öde; ödeme hash'ine asla zincir üstü fon gönderme.

asset_idUUIDher zaman

Yapılandırılmış ödeme varlığı tanımlayıcısı.

asset_keystringher zaman

Kanonik CAIP biçimli varlık anahtarı.

chain_slugstringher zaman

Wholly Crypto zincir tanımlayıcısı.

networkstringher zaman

Yapılandırılmış ağ; desteklenen ödeme varlıkları için şu anda mainnet.

caip_network_idstringher zaman

Kanonik CAIP-2 ağ tanımlayıcısı.

caip_asset_idstring | nullher zaman

Kayıtlı olduğu yerlerde kanonik CAIP-19 tanımlayıcısı.

symbolstringher zaman

Varlık sembolü.

asset_decimalsintegerher zaman

Atomik birim hassasiyeti. Lightning BTC, zincir üstü Bitcoin'in 8 basamağı yerine 11 (millisatoshi) kullanır. Teklifler tam satoshi'dir; tahsilatlar millisatoshi hassasiyetini korur.

statusintent statusher zaman

pending, partial, paid, overpaid, expired veya invalid.

finality_modeconfirmations | finalizedher zaman

Kesinlik politikası.

required_confirmationsintegerher zaman

Uygulanabilir olduğunda gereken onay sayısı.

quote_ratedecimal stringher zaman

Kilitlenmiş fiyat marjı dahil, bir fatura para birimi başına varlık birimi. Örneğin USD başına 1.02 USDC. Ters kur değildir.

quote_detailsobject | nullher zaman
Kilitlenmiş teklif kökeni: fiyat marjı öncesi reference_rate, unrounded_payment_amount, rounding_adjustment, pricing_provider, asset_provider, pricing_fetched_at ve asset_fetched_at. Eski faturalarda null; geçmiş değerler uydurulmaz.Ayrıntılar

Kilitlenmiş teklif kökeni: fiyat marjı öncesi reference_rate, unrounded_payment_amount, rounding_adjustment, pricing_provider, asset_provider, pricing_fetched_at ve asset_fetched_at. Eski faturalarda null; geçmiş değerler uydurulmaz.

expected_amountdecimal stringher zaman
Fiyat marjı ve yukarı yuvarlamadan sonra ödenecek tam kilitli varlık tutarı. 4.1.1'den itibaren tanınan ve doğrulanmış itibari para stablecoin'leri (USDC, USDT, DAI, USDS, EURC gibi) en fazla iki ondalık basamağa yukarı yuvarlanır; 1.321, 1.33 olur, asla 1.32 olmaz. Tolerans sıfır olsa bile beklenen tutar budur. Diğer varlıklar uyarlanabilir hassasiyetini korur. Mevcut faturalar asla yeniden fiyatlandırılmaz.Ayrıntılar

Fiyat marjı ve yukarı yuvarlamadan sonra ödenecek tam kilitli varlık tutarı. 4.1.1'den itibaren tanınan ve doğrulanmış itibari para stablecoin'leri (USDC, USDT, DAI, USDS, EURC gibi) en fazla iki ondalık basamağa yukarı yuvarlanır; 1.321, 1.33 olur, asla 1.32 olmaz. Tolerans sıfır olsa bile beklenen tutar budur. Diğer varlıklar uyarlanabilir hassasiyetini korur. Mevcut faturalar asla yeniden fiyatlandırılmaz.

expected_amount_atomicinteger stringher zaman

Varlığın en küçük biriminde tam tutar.

minimum_payment_amountdecimal stringher zaman

Fatura toleransı uygulandıktan sonra ödendi olarak kabul edilen en küçük tutar.

minimum_payment_amount_atomicinteger stringher zaman

Varlığın en küçük biriminde tam kabul eşiği.

received_amountdecimal stringher zaman

Gözlenen tutar.

received_amount_atomicinteger stringher zaman

Gözlenen atomik tutar.

confirmed_amountdecimal stringher zaman

Onaylanmış/kesinleşmiş tutar.

confirmed_amount_atomicinteger stringher zaman

Onaylanmış/kesinleşmiş atomik tutar.

destination_addressstringher zaman

Zincir üstü ödeme alma adresi veya Lightning için 64 karakterlik ödeme hash'i. Lightning ödemek için bolt11 kullan; hash'i Bitcoin adresi değildir.

destination_tagstring | nullher zaman

Ödeme altyapısı gerektiriyorsa zorunlu herkese açık ödeme referansı: XRP destination tag, Stellar memo ID veya TON fatura açıklaması. Benzersiz adresli altyapılarda null.

derivation_indexintegerher zaman

Ayrılmış cüzdan alt adres indeksi; yalnızca satıcı ayrıntısında.

quote_expires_atRFC 3339 timestampher zaman

Teklifin sona erme zamanı.

monitoring_expires_atRFC 3339 timestampher zaman

Bu yöntem için geç ödeme izlemesinin bitişi.

next_check_attimestamp | nullher zaman

Sonraki zamanlanmış zincir kontrolü.

last_checked_attimestamp | nullher zaman

Son zincir kontrolü.

last_chain_heightinteger | nullher zaman

İzleyicinin gözlediği son güvenilir yükseklik.

last_anchor_hashstring | nullher zaman

Son izleme referansı/blok hash'i.

last_monitor_errorstring | nullher zaman

Operatörler için güvenli izleme teşhisi.

first_payment_attimestamp | nullher zaman

Ödemenin ilk gözlendiği zaman.

fully_paid_attimestamp | nullher zaman

Kabul edilen asgari tutara ilk ulaşılan zaman.

finalized_attimestamp | nullher zaman

Ödemenin kesinlik politikasını karşıladığı zaman.

caseobject | nullher zaman

Durum, nedenler, revizyon ve zaman damgalarıyla güncel vaka; istisna yoksa null. Dahili kanıtlar hariç tutulur.

statusstring
reasons[]array
revisioninteger
methods[]object[]her zaman
id, wallet_id, asset_id, symbol, chain, decimals, expected_atomic, received_atomic, confirmed_atomic, refundable_atomic, address, tag, monitor_error, last_checked_at, monitoring_expires_at ve spending_supported. Atomik tutarlar dizedir.Ayrıntılar

id, wallet_id, asset_id, symbol, chain, decimals, expected_atomic, received_atomic, confirmed_atomic, refundable_atomic, address, tag, monitor_error, last_checked_at, monitoring_expires_at ve spending_supported. Atomik tutarlar dizedir.

history[]object[]her zaman

Bu sayfanın en yeni 25 kararı: id, action, note, actor, result, created_at.

history_paginationobjecther zaman

page, per_page (25), total. Yalnızca karar geçmişi page ile sayfalanır.

pageinteger
per_pageinteger
totalinteger
refunds[]object[]her zaman
En yeni 100 iade: id, payment_intent_id, amount_atomic, destination, status, request, treasury_intent_id, transfer_status, created_at ve transactions (id/status). İade gönderimi yalnızca konsoldan yapılır.Ayrıntılar

En yeni 100 iade: id, payment_intent_id, amount_atomic, destination, status, request, treasury_intent_id, transfer_status, created_at ve transactions (id/status). İade gönderimi yalnızca konsoldan yapılır.

observations[]object[]her zaman
En yeni 100: payment_intent_id, transaction_id, event_index, amount, status, confirmations, observed_at, symbol, chain ve disabled_at_detection. Desteklendiğinde explorer_name/explorer_url eklenir.Ayrıntılar

En yeni 100: payment_intent_id, transaction_id, event_index, amount, status, confirmations, observed_at, symbol, chain ve disabled_at_detection. Desteklendiğinde explorer_name/explorer_url eklenir.

deliveries[]object[]her zaman

En yeni 50: id, kind, status, attempts, response_status, error, next_attempt_at, event_type ve created_at. Geri çağrı sırları yoktur.

Kullanım notları
  • Fatura istisna üretmediyse case null'dur. En son 100 gözlem ve 50 teslim döndürülür; karar geçmişi sayfalanır.
  • refundable_atomic en az bir ağ onayı gerektirir, mevcut iade rezervasyonlarını hariç tutar ve harcanabilir cüzdan fonu sözü değildir. Canlı teklif ayrıca cüzdan hazırlığını, kaynak bakiyelerini ve ücretleri doğrular.
  • Ağa yayınlanmış iade, zincir uç noktasına iletildi demektir; müşterinin aldığının bağımsız olarak onaylandığı anlamına gelmez. Ücretler eklenir ve iade yapmak itibari para işlem ücretlerini otomatik olarak geri kredilendirmez.
  • Konsol proje menüsü → İlgilenilmesi gerekenler; iptal, kabul, ret, yeniden açma, inceleme, notlar, Yeniden tara, teslimi yeniden deneme ve desteklenen zincirlerde iade sunar. Kararlar CSRF korumalı oturum, benzersiz request_id, güncel vaka revizyonu, zorunlu not ve açık onay kullanır; bearer token'ları bu değişiklikleri çağıramaz.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETAPI hizmet keşfi/Herkese açık

v1 herkese açık API rolünü doğrulayan yönetilen API ana makinesi giriş yanıtı. Bu yanıtı satıcı Axum yönlendiricisi değil, yönetilen proxy üretir.

Kimlik doğrulama ve üst bilgiler

Herkese açık

İstek

curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/"

Yanıt 200 application/json

Örnek yanıt
{
  "service": "Wholly Crypto API",
  "status": "ready",
  "version": "v1"
}

Yanıt alanları

servicestring
statusstring
versionstring
Kullanım notları
  • Bearer token gerekmez.
  • Bu tam kök yanıtını yalnızca yönetilen API ana makine adı garanti eder.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETHizmet sağlığı/healthzHerkese açık

Uygulama erişilebilirliğini ve iki saniyelik veritabanı ping'ini kontrol eder. İzleme için kullan; fatura durumunun yerine koyma.

Kimlik doğrulama ve üst bilgiler

Herkese açık

İstek

curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/healthz"

Yanıt 200 healthy; 503 database unavailable

Örnek yanıt
{
  "status": "ok",
  "database": "ok",
  "version": "0.1.0"
}

Yanıt alanları

statusstring
databasestring
versionstring
Kullanım notları
  • Bearer token gerekmez.
  • version değeri API yol sürümü değil, çalışan paket sürümüdür.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETProje ödeme varlıklarını listele/v1/projects/{project_id}/payment-assetsSalt okunur

Yerel varlıkları ve doğrulanmış token'ları proje politikası, zincir cüzdanı hazırlığı ve kurulu tarayıcı/bakiye yetenekleriyle listeler. scanner_ready canlı uç nokta yeter sayısı sonucu değil, adaptör derleme kontrolüdür. 6.0.6'dan itibaren fatura oluşturma tarayıcı kesintisinde yapılandırılmış yöntemleri korur. Ödeme alma doğrulaması yine yapılandırılmış sağlıklı, tam role uygun sağlayıcı eşiğini gerektirir (varsayılan 2, isteğe bağlı 1).

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MERCHANT_API_TOKEN
Acceptönerilenapplication/json

Yol parametreleri

project_idUUIDzorunlu

Kimlik bilgisine atanmış etkin proje.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/projects/YOUR_PROJECT_ID/payment-assets" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Accept: application/json'

Yanıt 200 application/json

Örnek yanıt
{
  "data": [
    {
      "asset": {
        "id": "10000000-0000-4000-8000-000000000003",
        "asset_key": "eip155:1/slip44:60",
        "chain_slug": "ethereum",
        "network": "mainnet",
        "caip_network_id": "eip155:1",
        "caip_asset_id": "eip155:1/slip44:60",
        "asset_kind": "native",
        "payment_rail": "evm-native",
        "symbol": "ETH",
        "name": "Ethereum",
        "decimals": 18,
        "contract_address": null,
        "coingecko_id": "ethereum",
        "icon_path": "/assets/coingecko/ethereum.png",
        "token_standard": null,
        "metadata_verified_at": null,
        "payment_supported": true,
        "scanner_ready": true,
        "balance_ready": true,
        "default_finality_mode": "confirmations",
        "default_required_confirmations": 12,
        "default_monitoring_minutes": 60
      },
      "policy": {
        "enabled": true,
        "finality_mode": "confirmations",
        "required_confirmations": 12,
        "monitoring_minutes": 60,
        "late_monitoring_days": 30
      },
      "wallet": null,
      "wallet_readiness": "wallet_missing",
      "receive_readiness": { "ready": false, "invoice_creatable": false, "checked_at": "2026-09-16T09:00:00Z", "issues": [{ "chain_slug": "ethereum", "asset_id": "10000000-0000-4000-8000-000000000003", "asset_ticker": "ETH", "reason_code": "wallet_missing", "message": "ethereum / ETH: Create a project wallet for this chain.", "action": "wallets" }] }
    }
  ]
}

Yanıt alanları

data[]object[]
assetobjecther zaman

Kalıcı yerel varlık veya doğrulanmış token varlığı.

idUUIDher zaman

Proje ve mağaza politika rotalarının kullandığı kalıcı ödeme varlığı tanımlayıcısı.

asset_keystringher zaman

Kanonik CAIP biçimli yerel veya sözleşme varlığı kimliği.

chain_slugstringher zaman

Wholly Crypto zincir tanımlayıcısı ve yapılandırılmış ağ.

networkstringher zaman

Wholly Crypto zincir tanımlayıcısı ve yapılandırılmış ağ.

caip_network_idstringher zaman

Kanonik ağ ve varlık kimlikleri.

caip_asset_idstring|nullher zaman

Kanonik ağ ve varlık kimlikleri.

asset_kindnative | tokenher zaman

Ödeme tamamlanmasında zincir para biriminin mi, doğrulanmış sözleşme/mint'in mi kullanıldığı.

payment_railstringher zaman

Çalışma zamanı ödeme altyapısı: utxo, evm-native, solana-native, account-native, privacy-native veya token-transfer.

symbolstringher zaman

Görüntüleme kimliği ve tam atomik birim hassasiyeti.

namestringher zaman

Görüntüleme kimliği ve tam atomik birim hassasiyeti.

decimalsintegerher zaman

Görüntüleme kimliği ve tam atomik birim hassasiyeti.

contract_addressstring | nullher zaman

Token'lar için kanonik ERC-20 sözleşmesi veya SPL mint'i; yerel varlıklarda null.

coingecko_idstring | nullher zaman

Keşif/fiyatlandırma kimliği. Özel sözleşmelerde null; sembollerinden piyasa fiyatı çıkarma. CoinGecko meta verileri tek başına token'ı seçilebilir yapmaz.

custom_tokenbooleanher zaman

Proje kapsamlı sabit USD veya seçili DEX havuzu fiyatlandırması olan, zincir üstünde doğrulanmış özel sözleşme.

icon_pathpath | nullher zaman

Varsa yerel önbellekteki token simgesi.

token_standarderc20 | spl-token | nullher zaman

Doğrulanmış çalışma zamanı token standardı; yerel varlıklarda null.

metadata_verified_attimestamp | nullher zaman

Ödeme varlığına dönüştürülen token'ların zincir üstü meta veri doğrulama zamanı.

payment_supportedbooleanher zaman
Derleme zamanı kayıt kontrolleri. scanner_ready ödeme tarayıcısı çalışma ortamının kurulu olduğu anlamına gelir; ödeme onayı, yapılandırılmış sayıda sağlıklı ve tam role uygun sağlayıcı gerektirir (varsayılan 2, isteğe bağlı 1); geçici tarayıcı kullanılabilirliği 6.0.6'dan itibaren fatura oluşturmayı engellemez. balance_ready yalnızca uygulanmış bakiye adaptörlerinde true olur.Ayrıntılar

Derleme zamanı kayıt kontrolleri. scanner_ready ödeme tarayıcısı çalışma ortamının kurulu olduğu anlamına gelir; ödeme onayı, yapılandırılmış sayıda sağlıklı ve tam role uygun sağlayıcı gerektirir (varsayılan 2, isteğe bağlı 1); geçici tarayıcı kullanılabilirliği 6.0.6'dan itibaren fatura oluşturmayı engellemez. balance_ready yalnızca uygulanmış bakiye adaptörlerinde true olur.

scanner_readybooleanher zaman
Derleme zamanı kayıt kontrolleri. scanner_ready ödeme tarayıcısı çalışma ortamının kurulu olduğu anlamına gelir; ödeme onayı, yapılandırılmış sayıda sağlıklı ve tam role uygun sağlayıcı gerektirir (varsayılan 2, isteğe bağlı 1); geçici tarayıcı kullanılabilirliği 6.0.6'dan itibaren fatura oluşturmayı engellemez. balance_ready yalnızca uygulanmış bakiye adaptörlerinde true olur.Ayrıntılar

Derleme zamanı kayıt kontrolleri. scanner_ready ödeme tarayıcısı çalışma ortamının kurulu olduğu anlamına gelir; ödeme onayı, yapılandırılmış sayıda sağlıklı ve tam role uygun sağlayıcı gerektirir (varsayılan 2, isteğe bağlı 1); geçici tarayıcı kullanılabilirliği 6.0.6'dan itibaren fatura oluşturmayı engellemez. balance_ready yalnızca uygulanmış bakiye adaptörlerinde true olur.

balance_readybooleanher zaman
Derleme zamanı kayıt kontrolleri. scanner_ready ödeme tarayıcısı çalışma ortamının kurulu olduğu anlamına gelir; ödeme onayı, yapılandırılmış sayıda sağlıklı ve tam role uygun sağlayıcı gerektirir (varsayılan 2, isteğe bağlı 1); geçici tarayıcı kullanılabilirliği 6.0.6'dan itibaren fatura oluşturmayı engellemez. balance_ready yalnızca uygulanmış bakiye adaptörlerinde true olur.Ayrıntılar

Derleme zamanı kayıt kontrolleri. scanner_ready ödeme tarayıcısı çalışma ortamının kurulu olduğu anlamına gelir; ödeme onayı, yapılandırılmış sayıda sağlıklı ve tam role uygun sağlayıcı gerektirir (varsayılan 2, isteğe bağlı 1); geçici tarayıcı kullanılabilirliği 6.0.6'dan itibaren fatura oluşturmayı engellemez. balance_ready yalnızca uygulanmış bakiye adaptörlerinde true olur.

default_finality_modeconfirmations | finalizedher zaman

Yeni proje politikasının devraldığı varsayılan kesinlik modeli.

default_required_confirmationsintegerher zaman

Varsayılan onay ve izleme politikası.

default_monitoring_minutesintegerher zaman

Varsayılan onay ve izleme politikası.

policyobject | nullher zaman
Proje etkinleştirme/kesinlik politikası; yapılandırılmadıysa null. custom_price_mode (fixed/dex), custom_price_usd (sabit ondalık sayı dizesi veya null), custom_dex_pair (seçilen havuz veya null) ve custom_dex (dex_id, quote_symbol, güncel price_usd veya null, liquidity_usd, fetched_at, last_error) içerir. Özel fiyatlandırma bu projedeki mağazalar tarafından paylaşılır.Ayrıntılar

Proje etkinleştirme/kesinlik politikası; yapılandırılmadıysa null. custom_price_mode (fixed/dex), custom_price_usd (sabit ondalık sayı dizesi veya null), custom_dex_pair (seçilen havuz veya null) ve custom_dex (dex_id, quote_symbol, güncel price_usd veya null, liquidity_usd, fetched_at, last_error) içerir. Özel fiyatlandırma bu projedeki mağazalar tarafından paylaşılır.

enabledbooleanzorunlu

Varlığı proje için etkinleştirir veya devre dışı bırakır. Herhangi bir token'dan önce yerel zincir etkin olmalıdır.

finality_modeconfirmations | finalizedzorunlu

Varlık ödeme altyapısının desteklediği kesinlik politikası. finalized, required_confirmations=1 gerektirir.

required_confirmationsintegerzorunlu
Bitcoin ve EVM altyapıları sıfır kabul eder; diğer onay altyapıları en az bir, yalnızca finalized altyapıları tam bir gerektirir. Her transferin işlem yeniden oynatma aralığında kalması için EVM altyapıları 0–48 ile sınırlıdır.Ayrıntılar

Bitcoin ve EVM altyapıları sıfır kabul eder; diğer onay altyapıları en az bir, yalnızca finalized altyapıları tam bir gerektirir. Her transferin işlem yeniden oynatma aralığında kalması için EVM altyapıları 0–48 ile sınırlıdır.

monitoring_minutesintegerzorunlu

Fatura etkinken 1–10.080 dakikalık sorgulama aralığı.

late_monitoring_daysintegerzorunlu

Fatura süresi dolduktan sonra 0–3.650 gün izleme.

walletobject | nullher zaman

Zincirin saklama hizmeti olmayan proje cüzdanı. Token'lar zincirlerinin yerel cüzdanını paylaşır.

idUUIDher zaman

Cüzdan, sahibi proje ve zincirin yerel varlık tanımlayıcıları.

project_idUUIDher zaman

Cüzdan, sahibi proje ve zincirin yerel varlık tanımlayıcıları.

native_asset_idUUIDher zaman

Cüzdan, sahibi proje ve zincirin yerel varlık tanımlayıcıları.

chain_slugstringher zaman

Cüzdan zinciri ve ağı.

networkstringher zaman

Cüzdan zinciri ve ağı.

asset_symbolstringher zaman

Zincirin yerel varlığının görüntüleme kimliği.

asset_namestringher zaman

Zincirin yerel varlığının görüntüleme kimliği.

statuspending | active | disabled | errorher zaman

Cüzdanın çalışma durumu.

labelstringher zaman

Operatör etiketi.

public_keystring | nullher zaman

Herkese açık cüzdan kimliği; kurtarma ifadesi veya özel anahtar açığa çıkarılmaz.

primary_addressstring | nullher zaman

Herkese açık cüzdan kimliği; kurtarma ifadesi veya özel anahtar açığa çıkarılmaz.

derivation_schemestring | nullher zaman

Adres politikası ve biçimi.

address_formatstring | nullher zaman

Adres politikası ve biçimi.

backup_confirmed_attimestamp | nullher zaman

Operatör kurtarma yedeğini onayladıktan sonra null değildir.

activation_requiredbooleanher zaman
XRP ve Stellar ortak hesapları, operatör gösterilen adrese fon gönderene ve yapılandırılmış tarayıcı sağlayıcıları tam olarak o hesabı doğrulayana kadar kullanılamaz. Kalıcı kanıtın süresi dolmaz; canlı tarayıcı sağlığı fatura oluşturma için değil, ödeme doğrulaması için ayrı kontrol edilir.Ayrıntılar

XRP ve Stellar ortak hesapları, operatör gösterilen adrese fon gönderene ve yapılandırılmış tarayıcı sağlayıcıları tam olarak o hesabı doğrulayana kadar kullanılamaz. Kalıcı kanıtın süresi dolmaz; canlı tarayıcı sağlığı fatura oluşturma için değil, ödeme doğrulaması için ayrı kontrol edilir.

activation_verified_attimestamp|nullher zaman
XRP ve Stellar ortak hesapları, operatör gösterilen adrese fon gönderene ve yapılandırılmış tarayıcı sağlayıcıları tam olarak o hesabı doğrulayana kadar kullanılamaz. Kalıcı kanıtın süresi dolmaz; canlı tarayıcı sağlığı fatura oluşturma için değil, ödeme doğrulaması için ayrı kontrol edilir.Ayrıntılar

XRP ve Stellar ortak hesapları, operatör gösterilen adrese fon gönderene ve yapılandırılmış tarayıcı sağlayıcıları tam olarak o hesabı doğrulayana kadar kullanılamaz. Kalıcı kanıtın süresi dolmaz; canlı tarayıcı sağlığı fatura oluşturma için değil, ödeme doğrulaması için ayrı kontrol edilir.

receive_readinessobject | null5.5.0+
Cüzdan listelerine dahildir: proje ödeme alma kurulumu ve zincir tarayıcısı ön koşulları. Bakiyelerden, token gas'ından ve gönderime hazır olma durumundan ayrıdır. Diğer cüzdan yanıtlarında null kalabilir.Ayrıntılar

Cüzdan listelerine dahildir: proje ödeme alma kurulumu ve zincir tarayıcısı ön koşulları. Bakiyelerden, token gas'ından ve gönderime hazır olma durumundan ayrıdır. Diğer cüzdan yanıtlarında null kalabilir.

readybooleanher zaman

Ödeme alma kurulum kontrolleri geçti. Harcamaya hazır olmayı, gas'ı, bakiye yenilemeyi veya garantili gelecek teklifi açıklamaz.

invoice_creatableboolean6.0.6+
Yapılandırma geçici tarayıcı uyarılarına rağmen fatura yöntemine izin verir. Para birimi fiyatlandırması oluşturma sırasında kontrol edilir. Bu ödeme doğrulaması değildir: invoice_creatable true iken ready false olabilir. Eksik cüzdanlar, devre dışı politika ve desteklenmeyen adaptörler yine güvenli biçimde başarısız olur.Ayrıntılar

Yapılandırma geçici tarayıcı uyarılarına rağmen fatura yöntemine izin verir. Para birimi fiyatlandırması oluşturma sırasında kontrol edilir. Bu ödeme doğrulaması değildir: invoice_creatable true iken ready false olabilir. Eksik cüzdanlar, devre dışı politika ve desteklenmeyen adaptörler yine güvenli biçimde başarısız olur.

checked_attimestampher zaman

Değerlendirme zamanı. Listeleme ağ isteği veya adres ayırma yapmaz.

issues[]object[]her zaman
Hazırsa boş; aksi halde ödeme alma uyarısı veya yapılandırma engeli. Geçici tarayıcı uyarılarını fatura kurulum hatalarından ayırmak için invoice_creatable kontrol et.Ayrıntılar

Hazırsa boş; aksi halde ödeme alma uyarısı veya yapılandırma engeli. Geçici tarayıcı uyarılarını fatura kurulum hatalarından ayırmak için invoice_creatable kontrol et.

chain_slugstringbiliniyorsa

Etkilenen zinciri ve varlığı tanımlar. Lightning asset_id içermeyebilir.

asset_idUUIDbiliniyorsa

Etkilenen zinciri ve varlığı tanımlar. Lightning asset_id içermeyebilir.

asset_tickerstringbiliniyorsa

Etkilenen zinciri ve varlığı tanımlar. Lightning asset_id içermeyebilir.

reason_codestringher zaman
scanner_provider_quorum, scanner_not_checked, scanner_unavailable, wallet_missing, wallet_disabled, wallet_backup_required, wallet_key_unavailable, wallet_activation_required, monero_binding_unavailable, rate_unavailable, custom_rate_unavailable, lightning_unavailable, project_disabled, store_disabled, chain_disabled, asset_disabled veya asset_not_accepted.Ayrıntılar

scanner_provider_quorum, scanner_not_checked, scanner_unavailable, wallet_missing, wallet_disabled, wallet_backup_required, wallet_key_unavailable, wallet_activation_required, monero_binding_unavailable, rate_unavailable, custom_rate_unavailable, lightning_unavailable, project_disabled, store_disabled, chain_disabled, asset_disabled veya asset_not_accepted.

messagestringvarsa
Satıcıya yönelik açıklama ve eylem tanımlayıcısı: chain_connections, wallets, rates, payment_methods, project_settings veya store_settings. Kimlik bilgisi veya özel sağlayıcı URL'si içermez.Ayrıntılar

Satıcıya yönelik açıklama ve eylem tanımlayıcısı: chain_connections, wallets, rates, payment_methods, project_settings veya store_settings. Kimlik bilgisi veya özel sağlayıcı URL'si içermez.

actionstringvarsa
Satıcıya yönelik açıklama ve eylem tanımlayıcısı: chain_connections, wallets, rates, payment_methods, project_settings veya store_settings. Kimlik bilgisi veya özel sağlayıcı URL'si içermez.Ayrıntılar

Satıcıya yönelik açıklama ve eylem tanımlayıcısı: chain_connections, wallets, rates, payment_methods, project_settings veya store_settings. Kimlik bilgisi veya özel sağlayıcı URL'si içermez.

required_endpoint_rolestring | nullzincir üstü
Tercih edilen tarayıcı API rolü (eski alan). Tam uyumluluk listesi için accepted_endpoint_roles kullan. Temel düğüm sağlığı ödeme geçmişi desteğini kanıtlamaz.Ayrıntılar

Tercih edilen tarayıcı API rolü (eski alan). Tam uyumluluk listesi için accepted_endpoint_roles kullan. Temel düğüm sağlığı ödeme geçmişi desteğini kanıtlamaz.

accepted_endpoint_roles[]string[] | nullzincir üstü
Uyumlu API biçimleri; uç nokta geçmişi veya kapasitesi kanıtı değildir. Ham node-rpc, BTC/BCH/LTC/DOGE/DASH ve şeffaf ZEC (tam çözümlenmiş bloklar, 1–48 onay), solidified yerel TRX, algod üzerinden yerel ALGO, Octez üzerinden XTZ, SCALE meta verileriyle kesinleşmiş Asset Hub DOT ve fatura memo ID'siyle Stellar RPC üzerinden yerel XLM destekler. Budanmış veya eksik geçmiş uygun değildir. Bu ham adaptörler token altyapısı eklemez. İndeksli API'ler alternatif olmaya devam eder; aşağıdaki altyapı tablosuna bak. Karma ham/indeksli kaynaklar sınırlı aralıkları bağımsız doğrular; varsayılan, tek operatörün takma adları değil, iki bağımsız sağlayıcıdır. Temel düğüm yüksekliği, ORDnet zincir bilgisi ve EVM dışı altyapı için EVM rölesi ödeme alma kanıtı değildir. Monero yine projeye bağlı, yalnızca görüntüleme yetkili wallet-RPC gerektirir.Ayrıntılar

Uyumlu API biçimleri; uç nokta geçmişi veya kapasitesi kanıtı değildir. Ham node-rpc, BTC/BCH/LTC/DOGE/DASH ve şeffaf ZEC (tam çözümlenmiş bloklar, 1–48 onay), solidified yerel TRX, algod üzerinden yerel ALGO, Octez üzerinden XTZ, SCALE meta verileriyle kesinleşmiş Asset Hub DOT ve fatura memo ID'siyle Stellar RPC üzerinden yerel XLM destekler. Budanmış veya eksik geçmiş uygun değildir. Bu ham adaptörler token altyapısı eklemez. İndeksli API'ler alternatif olmaya devam eder; aşağıdaki altyapı tablosuna bak. Karma ham/indeksli kaynaklar sınırlı aralıkları bağımsız doğrular; varsayılan, tek operatörün takma adları değil, iki bağımsız sağlayıcıdır. Temel düğüm yüksekliği, ORDnet zincir bilgisi ve EVM dışı altyapı için EVM rölesi ödeme alma kanıtı değildir. Monero yine projeye bağlı, yalnızca görüntüleme yetkili wallet-RPC gerektirir.

healthy_endpointsintegerzincir üstü

Sağlıklı eşleşen uç noktalar; bağımsız sağlayıcı sayısı değildir.

usable_independent_providersintegerzincir üstü
En fazla iki kullanılabilir doğrulama yuvası. required_independent_providers zincir ayarıdır: varsayılan 2, yöneticinin açık seçimiyle 1. İki sağlayıcı modunda farklı sağlayıcı anahtarları VE ana makineler gerekir. Devre dışı, eski (on dakikadan fazla) veya bekleme süresindeki kaynaklar yuva doldurmaz. Lightning kendi bağlantı kurallarını kullanır.Ayrıntılar

En fazla iki kullanılabilir doğrulama yuvası. required_independent_providers zincir ayarıdır: varsayılan 2, yöneticinin açık seçimiyle 1. İki sağlayıcı modunda farklı sağlayıcı anahtarları VE ana makineler gerekir. Devre dışı, eski (on dakikadan fazla) veya bekleme süresindeki kaynaklar yuva doldurmaz. Lightning kendi bağlantı kurallarını kullanır.

required_independent_providersintegerzincir üstü
En fazla iki kullanılabilir doğrulama yuvası. required_independent_providers zincir ayarıdır: varsayılan 2, yöneticinin açık seçimiyle 1. İki sağlayıcı modunda farklı sağlayıcı anahtarları VE ana makineler gerekir. Devre dışı, eski (on dakikadan fazla) veya bekleme süresindeki kaynaklar yuva doldurmaz. Lightning kendi bağlantı kurallarını kullanır.Ayrıntılar

En fazla iki kullanılabilir doğrulama yuvası. required_independent_providers zincir ayarıdır: varsayılan 2, yöneticinin açık seçimiyle 1. İki sağlayıcı modunda farklı sağlayıcı anahtarları VE ana makineler gerekir. Devre dışı, eski (on dakikadan fazla) veya bekleme süresindeki kaynaklar yuva doldurmaz. Lightning kendi bağlantı kurallarını kullanır.

last_checked_attimestamp | nullzincir üstü

Değerlendirme zamanından ayrı, son eşleşen uç nokta sağlık kontrolü.

monero_wallet_rpcMoneroWalletRpcBinding | nullher zaman
Monero için hassas bilgileri ayıklanmış harici, yalnızca görüntüleme yetkili wallet-RPC bağlantı durumu. Uç nokta, kimlik doğrulama modu, account-0 birincil adresi, teknik kanıt işaretleri/yükseklikleri ve operatör beyanı zaman damgaları içerir; kimlik bilgileri, cüzdan anahtarları ve cüzdan dosyaları asla serileştirilmez.Ayrıntılar

Monero için hassas bilgileri ayıklanmış harici, yalnızca görüntüleme yetkili wallet-RPC bağlantı durumu. Uç nokta, kimlik doğrulama modu, account-0 birincil adresi, teknik kanıt işaretleri/yükseklikleri ve operatör beyanı zaman damgaları içerir; kimlik bilgileri, cüzdan anahtarları ve cüzdan dosyaları asla serileştirilmez.

last_secret_revealed_attimestamp|nullher zaman

Konsol tarafı sır gösterimi denetim meta verileri.

secret_reveal_countintegerher zaman

Konsol tarafı sır gösterimi denetim meta verileri.

next_receive_indexintegerher zaman

Sonraki ayrılmış alt adres indeksi.

last_scanned_heightinteger|nullher zaman

Cüzdan tarayıcısı durumu.

last_scanned_attimestamp|nullher zaman

Cüzdan tarayıcısı durumu.

last_errorstring|nullher zaman

Cüzdan tarayıcısı durumu.

balances[]object[]her zaman
30 yerel zincir altyapısının her biri ve doğrulanmış ERC-20 ile SPL varlıkları için önbellekteki bakiyeler. Monero için yapılandırılmış harici, yalnızca görüntüleme yetkili wallet-RPC gerekir.Ayrıntılar

30 yerel zincir altyapısının her biri ve doğrulanmış ERC-20 ile SPL varlıkları için önbellekteki bakiyeler. Monero için yapılandırılmış harici, yalnızca görüntüleme yetkili wallet-RPC gerekir.

wallet_idUUIDher zaman

Cüzdan ve kalıcı varlık kimlikleri.

asset_idUUIDher zaman

Cüzdan ve kalıcı varlık kimlikleri.

project_enabledbooleanher zaman

Bu varlığın şu anda projenin varlık politikasıyla etkin olup olmadığı.

active_store_countintegerher zaman

Şu anda bu varlığı seçen etkin mağaza sayısı. Bu, kabul durumunun görünümüdür; salt okunur bakiye takibi bağımsız kalır.

active_store_ids[]UUID[]her zaman

Bu projede varlığı şu anda kabul eden etkin mağazalar. Başka API isteği olmadan tam yerel mağaza filtrelemesi sağlar.

tracking_activebooleanher zaman
Bu okunabilir cüzdan ve kayıtlı aynı zincir varlığının arka plan bakiye yenilemesine uygun olup olmadığı. Proje ve ödeme yöntemi kabul anahtarları salt okunur takibi duraklatmaz.Ayrıntılar

Bu okunabilir cüzdan ve kayıtlı aynı zincir varlığının arka plan bakiye yenilemesine uygun olup olmadığı. Proje ve ödeme yöntemi kabul anahtarları salt okunur takibi duraklatmaz.

asset_kindnative | tokenher zaman

Yerel para birimi veya doğrulanmış sözleşme/mint varlığı.

contract_addressstring | nullher zaman

Token sözleşmesi veya mint'i; yerel para biriminde null.

symbolstringher zaman

Görüntüleme kimliği ve atomik hassasiyet.

namestringher zaman

Görüntüleme kimliği ve atomik hassasiyet.

decimalsintegerher zaman

Görüntüleme kimliği ve atomik hassasiyet.

coingecko_idstring | nullher zaman

Eşleştirilmişse fiyatlandırma kimliği.

balancedecimal string|nullher zaman

Cüzdanın birincil adresi ve oluşturulmuş fatura adresleri genelindeki tam gösterim ve atomik bakiye. Tam değer bulunamıyorsa null.

balance_atomicinteger string|nullher zaman

Cüzdanın birincil adresi ve oluşturulmuş fatura adresleri genelindeki tam gösterim ve atomik bakiye. Tam değer bulunamıyorsa null.

price_usddecimal string | nullher zaman

Değerleme için kullanılan bilgi amaçlı önbellek USD birim fiyatı.

value_usddecimal string | nullher zaman

Güncel kur varsa bilgi amaçlı itibari para değerlemesi.

statuspending | refreshing | fresh | stale | errorher zaman
Önbellek tarama durumu. refreshing tamamlanmış bakiyeyi koruyabilir: yaşı için checked_at kullan. Pending tamamlanmış görüntü yok demektir. Bu durumların hiçbiri transferin beklediğini veya faturanın tamamlandığını kanıtlamaz.Ayrıntılar

Önbellek tarama durumu. refreshing tamamlanmış bakiyeyi koruyabilir: yaşı için checked_at kullan. Pending tamamlanmış görüntü yok demektir. Bu durumların hiçbiri transferin beklediğini veya faturanın tamamlandığını kanıtlamaz.

checked_attimestamp | nullher zaman

Tamamlanmış bakiye taramasının temsil ettiği zaman.

last_errorstring | nullher zaman

Güvenli operatör teşhisi.

total_value_usddecimal string | nullher zaman

Güncel USD fiyatı bulunan bakiyelerin bilgi amaçlı toplamı.

balance_statuspending | refreshing | fresh | stale | error | unknownher zaman

Birleştirilmiş önbellek güncelliği; unknown temkinli yedek değerdir ve bu durumların hiçbiri fatura ödemesinin tamamlandığını kanıtlamaz.

balance_checked_attimestamp | nullher zaman

Toplamın temsil ettiği en eski ilgili başarılı bakiye kontrolü.

recent_payments[]object[]her zaman

Tam olarak bu cüzdana atfedilen, en yeni en fazla üç geçerli detected, confirming veya final gözlem.

invoice_public_idUUIDher zaman

Gözlemle ilişkili, müşteriye görünen fatura kimliği.

chain_slugstringher zaman

Zincir ve yerel coin veya doğrulanmış token görüntüleme sembolü.

symbolstringher zaman

Zincir ve yerel coin veya doğrulanmış token görüntüleme sembolü.

transaction_idstringher zaman

Kanonik işlem ve transfer olayı kimliği.

event_indexintegerher zaman

Kanonik işlem ve transfer olayı kimliği.

amountdecimal stringher zaman

Kayan nokta dönüşümü yapılmadan gözlenen tam varlık tutarı.

statusdetected | confirming | finalher zaman

Güncel geçerli gözlem durumu. Reorged, replaced ve invalid gözlemler hariç tutulur.

confirmationsintegerher zaman

Son gözlenen onay sayısı.

observed_atRFC 3339 timestampher zaman

Wholly Crypto'nun ödemeyi ilk gözlediği zaman.

created_atRFC 3339 timestampher zaman

Oluşturulma ve son cüzdan güncelleme zamanı.

updated_atRFC 3339 timestampher zaman

Oluşturulma ve son cüzdan güncelleme zamanı.

wallet_readinessreadiness enumher zaman
unsupported, project_disabled, project_asset_disabled, store_disabled, store_asset_disabled, wallet_missing, wallet_pending, wallet_disabled, wallet_error, backup_required, account_activation_required, external_wallet_rpc_required veya ready.Ayrıntılar

unsupported, project_disabled, project_asset_disabled, store_disabled, store_asset_disabled, wallet_missing, wallet_pending, wallet_disabled, wallet_error, backup_required, account_activation_required, external_wallet_rpc_required veya ready.

receive_readinessobject | null5.5.0+
Ortak proje ödeme alma kurulumu değerlendirmesi. Bakiye güncelliğinden ve gönderim gas'ından ayrı cüzdan ve bağımsız tarayıcı sağlayıcısı kontrollerini içerir. Proje politikası yoksa null. Fatura para birimi/kurları fatura oluştururken kontrol edilir.Ayrıntılar

Ortak proje ödeme alma kurulumu değerlendirmesi. Bakiye güncelliğinden ve gönderim gas'ından ayrı cüzdan ve bağımsız tarayıcı sağlayıcısı kontrollerini içerir. Proje politikası yoksa null. Fatura para birimi/kurları fatura oluştururken kontrol edilir.

readybooleanher zaman

Ödeme alma kurulum kontrolleri geçti. Harcamaya hazır olmayı, gas'ı, bakiye yenilemeyi veya garantili gelecek teklifi açıklamaz.

invoice_creatableboolean6.0.6+
Yapılandırma geçici tarayıcı uyarılarına rağmen fatura yöntemine izin verir. Para birimi fiyatlandırması oluşturma sırasında kontrol edilir. Bu ödeme doğrulaması değildir: invoice_creatable true iken ready false olabilir. Eksik cüzdanlar, devre dışı politika ve desteklenmeyen adaptörler yine güvenli biçimde başarısız olur.Ayrıntılar

Yapılandırma geçici tarayıcı uyarılarına rağmen fatura yöntemine izin verir. Para birimi fiyatlandırması oluşturma sırasında kontrol edilir. Bu ödeme doğrulaması değildir: invoice_creatable true iken ready false olabilir. Eksik cüzdanlar, devre dışı politika ve desteklenmeyen adaptörler yine güvenli biçimde başarısız olur.

checked_attimestampher zaman

Değerlendirme zamanı. Listeleme ağ isteği veya adres ayırma yapmaz.

issues[]object[]her zaman
Hazırsa boş; aksi halde ödeme alma uyarısı veya yapılandırma engeli. Geçici tarayıcı uyarılarını fatura kurulum hatalarından ayırmak için invoice_creatable kontrol et.Ayrıntılar

Hazırsa boş; aksi halde ödeme alma uyarısı veya yapılandırma engeli. Geçici tarayıcı uyarılarını fatura kurulum hatalarından ayırmak için invoice_creatable kontrol et.

chain_slugstringbiliniyorsa

Etkilenen zinciri ve varlığı tanımlar. Lightning asset_id içermeyebilir.

asset_idUUIDbiliniyorsa

Etkilenen zinciri ve varlığı tanımlar. Lightning asset_id içermeyebilir.

asset_tickerstringbiliniyorsa

Etkilenen zinciri ve varlığı tanımlar. Lightning asset_id içermeyebilir.

reason_codestringher zaman
scanner_provider_quorum, scanner_not_checked, scanner_unavailable, wallet_missing, wallet_disabled, wallet_backup_required, wallet_key_unavailable, wallet_activation_required, monero_binding_unavailable, rate_unavailable, custom_rate_unavailable, lightning_unavailable, project_disabled, store_disabled, chain_disabled, asset_disabled veya asset_not_accepted.Ayrıntılar

scanner_provider_quorum, scanner_not_checked, scanner_unavailable, wallet_missing, wallet_disabled, wallet_backup_required, wallet_key_unavailable, wallet_activation_required, monero_binding_unavailable, rate_unavailable, custom_rate_unavailable, lightning_unavailable, project_disabled, store_disabled, chain_disabled, asset_disabled veya asset_not_accepted.

messagestringvarsa
Satıcıya yönelik açıklama ve eylem tanımlayıcısı: chain_connections, wallets, rates, payment_methods, project_settings veya store_settings. Kimlik bilgisi veya özel sağlayıcı URL'si içermez.Ayrıntılar

Satıcıya yönelik açıklama ve eylem tanımlayıcısı: chain_connections, wallets, rates, payment_methods, project_settings veya store_settings. Kimlik bilgisi veya özel sağlayıcı URL'si içermez.

actionstringvarsa
Satıcıya yönelik açıklama ve eylem tanımlayıcısı: chain_connections, wallets, rates, payment_methods, project_settings veya store_settings. Kimlik bilgisi veya özel sağlayıcı URL'si içermez.Ayrıntılar

Satıcıya yönelik açıklama ve eylem tanımlayıcısı: chain_connections, wallets, rates, payment_methods, project_settings veya store_settings. Kimlik bilgisi veya özel sağlayıcı URL'si içermez.

required_endpoint_rolestring | nullzincir üstü
Tercih edilen tarayıcı API rolü (eski alan). Tam uyumluluk listesi için accepted_endpoint_roles kullan. Temel düğüm sağlığı ödeme geçmişi desteğini kanıtlamaz.Ayrıntılar

Tercih edilen tarayıcı API rolü (eski alan). Tam uyumluluk listesi için accepted_endpoint_roles kullan. Temel düğüm sağlığı ödeme geçmişi desteğini kanıtlamaz.

accepted_endpoint_roles[]string[] | nullzincir üstü
Uyumlu API biçimleri; uç nokta geçmişi veya kapasitesi kanıtı değildir. Ham node-rpc, BTC/BCH/LTC/DOGE/DASH ve şeffaf ZEC (tam çözümlenmiş bloklar, 1–48 onay), solidified yerel TRX, algod üzerinden yerel ALGO, Octez üzerinden XTZ, SCALE meta verileriyle kesinleşmiş Asset Hub DOT ve fatura memo ID'siyle Stellar RPC üzerinden yerel XLM destekler. Budanmış veya eksik geçmiş uygun değildir. Bu ham adaptörler token altyapısı eklemez. İndeksli API'ler alternatif olmaya devam eder; aşağıdaki altyapı tablosuna bak. Karma ham/indeksli kaynaklar sınırlı aralıkları bağımsız doğrular; varsayılan, tek operatörün takma adları değil, iki bağımsız sağlayıcıdır. Temel düğüm yüksekliği, ORDnet zincir bilgisi ve EVM dışı altyapı için EVM rölesi ödeme alma kanıtı değildir. Monero yine projeye bağlı, yalnızca görüntüleme yetkili wallet-RPC gerektirir.Ayrıntılar

Uyumlu API biçimleri; uç nokta geçmişi veya kapasitesi kanıtı değildir. Ham node-rpc, BTC/BCH/LTC/DOGE/DASH ve şeffaf ZEC (tam çözümlenmiş bloklar, 1–48 onay), solidified yerel TRX, algod üzerinden yerel ALGO, Octez üzerinden XTZ, SCALE meta verileriyle kesinleşmiş Asset Hub DOT ve fatura memo ID'siyle Stellar RPC üzerinden yerel XLM destekler. Budanmış veya eksik geçmiş uygun değildir. Bu ham adaptörler token altyapısı eklemez. İndeksli API'ler alternatif olmaya devam eder; aşağıdaki altyapı tablosuna bak. Karma ham/indeksli kaynaklar sınırlı aralıkları bağımsız doğrular; varsayılan, tek operatörün takma adları değil, iki bağımsız sağlayıcıdır. Temel düğüm yüksekliği, ORDnet zincir bilgisi ve EVM dışı altyapı için EVM rölesi ödeme alma kanıtı değildir. Monero yine projeye bağlı, yalnızca görüntüleme yetkili wallet-RPC gerektirir.

healthy_endpointsintegerzincir üstü

Sağlıklı eşleşen uç noktalar; bağımsız sağlayıcı sayısı değildir.

usable_independent_providersintegerzincir üstü
En fazla iki kullanılabilir doğrulama yuvası. required_independent_providers zincir ayarıdır: varsayılan 2, yöneticinin açık seçimiyle 1. İki sağlayıcı modunda farklı sağlayıcı anahtarları VE ana makineler gerekir. Devre dışı, eski (on dakikadan fazla) veya bekleme süresindeki kaynaklar yuva doldurmaz. Lightning kendi bağlantı kurallarını kullanır.Ayrıntılar

En fazla iki kullanılabilir doğrulama yuvası. required_independent_providers zincir ayarıdır: varsayılan 2, yöneticinin açık seçimiyle 1. İki sağlayıcı modunda farklı sağlayıcı anahtarları VE ana makineler gerekir. Devre dışı, eski (on dakikadan fazla) veya bekleme süresindeki kaynaklar yuva doldurmaz. Lightning kendi bağlantı kurallarını kullanır.

required_independent_providersintegerzincir üstü
En fazla iki kullanılabilir doğrulama yuvası. required_independent_providers zincir ayarıdır: varsayılan 2, yöneticinin açık seçimiyle 1. İki sağlayıcı modunda farklı sağlayıcı anahtarları VE ana makineler gerekir. Devre dışı, eski (on dakikadan fazla) veya bekleme süresindeki kaynaklar yuva doldurmaz. Lightning kendi bağlantı kurallarını kullanır.Ayrıntılar

En fazla iki kullanılabilir doğrulama yuvası. required_independent_providers zincir ayarıdır: varsayılan 2, yöneticinin açık seçimiyle 1. İki sağlayıcı modunda farklı sağlayıcı anahtarları VE ana makineler gerekir. Devre dışı, eski (on dakikadan fazla) veya bekleme süresindeki kaynaklar yuva doldurmaz. Lightning kendi bağlantı kurallarını kullanır.

last_checked_attimestamp | nullzincir üstü

Değerlendirme zamanından ayrı, son eşleşen uç nokta sağlık kontrolü.

Kullanım notları
  • Token küresel katalogda listelense bile scanner_ready veya payment_supported false olduğunda seçilemez kalabilir.
  • Operatör yetenek matrisi tarayıcının tam uç nokta rolünü de gerektirir; uyumsuz API sunan sağlıklı uç nokta sayılmaz.
  • Token'lar yerel zincirlerinin proje cüzdanını paylaşır; yeni kurtarma ifadesi oluşturmaz.
  • Gömülü cüzdan özetleri yalnızca hazırlık içindir ve bakiyeleri boş bırakır; zenginleştirilmiş bakiyeler için GET /v1/projects/{project_id}/wallets kullan.

Hatalar

Hata kodları ve yeniden deneme kuralları

PUTProje varlık politikasını güncelle/v1/projects/{project_id}/payment-assets/{asset_id}Okuma ve yazma

Tek bir kalıcı varlığın proje politikasını oluşturur veya değiştirir ve yenilenmiş proje varlık listesini döndürür. Yerel zinciri kapatmak yerel varlığı ve token'larını yeni faturalar için kullanılamaz yapar; ancak sonra devam edilebilsin diye token politikalarını, cüzdanları ve mağaza seçimlerini korur.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MERCHANT_API_TOKEN
Content-Typezorunluapplication/json
Acceptönerilenapplication/json

Yol parametreleri

project_idUUIDzorunlu

Kimlik bilgisine atanmış etkin proje.

asset_idUUIDzorunlu

Proje varlık listesinin veya token kaydının döndürdüğü varlık id'si.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request PUT \
  --url "https://api.example.com/v1/projects/YOUR_PROJECT_ID/payment-assets/YOUR_ASSET_ID" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "enabled": true,
  "finality_mode": "confirmations",
  "required_confirmations": 2,
  "monitoring_minutes": 60,
  "late_monitoring_days": 30
}'

İstek gövdesi

enabledbooleanzorunlu

Varlığı proje için etkinleştirir veya devre dışı bırakır. Herhangi bir token'dan önce yerel zincir etkin olmalıdır.

finality_modeconfirmations | finalizedzorunlu

Varlık ödeme altyapısının desteklediği kesinlik politikası. finalized, required_confirmations=1 gerektirir.

required_confirmationsintegerzorunlu
Bitcoin ve EVM altyapıları sıfır kabul eder; diğer onay altyapıları en az bir, yalnızca finalized altyapıları tam bir gerektirir. Her transferin işlem yeniden oynatma aralığında kalması için EVM altyapıları 0–48 ile sınırlıdır.Ayrıntılar

Bitcoin ve EVM altyapıları sıfır kabul eder; diğer onay altyapıları en az bir, yalnızca finalized altyapıları tam bir gerektirir. Her transferin işlem yeniden oynatma aralığında kalması için EVM altyapıları 0–48 ile sınırlıdır.

monitoring_minutesintegerzorunlu

Fatura etkinken 1–10.080 dakikalık sorgulama aralığı.

late_monitoring_daysintegerzorunlu

Fatura süresi dolduktan sonra 0–3.650 gün izleme.

Yanıt 200 application/json

Örnek yanıt
{
  "data": [
    { "asset": { "id": "ASSET_UUID", "symbol": "USDC", "asset_kind": "token", "scanner_ready": true }, "policy": { "enabled": true, "finality_mode": "confirmations", "required_confirmations": 2, "monitoring_minutes": 60, "late_monitoring_days": 30 }, "wallet_readiness": "ready" }
  ]
}

Yanıt alanları

data[]object[]
assetobjecther zaman

Kalıcı yerel varlık veya doğrulanmış token varlığı.

idUUIDher zaman

Proje ve mağaza politika rotalarının kullandığı kalıcı ödeme varlığı tanımlayıcısı.

asset_keystringher zaman

Kanonik CAIP biçimli yerel veya sözleşme varlığı kimliği.

chain_slugstringher zaman

Wholly Crypto zincir tanımlayıcısı ve yapılandırılmış ağ.

networkstringher zaman

Wholly Crypto zincir tanımlayıcısı ve yapılandırılmış ağ.

caip_network_idstringher zaman

Kanonik ağ ve varlık kimlikleri.

caip_asset_idstring|nullher zaman

Kanonik ağ ve varlık kimlikleri.

asset_kindnative | tokenher zaman

Ödeme tamamlanmasında zincir para biriminin mi, doğrulanmış sözleşme/mint'in mi kullanıldığı.

payment_railstringher zaman

Çalışma zamanı ödeme altyapısı: utxo, evm-native, solana-native, account-native, privacy-native veya token-transfer.

symbolstringher zaman

Görüntüleme kimliği ve tam atomik birim hassasiyeti.

namestringher zaman

Görüntüleme kimliği ve tam atomik birim hassasiyeti.

decimalsintegerher zaman

Görüntüleme kimliği ve tam atomik birim hassasiyeti.

contract_addressstring | nullher zaman

Token'lar için kanonik ERC-20 sözleşmesi veya SPL mint'i; yerel varlıklarda null.

coingecko_idstring | nullher zaman

Keşif/fiyatlandırma kimliği. Özel sözleşmelerde null; sembollerinden piyasa fiyatı çıkarma. CoinGecko meta verileri tek başına token'ı seçilebilir yapmaz.

custom_tokenbooleanher zaman

Proje kapsamlı sabit USD veya seçili DEX havuzu fiyatlandırması olan, zincir üstünde doğrulanmış özel sözleşme.

icon_pathpath | nullher zaman

Varsa yerel önbellekteki token simgesi.

token_standarderc20 | spl-token | nullher zaman

Doğrulanmış çalışma zamanı token standardı; yerel varlıklarda null.

metadata_verified_attimestamp | nullher zaman

Ödeme varlığına dönüştürülen token'ların zincir üstü meta veri doğrulama zamanı.

payment_supportedbooleanher zaman
Derleme zamanı kayıt kontrolleri. scanner_ready ödeme tarayıcısı çalışma ortamının kurulu olduğu anlamına gelir; ödeme onayı, yapılandırılmış sayıda sağlıklı ve tam role uygun sağlayıcı gerektirir (varsayılan 2, isteğe bağlı 1); geçici tarayıcı kullanılabilirliği 6.0.6'dan itibaren fatura oluşturmayı engellemez. balance_ready yalnızca uygulanmış bakiye adaptörlerinde true olur.Ayrıntılar

Derleme zamanı kayıt kontrolleri. scanner_ready ödeme tarayıcısı çalışma ortamının kurulu olduğu anlamına gelir; ödeme onayı, yapılandırılmış sayıda sağlıklı ve tam role uygun sağlayıcı gerektirir (varsayılan 2, isteğe bağlı 1); geçici tarayıcı kullanılabilirliği 6.0.6'dan itibaren fatura oluşturmayı engellemez. balance_ready yalnızca uygulanmış bakiye adaptörlerinde true olur.

scanner_readybooleanher zaman
Derleme zamanı kayıt kontrolleri. scanner_ready ödeme tarayıcısı çalışma ortamının kurulu olduğu anlamına gelir; ödeme onayı, yapılandırılmış sayıda sağlıklı ve tam role uygun sağlayıcı gerektirir (varsayılan 2, isteğe bağlı 1); geçici tarayıcı kullanılabilirliği 6.0.6'dan itibaren fatura oluşturmayı engellemez. balance_ready yalnızca uygulanmış bakiye adaptörlerinde true olur.Ayrıntılar

Derleme zamanı kayıt kontrolleri. scanner_ready ödeme tarayıcısı çalışma ortamının kurulu olduğu anlamına gelir; ödeme onayı, yapılandırılmış sayıda sağlıklı ve tam role uygun sağlayıcı gerektirir (varsayılan 2, isteğe bağlı 1); geçici tarayıcı kullanılabilirliği 6.0.6'dan itibaren fatura oluşturmayı engellemez. balance_ready yalnızca uygulanmış bakiye adaptörlerinde true olur.

balance_readybooleanher zaman
Derleme zamanı kayıt kontrolleri. scanner_ready ödeme tarayıcısı çalışma ortamının kurulu olduğu anlamına gelir; ödeme onayı, yapılandırılmış sayıda sağlıklı ve tam role uygun sağlayıcı gerektirir (varsayılan 2, isteğe bağlı 1); geçici tarayıcı kullanılabilirliği 6.0.6'dan itibaren fatura oluşturmayı engellemez. balance_ready yalnızca uygulanmış bakiye adaptörlerinde true olur.Ayrıntılar

Derleme zamanı kayıt kontrolleri. scanner_ready ödeme tarayıcısı çalışma ortamının kurulu olduğu anlamına gelir; ödeme onayı, yapılandırılmış sayıda sağlıklı ve tam role uygun sağlayıcı gerektirir (varsayılan 2, isteğe bağlı 1); geçici tarayıcı kullanılabilirliği 6.0.6'dan itibaren fatura oluşturmayı engellemez. balance_ready yalnızca uygulanmış bakiye adaptörlerinde true olur.

default_finality_modeconfirmations | finalizedher zaman

Yeni proje politikasının devraldığı varsayılan kesinlik modeli.

default_required_confirmationsintegerher zaman

Varsayılan onay ve izleme politikası.

default_monitoring_minutesintegerher zaman

Varsayılan onay ve izleme politikası.

policyobject | nullher zaman
Proje etkinleştirme/kesinlik politikası; yapılandırılmadıysa null. custom_price_mode (fixed/dex), custom_price_usd (sabit ondalık sayı dizesi veya null), custom_dex_pair (seçilen havuz veya null) ve custom_dex (dex_id, quote_symbol, güncel price_usd veya null, liquidity_usd, fetched_at, last_error) içerir. Özel fiyatlandırma bu projedeki mağazalar tarafından paylaşılır.Ayrıntılar

Proje etkinleştirme/kesinlik politikası; yapılandırılmadıysa null. custom_price_mode (fixed/dex), custom_price_usd (sabit ondalık sayı dizesi veya null), custom_dex_pair (seçilen havuz veya null) ve custom_dex (dex_id, quote_symbol, güncel price_usd veya null, liquidity_usd, fetched_at, last_error) içerir. Özel fiyatlandırma bu projedeki mağazalar tarafından paylaşılır.

enabledbooleanzorunlu

Varlığı proje için etkinleştirir veya devre dışı bırakır. Herhangi bir token'dan önce yerel zincir etkin olmalıdır.

finality_modeconfirmations | finalizedzorunlu

Varlık ödeme altyapısının desteklediği kesinlik politikası. finalized, required_confirmations=1 gerektirir.

required_confirmationsintegerzorunlu
Bitcoin ve EVM altyapıları sıfır kabul eder; diğer onay altyapıları en az bir, yalnızca finalized altyapıları tam bir gerektirir. Her transferin işlem yeniden oynatma aralığında kalması için EVM altyapıları 0–48 ile sınırlıdır.Ayrıntılar

Bitcoin ve EVM altyapıları sıfır kabul eder; diğer onay altyapıları en az bir, yalnızca finalized altyapıları tam bir gerektirir. Her transferin işlem yeniden oynatma aralığında kalması için EVM altyapıları 0–48 ile sınırlıdır.

monitoring_minutesintegerzorunlu

Fatura etkinken 1–10.080 dakikalık sorgulama aralığı.

late_monitoring_daysintegerzorunlu

Fatura süresi dolduktan sonra 0–3.650 gün izleme.

walletobject | nullher zaman

Zincirin saklama hizmeti olmayan proje cüzdanı. Token'lar zincirlerinin yerel cüzdanını paylaşır.

idUUIDher zaman

Cüzdan, sahibi proje ve zincirin yerel varlık tanımlayıcıları.

project_idUUIDher zaman

Cüzdan, sahibi proje ve zincirin yerel varlık tanımlayıcıları.

native_asset_idUUIDher zaman

Cüzdan, sahibi proje ve zincirin yerel varlık tanımlayıcıları.

chain_slugstringher zaman

Cüzdan zinciri ve ağı.

networkstringher zaman

Cüzdan zinciri ve ağı.

asset_symbolstringher zaman

Zincirin yerel varlığının görüntüleme kimliği.

asset_namestringher zaman

Zincirin yerel varlığının görüntüleme kimliği.

statuspending | active | disabled | errorher zaman

Cüzdanın çalışma durumu.

labelstringher zaman

Operatör etiketi.

public_keystring | nullher zaman

Herkese açık cüzdan kimliği; kurtarma ifadesi veya özel anahtar açığa çıkarılmaz.

primary_addressstring | nullher zaman

Herkese açık cüzdan kimliği; kurtarma ifadesi veya özel anahtar açığa çıkarılmaz.

derivation_schemestring | nullher zaman

Adres politikası ve biçimi.

address_formatstring | nullher zaman

Adres politikası ve biçimi.

backup_confirmed_attimestamp | nullher zaman

Operatör kurtarma yedeğini onayladıktan sonra null değildir.

activation_requiredbooleanher zaman
XRP ve Stellar ortak hesapları, operatör gösterilen adrese fon gönderene ve yapılandırılmış tarayıcı sağlayıcıları tam olarak o hesabı doğrulayana kadar kullanılamaz. Kalıcı kanıtın süresi dolmaz; canlı tarayıcı sağlığı fatura oluşturma için değil, ödeme doğrulaması için ayrı kontrol edilir.Ayrıntılar

XRP ve Stellar ortak hesapları, operatör gösterilen adrese fon gönderene ve yapılandırılmış tarayıcı sağlayıcıları tam olarak o hesabı doğrulayana kadar kullanılamaz. Kalıcı kanıtın süresi dolmaz; canlı tarayıcı sağlığı fatura oluşturma için değil, ödeme doğrulaması için ayrı kontrol edilir.

activation_verified_attimestamp|nullher zaman
XRP ve Stellar ortak hesapları, operatör gösterilen adrese fon gönderene ve yapılandırılmış tarayıcı sağlayıcıları tam olarak o hesabı doğrulayana kadar kullanılamaz. Kalıcı kanıtın süresi dolmaz; canlı tarayıcı sağlığı fatura oluşturma için değil, ödeme doğrulaması için ayrı kontrol edilir.Ayrıntılar

XRP ve Stellar ortak hesapları, operatör gösterilen adrese fon gönderene ve yapılandırılmış tarayıcı sağlayıcıları tam olarak o hesabı doğrulayana kadar kullanılamaz. Kalıcı kanıtın süresi dolmaz; canlı tarayıcı sağlığı fatura oluşturma için değil, ödeme doğrulaması için ayrı kontrol edilir.

receive_readinessobject | null5.5.0+
Cüzdan listelerine dahildir: proje ödeme alma kurulumu ve zincir tarayıcısı ön koşulları. Bakiyelerden, token gas'ından ve gönderime hazır olma durumundan ayrıdır. Diğer cüzdan yanıtlarında null kalabilir.Ayrıntılar

Cüzdan listelerine dahildir: proje ödeme alma kurulumu ve zincir tarayıcısı ön koşulları. Bakiyelerden, token gas'ından ve gönderime hazır olma durumundan ayrıdır. Diğer cüzdan yanıtlarında null kalabilir.

readybooleanher zaman

Ödeme alma kurulum kontrolleri geçti. Harcamaya hazır olmayı, gas'ı, bakiye yenilemeyi veya garantili gelecek teklifi açıklamaz.

invoice_creatableboolean6.0.6+
Yapılandırma geçici tarayıcı uyarılarına rağmen fatura yöntemine izin verir. Para birimi fiyatlandırması oluşturma sırasında kontrol edilir. Bu ödeme doğrulaması değildir: invoice_creatable true iken ready false olabilir. Eksik cüzdanlar, devre dışı politika ve desteklenmeyen adaptörler yine güvenli biçimde başarısız olur.Ayrıntılar

Yapılandırma geçici tarayıcı uyarılarına rağmen fatura yöntemine izin verir. Para birimi fiyatlandırması oluşturma sırasında kontrol edilir. Bu ödeme doğrulaması değildir: invoice_creatable true iken ready false olabilir. Eksik cüzdanlar, devre dışı politika ve desteklenmeyen adaptörler yine güvenli biçimde başarısız olur.

checked_attimestampher zaman

Değerlendirme zamanı. Listeleme ağ isteği veya adres ayırma yapmaz.

issues[]object[]her zaman
Hazırsa boş; aksi halde ödeme alma uyarısı veya yapılandırma engeli. Geçici tarayıcı uyarılarını fatura kurulum hatalarından ayırmak için invoice_creatable kontrol et.Ayrıntılar

Hazırsa boş; aksi halde ödeme alma uyarısı veya yapılandırma engeli. Geçici tarayıcı uyarılarını fatura kurulum hatalarından ayırmak için invoice_creatable kontrol et.

chain_slugstringbiliniyorsa

Etkilenen zinciri ve varlığı tanımlar. Lightning asset_id içermeyebilir.

asset_idUUIDbiliniyorsa

Etkilenen zinciri ve varlığı tanımlar. Lightning asset_id içermeyebilir.

asset_tickerstringbiliniyorsa

Etkilenen zinciri ve varlığı tanımlar. Lightning asset_id içermeyebilir.

reason_codestringher zaman
scanner_provider_quorum, scanner_not_checked, scanner_unavailable, wallet_missing, wallet_disabled, wallet_backup_required, wallet_key_unavailable, wallet_activation_required, monero_binding_unavailable, rate_unavailable, custom_rate_unavailable, lightning_unavailable, project_disabled, store_disabled, chain_disabled, asset_disabled veya asset_not_accepted.Ayrıntılar

scanner_provider_quorum, scanner_not_checked, scanner_unavailable, wallet_missing, wallet_disabled, wallet_backup_required, wallet_key_unavailable, wallet_activation_required, monero_binding_unavailable, rate_unavailable, custom_rate_unavailable, lightning_unavailable, project_disabled, store_disabled, chain_disabled, asset_disabled veya asset_not_accepted.

messagestringvarsa
Satıcıya yönelik açıklama ve eylem tanımlayıcısı: chain_connections, wallets, rates, payment_methods, project_settings veya store_settings. Kimlik bilgisi veya özel sağlayıcı URL'si içermez.Ayrıntılar

Satıcıya yönelik açıklama ve eylem tanımlayıcısı: chain_connections, wallets, rates, payment_methods, project_settings veya store_settings. Kimlik bilgisi veya özel sağlayıcı URL'si içermez.

actionstringvarsa
Satıcıya yönelik açıklama ve eylem tanımlayıcısı: chain_connections, wallets, rates, payment_methods, project_settings veya store_settings. Kimlik bilgisi veya özel sağlayıcı URL'si içermez.Ayrıntılar

Satıcıya yönelik açıklama ve eylem tanımlayıcısı: chain_connections, wallets, rates, payment_methods, project_settings veya store_settings. Kimlik bilgisi veya özel sağlayıcı URL'si içermez.

required_endpoint_rolestring | nullzincir üstü
Tercih edilen tarayıcı API rolü (eski alan). Tam uyumluluk listesi için accepted_endpoint_roles kullan. Temel düğüm sağlığı ödeme geçmişi desteğini kanıtlamaz.Ayrıntılar

Tercih edilen tarayıcı API rolü (eski alan). Tam uyumluluk listesi için accepted_endpoint_roles kullan. Temel düğüm sağlığı ödeme geçmişi desteğini kanıtlamaz.

accepted_endpoint_roles[]string[] | nullzincir üstü
Uyumlu API biçimleri; uç nokta geçmişi veya kapasitesi kanıtı değildir. Ham node-rpc, BTC/BCH/LTC/DOGE/DASH ve şeffaf ZEC (tam çözümlenmiş bloklar, 1–48 onay), solidified yerel TRX, algod üzerinden yerel ALGO, Octez üzerinden XTZ, SCALE meta verileriyle kesinleşmiş Asset Hub DOT ve fatura memo ID'siyle Stellar RPC üzerinden yerel XLM destekler. Budanmış veya eksik geçmiş uygun değildir. Bu ham adaptörler token altyapısı eklemez. İndeksli API'ler alternatif olmaya devam eder; aşağıdaki altyapı tablosuna bak. Karma ham/indeksli kaynaklar sınırlı aralıkları bağımsız doğrular; varsayılan, tek operatörün takma adları değil, iki bağımsız sağlayıcıdır. Temel düğüm yüksekliği, ORDnet zincir bilgisi ve EVM dışı altyapı için EVM rölesi ödeme alma kanıtı değildir. Monero yine projeye bağlı, yalnızca görüntüleme yetkili wallet-RPC gerektirir.Ayrıntılar

Uyumlu API biçimleri; uç nokta geçmişi veya kapasitesi kanıtı değildir. Ham node-rpc, BTC/BCH/LTC/DOGE/DASH ve şeffaf ZEC (tam çözümlenmiş bloklar, 1–48 onay), solidified yerel TRX, algod üzerinden yerel ALGO, Octez üzerinden XTZ, SCALE meta verileriyle kesinleşmiş Asset Hub DOT ve fatura memo ID'siyle Stellar RPC üzerinden yerel XLM destekler. Budanmış veya eksik geçmiş uygun değildir. Bu ham adaptörler token altyapısı eklemez. İndeksli API'ler alternatif olmaya devam eder; aşağıdaki altyapı tablosuna bak. Karma ham/indeksli kaynaklar sınırlı aralıkları bağımsız doğrular; varsayılan, tek operatörün takma adları değil, iki bağımsız sağlayıcıdır. Temel düğüm yüksekliği, ORDnet zincir bilgisi ve EVM dışı altyapı için EVM rölesi ödeme alma kanıtı değildir. Monero yine projeye bağlı, yalnızca görüntüleme yetkili wallet-RPC gerektirir.

healthy_endpointsintegerzincir üstü

Sağlıklı eşleşen uç noktalar; bağımsız sağlayıcı sayısı değildir.

usable_independent_providersintegerzincir üstü
En fazla iki kullanılabilir doğrulama yuvası. required_independent_providers zincir ayarıdır: varsayılan 2, yöneticinin açık seçimiyle 1. İki sağlayıcı modunda farklı sağlayıcı anahtarları VE ana makineler gerekir. Devre dışı, eski (on dakikadan fazla) veya bekleme süresindeki kaynaklar yuva doldurmaz. Lightning kendi bağlantı kurallarını kullanır.Ayrıntılar

En fazla iki kullanılabilir doğrulama yuvası. required_independent_providers zincir ayarıdır: varsayılan 2, yöneticinin açık seçimiyle 1. İki sağlayıcı modunda farklı sağlayıcı anahtarları VE ana makineler gerekir. Devre dışı, eski (on dakikadan fazla) veya bekleme süresindeki kaynaklar yuva doldurmaz. Lightning kendi bağlantı kurallarını kullanır.

required_independent_providersintegerzincir üstü
En fazla iki kullanılabilir doğrulama yuvası. required_independent_providers zincir ayarıdır: varsayılan 2, yöneticinin açık seçimiyle 1. İki sağlayıcı modunda farklı sağlayıcı anahtarları VE ana makineler gerekir. Devre dışı, eski (on dakikadan fazla) veya bekleme süresindeki kaynaklar yuva doldurmaz. Lightning kendi bağlantı kurallarını kullanır.Ayrıntılar

En fazla iki kullanılabilir doğrulama yuvası. required_independent_providers zincir ayarıdır: varsayılan 2, yöneticinin açık seçimiyle 1. İki sağlayıcı modunda farklı sağlayıcı anahtarları VE ana makineler gerekir. Devre dışı, eski (on dakikadan fazla) veya bekleme süresindeki kaynaklar yuva doldurmaz. Lightning kendi bağlantı kurallarını kullanır.

last_checked_attimestamp | nullzincir üstü

Değerlendirme zamanından ayrı, son eşleşen uç nokta sağlık kontrolü.

monero_wallet_rpcMoneroWalletRpcBinding | nullher zaman
Monero için hassas bilgileri ayıklanmış harici, yalnızca görüntüleme yetkili wallet-RPC bağlantı durumu. Uç nokta, kimlik doğrulama modu, account-0 birincil adresi, teknik kanıt işaretleri/yükseklikleri ve operatör beyanı zaman damgaları içerir; kimlik bilgileri, cüzdan anahtarları ve cüzdan dosyaları asla serileştirilmez.Ayrıntılar

Monero için hassas bilgileri ayıklanmış harici, yalnızca görüntüleme yetkili wallet-RPC bağlantı durumu. Uç nokta, kimlik doğrulama modu, account-0 birincil adresi, teknik kanıt işaretleri/yükseklikleri ve operatör beyanı zaman damgaları içerir; kimlik bilgileri, cüzdan anahtarları ve cüzdan dosyaları asla serileştirilmez.

last_secret_revealed_attimestamp|nullher zaman

Konsol tarafı sır gösterimi denetim meta verileri.

secret_reveal_countintegerher zaman

Konsol tarafı sır gösterimi denetim meta verileri.

next_receive_indexintegerher zaman

Sonraki ayrılmış alt adres indeksi.

last_scanned_heightinteger|nullher zaman

Cüzdan tarayıcısı durumu.

last_scanned_attimestamp|nullher zaman

Cüzdan tarayıcısı durumu.

last_errorstring|nullher zaman

Cüzdan tarayıcısı durumu.

balances[]object[]her zaman
30 yerel zincir altyapısının her biri ve doğrulanmış ERC-20 ile SPL varlıkları için önbellekteki bakiyeler. Monero için yapılandırılmış harici, yalnızca görüntüleme yetkili wallet-RPC gerekir.Ayrıntılar

30 yerel zincir altyapısının her biri ve doğrulanmış ERC-20 ile SPL varlıkları için önbellekteki bakiyeler. Monero için yapılandırılmış harici, yalnızca görüntüleme yetkili wallet-RPC gerekir.

wallet_idUUIDher zaman

Cüzdan ve kalıcı varlık kimlikleri.

asset_idUUIDher zaman

Cüzdan ve kalıcı varlık kimlikleri.

project_enabledbooleanher zaman

Bu varlığın şu anda projenin varlık politikasıyla etkin olup olmadığı.

active_store_countintegerher zaman

Şu anda bu varlığı seçen etkin mağaza sayısı. Bu, kabul durumunun görünümüdür; salt okunur bakiye takibi bağımsız kalır.

active_store_ids[]UUID[]her zaman

Bu projede varlığı şu anda kabul eden etkin mağazalar. Başka API isteği olmadan tam yerel mağaza filtrelemesi sağlar.

tracking_activebooleanher zaman
Bu okunabilir cüzdan ve kayıtlı aynı zincir varlığının arka plan bakiye yenilemesine uygun olup olmadığı. Proje ve ödeme yöntemi kabul anahtarları salt okunur takibi duraklatmaz.Ayrıntılar

Bu okunabilir cüzdan ve kayıtlı aynı zincir varlığının arka plan bakiye yenilemesine uygun olup olmadığı. Proje ve ödeme yöntemi kabul anahtarları salt okunur takibi duraklatmaz.

asset_kindnative | tokenher zaman

Yerel para birimi veya doğrulanmış sözleşme/mint varlığı.

contract_addressstring | nullher zaman

Token sözleşmesi veya mint'i; yerel para biriminde null.

symbolstringher zaman

Görüntüleme kimliği ve atomik hassasiyet.

namestringher zaman

Görüntüleme kimliği ve atomik hassasiyet.

decimalsintegerher zaman

Görüntüleme kimliği ve atomik hassasiyet.

coingecko_idstring | nullher zaman

Eşleştirilmişse fiyatlandırma kimliği.

balancedecimal string|nullher zaman

Cüzdanın birincil adresi ve oluşturulmuş fatura adresleri genelindeki tam gösterim ve atomik bakiye. Tam değer bulunamıyorsa null.

balance_atomicinteger string|nullher zaman

Cüzdanın birincil adresi ve oluşturulmuş fatura adresleri genelindeki tam gösterim ve atomik bakiye. Tam değer bulunamıyorsa null.

price_usddecimal string | nullher zaman

Değerleme için kullanılan bilgi amaçlı önbellek USD birim fiyatı.

value_usddecimal string | nullher zaman

Güncel kur varsa bilgi amaçlı itibari para değerlemesi.

statuspending | refreshing | fresh | stale | errorher zaman
Önbellek tarama durumu. refreshing tamamlanmış bakiyeyi koruyabilir: yaşı için checked_at kullan. Pending tamamlanmış görüntü yok demektir. Bu durumların hiçbiri transferin beklediğini veya faturanın tamamlandığını kanıtlamaz.Ayrıntılar

Önbellek tarama durumu. refreshing tamamlanmış bakiyeyi koruyabilir: yaşı için checked_at kullan. Pending tamamlanmış görüntü yok demektir. Bu durumların hiçbiri transferin beklediğini veya faturanın tamamlandığını kanıtlamaz.

checked_attimestamp | nullher zaman

Tamamlanmış bakiye taramasının temsil ettiği zaman.

last_errorstring | nullher zaman

Güvenli operatör teşhisi.

total_value_usddecimal string | nullher zaman

Güncel USD fiyatı bulunan bakiyelerin bilgi amaçlı toplamı.

balance_statuspending | refreshing | fresh | stale | error | unknownher zaman

Birleştirilmiş önbellek güncelliği; unknown temkinli yedek değerdir ve bu durumların hiçbiri fatura ödemesinin tamamlandığını kanıtlamaz.

balance_checked_attimestamp | nullher zaman

Toplamın temsil ettiği en eski ilgili başarılı bakiye kontrolü.

recent_payments[]object[]her zaman

Tam olarak bu cüzdana atfedilen, en yeni en fazla üç geçerli detected, confirming veya final gözlem.

invoice_public_idUUIDher zaman

Gözlemle ilişkili, müşteriye görünen fatura kimliği.

chain_slugstringher zaman

Zincir ve yerel coin veya doğrulanmış token görüntüleme sembolü.

symbolstringher zaman

Zincir ve yerel coin veya doğrulanmış token görüntüleme sembolü.

transaction_idstringher zaman

Kanonik işlem ve transfer olayı kimliği.

event_indexintegerher zaman

Kanonik işlem ve transfer olayı kimliği.

amountdecimal stringher zaman

Kayan nokta dönüşümü yapılmadan gözlenen tam varlık tutarı.

statusdetected | confirming | finalher zaman

Güncel geçerli gözlem durumu. Reorged, replaced ve invalid gözlemler hariç tutulur.

confirmationsintegerher zaman

Son gözlenen onay sayısı.

observed_atRFC 3339 timestampher zaman

Wholly Crypto'nun ödemeyi ilk gözlediği zaman.

created_atRFC 3339 timestampher zaman

Oluşturulma ve son cüzdan güncelleme zamanı.

updated_atRFC 3339 timestampher zaman

Oluşturulma ve son cüzdan güncelleme zamanı.

wallet_readinessreadiness enumher zaman
unsupported, project_disabled, project_asset_disabled, store_disabled, store_asset_disabled, wallet_missing, wallet_pending, wallet_disabled, wallet_error, backup_required, account_activation_required, external_wallet_rpc_required veya ready.Ayrıntılar

unsupported, project_disabled, project_asset_disabled, store_disabled, store_asset_disabled, wallet_missing, wallet_pending, wallet_disabled, wallet_error, backup_required, account_activation_required, external_wallet_rpc_required veya ready.

receive_readinessobject | null5.5.0+
Ortak proje ödeme alma kurulumu değerlendirmesi. Bakiye güncelliğinden ve gönderim gas'ından ayrı cüzdan ve bağımsız tarayıcı sağlayıcısı kontrollerini içerir. Proje politikası yoksa null. Fatura para birimi/kurları fatura oluştururken kontrol edilir.Ayrıntılar

Ortak proje ödeme alma kurulumu değerlendirmesi. Bakiye güncelliğinden ve gönderim gas'ından ayrı cüzdan ve bağımsız tarayıcı sağlayıcısı kontrollerini içerir. Proje politikası yoksa null. Fatura para birimi/kurları fatura oluştururken kontrol edilir.

readybooleanher zaman

Ödeme alma kurulum kontrolleri geçti. Harcamaya hazır olmayı, gas'ı, bakiye yenilemeyi veya garantili gelecek teklifi açıklamaz.

invoice_creatableboolean6.0.6+
Yapılandırma geçici tarayıcı uyarılarına rağmen fatura yöntemine izin verir. Para birimi fiyatlandırması oluşturma sırasında kontrol edilir. Bu ödeme doğrulaması değildir: invoice_creatable true iken ready false olabilir. Eksik cüzdanlar, devre dışı politika ve desteklenmeyen adaptörler yine güvenli biçimde başarısız olur.Ayrıntılar

Yapılandırma geçici tarayıcı uyarılarına rağmen fatura yöntemine izin verir. Para birimi fiyatlandırması oluşturma sırasında kontrol edilir. Bu ödeme doğrulaması değildir: invoice_creatable true iken ready false olabilir. Eksik cüzdanlar, devre dışı politika ve desteklenmeyen adaptörler yine güvenli biçimde başarısız olur.

checked_attimestampher zaman

Değerlendirme zamanı. Listeleme ağ isteği veya adres ayırma yapmaz.

issues[]object[]her zaman
Hazırsa boş; aksi halde ödeme alma uyarısı veya yapılandırma engeli. Geçici tarayıcı uyarılarını fatura kurulum hatalarından ayırmak için invoice_creatable kontrol et.Ayrıntılar

Hazırsa boş; aksi halde ödeme alma uyarısı veya yapılandırma engeli. Geçici tarayıcı uyarılarını fatura kurulum hatalarından ayırmak için invoice_creatable kontrol et.

chain_slugstringbiliniyorsa

Etkilenen zinciri ve varlığı tanımlar. Lightning asset_id içermeyebilir.

asset_idUUIDbiliniyorsa

Etkilenen zinciri ve varlığı tanımlar. Lightning asset_id içermeyebilir.

asset_tickerstringbiliniyorsa

Etkilenen zinciri ve varlığı tanımlar. Lightning asset_id içermeyebilir.

reason_codestringher zaman
scanner_provider_quorum, scanner_not_checked, scanner_unavailable, wallet_missing, wallet_disabled, wallet_backup_required, wallet_key_unavailable, wallet_activation_required, monero_binding_unavailable, rate_unavailable, custom_rate_unavailable, lightning_unavailable, project_disabled, store_disabled, chain_disabled, asset_disabled veya asset_not_accepted.Ayrıntılar

scanner_provider_quorum, scanner_not_checked, scanner_unavailable, wallet_missing, wallet_disabled, wallet_backup_required, wallet_key_unavailable, wallet_activation_required, monero_binding_unavailable, rate_unavailable, custom_rate_unavailable, lightning_unavailable, project_disabled, store_disabled, chain_disabled, asset_disabled veya asset_not_accepted.

messagestringvarsa
Satıcıya yönelik açıklama ve eylem tanımlayıcısı: chain_connections, wallets, rates, payment_methods, project_settings veya store_settings. Kimlik bilgisi veya özel sağlayıcı URL'si içermez.Ayrıntılar

Satıcıya yönelik açıklama ve eylem tanımlayıcısı: chain_connections, wallets, rates, payment_methods, project_settings veya store_settings. Kimlik bilgisi veya özel sağlayıcı URL'si içermez.

actionstringvarsa
Satıcıya yönelik açıklama ve eylem tanımlayıcısı: chain_connections, wallets, rates, payment_methods, project_settings veya store_settings. Kimlik bilgisi veya özel sağlayıcı URL'si içermez.Ayrıntılar

Satıcıya yönelik açıklama ve eylem tanımlayıcısı: chain_connections, wallets, rates, payment_methods, project_settings veya store_settings. Kimlik bilgisi veya özel sağlayıcı URL'si içermez.

required_endpoint_rolestring | nullzincir üstü
Tercih edilen tarayıcı API rolü (eski alan). Tam uyumluluk listesi için accepted_endpoint_roles kullan. Temel düğüm sağlığı ödeme geçmişi desteğini kanıtlamaz.Ayrıntılar

Tercih edilen tarayıcı API rolü (eski alan). Tam uyumluluk listesi için accepted_endpoint_roles kullan. Temel düğüm sağlığı ödeme geçmişi desteğini kanıtlamaz.

accepted_endpoint_roles[]string[] | nullzincir üstü
Uyumlu API biçimleri; uç nokta geçmişi veya kapasitesi kanıtı değildir. Ham node-rpc, BTC/BCH/LTC/DOGE/DASH ve şeffaf ZEC (tam çözümlenmiş bloklar, 1–48 onay), solidified yerel TRX, algod üzerinden yerel ALGO, Octez üzerinden XTZ, SCALE meta verileriyle kesinleşmiş Asset Hub DOT ve fatura memo ID'siyle Stellar RPC üzerinden yerel XLM destekler. Budanmış veya eksik geçmiş uygun değildir. Bu ham adaptörler token altyapısı eklemez. İndeksli API'ler alternatif olmaya devam eder; aşağıdaki altyapı tablosuna bak. Karma ham/indeksli kaynaklar sınırlı aralıkları bağımsız doğrular; varsayılan, tek operatörün takma adları değil, iki bağımsız sağlayıcıdır. Temel düğüm yüksekliği, ORDnet zincir bilgisi ve EVM dışı altyapı için EVM rölesi ödeme alma kanıtı değildir. Monero yine projeye bağlı, yalnızca görüntüleme yetkili wallet-RPC gerektirir.Ayrıntılar

Uyumlu API biçimleri; uç nokta geçmişi veya kapasitesi kanıtı değildir. Ham node-rpc, BTC/BCH/LTC/DOGE/DASH ve şeffaf ZEC (tam çözümlenmiş bloklar, 1–48 onay), solidified yerel TRX, algod üzerinden yerel ALGO, Octez üzerinden XTZ, SCALE meta verileriyle kesinleşmiş Asset Hub DOT ve fatura memo ID'siyle Stellar RPC üzerinden yerel XLM destekler. Budanmış veya eksik geçmiş uygun değildir. Bu ham adaptörler token altyapısı eklemez. İndeksli API'ler alternatif olmaya devam eder; aşağıdaki altyapı tablosuna bak. Karma ham/indeksli kaynaklar sınırlı aralıkları bağımsız doğrular; varsayılan, tek operatörün takma adları değil, iki bağımsız sağlayıcıdır. Temel düğüm yüksekliği, ORDnet zincir bilgisi ve EVM dışı altyapı için EVM rölesi ödeme alma kanıtı değildir. Monero yine projeye bağlı, yalnızca görüntüleme yetkili wallet-RPC gerektirir.

healthy_endpointsintegerzincir üstü

Sağlıklı eşleşen uç noktalar; bağımsız sağlayıcı sayısı değildir.

usable_independent_providersintegerzincir üstü
En fazla iki kullanılabilir doğrulama yuvası. required_independent_providers zincir ayarıdır: varsayılan 2, yöneticinin açık seçimiyle 1. İki sağlayıcı modunda farklı sağlayıcı anahtarları VE ana makineler gerekir. Devre dışı, eski (on dakikadan fazla) veya bekleme süresindeki kaynaklar yuva doldurmaz. Lightning kendi bağlantı kurallarını kullanır.Ayrıntılar

En fazla iki kullanılabilir doğrulama yuvası. required_independent_providers zincir ayarıdır: varsayılan 2, yöneticinin açık seçimiyle 1. İki sağlayıcı modunda farklı sağlayıcı anahtarları VE ana makineler gerekir. Devre dışı, eski (on dakikadan fazla) veya bekleme süresindeki kaynaklar yuva doldurmaz. Lightning kendi bağlantı kurallarını kullanır.

required_independent_providersintegerzincir üstü
En fazla iki kullanılabilir doğrulama yuvası. required_independent_providers zincir ayarıdır: varsayılan 2, yöneticinin açık seçimiyle 1. İki sağlayıcı modunda farklı sağlayıcı anahtarları VE ana makineler gerekir. Devre dışı, eski (on dakikadan fazla) veya bekleme süresindeki kaynaklar yuva doldurmaz. Lightning kendi bağlantı kurallarını kullanır.Ayrıntılar

En fazla iki kullanılabilir doğrulama yuvası. required_independent_providers zincir ayarıdır: varsayılan 2, yöneticinin açık seçimiyle 1. İki sağlayıcı modunda farklı sağlayıcı anahtarları VE ana makineler gerekir. Devre dışı, eski (on dakikadan fazla) veya bekleme süresindeki kaynaklar yuva doldurmaz. Lightning kendi bağlantı kurallarını kullanır.

last_checked_attimestamp | nullzincir üstü

Değerlendirme zamanından ayrı, son eşleşen uç nokta sağlık kontrolü.

Kullanım notları
  • Gövde politikanın tamamını değiştirir ve bilinmeyen alanları reddeder.
  • Projede etkinleştirmek tek başına varlığı herhangi bir mağaza için seçmez.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETÖdeme token'ı adaylarına göz at/v1/projects/{project_id}/payment-token-candidatesSalt okunur

Yalnızca token fatura tarayıcısı ve bakiye adaptörü uygulanmış zincirlerde yerel önbellekteki CoinGecko sözleşme eşlemelerini arar. Sonuçlar güvenilir ödeme varlıkları değil, keşif adaylarıdır.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MERCHANT_API_TOKEN
Acceptönerilenapplication/json

Yol parametreleri

project_idUUIDzorunlu

Kimlik bilgisine atanmış etkin proje.

Sorgu parametreleri

chain_slugstring

Desteklenen EVM zincir kısa adı veya solana zorunludur.

qstring

İsteğe bağlı ad, sembol, CoinGecko id, sözleşme veya mint alt dizesi; en fazla 80 karakter.

limitinteger

İsteğe bağlı 1–100; varsayılan 50.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/projects/YOUR_PROJECT_ID/payment-token-candidates?chain_slug=ethereum&q=USDC&limit=50" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "data": [
    {
      "coingecko_id": "usd-coin",
      "chain_slug": "ethereum",
      "symbol": "USDC",
      "name": "USDC",
      "contract_address": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
      "market_cap_rank": 7,
      "icon_path": "/assets/coingecko/usd-coin.png",
      "current_price_usd": "1.0001",
      "token_standard": "erc20",
      "scanner_ready": true,
      "registered_asset_id": null,
      "project_enabled": false
    }
  ]
}

Yanıt alanları

data[]object[]
coingecko_idstringher zaman

Kayıt isteğinin kullandığı CoinGecko keşif kimliği.

chain_slugstringher zaman

Eşleşen Wholly Crypto zinciri.

symbolstringher zaman

Katalog görüntüleme kimliği.

namestringher zaman

Katalog görüntüleme kimliği.

contract_addressstringher zaman

Eşleşen sözleşme veya mint; kayıttan önce zincir üstünde doğrulanır.

market_cap_rankinteger | nullher zaman

Keşif sırası; güven veya ödemeye hazır olma sinyali değildir.

icon_pathpathher zaman

Yerel önbellekteki CoinGecko simge yolu.

current_price_usddecimal string | nullher zaman

Bilgi amaçlı önbellek USD fiyatı.

token_standarderc20 | spl-tokenher zaman

Seçilen zincir adaptörünün desteklediği token standardı.

scanner_readybooleanher zaman

Yalnızca bu derlemede uygulanmış token altyapısındaki adaylar için true.

registered_asset_idUUID | nullher zaman

Daha önce ödeme varlığına dönüştürüldüyse mevcut kalıcı varlık.

project_enabledbooleanher zaman

Kayıtlı varlığın bu proje için etkin olup olmadığı.

Kullanım notları
  • Desteklenen token adaptörleri: Ethereum, Base, BNB Chain, HyperEVM, Avalanche, Polygon, Arbitrum ve Optimism üzerinde ERC-20; Solana üzerinde SPL.
  • Desteklenmeyen katalog zincirleri seçilebilir görünmek yerine reddedilir.
  • CoinGecko sırası, simgesi ve fiyatı bilgi amaçlı keşif verisidir.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTToken doğrula ve kaydet/v1/projects/{project_id}/payment-token-assetsOkuma ve yazma

Yalnızca yapılandırılmış düğümler zincir kimliğini, sözleşme/mint kimliğini, ondalık basamakları ve kullanılabilir bakiye sorgusunu doğruladıktan sonra mevcut adayı kalıcı ödeme kaydına alır. Kayıt, CoinGecko meta verilerine tek başına asla güvenmez ve her projede en fazla 20 kayıtlı token varlığı olabilir.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MERCHANT_API_TOKEN
Content-Typezorunluapplication/json
Acceptönerilenapplication/json

Yol parametreleri

project_idUUIDzorunlu

Kimlik bilgisine atanmış etkin proje.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/projects/YOUR_PROJECT_ID/payment-token-assets" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "chain_slug": "ethereum",
  "coingecko_id": "usd-coin",
  "enabled": true
}'

İstek gövdesi

chain_slugstringzorunlu

ethereum, base, bnb-chain, hyperliquid, avalanche, polygon, arbitrum, optimism veya solana.

coingecko_idstringzorunlu
Token aramasının döndürdüğü tam aday kimliği. _ veya -6 gibi baştaki alt çizgi veya tireleri koru. Bu kimliği token adından veya sembolünden türetme.Ayrıntılar

Token aramasının döndürdüğü tam aday kimliği. _ veya -6 gibi baştaki alt çizgi veya tireleri koru. Bu kimliği token adından veya sembolünden türetme.

enabledbooleanisteğe bağlı

Doğrulama sonrası proje politikası durumu; varsayılan true.

Yanıt 201 application/json

Örnek yanıt
{
  "data": {
    "asset_id": "44444444-4444-4444-8444-444444444444",
    "chain_slug": "ethereum",
    "coingecko_id": "usd-coin",
    "contract_address": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
    "token_standard": "erc20",
    "symbol": "USDC",
    "name": "USDC",
    "decimals": 6,
    "enabled": true,
    "metadata_verified_at": "2026-08-31T18:00:00Z"
  }
}

Yanıt alanları

dataobject
asset_idUUIDher zaman

Kalıcı ödeme varlığı tanımlayıcısı.

chain_slugstringher zaman

Doğrulanmış zincir ve saklanan keşif/fiyatlandırma kimliği.

coingecko_idstringher zaman

Doğrulanmış zincir ve saklanan keşif/fiyatlandırma kimliği.

contract_addressstringher zaman

Kanonik doğrulanmış sözleşme veya mint.

token_standarderc20 | spl-tokenher zaman

Doğrulanmış çalışma zamanı token standardı.

symbolstringher zaman

Kaydedilen görüntüleme kimliği ve tam hassasiyet.

namestringher zaman

Kaydedilen görüntüleme kimliği ve tam hassasiyet.

decimalsintegerher zaman

Kaydedilen görüntüleme kimliği ve tam hassasiyet.

enabledbooleanher zaman

İlk proje politikası durumu.

metadata_verified_atRFC 3339 timestampher zaman

Zincir üstü doğrulama zamanı.

Kullanım notları
  • Token'larını kaydetmeden önce zincirin yerel proje varlığını etkinleştir.
  • Proje en fazla 20 token varlığı kaydedebilir; bu sınırın üzerindeki yeni aday token_chain_not_ready (409) döndürür. Zaten kayıtlı varlığı kullanmak başka yuva tüketmez.
  • Düğüm doğrulaması katalog okumasından uzun sürebilir; açık istemci zaman aşımı kullan.
  • Kayıttan sonra varlığı sunması gereken her mağaza için seç.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETÖzel token DEX havuzlarını bul/v1/projects/{project_id}/payment-token-dex-poolsSalt okunur

DEX Screener üzerinden tam zincir ve temel token sözleşmesine göre likidite sıralı en fazla 12 uygun havuz bul. Bu işlem token kaydetmez veya etkinleştirmez.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MERCHANT_API_TOKEN

Yol parametreleri

project_idUUIDzorunlu

Atanmış proje.

Sorgu parametreleri

chain_slugstring

Desteklenen EVM token zinciri veya solana.

contract_addressstring

Tam ERC-20 sözleşmesi veya klasik SPL mint'i.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/projects/YOUR_PROJECT_ID/payment-token-dex-pools?chain_slug=ethereum&contract_address=YOUR_TOKEN_CONTRACT" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{"data":[{"pair_address":"0x2222222222222222222222222222222222222222","dex_id":"uniswap","quote_symbol":"WETH","price_usd":"0.25","liquidity_usd":"250000.00","fetched_at":"2026-09-09T12:00:00Z","url":"https://dexscreener.com/ethereum/0x2222222222222222222222222222222222222222"}]}

Yanıt alanları

data[]object[]
pair_addressstringher zaman

Tam havuz tanımlayıcısı, borsa kimliği (ör. uniswap/pancakeswap) ve yalnızca görüntüleme için eş token sembolü.

dex_idstringher zaman

Tam havuz tanımlayıcısı, borsa kimliği (ör. uniswap/pancakeswap) ve yalnızca görüntüleme için eş token sembolü.

quote_symbolstringher zaman

Tam havuz tanımlayıcısı, borsa kimliği (ör. uniswap/pancakeswap) ve yalnızca görüntüleme için eş token sembolü.

price_usddecimal stringher zaman

İstenen temel token'ın USD fiyatı ve toplam havuz likiditesi. En az 10.000 $ likidite ve son bir saat içinde işlem gereklidir.

liquidity_usddecimal stringher zaman

İstenen temel token'ın USD fiyatı ve toplam havuz likiditesi. En az 10.000 $ likidite ve son bir saat içinde işlem gereklidir.

fetched_atRFC 3339 timestampher zaman

Zincir üstü işlem zaman damgası değil, sunucunun sağlayıcı gözlemini aldığı zaman.

urlHTTPS URLher zaman

Bu havuza doğrulanmış DEX Screener bağlantısı.

Kullanım notları
  • Boş data dizisi uygun havuz bulunmadığını gösterir. Yalnızca istenen tam sözleşmenin temel token olduğu havuzlar döndürülür; karşı varlığın USD fiyatı asla varsayılmaz.
  • DEX'te listelenmek güvenlik denetimi değildir. Asgari likidite ve yakın tarihli etkinlik kullanılamayan teklifleri azaltır, ancak piyasa manipülasyonunu önlemez.
  • Mevcut zincir tarayıcısının token desteklediği yerlerde Uniswap, PancakeSwap ve diğer indekslenmiş DEX'ler desteklenir. API erişimi proje kapsamlı ve istek sınırlı kalır. Sağlayıcı çağrıları da sıraya alınır ve hızla sınırlandırılır.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTÖzel token ekle veya yeniden fiyatlandır/v1/projects/{project_id}/payment-token-assets/customOkuma ve yazma

Özel sözleşmeyi yapılandırılmış zincir düğümleriyle doğrular ve CoinGecko listesi gerektirmeden kaydeder. Sabit USD fiyatı veya seçilen otomatik DEX havuzu sembole ya da başka projelere değil, bu projeye aittir. Aynı kimliği tekrarlamak mevcut etkin/devre dışı politikayı değiştirmeden proje fiyatını günceller.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MERCHANT_API_TOKEN
Content-Typezorunluapplication/json

Yol parametreleri

project_idUUIDzorunlu

Bu yazma yetkili kimlik bilgisine atanmış proje.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/projects/YOUR_PROJECT_ID/payment-token-assets/custom" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "chain_slug": "ethereum",
  "contract_address": "YOUR_VERIFIED_TOKEN_CONTRACT",
  "name": "Example token",
  "symbol": "EXAMPLE",
  "price_usd": "0.25"
}'

İstek gövdesi

chain_slugstringzorunlu

ethereum, base, bnb-chain, hyperliquid, avalanche, polygon, arbitrum, optimism veya solana. Bu sözleşme için sabittir.

contract_addressstringzorunlu
ERC-20 sözleşmesi (0x ve 40 onaltılık karakter) veya klasik SPL mint'i. Düğümler ağ kimliğini ve tam ondalık basamak sayısını doğrular; çağıranın verdiği ondalık basamak ve RPC URL'leri reddedilir.Ayrıntılar

ERC-20 sözleşmesi (0x ve 40 onaltılık karakter) veya klasik SPL mint'i. Düğümler ağ kimliğini ve tam ondalık basamak sayısını doğrular; çağıranın verdiği ondalık basamak ve RPC URL'leri reddedilir.

namestringzorunlu
Görünen ad (1–80 karakter) ve sembol (1–16 harf/rakam/nokta/alt çizgi/tire; ilk karakter harf veya rakam). Bu uç nokta mevcut kimlikleri yeniden adlandıramaz.Ayrıntılar

Görünen ad (1–80 karakter) ve sembol (1–16 harf/rakam/nokta/alt çizgi/tire; ilk karakter harf veya rakam). Bu uç nokta mevcut kimlikleri yeniden adlandıramaz.

symbolstringzorunlu
Görünen ad (1–80 karakter) ve sembol (1–16 harf/rakam/nokta/alt çizgi/tire; ilk karakter harf veya rakam). Bu uç nokta mevcut kimlikleri yeniden adlandıramaz.Ayrıntılar

Görünen ad (1–80 karakter) ve sembol (1–16 harf/rakam/nokta/alt çizgi/tire; ilk karakter harf veya rakam). Bu uç nokta mevcut kimlikleri yeniden adlandıramaz.

price_modefixed | dexisteğe bağlı

Geriye uyumluluk için varsayılan fixed. DEX, tam zincir ve sözleşme için keşfedilmiş belirli havuzu kullanır.

price_usddecimal stringfixed modu

BİR token'ın sabit USD değeri; pozitif, en fazla 30 ondalık basamak, üst sınır 1000000000000000000000000. Üs veya kayan nokta yok. dex modunda atla.

dex_pair_addressstringdex modu
payment-token-dex-pools kaynağından havuz adresi. dex modunda zorunlu; fixed modunda atla. Sunucu her kayıtta havuz kimliğini, fiyatı, likiditeyi ve etkinliği yeniden kontrol eder.Ayrıntılar

payment-token-dex-pools kaynağından havuz adresi. dex modunda zorunlu; fixed modunda atla. Sunucu her kayıtta havuz kimliğini, fiyatı, likiditeyi ve etkinliği yeniden kontrol eder.

Yanıt 200 application/json

Örnek yanıt
{"data":{"asset_id":"44444444-4444-4444-8444-444444444444"}}

Yanıt alanları

dataobject
asset_idstring
Kullanım notları
  • Kayıttan sonra mağazanın payment-assets uç noktasında asset_id seç; kayıt tek başına mağaza yöntemini asla etkinleştirmez.
  • Özel ve katalog token'ları projenin 20 token sınırını paylaşır. Aynı sözleşme farklı zincirlerde farklı ödeme varlığıdır.
  • Mevcut katalog sözleşmeleri 409 döndürür: otomatik piyasa kurlarını korumak için katalog kaydı kullan. Özel sembol aynı adlı token'ın fiyatını asla almaz.
  • Sabit fiyatlar operatör tahminidir. Otomatik DEX fiyatları, manipülasyona dayanıklı oracle değil, DEX Screener üzerinden seçilen havuzun spot gözlemleridir. Güncel itibari para kurlarıyla mağaza fiyat marjı ve yukarı yuvarlama yine uygulanır. Önceden düzenlenmiş teklifler değişmez.
  • DEX modu için önce havuz keşfet, ardından price_usd atlayarak price_mode: dex ve dex_pair_address gönder. Ortak arka plan görevi seçilen havuzları her dakika yeniler. Başarısız kontroller veya beş dakikadan eski fiyatlar token'ı yeni tekliflerden çıkarır; sessizce sabit fiyat veya sembol bazlı yedek fiyata geçilmez.
  • Yalnızca standart ERC-20 ve klasik SPL token'ları kabul edilir. Token-2022/uzantıları ve yalnızca yerel coin destekleyen zincirler reddedilir. Teknik doğrulama, ihraççı/sözleşme güvenlik denetimi değildir; transfer ücreti alan, rebasing yapan veya kara liste kullanan token'lar uyumsuz davranabilir.
  • En az 60 saniyelik istemci zaman aşımı kullan. Doğrulama sınırlıdır ve yedek düğümleri deneyebilir. Geçersiz girdi 400; başarısız zincir/sözleşme kontrolleri 422; kimlik çakışmaları veya sınırlar 409 döndürür.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETMağaza ödeme yöntemlerini listele/v1/projects/{project_id}/stores/{store_id}/payment-assetsSalt okunur

Zincir üstü varlıkları data içinde, ayrı Lightning hazırlığını lightning içinde listeler. Zincir üstü yöntemler hazır zincir cüzdanları gerektirir. Lightning, zincir üstü Bitcoin cüzdanından bağımsız olarak mağazada seçilen doğrulanmış harici ödeme alma bağlantısını kullanır.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MERCHANT_API_TOKEN
Acceptönerilenapplication/json

Yol parametreleri

project_idUUIDzorunlu

Kimlik bilgisine atanmış proje; duraklatılmış olabilir.

store_idUUIDzorunlu

project_id'ye ait mağaza; duraklatılmış olabilir.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/projects/YOUR_PROJECT_ID/stores/YOUR_STORE_ID/payment-assets" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "data": [
    { "asset": { "id": "ASSET_UUID", "chain_slug": "ethereum", "symbol": "USDC", "asset_kind": "token", "token_standard": "erc20", "scanner_ready": true }, "project_policy": { "enabled": true, "required_confirmations": 12 }, "selected": true, "display_order": 0, "confirmation_policy": { "finality_mode": "confirmations", "project_required_confirmations": 12, "override_required_confirmations": 3, "effective_required_confirmations": 3, "editable": true, "minimum_required_confirmations": 0, "maximum_required_confirmations": 48 }, "wallet": { "id": "WALLET_UUID", "status": "active" }, "wallet_readiness": "ready" }
  ],
  "lightning": { "payment_rail": "lightning", "symbol": "BTC", "asset_decimals": 11, "enabled": true, "ready": true }
}

Yanıt alanları

data[]object[]
assetobjecther zaman

Projenin görebildiği yerel veya doğrulanmış token varlığı.

idUUIDher zaman

Proje ve mağaza politika rotalarının kullandığı kalıcı ödeme varlığı tanımlayıcısı.

asset_keystringher zaman

Kanonik CAIP biçimli yerel veya sözleşme varlığı kimliği.

chain_slugstringher zaman

Wholly Crypto zincir tanımlayıcısı ve yapılandırılmış ağ.

networkstringher zaman

Wholly Crypto zincir tanımlayıcısı ve yapılandırılmış ağ.

caip_network_idstringher zaman

Kanonik ağ ve varlık kimlikleri.

caip_asset_idstring|nullher zaman

Kanonik ağ ve varlık kimlikleri.

asset_kindnative | tokenher zaman

Ödeme tamamlanmasında zincir para biriminin mi, doğrulanmış sözleşme/mint'in mi kullanıldığı.

payment_railstringher zaman

Çalışma zamanı ödeme altyapısı: utxo, evm-native, solana-native, account-native, privacy-native veya token-transfer.

symbolstringher zaman

Görüntüleme kimliği ve tam atomik birim hassasiyeti.

namestringher zaman

Görüntüleme kimliği ve tam atomik birim hassasiyeti.

decimalsintegerher zaman

Görüntüleme kimliği ve tam atomik birim hassasiyeti.

contract_addressstring | nullher zaman

Token'lar için kanonik ERC-20 sözleşmesi veya SPL mint'i; yerel varlıklarda null.

coingecko_idstring | nullher zaman

Keşif/fiyatlandırma kimliği. Özel sözleşmelerde null; sembollerinden piyasa fiyatı çıkarma. CoinGecko meta verileri tek başına token'ı seçilebilir yapmaz.

custom_tokenbooleanher zaman

Proje kapsamlı sabit USD veya seçili DEX havuzu fiyatlandırması olan, zincir üstünde doğrulanmış özel sözleşme.

icon_pathpath | nullher zaman

Varsa yerel önbellekteki token simgesi.

token_standarderc20 | spl-token | nullher zaman

Doğrulanmış çalışma zamanı token standardı; yerel varlıklarda null.

metadata_verified_attimestamp | nullher zaman

Ödeme varlığına dönüştürülen token'ların zincir üstü meta veri doğrulama zamanı.

payment_supportedbooleanher zaman
Derleme zamanı kayıt kontrolleri. scanner_ready ödeme tarayıcısı çalışma ortamının kurulu olduğu anlamına gelir; ödeme onayı, yapılandırılmış sayıda sağlıklı ve tam role uygun sağlayıcı gerektirir (varsayılan 2, isteğe bağlı 1); geçici tarayıcı kullanılabilirliği 6.0.6'dan itibaren fatura oluşturmayı engellemez. balance_ready yalnızca uygulanmış bakiye adaptörlerinde true olur.Ayrıntılar

Derleme zamanı kayıt kontrolleri. scanner_ready ödeme tarayıcısı çalışma ortamının kurulu olduğu anlamına gelir; ödeme onayı, yapılandırılmış sayıda sağlıklı ve tam role uygun sağlayıcı gerektirir (varsayılan 2, isteğe bağlı 1); geçici tarayıcı kullanılabilirliği 6.0.6'dan itibaren fatura oluşturmayı engellemez. balance_ready yalnızca uygulanmış bakiye adaptörlerinde true olur.

scanner_readybooleanher zaman
Derleme zamanı kayıt kontrolleri. scanner_ready ödeme tarayıcısı çalışma ortamının kurulu olduğu anlamına gelir; ödeme onayı, yapılandırılmış sayıda sağlıklı ve tam role uygun sağlayıcı gerektirir (varsayılan 2, isteğe bağlı 1); geçici tarayıcı kullanılabilirliği 6.0.6'dan itibaren fatura oluşturmayı engellemez. balance_ready yalnızca uygulanmış bakiye adaptörlerinde true olur.Ayrıntılar

Derleme zamanı kayıt kontrolleri. scanner_ready ödeme tarayıcısı çalışma ortamının kurulu olduğu anlamına gelir; ödeme onayı, yapılandırılmış sayıda sağlıklı ve tam role uygun sağlayıcı gerektirir (varsayılan 2, isteğe bağlı 1); geçici tarayıcı kullanılabilirliği 6.0.6'dan itibaren fatura oluşturmayı engellemez. balance_ready yalnızca uygulanmış bakiye adaptörlerinde true olur.

balance_readybooleanher zaman
Derleme zamanı kayıt kontrolleri. scanner_ready ödeme tarayıcısı çalışma ortamının kurulu olduğu anlamına gelir; ödeme onayı, yapılandırılmış sayıda sağlıklı ve tam role uygun sağlayıcı gerektirir (varsayılan 2, isteğe bağlı 1); geçici tarayıcı kullanılabilirliği 6.0.6'dan itibaren fatura oluşturmayı engellemez. balance_ready yalnızca uygulanmış bakiye adaptörlerinde true olur.Ayrıntılar

Derleme zamanı kayıt kontrolleri. scanner_ready ödeme tarayıcısı çalışma ortamının kurulu olduğu anlamına gelir; ödeme onayı, yapılandırılmış sayıda sağlıklı ve tam role uygun sağlayıcı gerektirir (varsayılan 2, isteğe bağlı 1); geçici tarayıcı kullanılabilirliği 6.0.6'dan itibaren fatura oluşturmayı engellemez. balance_ready yalnızca uygulanmış bakiye adaptörlerinde true olur.

default_finality_modeconfirmations | finalizedher zaman

Yeni proje politikasının devraldığı varsayılan kesinlik modeli.

default_required_confirmationsintegerher zaman

Varsayılan onay ve izleme politikası.

default_monitoring_minutesintegerher zaman

Varsayılan onay ve izleme politikası.

project_policyobject | nullher zaman

Üst proje politikası.

enabledbooleanzorunlu

Varlığı proje için etkinleştirir veya devre dışı bırakır. Herhangi bir token'dan önce yerel zincir etkin olmalıdır.

finality_modeconfirmations | finalizedzorunlu

Varlık ödeme altyapısının desteklediği kesinlik politikası. finalized, required_confirmations=1 gerektirir.

required_confirmationsintegerzorunlu
Bitcoin ve EVM altyapıları sıfır kabul eder; diğer onay altyapıları en az bir, yalnızca finalized altyapıları tam bir gerektirir. Her transferin işlem yeniden oynatma aralığında kalması için EVM altyapıları 0–48 ile sınırlıdır.Ayrıntılar

Bitcoin ve EVM altyapıları sıfır kabul eder; diğer onay altyapıları en az bir, yalnızca finalized altyapıları tam bir gerektirir. Her transferin işlem yeniden oynatma aralığında kalması için EVM altyapıları 0–48 ile sınırlıdır.

monitoring_minutesintegerzorunlu

Fatura etkinken 1–10.080 dakikalık sorgulama aralığı.

late_monitoring_daysintegerzorunlu

Fatura süresi dolduktan sonra 0–3.650 gün izleme.

selectedbooleanher zaman
Bu yöntemin mağazanın kayıtlı istenen yapılandırmasına dahil olup olmadığı. Proje politikası, cüzdan, kurulu adaptör ve fiyatlandırma geçerliyse sunulur. Geçici tarayıcı kesintileri yöntemi yeni faturalardan çıkarmaz.Ayrıntılar

Bu yöntemin mağazanın kayıtlı istenen yapılandırmasına dahil olup olmadığı. Proje politikası, cüzdan, kurulu adaptör ve fiyatlandırma geçerliyse sunulur. Geçici tarayıcı kesintileri yöntemi yeni faturalardan çıkarmaz.

display_orderinteger | nullher zaman

Seçildiğinde mağaza ödeme sayfasındaki sırası.

confirmation_policyobject | nullher zaman

Projede yapılandırılan varlık için geçerli mağaza politikası. Proje politikası yoksa null.

finality_modeconfirmations | finalizedher zaman

Ödeme tamamlanmasının ayarlanabilir blok sayısına mı, ağ kesinliğine mi dayandığı.

project_required_confirmationsintegerher zaman

Mağazaya özel değer yoksa sonraki faturaların kullanacağı güncel proje varsayılanı.

override_required_confirmationsinteger | nullher zaman

Mağazaya özel sayı veya proje varsayılanını devralmak için null.

effective_required_confirmationsintegerher zaman

Bu mağaza ve varlık için yeni faturaların kaydedeceği sayı.

editablebooleanher zaman

Kesinlik politikası değiştirilemeyen finalized ağlarda false.

minimum_required_confirmationsintegerher zaman

Dahil, zincire uygun alt sınır; 0 yalnızca tespit anında kabulü destekleyen altyapılarda sunulur.

maximum_required_confirmationsintegerher zaman

Dahil, zincire uygun üst sınır.

walletobject | nullher zaman

Yerel ve token varlıklarının paylaştığı zincir cüzdanı.

idUUIDher zaman

Cüzdan, sahibi proje ve zincirin yerel varlık tanımlayıcıları.

project_idUUIDher zaman

Cüzdan, sahibi proje ve zincirin yerel varlık tanımlayıcıları.

native_asset_idUUIDher zaman

Cüzdan, sahibi proje ve zincirin yerel varlık tanımlayıcıları.

chain_slugstringher zaman

Cüzdan zinciri ve ağı.

networkstringher zaman

Cüzdan zinciri ve ağı.

asset_symbolstringher zaman

Zincirin yerel varlığının görüntüleme kimliği.

asset_namestringher zaman

Zincirin yerel varlığının görüntüleme kimliği.

statuspending | active | disabled | errorher zaman

Cüzdanın çalışma durumu.

labelstringher zaman

Operatör etiketi.

public_keystring | nullher zaman

Herkese açık cüzdan kimliği; kurtarma ifadesi veya özel anahtar açığa çıkarılmaz.

primary_addressstring | nullher zaman

Herkese açık cüzdan kimliği; kurtarma ifadesi veya özel anahtar açığa çıkarılmaz.

derivation_schemestring | nullher zaman

Adres politikası ve biçimi.

address_formatstring | nullher zaman

Adres politikası ve biçimi.

backup_confirmed_attimestamp | nullher zaman

Operatör kurtarma yedeğini onayladıktan sonra null değildir.

activation_requiredbooleanher zaman
XRP ve Stellar ortak hesapları, operatör gösterilen adrese fon gönderene ve yapılandırılmış tarayıcı sağlayıcıları tam olarak o hesabı doğrulayana kadar kullanılamaz. Kalıcı kanıtın süresi dolmaz; canlı tarayıcı sağlığı fatura oluşturma için değil, ödeme doğrulaması için ayrı kontrol edilir.Ayrıntılar

XRP ve Stellar ortak hesapları, operatör gösterilen adrese fon gönderene ve yapılandırılmış tarayıcı sağlayıcıları tam olarak o hesabı doğrulayana kadar kullanılamaz. Kalıcı kanıtın süresi dolmaz; canlı tarayıcı sağlığı fatura oluşturma için değil, ödeme doğrulaması için ayrı kontrol edilir.

activation_verified_attimestamp|nullher zaman
XRP ve Stellar ortak hesapları, operatör gösterilen adrese fon gönderene ve yapılandırılmış tarayıcı sağlayıcıları tam olarak o hesabı doğrulayana kadar kullanılamaz. Kalıcı kanıtın süresi dolmaz; canlı tarayıcı sağlığı fatura oluşturma için değil, ödeme doğrulaması için ayrı kontrol edilir.Ayrıntılar

XRP ve Stellar ortak hesapları, operatör gösterilen adrese fon gönderene ve yapılandırılmış tarayıcı sağlayıcıları tam olarak o hesabı doğrulayana kadar kullanılamaz. Kalıcı kanıtın süresi dolmaz; canlı tarayıcı sağlığı fatura oluşturma için değil, ödeme doğrulaması için ayrı kontrol edilir.

receive_readinessobject | null5.5.0+
Cüzdan listelerine dahildir: proje ödeme alma kurulumu ve zincir tarayıcısı ön koşulları. Bakiyelerden, token gas'ından ve gönderime hazır olma durumundan ayrıdır. Diğer cüzdan yanıtlarında null kalabilir.Ayrıntılar

Cüzdan listelerine dahildir: proje ödeme alma kurulumu ve zincir tarayıcısı ön koşulları. Bakiyelerden, token gas'ından ve gönderime hazır olma durumundan ayrıdır. Diğer cüzdan yanıtlarında null kalabilir.

readybooleanher zaman

Ödeme alma kurulum kontrolleri geçti. Harcamaya hazır olmayı, gas'ı, bakiye yenilemeyi veya garantili gelecek teklifi açıklamaz.

invoice_creatableboolean6.0.6+
Yapılandırma geçici tarayıcı uyarılarına rağmen fatura yöntemine izin verir. Para birimi fiyatlandırması oluşturma sırasında kontrol edilir. Bu ödeme doğrulaması değildir: invoice_creatable true iken ready false olabilir. Eksik cüzdanlar, devre dışı politika ve desteklenmeyen adaptörler yine güvenli biçimde başarısız olur.Ayrıntılar

Yapılandırma geçici tarayıcı uyarılarına rağmen fatura yöntemine izin verir. Para birimi fiyatlandırması oluşturma sırasında kontrol edilir. Bu ödeme doğrulaması değildir: invoice_creatable true iken ready false olabilir. Eksik cüzdanlar, devre dışı politika ve desteklenmeyen adaptörler yine güvenli biçimde başarısız olur.

checked_attimestampher zaman

Değerlendirme zamanı. Listeleme ağ isteği veya adres ayırma yapmaz.

issues[]object[]her zaman
Hazırsa boş; aksi halde ödeme alma uyarısı veya yapılandırma engeli. Geçici tarayıcı uyarılarını fatura kurulum hatalarından ayırmak için invoice_creatable kontrol et.Ayrıntılar

Hazırsa boş; aksi halde ödeme alma uyarısı veya yapılandırma engeli. Geçici tarayıcı uyarılarını fatura kurulum hatalarından ayırmak için invoice_creatable kontrol et.

chain_slugstringbiliniyorsa

Etkilenen zinciri ve varlığı tanımlar. Lightning asset_id içermeyebilir.

asset_idUUIDbiliniyorsa

Etkilenen zinciri ve varlığı tanımlar. Lightning asset_id içermeyebilir.

asset_tickerstringbiliniyorsa

Etkilenen zinciri ve varlığı tanımlar. Lightning asset_id içermeyebilir.

reason_codestringher zaman
scanner_provider_quorum, scanner_not_checked, scanner_unavailable, wallet_missing, wallet_disabled, wallet_backup_required, wallet_key_unavailable, wallet_activation_required, monero_binding_unavailable, rate_unavailable, custom_rate_unavailable, lightning_unavailable, project_disabled, store_disabled, chain_disabled, asset_disabled veya asset_not_accepted.Ayrıntılar

scanner_provider_quorum, scanner_not_checked, scanner_unavailable, wallet_missing, wallet_disabled, wallet_backup_required, wallet_key_unavailable, wallet_activation_required, monero_binding_unavailable, rate_unavailable, custom_rate_unavailable, lightning_unavailable, project_disabled, store_disabled, chain_disabled, asset_disabled veya asset_not_accepted.

messagestringvarsa
Satıcıya yönelik açıklama ve eylem tanımlayıcısı: chain_connections, wallets, rates, payment_methods, project_settings veya store_settings. Kimlik bilgisi veya özel sağlayıcı URL'si içermez.Ayrıntılar

Satıcıya yönelik açıklama ve eylem tanımlayıcısı: chain_connections, wallets, rates, payment_methods, project_settings veya store_settings. Kimlik bilgisi veya özel sağlayıcı URL'si içermez.

actionstringvarsa
Satıcıya yönelik açıklama ve eylem tanımlayıcısı: chain_connections, wallets, rates, payment_methods, project_settings veya store_settings. Kimlik bilgisi veya özel sağlayıcı URL'si içermez.Ayrıntılar

Satıcıya yönelik açıklama ve eylem tanımlayıcısı: chain_connections, wallets, rates, payment_methods, project_settings veya store_settings. Kimlik bilgisi veya özel sağlayıcı URL'si içermez.

required_endpoint_rolestring | nullzincir üstü
Tercih edilen tarayıcı API rolü (eski alan). Tam uyumluluk listesi için accepted_endpoint_roles kullan. Temel düğüm sağlığı ödeme geçmişi desteğini kanıtlamaz.Ayrıntılar

Tercih edilen tarayıcı API rolü (eski alan). Tam uyumluluk listesi için accepted_endpoint_roles kullan. Temel düğüm sağlığı ödeme geçmişi desteğini kanıtlamaz.

accepted_endpoint_roles[]string[] | nullzincir üstü
Uyumlu API biçimleri; uç nokta geçmişi veya kapasitesi kanıtı değildir. Ham node-rpc, BTC/BCH/LTC/DOGE/DASH ve şeffaf ZEC (tam çözümlenmiş bloklar, 1–48 onay), solidified yerel TRX, algod üzerinden yerel ALGO, Octez üzerinden XTZ, SCALE meta verileriyle kesinleşmiş Asset Hub DOT ve fatura memo ID'siyle Stellar RPC üzerinden yerel XLM destekler. Budanmış veya eksik geçmiş uygun değildir. Bu ham adaptörler token altyapısı eklemez. İndeksli API'ler alternatif olmaya devam eder; aşağıdaki altyapı tablosuna bak. Karma ham/indeksli kaynaklar sınırlı aralıkları bağımsız doğrular; varsayılan, tek operatörün takma adları değil, iki bağımsız sağlayıcıdır. Temel düğüm yüksekliği, ORDnet zincir bilgisi ve EVM dışı altyapı için EVM rölesi ödeme alma kanıtı değildir. Monero yine projeye bağlı, yalnızca görüntüleme yetkili wallet-RPC gerektirir.Ayrıntılar

Uyumlu API biçimleri; uç nokta geçmişi veya kapasitesi kanıtı değildir. Ham node-rpc, BTC/BCH/LTC/DOGE/DASH ve şeffaf ZEC (tam çözümlenmiş bloklar, 1–48 onay), solidified yerel TRX, algod üzerinden yerel ALGO, Octez üzerinden XTZ, SCALE meta verileriyle kesinleşmiş Asset Hub DOT ve fatura memo ID'siyle Stellar RPC üzerinden yerel XLM destekler. Budanmış veya eksik geçmiş uygun değildir. Bu ham adaptörler token altyapısı eklemez. İndeksli API'ler alternatif olmaya devam eder; aşağıdaki altyapı tablosuna bak. Karma ham/indeksli kaynaklar sınırlı aralıkları bağımsız doğrular; varsayılan, tek operatörün takma adları değil, iki bağımsız sağlayıcıdır. Temel düğüm yüksekliği, ORDnet zincir bilgisi ve EVM dışı altyapı için EVM rölesi ödeme alma kanıtı değildir. Monero yine projeye bağlı, yalnızca görüntüleme yetkili wallet-RPC gerektirir.

healthy_endpointsintegerzincir üstü

Sağlıklı eşleşen uç noktalar; bağımsız sağlayıcı sayısı değildir.

usable_independent_providersintegerzincir üstü
En fazla iki kullanılabilir doğrulama yuvası. required_independent_providers zincir ayarıdır: varsayılan 2, yöneticinin açık seçimiyle 1. İki sağlayıcı modunda farklı sağlayıcı anahtarları VE ana makineler gerekir. Devre dışı, eski (on dakikadan fazla) veya bekleme süresindeki kaynaklar yuva doldurmaz. Lightning kendi bağlantı kurallarını kullanır.Ayrıntılar

En fazla iki kullanılabilir doğrulama yuvası. required_independent_providers zincir ayarıdır: varsayılan 2, yöneticinin açık seçimiyle 1. İki sağlayıcı modunda farklı sağlayıcı anahtarları VE ana makineler gerekir. Devre dışı, eski (on dakikadan fazla) veya bekleme süresindeki kaynaklar yuva doldurmaz. Lightning kendi bağlantı kurallarını kullanır.

required_independent_providersintegerzincir üstü
En fazla iki kullanılabilir doğrulama yuvası. required_independent_providers zincir ayarıdır: varsayılan 2, yöneticinin açık seçimiyle 1. İki sağlayıcı modunda farklı sağlayıcı anahtarları VE ana makineler gerekir. Devre dışı, eski (on dakikadan fazla) veya bekleme süresindeki kaynaklar yuva doldurmaz. Lightning kendi bağlantı kurallarını kullanır.Ayrıntılar

En fazla iki kullanılabilir doğrulama yuvası. required_independent_providers zincir ayarıdır: varsayılan 2, yöneticinin açık seçimiyle 1. İki sağlayıcı modunda farklı sağlayıcı anahtarları VE ana makineler gerekir. Devre dışı, eski (on dakikadan fazla) veya bekleme süresindeki kaynaklar yuva doldurmaz. Lightning kendi bağlantı kurallarını kullanır.

last_checked_attimestamp | nullzincir üstü

Değerlendirme zamanından ayrı, son eşleşen uç nokta sağlık kontrolü.

monero_wallet_rpcMoneroWalletRpcBinding | nullher zaman
Monero için hassas bilgileri ayıklanmış harici, yalnızca görüntüleme yetkili wallet-RPC bağlantı durumu. Uç nokta, kimlik doğrulama modu, account-0 birincil adresi, teknik kanıt işaretleri/yükseklikleri ve operatör beyanı zaman damgaları içerir; kimlik bilgileri, cüzdan anahtarları ve cüzdan dosyaları asla serileştirilmez.Ayrıntılar

Monero için hassas bilgileri ayıklanmış harici, yalnızca görüntüleme yetkili wallet-RPC bağlantı durumu. Uç nokta, kimlik doğrulama modu, account-0 birincil adresi, teknik kanıt işaretleri/yükseklikleri ve operatör beyanı zaman damgaları içerir; kimlik bilgileri, cüzdan anahtarları ve cüzdan dosyaları asla serileştirilmez.

last_secret_revealed_attimestamp|nullher zaman

Konsol tarafı sır gösterimi denetim meta verileri.

secret_reveal_countintegerher zaman

Konsol tarafı sır gösterimi denetim meta verileri.

next_receive_indexintegerher zaman

Sonraki ayrılmış alt adres indeksi.

last_scanned_heightinteger|nullher zaman

Cüzdan tarayıcısı durumu.

last_scanned_attimestamp|nullher zaman

Cüzdan tarayıcısı durumu.

last_errorstring|nullher zaman

Cüzdan tarayıcısı durumu.

balances[]object[]her zaman
30 yerel zincir altyapısının her biri ve doğrulanmış ERC-20 ile SPL varlıkları için önbellekteki bakiyeler. Monero için yapılandırılmış harici, yalnızca görüntüleme yetkili wallet-RPC gerekir.Ayrıntılar

30 yerel zincir altyapısının her biri ve doğrulanmış ERC-20 ile SPL varlıkları için önbellekteki bakiyeler. Monero için yapılandırılmış harici, yalnızca görüntüleme yetkili wallet-RPC gerekir.

wallet_idUUIDher zaman

Cüzdan ve kalıcı varlık kimlikleri.

asset_idUUIDher zaman

Cüzdan ve kalıcı varlık kimlikleri.

project_enabledbooleanher zaman

Bu varlığın şu anda projenin varlık politikasıyla etkin olup olmadığı.

active_store_countintegerher zaman

Şu anda bu varlığı seçen etkin mağaza sayısı. Bu, kabul durumunun görünümüdür; salt okunur bakiye takibi bağımsız kalır.

active_store_ids[]UUID[]her zaman

Bu projede varlığı şu anda kabul eden etkin mağazalar. Başka API isteği olmadan tam yerel mağaza filtrelemesi sağlar.

tracking_activebooleanher zaman
Bu okunabilir cüzdan ve kayıtlı aynı zincir varlığının arka plan bakiye yenilemesine uygun olup olmadığı. Proje ve ödeme yöntemi kabul anahtarları salt okunur takibi duraklatmaz.Ayrıntılar

Bu okunabilir cüzdan ve kayıtlı aynı zincir varlığının arka plan bakiye yenilemesine uygun olup olmadığı. Proje ve ödeme yöntemi kabul anahtarları salt okunur takibi duraklatmaz.

asset_kindnative | tokenher zaman

Yerel para birimi veya doğrulanmış sözleşme/mint varlığı.

contract_addressstring | nullher zaman

Token sözleşmesi veya mint'i; yerel para biriminde null.

symbolstringher zaman

Görüntüleme kimliği ve atomik hassasiyet.

namestringher zaman

Görüntüleme kimliği ve atomik hassasiyet.

decimalsintegerher zaman

Görüntüleme kimliği ve atomik hassasiyet.

coingecko_idstring | nullher zaman

Eşleştirilmişse fiyatlandırma kimliği.

balancedecimal string|nullher zaman

Cüzdanın birincil adresi ve oluşturulmuş fatura adresleri genelindeki tam gösterim ve atomik bakiye. Tam değer bulunamıyorsa null.

balance_atomicinteger string|nullher zaman

Cüzdanın birincil adresi ve oluşturulmuş fatura adresleri genelindeki tam gösterim ve atomik bakiye. Tam değer bulunamıyorsa null.

price_usddecimal string | nullher zaman

Değerleme için kullanılan bilgi amaçlı önbellek USD birim fiyatı.

value_usddecimal string | nullher zaman

Güncel kur varsa bilgi amaçlı itibari para değerlemesi.

statuspending | refreshing | fresh | stale | errorher zaman
Önbellek tarama durumu. refreshing tamamlanmış bakiyeyi koruyabilir: yaşı için checked_at kullan. Pending tamamlanmış görüntü yok demektir. Bu durumların hiçbiri transferin beklediğini veya faturanın tamamlandığını kanıtlamaz.Ayrıntılar

Önbellek tarama durumu. refreshing tamamlanmış bakiyeyi koruyabilir: yaşı için checked_at kullan. Pending tamamlanmış görüntü yok demektir. Bu durumların hiçbiri transferin beklediğini veya faturanın tamamlandığını kanıtlamaz.

checked_attimestamp | nullher zaman

Tamamlanmış bakiye taramasının temsil ettiği zaman.

last_errorstring | nullher zaman

Güvenli operatör teşhisi.

total_value_usddecimal string | nullher zaman

Güncel USD fiyatı bulunan bakiyelerin bilgi amaçlı toplamı.

balance_statuspending | refreshing | fresh | stale | error | unknownher zaman

Birleştirilmiş önbellek güncelliği; unknown temkinli yedek değerdir ve bu durumların hiçbiri fatura ödemesinin tamamlandığını kanıtlamaz.

balance_checked_attimestamp | nullher zaman

Toplamın temsil ettiği en eski ilgili başarılı bakiye kontrolü.

recent_payments[]object[]her zaman

Tam olarak bu cüzdana atfedilen, en yeni en fazla üç geçerli detected, confirming veya final gözlem.

invoice_public_idUUIDher zaman

Gözlemle ilişkili, müşteriye görünen fatura kimliği.

chain_slugstringher zaman

Zincir ve yerel coin veya doğrulanmış token görüntüleme sembolü.

symbolstringher zaman

Zincir ve yerel coin veya doğrulanmış token görüntüleme sembolü.

transaction_idstringher zaman

Kanonik işlem ve transfer olayı kimliği.

event_indexintegerher zaman

Kanonik işlem ve transfer olayı kimliği.

amountdecimal stringher zaman

Kayan nokta dönüşümü yapılmadan gözlenen tam varlık tutarı.

statusdetected | confirming | finalher zaman

Güncel geçerli gözlem durumu. Reorged, replaced ve invalid gözlemler hariç tutulur.

confirmationsintegerher zaman

Son gözlenen onay sayısı.

observed_atRFC 3339 timestampher zaman

Wholly Crypto'nun ödemeyi ilk gözlediği zaman.

created_atRFC 3339 timestampher zaman

Oluşturulma ve son cüzdan güncelleme zamanı.

updated_atRFC 3339 timestampher zaman

Oluşturulma ve son cüzdan güncelleme zamanı.

wallet_readinessreadiness enumher zaman

Yalnızca cüzdan/politika durumu; tarayıcı ön koşulları için receive_readiness kullan.

receive_readinessobject | null5.5.0+
Ortak ödeme alma kurulumu ve mağaza kabulü. Önbellek gözlemlerini kullanır; rezervasyon veya garanti değildir. Oluşturma gereksinimleri ve gerçek fatura kurunu yeniden kontrol eder.Ayrıntılar

Ortak ödeme alma kurulumu ve mağaza kabulü. Önbellek gözlemlerini kullanır; rezervasyon veya garanti değildir. Oluşturma gereksinimleri ve gerçek fatura kurunu yeniden kontrol eder.

readybooleanher zaman

Ödeme alma kurulum kontrolleri geçti. Harcamaya hazır olmayı, gas'ı, bakiye yenilemeyi veya garantili gelecek teklifi açıklamaz.

invoice_creatableboolean6.0.6+
Yapılandırma geçici tarayıcı uyarılarına rağmen fatura yöntemine izin verir. Para birimi fiyatlandırması oluşturma sırasında kontrol edilir. Bu ödeme doğrulaması değildir: invoice_creatable true iken ready false olabilir. Eksik cüzdanlar, devre dışı politika ve desteklenmeyen adaptörler yine güvenli biçimde başarısız olur.Ayrıntılar

Yapılandırma geçici tarayıcı uyarılarına rağmen fatura yöntemine izin verir. Para birimi fiyatlandırması oluşturma sırasında kontrol edilir. Bu ödeme doğrulaması değildir: invoice_creatable true iken ready false olabilir. Eksik cüzdanlar, devre dışı politika ve desteklenmeyen adaptörler yine güvenli biçimde başarısız olur.

checked_attimestampher zaman

Değerlendirme zamanı. Listeleme ağ isteği veya adres ayırma yapmaz.

issues[]object[]her zaman
Hazırsa boş; aksi halde ödeme alma uyarısı veya yapılandırma engeli. Geçici tarayıcı uyarılarını fatura kurulum hatalarından ayırmak için invoice_creatable kontrol et.Ayrıntılar

Hazırsa boş; aksi halde ödeme alma uyarısı veya yapılandırma engeli. Geçici tarayıcı uyarılarını fatura kurulum hatalarından ayırmak için invoice_creatable kontrol et.

chain_slugstringbiliniyorsa

Etkilenen zinciri ve varlığı tanımlar. Lightning asset_id içermeyebilir.

asset_idUUIDbiliniyorsa

Etkilenen zinciri ve varlığı tanımlar. Lightning asset_id içermeyebilir.

asset_tickerstringbiliniyorsa

Etkilenen zinciri ve varlığı tanımlar. Lightning asset_id içermeyebilir.

reason_codestringher zaman
scanner_provider_quorum, scanner_not_checked, scanner_unavailable, wallet_missing, wallet_disabled, wallet_backup_required, wallet_key_unavailable, wallet_activation_required, monero_binding_unavailable, rate_unavailable, custom_rate_unavailable, lightning_unavailable, project_disabled, store_disabled, chain_disabled, asset_disabled veya asset_not_accepted.Ayrıntılar

scanner_provider_quorum, scanner_not_checked, scanner_unavailable, wallet_missing, wallet_disabled, wallet_backup_required, wallet_key_unavailable, wallet_activation_required, monero_binding_unavailable, rate_unavailable, custom_rate_unavailable, lightning_unavailable, project_disabled, store_disabled, chain_disabled, asset_disabled veya asset_not_accepted.

messagestringvarsa
Satıcıya yönelik açıklama ve eylem tanımlayıcısı: chain_connections, wallets, rates, payment_methods, project_settings veya store_settings. Kimlik bilgisi veya özel sağlayıcı URL'si içermez.Ayrıntılar

Satıcıya yönelik açıklama ve eylem tanımlayıcısı: chain_connections, wallets, rates, payment_methods, project_settings veya store_settings. Kimlik bilgisi veya özel sağlayıcı URL'si içermez.

actionstringvarsa
Satıcıya yönelik açıklama ve eylem tanımlayıcısı: chain_connections, wallets, rates, payment_methods, project_settings veya store_settings. Kimlik bilgisi veya özel sağlayıcı URL'si içermez.Ayrıntılar

Satıcıya yönelik açıklama ve eylem tanımlayıcısı: chain_connections, wallets, rates, payment_methods, project_settings veya store_settings. Kimlik bilgisi veya özel sağlayıcı URL'si içermez.

required_endpoint_rolestring | nullzincir üstü
Tercih edilen tarayıcı API rolü (eski alan). Tam uyumluluk listesi için accepted_endpoint_roles kullan. Temel düğüm sağlığı ödeme geçmişi desteğini kanıtlamaz.Ayrıntılar

Tercih edilen tarayıcı API rolü (eski alan). Tam uyumluluk listesi için accepted_endpoint_roles kullan. Temel düğüm sağlığı ödeme geçmişi desteğini kanıtlamaz.

accepted_endpoint_roles[]string[] | nullzincir üstü
Uyumlu API biçimleri; uç nokta geçmişi veya kapasitesi kanıtı değildir. Ham node-rpc, BTC/BCH/LTC/DOGE/DASH ve şeffaf ZEC (tam çözümlenmiş bloklar, 1–48 onay), solidified yerel TRX, algod üzerinden yerel ALGO, Octez üzerinden XTZ, SCALE meta verileriyle kesinleşmiş Asset Hub DOT ve fatura memo ID'siyle Stellar RPC üzerinden yerel XLM destekler. Budanmış veya eksik geçmiş uygun değildir. Bu ham adaptörler token altyapısı eklemez. İndeksli API'ler alternatif olmaya devam eder; aşağıdaki altyapı tablosuna bak. Karma ham/indeksli kaynaklar sınırlı aralıkları bağımsız doğrular; varsayılan, tek operatörün takma adları değil, iki bağımsız sağlayıcıdır. Temel düğüm yüksekliği, ORDnet zincir bilgisi ve EVM dışı altyapı için EVM rölesi ödeme alma kanıtı değildir. Monero yine projeye bağlı, yalnızca görüntüleme yetkili wallet-RPC gerektirir.Ayrıntılar

Uyumlu API biçimleri; uç nokta geçmişi veya kapasitesi kanıtı değildir. Ham node-rpc, BTC/BCH/LTC/DOGE/DASH ve şeffaf ZEC (tam çözümlenmiş bloklar, 1–48 onay), solidified yerel TRX, algod üzerinden yerel ALGO, Octez üzerinden XTZ, SCALE meta verileriyle kesinleşmiş Asset Hub DOT ve fatura memo ID'siyle Stellar RPC üzerinden yerel XLM destekler. Budanmış veya eksik geçmiş uygun değildir. Bu ham adaptörler token altyapısı eklemez. İndeksli API'ler alternatif olmaya devam eder; aşağıdaki altyapı tablosuna bak. Karma ham/indeksli kaynaklar sınırlı aralıkları bağımsız doğrular; varsayılan, tek operatörün takma adları değil, iki bağımsız sağlayıcıdır. Temel düğüm yüksekliği, ORDnet zincir bilgisi ve EVM dışı altyapı için EVM rölesi ödeme alma kanıtı değildir. Monero yine projeye bağlı, yalnızca görüntüleme yetkili wallet-RPC gerektirir.

healthy_endpointsintegerzincir üstü

Sağlıklı eşleşen uç noktalar; bağımsız sağlayıcı sayısı değildir.

usable_independent_providersintegerzincir üstü
En fazla iki kullanılabilir doğrulama yuvası. required_independent_providers zincir ayarıdır: varsayılan 2, yöneticinin açık seçimiyle 1. İki sağlayıcı modunda farklı sağlayıcı anahtarları VE ana makineler gerekir. Devre dışı, eski (on dakikadan fazla) veya bekleme süresindeki kaynaklar yuva doldurmaz. Lightning kendi bağlantı kurallarını kullanır.Ayrıntılar

En fazla iki kullanılabilir doğrulama yuvası. required_independent_providers zincir ayarıdır: varsayılan 2, yöneticinin açık seçimiyle 1. İki sağlayıcı modunda farklı sağlayıcı anahtarları VE ana makineler gerekir. Devre dışı, eski (on dakikadan fazla) veya bekleme süresindeki kaynaklar yuva doldurmaz. Lightning kendi bağlantı kurallarını kullanır.

required_independent_providersintegerzincir üstü
En fazla iki kullanılabilir doğrulama yuvası. required_independent_providers zincir ayarıdır: varsayılan 2, yöneticinin açık seçimiyle 1. İki sağlayıcı modunda farklı sağlayıcı anahtarları VE ana makineler gerekir. Devre dışı, eski (on dakikadan fazla) veya bekleme süresindeki kaynaklar yuva doldurmaz. Lightning kendi bağlantı kurallarını kullanır.Ayrıntılar

En fazla iki kullanılabilir doğrulama yuvası. required_independent_providers zincir ayarıdır: varsayılan 2, yöneticinin açık seçimiyle 1. İki sağlayıcı modunda farklı sağlayıcı anahtarları VE ana makineler gerekir. Devre dışı, eski (on dakikadan fazla) veya bekleme süresindeki kaynaklar yuva doldurmaz. Lightning kendi bağlantı kurallarını kullanır.

last_checked_attimestamp | nullzincir üstü

Değerlendirme zamanından ayrı, son eşleşen uç nokta sağlık kontrolü.

lightningobject
payment_railstring
symbolstring
asset_decimalsinteger
enabledboolean
readyboolean
Kullanım notları
  • selected zincir üstü yapılandırmadır; wallet_readiness onun güncel uygunluk kontrolüdür.
  • lightning yanıt üyesi payment_rail: lightning, symbol: BTC, asset_decimals: 11, enabled ve ready içerir. Düğüm kimlik bilgilerini asla içermez. Bu yöntemi mağaza konsolunda yapılandır; assets dizisini güncellemek Lightning'i değiştirmez.
  • confirmation_policy yalnızca zincir üstü yöntemlere uygulanır. Lightning blok onayı olmadan tamamlanır ve kısmi ödeme toleransı olmadan tam BOLT11 tutarını gerektirir.
  • Aynı zincirdeki yerel coin ve token yöntemleri o zincir cüzdanı için aynı fatura hedefini kullanır.
  • Gömülü cüzdan özetleri yalnızca hazırlık içindir ve bakiyeleri boş bırakır; güncel değerler için özel proje cüzdanları rotasını kullan.

Hatalar

Hata kodları ve yeniden deneme kuralları

PUTMağaza ödeme yöntemlerini değiştir/v1/projects/{project_id}/stores/{store_id}/payment-assetsOkuma ve yazma

Mağazanın sıralı varlık alt kümesinin tamamını atomik olarak değiştirir ve yenilenmiş listeyi döndürür. Atlanan varlıkların seçimi kaldırılır.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MERCHANT_API_TOKEN
Content-Typezorunluapplication/json
Acceptönerilenapplication/json

Yol parametreleri

project_idUUIDzorunlu

Kimlik bilgisine atanmış proje; duraklatılmış olabilir.

store_idUUIDzorunlu

project_id'ye ait mağaza; duraklatılmış olabilir.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request PUT \
  --url "https://api.example.com/v1/projects/YOUR_PROJECT_ID/stores/YOUR_STORE_ID/payment-assets" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "assets": [
    {
      "asset_id": "YOUR_ASSET_ID",
      "display_order": 0
    }
  ]
}'

İstek gövdesi

assets[]object[]zorunlu

Tam değiştirme listesi; en fazla 64 girdi. Her girdi benzersiz asset_id ve 0–10.000 arası benzersiz display_order içerir.

asset_idUUIDzorunlu
display_orderintegeristeğe bağlı

Yanıt 200 application/json

Örnek yanıt
{
  "data": [
    { "asset": { "id": "44444444-4444-4444-8444-444444444444", "symbol": "USDC" }, "selected": true, "display_order": 0, "confirmation_policy": { "finality_mode": "confirmations", "project_required_confirmations": 12, "override_required_confirmations": null, "effective_required_confirmations": 12, "editable": true, "minimum_required_confirmations": 0, "maximum_required_confirmations": 48 }, "wallet_readiness": "ready" }
  ]
}

Yanıt alanları

data[]object[]
assetobjecther zaman

Projenin görebildiği yerel veya doğrulanmış token varlığı.

idUUIDher zaman

Proje ve mağaza politika rotalarının kullandığı kalıcı ödeme varlığı tanımlayıcısı.

asset_keystringher zaman

Kanonik CAIP biçimli yerel veya sözleşme varlığı kimliği.

chain_slugstringher zaman

Wholly Crypto zincir tanımlayıcısı ve yapılandırılmış ağ.

networkstringher zaman

Wholly Crypto zincir tanımlayıcısı ve yapılandırılmış ağ.

caip_network_idstringher zaman

Kanonik ağ ve varlık kimlikleri.

caip_asset_idstring|nullher zaman

Kanonik ağ ve varlık kimlikleri.

asset_kindnative | tokenher zaman

Ödeme tamamlanmasında zincir para biriminin mi, doğrulanmış sözleşme/mint'in mi kullanıldığı.

payment_railstringher zaman

Çalışma zamanı ödeme altyapısı: utxo, evm-native, solana-native, account-native, privacy-native veya token-transfer.

symbolstringher zaman

Görüntüleme kimliği ve tam atomik birim hassasiyeti.

namestringher zaman

Görüntüleme kimliği ve tam atomik birim hassasiyeti.

decimalsintegerher zaman

Görüntüleme kimliği ve tam atomik birim hassasiyeti.

contract_addressstring | nullher zaman

Token'lar için kanonik ERC-20 sözleşmesi veya SPL mint'i; yerel varlıklarda null.

coingecko_idstring | nullher zaman

Keşif/fiyatlandırma kimliği. Özel sözleşmelerde null; sembollerinden piyasa fiyatı çıkarma. CoinGecko meta verileri tek başına token'ı seçilebilir yapmaz.

custom_tokenbooleanher zaman

Proje kapsamlı sabit USD veya seçili DEX havuzu fiyatlandırması olan, zincir üstünde doğrulanmış özel sözleşme.

icon_pathpath | nullher zaman

Varsa yerel önbellekteki token simgesi.

token_standarderc20 | spl-token | nullher zaman

Doğrulanmış çalışma zamanı token standardı; yerel varlıklarda null.

metadata_verified_attimestamp | nullher zaman

Ödeme varlığına dönüştürülen token'ların zincir üstü meta veri doğrulama zamanı.

payment_supportedbooleanher zaman
Derleme zamanı kayıt kontrolleri. scanner_ready ödeme tarayıcısı çalışma ortamının kurulu olduğu anlamına gelir; ödeme onayı, yapılandırılmış sayıda sağlıklı ve tam role uygun sağlayıcı gerektirir (varsayılan 2, isteğe bağlı 1); geçici tarayıcı kullanılabilirliği 6.0.6'dan itibaren fatura oluşturmayı engellemez. balance_ready yalnızca uygulanmış bakiye adaptörlerinde true olur.Ayrıntılar

Derleme zamanı kayıt kontrolleri. scanner_ready ödeme tarayıcısı çalışma ortamının kurulu olduğu anlamına gelir; ödeme onayı, yapılandırılmış sayıda sağlıklı ve tam role uygun sağlayıcı gerektirir (varsayılan 2, isteğe bağlı 1); geçici tarayıcı kullanılabilirliği 6.0.6'dan itibaren fatura oluşturmayı engellemez. balance_ready yalnızca uygulanmış bakiye adaptörlerinde true olur.

scanner_readybooleanher zaman
Derleme zamanı kayıt kontrolleri. scanner_ready ödeme tarayıcısı çalışma ortamının kurulu olduğu anlamına gelir; ödeme onayı, yapılandırılmış sayıda sağlıklı ve tam role uygun sağlayıcı gerektirir (varsayılan 2, isteğe bağlı 1); geçici tarayıcı kullanılabilirliği 6.0.6'dan itibaren fatura oluşturmayı engellemez. balance_ready yalnızca uygulanmış bakiye adaptörlerinde true olur.Ayrıntılar

Derleme zamanı kayıt kontrolleri. scanner_ready ödeme tarayıcısı çalışma ortamının kurulu olduğu anlamına gelir; ödeme onayı, yapılandırılmış sayıda sağlıklı ve tam role uygun sağlayıcı gerektirir (varsayılan 2, isteğe bağlı 1); geçici tarayıcı kullanılabilirliği 6.0.6'dan itibaren fatura oluşturmayı engellemez. balance_ready yalnızca uygulanmış bakiye adaptörlerinde true olur.

balance_readybooleanher zaman
Derleme zamanı kayıt kontrolleri. scanner_ready ödeme tarayıcısı çalışma ortamının kurulu olduğu anlamına gelir; ödeme onayı, yapılandırılmış sayıda sağlıklı ve tam role uygun sağlayıcı gerektirir (varsayılan 2, isteğe bağlı 1); geçici tarayıcı kullanılabilirliği 6.0.6'dan itibaren fatura oluşturmayı engellemez. balance_ready yalnızca uygulanmış bakiye adaptörlerinde true olur.Ayrıntılar

Derleme zamanı kayıt kontrolleri. scanner_ready ödeme tarayıcısı çalışma ortamının kurulu olduğu anlamına gelir; ödeme onayı, yapılandırılmış sayıda sağlıklı ve tam role uygun sağlayıcı gerektirir (varsayılan 2, isteğe bağlı 1); geçici tarayıcı kullanılabilirliği 6.0.6'dan itibaren fatura oluşturmayı engellemez. balance_ready yalnızca uygulanmış bakiye adaptörlerinde true olur.

default_finality_modeconfirmations | finalizedher zaman

Yeni proje politikasının devraldığı varsayılan kesinlik modeli.

default_required_confirmationsintegerher zaman

Varsayılan onay ve izleme politikası.

default_monitoring_minutesintegerher zaman

Varsayılan onay ve izleme politikası.

project_policyobject | nullher zaman

Üst proje politikası.

enabledbooleanzorunlu

Varlığı proje için etkinleştirir veya devre dışı bırakır. Herhangi bir token'dan önce yerel zincir etkin olmalıdır.

finality_modeconfirmations | finalizedzorunlu

Varlık ödeme altyapısının desteklediği kesinlik politikası. finalized, required_confirmations=1 gerektirir.

required_confirmationsintegerzorunlu
Bitcoin ve EVM altyapıları sıfır kabul eder; diğer onay altyapıları en az bir, yalnızca finalized altyapıları tam bir gerektirir. Her transferin işlem yeniden oynatma aralığında kalması için EVM altyapıları 0–48 ile sınırlıdır.Ayrıntılar

Bitcoin ve EVM altyapıları sıfır kabul eder; diğer onay altyapıları en az bir, yalnızca finalized altyapıları tam bir gerektirir. Her transferin işlem yeniden oynatma aralığında kalması için EVM altyapıları 0–48 ile sınırlıdır.

monitoring_minutesintegerzorunlu

Fatura etkinken 1–10.080 dakikalık sorgulama aralığı.

late_monitoring_daysintegerzorunlu

Fatura süresi dolduktan sonra 0–3.650 gün izleme.

selectedbooleanher zaman
Bu yöntemin mağazanın kayıtlı istenen yapılandırmasına dahil olup olmadığı. Proje politikası, cüzdan, kurulu adaptör ve fiyatlandırma geçerliyse sunulur. Geçici tarayıcı kesintileri yöntemi yeni faturalardan çıkarmaz.Ayrıntılar

Bu yöntemin mağazanın kayıtlı istenen yapılandırmasına dahil olup olmadığı. Proje politikası, cüzdan, kurulu adaptör ve fiyatlandırma geçerliyse sunulur. Geçici tarayıcı kesintileri yöntemi yeni faturalardan çıkarmaz.

display_orderinteger | nullher zaman

Seçildiğinde mağaza ödeme sayfasındaki sırası.

confirmation_policyobject | nullher zaman

Projede yapılandırılan varlık için geçerli mağaza politikası. Proje politikası yoksa null.

finality_modeconfirmations | finalizedher zaman

Ödeme tamamlanmasının ayarlanabilir blok sayısına mı, ağ kesinliğine mi dayandığı.

project_required_confirmationsintegerher zaman

Mağazaya özel değer yoksa sonraki faturaların kullanacağı güncel proje varsayılanı.

override_required_confirmationsinteger | nullher zaman

Mağazaya özel sayı veya proje varsayılanını devralmak için null.

effective_required_confirmationsintegerher zaman

Bu mağaza ve varlık için yeni faturaların kaydedeceği sayı.

editablebooleanher zaman

Kesinlik politikası değiştirilemeyen finalized ağlarda false.

minimum_required_confirmationsintegerher zaman

Dahil, zincire uygun alt sınır; 0 yalnızca tespit anında kabulü destekleyen altyapılarda sunulur.

maximum_required_confirmationsintegerher zaman

Dahil, zincire uygun üst sınır.

walletobject | nullher zaman

Yerel ve token varlıklarının paylaştığı zincir cüzdanı.

idUUIDher zaman

Cüzdan, sahibi proje ve zincirin yerel varlık tanımlayıcıları.

project_idUUIDher zaman

Cüzdan, sahibi proje ve zincirin yerel varlık tanımlayıcıları.

native_asset_idUUIDher zaman

Cüzdan, sahibi proje ve zincirin yerel varlık tanımlayıcıları.

chain_slugstringher zaman

Cüzdan zinciri ve ağı.

networkstringher zaman

Cüzdan zinciri ve ağı.

asset_symbolstringher zaman

Zincirin yerel varlığının görüntüleme kimliği.

asset_namestringher zaman

Zincirin yerel varlığının görüntüleme kimliği.

statuspending | active | disabled | errorher zaman

Cüzdanın çalışma durumu.

labelstringher zaman

Operatör etiketi.

public_keystring | nullher zaman

Herkese açık cüzdan kimliği; kurtarma ifadesi veya özel anahtar açığa çıkarılmaz.

primary_addressstring | nullher zaman

Herkese açık cüzdan kimliği; kurtarma ifadesi veya özel anahtar açığa çıkarılmaz.

derivation_schemestring | nullher zaman

Adres politikası ve biçimi.

address_formatstring | nullher zaman

Adres politikası ve biçimi.

backup_confirmed_attimestamp | nullher zaman

Operatör kurtarma yedeğini onayladıktan sonra null değildir.

activation_requiredbooleanher zaman
XRP ve Stellar ortak hesapları, operatör gösterilen adrese fon gönderene ve yapılandırılmış tarayıcı sağlayıcıları tam olarak o hesabı doğrulayana kadar kullanılamaz. Kalıcı kanıtın süresi dolmaz; canlı tarayıcı sağlığı fatura oluşturma için değil, ödeme doğrulaması için ayrı kontrol edilir.Ayrıntılar

XRP ve Stellar ortak hesapları, operatör gösterilen adrese fon gönderene ve yapılandırılmış tarayıcı sağlayıcıları tam olarak o hesabı doğrulayana kadar kullanılamaz. Kalıcı kanıtın süresi dolmaz; canlı tarayıcı sağlığı fatura oluşturma için değil, ödeme doğrulaması için ayrı kontrol edilir.

activation_verified_attimestamp|nullher zaman
XRP ve Stellar ortak hesapları, operatör gösterilen adrese fon gönderene ve yapılandırılmış tarayıcı sağlayıcıları tam olarak o hesabı doğrulayana kadar kullanılamaz. Kalıcı kanıtın süresi dolmaz; canlı tarayıcı sağlığı fatura oluşturma için değil, ödeme doğrulaması için ayrı kontrol edilir.Ayrıntılar

XRP ve Stellar ortak hesapları, operatör gösterilen adrese fon gönderene ve yapılandırılmış tarayıcı sağlayıcıları tam olarak o hesabı doğrulayana kadar kullanılamaz. Kalıcı kanıtın süresi dolmaz; canlı tarayıcı sağlığı fatura oluşturma için değil, ödeme doğrulaması için ayrı kontrol edilir.

receive_readinessobject | null5.5.0+
Cüzdan listelerine dahildir: proje ödeme alma kurulumu ve zincir tarayıcısı ön koşulları. Bakiyelerden, token gas'ından ve gönderime hazır olma durumundan ayrıdır. Diğer cüzdan yanıtlarında null kalabilir.Ayrıntılar

Cüzdan listelerine dahildir: proje ödeme alma kurulumu ve zincir tarayıcısı ön koşulları. Bakiyelerden, token gas'ından ve gönderime hazır olma durumundan ayrıdır. Diğer cüzdan yanıtlarında null kalabilir.

readybooleanher zaman

Ödeme alma kurulum kontrolleri geçti. Harcamaya hazır olmayı, gas'ı, bakiye yenilemeyi veya garantili gelecek teklifi açıklamaz.

invoice_creatableboolean6.0.6+
Yapılandırma geçici tarayıcı uyarılarına rağmen fatura yöntemine izin verir. Para birimi fiyatlandırması oluşturma sırasında kontrol edilir. Bu ödeme doğrulaması değildir: invoice_creatable true iken ready false olabilir. Eksik cüzdanlar, devre dışı politika ve desteklenmeyen adaptörler yine güvenli biçimde başarısız olur.Ayrıntılar

Yapılandırma geçici tarayıcı uyarılarına rağmen fatura yöntemine izin verir. Para birimi fiyatlandırması oluşturma sırasında kontrol edilir. Bu ödeme doğrulaması değildir: invoice_creatable true iken ready false olabilir. Eksik cüzdanlar, devre dışı politika ve desteklenmeyen adaptörler yine güvenli biçimde başarısız olur.

checked_attimestampher zaman

Değerlendirme zamanı. Listeleme ağ isteği veya adres ayırma yapmaz.

issues[]object[]her zaman
Hazırsa boş; aksi halde ödeme alma uyarısı veya yapılandırma engeli. Geçici tarayıcı uyarılarını fatura kurulum hatalarından ayırmak için invoice_creatable kontrol et.Ayrıntılar

Hazırsa boş; aksi halde ödeme alma uyarısı veya yapılandırma engeli. Geçici tarayıcı uyarılarını fatura kurulum hatalarından ayırmak için invoice_creatable kontrol et.

chain_slugstringbiliniyorsa

Etkilenen zinciri ve varlığı tanımlar. Lightning asset_id içermeyebilir.

asset_idUUIDbiliniyorsa

Etkilenen zinciri ve varlığı tanımlar. Lightning asset_id içermeyebilir.

asset_tickerstringbiliniyorsa

Etkilenen zinciri ve varlığı tanımlar. Lightning asset_id içermeyebilir.

reason_codestringher zaman
scanner_provider_quorum, scanner_not_checked, scanner_unavailable, wallet_missing, wallet_disabled, wallet_backup_required, wallet_key_unavailable, wallet_activation_required, monero_binding_unavailable, rate_unavailable, custom_rate_unavailable, lightning_unavailable, project_disabled, store_disabled, chain_disabled, asset_disabled veya asset_not_accepted.Ayrıntılar

scanner_provider_quorum, scanner_not_checked, scanner_unavailable, wallet_missing, wallet_disabled, wallet_backup_required, wallet_key_unavailable, wallet_activation_required, monero_binding_unavailable, rate_unavailable, custom_rate_unavailable, lightning_unavailable, project_disabled, store_disabled, chain_disabled, asset_disabled veya asset_not_accepted.

messagestringvarsa
Satıcıya yönelik açıklama ve eylem tanımlayıcısı: chain_connections, wallets, rates, payment_methods, project_settings veya store_settings. Kimlik bilgisi veya özel sağlayıcı URL'si içermez.Ayrıntılar

Satıcıya yönelik açıklama ve eylem tanımlayıcısı: chain_connections, wallets, rates, payment_methods, project_settings veya store_settings. Kimlik bilgisi veya özel sağlayıcı URL'si içermez.

actionstringvarsa
Satıcıya yönelik açıklama ve eylem tanımlayıcısı: chain_connections, wallets, rates, payment_methods, project_settings veya store_settings. Kimlik bilgisi veya özel sağlayıcı URL'si içermez.Ayrıntılar

Satıcıya yönelik açıklama ve eylem tanımlayıcısı: chain_connections, wallets, rates, payment_methods, project_settings veya store_settings. Kimlik bilgisi veya özel sağlayıcı URL'si içermez.

required_endpoint_rolestring | nullzincir üstü
Tercih edilen tarayıcı API rolü (eski alan). Tam uyumluluk listesi için accepted_endpoint_roles kullan. Temel düğüm sağlığı ödeme geçmişi desteğini kanıtlamaz.Ayrıntılar

Tercih edilen tarayıcı API rolü (eski alan). Tam uyumluluk listesi için accepted_endpoint_roles kullan. Temel düğüm sağlığı ödeme geçmişi desteğini kanıtlamaz.

accepted_endpoint_roles[]string[] | nullzincir üstü
Uyumlu API biçimleri; uç nokta geçmişi veya kapasitesi kanıtı değildir. Ham node-rpc, BTC/BCH/LTC/DOGE/DASH ve şeffaf ZEC (tam çözümlenmiş bloklar, 1–48 onay), solidified yerel TRX, algod üzerinden yerel ALGO, Octez üzerinden XTZ, SCALE meta verileriyle kesinleşmiş Asset Hub DOT ve fatura memo ID'siyle Stellar RPC üzerinden yerel XLM destekler. Budanmış veya eksik geçmiş uygun değildir. Bu ham adaptörler token altyapısı eklemez. İndeksli API'ler alternatif olmaya devam eder; aşağıdaki altyapı tablosuna bak. Karma ham/indeksli kaynaklar sınırlı aralıkları bağımsız doğrular; varsayılan, tek operatörün takma adları değil, iki bağımsız sağlayıcıdır. Temel düğüm yüksekliği, ORDnet zincir bilgisi ve EVM dışı altyapı için EVM rölesi ödeme alma kanıtı değildir. Monero yine projeye bağlı, yalnızca görüntüleme yetkili wallet-RPC gerektirir.Ayrıntılar

Uyumlu API biçimleri; uç nokta geçmişi veya kapasitesi kanıtı değildir. Ham node-rpc, BTC/BCH/LTC/DOGE/DASH ve şeffaf ZEC (tam çözümlenmiş bloklar, 1–48 onay), solidified yerel TRX, algod üzerinden yerel ALGO, Octez üzerinden XTZ, SCALE meta verileriyle kesinleşmiş Asset Hub DOT ve fatura memo ID'siyle Stellar RPC üzerinden yerel XLM destekler. Budanmış veya eksik geçmiş uygun değildir. Bu ham adaptörler token altyapısı eklemez. İndeksli API'ler alternatif olmaya devam eder; aşağıdaki altyapı tablosuna bak. Karma ham/indeksli kaynaklar sınırlı aralıkları bağımsız doğrular; varsayılan, tek operatörün takma adları değil, iki bağımsız sağlayıcıdır. Temel düğüm yüksekliği, ORDnet zincir bilgisi ve EVM dışı altyapı için EVM rölesi ödeme alma kanıtı değildir. Monero yine projeye bağlı, yalnızca görüntüleme yetkili wallet-RPC gerektirir.

healthy_endpointsintegerzincir üstü

Sağlıklı eşleşen uç noktalar; bağımsız sağlayıcı sayısı değildir.

usable_independent_providersintegerzincir üstü
En fazla iki kullanılabilir doğrulama yuvası. required_independent_providers zincir ayarıdır: varsayılan 2, yöneticinin açık seçimiyle 1. İki sağlayıcı modunda farklı sağlayıcı anahtarları VE ana makineler gerekir. Devre dışı, eski (on dakikadan fazla) veya bekleme süresindeki kaynaklar yuva doldurmaz. Lightning kendi bağlantı kurallarını kullanır.Ayrıntılar

En fazla iki kullanılabilir doğrulama yuvası. required_independent_providers zincir ayarıdır: varsayılan 2, yöneticinin açık seçimiyle 1. İki sağlayıcı modunda farklı sağlayıcı anahtarları VE ana makineler gerekir. Devre dışı, eski (on dakikadan fazla) veya bekleme süresindeki kaynaklar yuva doldurmaz. Lightning kendi bağlantı kurallarını kullanır.

required_independent_providersintegerzincir üstü
En fazla iki kullanılabilir doğrulama yuvası. required_independent_providers zincir ayarıdır: varsayılan 2, yöneticinin açık seçimiyle 1. İki sağlayıcı modunda farklı sağlayıcı anahtarları VE ana makineler gerekir. Devre dışı, eski (on dakikadan fazla) veya bekleme süresindeki kaynaklar yuva doldurmaz. Lightning kendi bağlantı kurallarını kullanır.Ayrıntılar

En fazla iki kullanılabilir doğrulama yuvası. required_independent_providers zincir ayarıdır: varsayılan 2, yöneticinin açık seçimiyle 1. İki sağlayıcı modunda farklı sağlayıcı anahtarları VE ana makineler gerekir. Devre dışı, eski (on dakikadan fazla) veya bekleme süresindeki kaynaklar yuva doldurmaz. Lightning kendi bağlantı kurallarını kullanır.

last_checked_attimestamp | nullzincir üstü

Değerlendirme zamanından ayrı, son eşleşen uç nokta sağlık kontrolü.

monero_wallet_rpcMoneroWalletRpcBinding | nullher zaman
Monero için hassas bilgileri ayıklanmış harici, yalnızca görüntüleme yetkili wallet-RPC bağlantı durumu. Uç nokta, kimlik doğrulama modu, account-0 birincil adresi, teknik kanıt işaretleri/yükseklikleri ve operatör beyanı zaman damgaları içerir; kimlik bilgileri, cüzdan anahtarları ve cüzdan dosyaları asla serileştirilmez.Ayrıntılar

Monero için hassas bilgileri ayıklanmış harici, yalnızca görüntüleme yetkili wallet-RPC bağlantı durumu. Uç nokta, kimlik doğrulama modu, account-0 birincil adresi, teknik kanıt işaretleri/yükseklikleri ve operatör beyanı zaman damgaları içerir; kimlik bilgileri, cüzdan anahtarları ve cüzdan dosyaları asla serileştirilmez.

last_secret_revealed_attimestamp|nullher zaman

Konsol tarafı sır gösterimi denetim meta verileri.

secret_reveal_countintegerher zaman

Konsol tarafı sır gösterimi denetim meta verileri.

next_receive_indexintegerher zaman

Sonraki ayrılmış alt adres indeksi.

last_scanned_heightinteger|nullher zaman

Cüzdan tarayıcısı durumu.

last_scanned_attimestamp|nullher zaman

Cüzdan tarayıcısı durumu.

last_errorstring|nullher zaman

Cüzdan tarayıcısı durumu.

balances[]object[]her zaman
30 yerel zincir altyapısının her biri ve doğrulanmış ERC-20 ile SPL varlıkları için önbellekteki bakiyeler. Monero için yapılandırılmış harici, yalnızca görüntüleme yetkili wallet-RPC gerekir.Ayrıntılar

30 yerel zincir altyapısının her biri ve doğrulanmış ERC-20 ile SPL varlıkları için önbellekteki bakiyeler. Monero için yapılandırılmış harici, yalnızca görüntüleme yetkili wallet-RPC gerekir.

wallet_idUUIDher zaman

Cüzdan ve kalıcı varlık kimlikleri.

asset_idUUIDher zaman

Cüzdan ve kalıcı varlık kimlikleri.

project_enabledbooleanher zaman

Bu varlığın şu anda projenin varlık politikasıyla etkin olup olmadığı.

active_store_countintegerher zaman

Şu anda bu varlığı seçen etkin mağaza sayısı. Bu, kabul durumunun görünümüdür; salt okunur bakiye takibi bağımsız kalır.

active_store_ids[]UUID[]her zaman

Bu projede varlığı şu anda kabul eden etkin mağazalar. Başka API isteği olmadan tam yerel mağaza filtrelemesi sağlar.

tracking_activebooleanher zaman
Bu okunabilir cüzdan ve kayıtlı aynı zincir varlığının arka plan bakiye yenilemesine uygun olup olmadığı. Proje ve ödeme yöntemi kabul anahtarları salt okunur takibi duraklatmaz.Ayrıntılar

Bu okunabilir cüzdan ve kayıtlı aynı zincir varlığının arka plan bakiye yenilemesine uygun olup olmadığı. Proje ve ödeme yöntemi kabul anahtarları salt okunur takibi duraklatmaz.

asset_kindnative | tokenher zaman

Yerel para birimi veya doğrulanmış sözleşme/mint varlığı.

contract_addressstring | nullher zaman

Token sözleşmesi veya mint'i; yerel para biriminde null.

symbolstringher zaman

Görüntüleme kimliği ve atomik hassasiyet.

namestringher zaman

Görüntüleme kimliği ve atomik hassasiyet.

decimalsintegerher zaman

Görüntüleme kimliği ve atomik hassasiyet.

coingecko_idstring | nullher zaman

Eşleştirilmişse fiyatlandırma kimliği.

balancedecimal string|nullher zaman

Cüzdanın birincil adresi ve oluşturulmuş fatura adresleri genelindeki tam gösterim ve atomik bakiye. Tam değer bulunamıyorsa null.

balance_atomicinteger string|nullher zaman

Cüzdanın birincil adresi ve oluşturulmuş fatura adresleri genelindeki tam gösterim ve atomik bakiye. Tam değer bulunamıyorsa null.

price_usddecimal string | nullher zaman

Değerleme için kullanılan bilgi amaçlı önbellek USD birim fiyatı.

value_usddecimal string | nullher zaman

Güncel kur varsa bilgi amaçlı itibari para değerlemesi.

statuspending | refreshing | fresh | stale | errorher zaman
Önbellek tarama durumu. refreshing tamamlanmış bakiyeyi koruyabilir: yaşı için checked_at kullan. Pending tamamlanmış görüntü yok demektir. Bu durumların hiçbiri transferin beklediğini veya faturanın tamamlandığını kanıtlamaz.Ayrıntılar

Önbellek tarama durumu. refreshing tamamlanmış bakiyeyi koruyabilir: yaşı için checked_at kullan. Pending tamamlanmış görüntü yok demektir. Bu durumların hiçbiri transferin beklediğini veya faturanın tamamlandığını kanıtlamaz.

checked_attimestamp | nullher zaman

Tamamlanmış bakiye taramasının temsil ettiği zaman.

last_errorstring | nullher zaman

Güvenli operatör teşhisi.

total_value_usddecimal string | nullher zaman

Güncel USD fiyatı bulunan bakiyelerin bilgi amaçlı toplamı.

balance_statuspending | refreshing | fresh | stale | error | unknownher zaman

Birleştirilmiş önbellek güncelliği; unknown temkinli yedek değerdir ve bu durumların hiçbiri fatura ödemesinin tamamlandığını kanıtlamaz.

balance_checked_attimestamp | nullher zaman

Toplamın temsil ettiği en eski ilgili başarılı bakiye kontrolü.

recent_payments[]object[]her zaman

Tam olarak bu cüzdana atfedilen, en yeni en fazla üç geçerli detected, confirming veya final gözlem.

invoice_public_idUUIDher zaman

Gözlemle ilişkili, müşteriye görünen fatura kimliği.

chain_slugstringher zaman

Zincir ve yerel coin veya doğrulanmış token görüntüleme sembolü.

symbolstringher zaman

Zincir ve yerel coin veya doğrulanmış token görüntüleme sembolü.

transaction_idstringher zaman

Kanonik işlem ve transfer olayı kimliği.

event_indexintegerher zaman

Kanonik işlem ve transfer olayı kimliği.

amountdecimal stringher zaman

Kayan nokta dönüşümü yapılmadan gözlenen tam varlık tutarı.

statusdetected | confirming | finalher zaman

Güncel geçerli gözlem durumu. Reorged, replaced ve invalid gözlemler hariç tutulur.

confirmationsintegerher zaman

Son gözlenen onay sayısı.

observed_atRFC 3339 timestampher zaman

Wholly Crypto'nun ödemeyi ilk gözlediği zaman.

created_atRFC 3339 timestampher zaman

Oluşturulma ve son cüzdan güncelleme zamanı.

updated_atRFC 3339 timestampher zaman

Oluşturulma ve son cüzdan güncelleme zamanı.

wallet_readinessreadiness enumher zaman

Yalnızca cüzdan/politika durumu; tarayıcı ön koşulları için receive_readiness kullan.

receive_readinessobject | null5.5.0+
Ortak ödeme alma kurulumu ve mağaza kabulü. Önbellek gözlemlerini kullanır; rezervasyon veya garanti değildir. Oluşturma gereksinimleri ve gerçek fatura kurunu yeniden kontrol eder.Ayrıntılar

Ortak ödeme alma kurulumu ve mağaza kabulü. Önbellek gözlemlerini kullanır; rezervasyon veya garanti değildir. Oluşturma gereksinimleri ve gerçek fatura kurunu yeniden kontrol eder.

readybooleanher zaman

Ödeme alma kurulum kontrolleri geçti. Harcamaya hazır olmayı, gas'ı, bakiye yenilemeyi veya garantili gelecek teklifi açıklamaz.

invoice_creatableboolean6.0.6+
Yapılandırma geçici tarayıcı uyarılarına rağmen fatura yöntemine izin verir. Para birimi fiyatlandırması oluşturma sırasında kontrol edilir. Bu ödeme doğrulaması değildir: invoice_creatable true iken ready false olabilir. Eksik cüzdanlar, devre dışı politika ve desteklenmeyen adaptörler yine güvenli biçimde başarısız olur.Ayrıntılar

Yapılandırma geçici tarayıcı uyarılarına rağmen fatura yöntemine izin verir. Para birimi fiyatlandırması oluşturma sırasında kontrol edilir. Bu ödeme doğrulaması değildir: invoice_creatable true iken ready false olabilir. Eksik cüzdanlar, devre dışı politika ve desteklenmeyen adaptörler yine güvenli biçimde başarısız olur.

checked_attimestampher zaman

Değerlendirme zamanı. Listeleme ağ isteği veya adres ayırma yapmaz.

issues[]object[]her zaman
Hazırsa boş; aksi halde ödeme alma uyarısı veya yapılandırma engeli. Geçici tarayıcı uyarılarını fatura kurulum hatalarından ayırmak için invoice_creatable kontrol et.Ayrıntılar

Hazırsa boş; aksi halde ödeme alma uyarısı veya yapılandırma engeli. Geçici tarayıcı uyarılarını fatura kurulum hatalarından ayırmak için invoice_creatable kontrol et.

chain_slugstringbiliniyorsa

Etkilenen zinciri ve varlığı tanımlar. Lightning asset_id içermeyebilir.

asset_idUUIDbiliniyorsa

Etkilenen zinciri ve varlığı tanımlar. Lightning asset_id içermeyebilir.

asset_tickerstringbiliniyorsa

Etkilenen zinciri ve varlığı tanımlar. Lightning asset_id içermeyebilir.

reason_codestringher zaman
scanner_provider_quorum, scanner_not_checked, scanner_unavailable, wallet_missing, wallet_disabled, wallet_backup_required, wallet_key_unavailable, wallet_activation_required, monero_binding_unavailable, rate_unavailable, custom_rate_unavailable, lightning_unavailable, project_disabled, store_disabled, chain_disabled, asset_disabled veya asset_not_accepted.Ayrıntılar

scanner_provider_quorum, scanner_not_checked, scanner_unavailable, wallet_missing, wallet_disabled, wallet_backup_required, wallet_key_unavailable, wallet_activation_required, monero_binding_unavailable, rate_unavailable, custom_rate_unavailable, lightning_unavailable, project_disabled, store_disabled, chain_disabled, asset_disabled veya asset_not_accepted.

messagestringvarsa
Satıcıya yönelik açıklama ve eylem tanımlayıcısı: chain_connections, wallets, rates, payment_methods, project_settings veya store_settings. Kimlik bilgisi veya özel sağlayıcı URL'si içermez.Ayrıntılar

Satıcıya yönelik açıklama ve eylem tanımlayıcısı: chain_connections, wallets, rates, payment_methods, project_settings veya store_settings. Kimlik bilgisi veya özel sağlayıcı URL'si içermez.

actionstringvarsa
Satıcıya yönelik açıklama ve eylem tanımlayıcısı: chain_connections, wallets, rates, payment_methods, project_settings veya store_settings. Kimlik bilgisi veya özel sağlayıcı URL'si içermez.Ayrıntılar

Satıcıya yönelik açıklama ve eylem tanımlayıcısı: chain_connections, wallets, rates, payment_methods, project_settings veya store_settings. Kimlik bilgisi veya özel sağlayıcı URL'si içermez.

required_endpoint_rolestring | nullzincir üstü
Tercih edilen tarayıcı API rolü (eski alan). Tam uyumluluk listesi için accepted_endpoint_roles kullan. Temel düğüm sağlığı ödeme geçmişi desteğini kanıtlamaz.Ayrıntılar

Tercih edilen tarayıcı API rolü (eski alan). Tam uyumluluk listesi için accepted_endpoint_roles kullan. Temel düğüm sağlığı ödeme geçmişi desteğini kanıtlamaz.

accepted_endpoint_roles[]string[] | nullzincir üstü
Uyumlu API biçimleri; uç nokta geçmişi veya kapasitesi kanıtı değildir. Ham node-rpc, BTC/BCH/LTC/DOGE/DASH ve şeffaf ZEC (tam çözümlenmiş bloklar, 1–48 onay), solidified yerel TRX, algod üzerinden yerel ALGO, Octez üzerinden XTZ, SCALE meta verileriyle kesinleşmiş Asset Hub DOT ve fatura memo ID'siyle Stellar RPC üzerinden yerel XLM destekler. Budanmış veya eksik geçmiş uygun değildir. Bu ham adaptörler token altyapısı eklemez. İndeksli API'ler alternatif olmaya devam eder; aşağıdaki altyapı tablosuna bak. Karma ham/indeksli kaynaklar sınırlı aralıkları bağımsız doğrular; varsayılan, tek operatörün takma adları değil, iki bağımsız sağlayıcıdır. Temel düğüm yüksekliği, ORDnet zincir bilgisi ve EVM dışı altyapı için EVM rölesi ödeme alma kanıtı değildir. Monero yine projeye bağlı, yalnızca görüntüleme yetkili wallet-RPC gerektirir.Ayrıntılar

Uyumlu API biçimleri; uç nokta geçmişi veya kapasitesi kanıtı değildir. Ham node-rpc, BTC/BCH/LTC/DOGE/DASH ve şeffaf ZEC (tam çözümlenmiş bloklar, 1–48 onay), solidified yerel TRX, algod üzerinden yerel ALGO, Octez üzerinden XTZ, SCALE meta verileriyle kesinleşmiş Asset Hub DOT ve fatura memo ID'siyle Stellar RPC üzerinden yerel XLM destekler. Budanmış veya eksik geçmiş uygun değildir. Bu ham adaptörler token altyapısı eklemez. İndeksli API'ler alternatif olmaya devam eder; aşağıdaki altyapı tablosuna bak. Karma ham/indeksli kaynaklar sınırlı aralıkları bağımsız doğrular; varsayılan, tek operatörün takma adları değil, iki bağımsız sağlayıcıdır. Temel düğüm yüksekliği, ORDnet zincir bilgisi ve EVM dışı altyapı için EVM rölesi ödeme alma kanıtı değildir. Monero yine projeye bağlı, yalnızca görüntüleme yetkili wallet-RPC gerektirir.

healthy_endpointsintegerzincir üstü

Sağlıklı eşleşen uç noktalar; bağımsız sağlayıcı sayısı değildir.

usable_independent_providersintegerzincir üstü
En fazla iki kullanılabilir doğrulama yuvası. required_independent_providers zincir ayarıdır: varsayılan 2, yöneticinin açık seçimiyle 1. İki sağlayıcı modunda farklı sağlayıcı anahtarları VE ana makineler gerekir. Devre dışı, eski (on dakikadan fazla) veya bekleme süresindeki kaynaklar yuva doldurmaz. Lightning kendi bağlantı kurallarını kullanır.Ayrıntılar

En fazla iki kullanılabilir doğrulama yuvası. required_independent_providers zincir ayarıdır: varsayılan 2, yöneticinin açık seçimiyle 1. İki sağlayıcı modunda farklı sağlayıcı anahtarları VE ana makineler gerekir. Devre dışı, eski (on dakikadan fazla) veya bekleme süresindeki kaynaklar yuva doldurmaz. Lightning kendi bağlantı kurallarını kullanır.

required_independent_providersintegerzincir üstü
En fazla iki kullanılabilir doğrulama yuvası. required_independent_providers zincir ayarıdır: varsayılan 2, yöneticinin açık seçimiyle 1. İki sağlayıcı modunda farklı sağlayıcı anahtarları VE ana makineler gerekir. Devre dışı, eski (on dakikadan fazla) veya bekleme süresindeki kaynaklar yuva doldurmaz. Lightning kendi bağlantı kurallarını kullanır.Ayrıntılar

En fazla iki kullanılabilir doğrulama yuvası. required_independent_providers zincir ayarıdır: varsayılan 2, yöneticinin açık seçimiyle 1. İki sağlayıcı modunda farklı sağlayıcı anahtarları VE ana makineler gerekir. Devre dışı, eski (on dakikadan fazla) veya bekleme süresindeki kaynaklar yuva doldurmaz. Lightning kendi bağlantı kurallarını kullanır.

last_checked_attimestamp | nullzincir üstü

Değerlendirme zamanından ayrı, son eşleşen uç nokta sağlık kontrolü.

Kullanım notları
  • Dizi en fazla 64 benzersiz varlık ve görüntüleme sırası kabul eder.
  • Seçimler kaydedilen istenen yapılandırmadır; cüzdan yedeklenmeden önce veya zincir duraklatılmışken hazırlanabilir. Fatura oluşturma yine yalnızca proje politikası, yerel üst politika, cüzdan ve çalışma zamanı kontrolleri hazır olan yöntemleri sunar.
  • Hiç ödeme yöntemi yapılandırmamak için boş assets dizisi gönder.

Hatalar

Hata kodları ve yeniden deneme kuralları

PUTMağaza onay politikası belirle/v1/projects/{project_id}/stores/{store_id}/payment-assets/{asset_id}/confirmation-policyOkuma ve yazma

Mağazaya özel tek bir onay değerini belirler veya temizler ve yenilenmiş mağaza ödeme yöntemi listesini döndürür. Varlık mağaza için zaten seçilmiş olmalıdır. Proje, mağaza, zincir veya cüzdan duraklatılmışken yapılandırma kullanılabilir kalır.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MERCHANT_API_TOKEN
Content-Typezorunluapplication/json
Acceptönerilenapplication/json

Yol parametreleri

project_idUUIDzorunlu

Kimlik bilgisine atanmış proje; duraklatılmış olabilir.

store_idUUIDzorunlu

project_id'ye ait mağaza; duraklatılmış olabilir.

asset_idUUIDzorunlu

Güncellenecek, şu anda seçili mağaza ödeme varlığı.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request PUT \
  --url "https://api.example.com/v1/projects/YOUR_PROJECT_ID/stores/YOUR_STORE_ID/payment-assets/YOUR_ASSET_ID/confirmation-policy" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "strategy": "custom",
  "required_confirmations": 0
}'

İstek gövdesi

strategyinherit | customzorunlu

Etiketli strateji. inherit mağazaya özel değeri kaldırır; custom, required_confirmations gerektirir.

required_confirmationsintegeryalnızca custom

Bu varlık için döndürülen alt/üst sınır içindeki tamsayı. Bilinmeyen veya ek alanlar reddedilir.

Yanıt 200 application/json

Örnek yanıt
{
  "data": [
    {
      "asset": { "id": "YOUR_ASSET_ID", "chain_slug": "bitcoin", "symbol": "BTC" },
      "selected": true,
      "display_order": 0,
      "confirmation_policy": {
        "finality_mode": "confirmations",
        "project_required_confirmations": 2,
        "override_required_confirmations": 0,
        "effective_required_confirmations": 0,
        "editable": true,
        "minimum_required_confirmations": 0,
        "maximum_required_confirmations": 10000
      },
      "wallet_readiness": "ready"
    }
  ]
}

Yanıt alanları

data[]object[]
assetobjecther zaman

Projenin görebildiği yerel veya doğrulanmış token varlığı.

idUUIDher zaman

Proje ve mağaza politika rotalarının kullandığı kalıcı ödeme varlığı tanımlayıcısı.

asset_keystringher zaman

Kanonik CAIP biçimli yerel veya sözleşme varlığı kimliği.

chain_slugstringher zaman

Wholly Crypto zincir tanımlayıcısı ve yapılandırılmış ağ.

networkstringher zaman

Wholly Crypto zincir tanımlayıcısı ve yapılandırılmış ağ.

caip_network_idstringher zaman

Kanonik ağ ve varlık kimlikleri.

caip_asset_idstring|nullher zaman

Kanonik ağ ve varlık kimlikleri.

asset_kindnative | tokenher zaman

Ödeme tamamlanmasında zincir para biriminin mi, doğrulanmış sözleşme/mint'in mi kullanıldığı.

payment_railstringher zaman

Çalışma zamanı ödeme altyapısı: utxo, evm-native, solana-native, account-native, privacy-native veya token-transfer.

symbolstringher zaman

Görüntüleme kimliği ve tam atomik birim hassasiyeti.

namestringher zaman

Görüntüleme kimliği ve tam atomik birim hassasiyeti.

decimalsintegerher zaman

Görüntüleme kimliği ve tam atomik birim hassasiyeti.

contract_addressstring | nullher zaman

Token'lar için kanonik ERC-20 sözleşmesi veya SPL mint'i; yerel varlıklarda null.

coingecko_idstring | nullher zaman

Keşif/fiyatlandırma kimliği. Özel sözleşmelerde null; sembollerinden piyasa fiyatı çıkarma. CoinGecko meta verileri tek başına token'ı seçilebilir yapmaz.

custom_tokenbooleanher zaman

Proje kapsamlı sabit USD veya seçili DEX havuzu fiyatlandırması olan, zincir üstünde doğrulanmış özel sözleşme.

icon_pathpath | nullher zaman

Varsa yerel önbellekteki token simgesi.

token_standarderc20 | spl-token | nullher zaman

Doğrulanmış çalışma zamanı token standardı; yerel varlıklarda null.

metadata_verified_attimestamp | nullher zaman

Ödeme varlığına dönüştürülen token'ların zincir üstü meta veri doğrulama zamanı.

payment_supportedbooleanher zaman
Derleme zamanı kayıt kontrolleri. scanner_ready ödeme tarayıcısı çalışma ortamının kurulu olduğu anlamına gelir; ödeme onayı, yapılandırılmış sayıda sağlıklı ve tam role uygun sağlayıcı gerektirir (varsayılan 2, isteğe bağlı 1); geçici tarayıcı kullanılabilirliği 6.0.6'dan itibaren fatura oluşturmayı engellemez. balance_ready yalnızca uygulanmış bakiye adaptörlerinde true olur.Ayrıntılar

Derleme zamanı kayıt kontrolleri. scanner_ready ödeme tarayıcısı çalışma ortamının kurulu olduğu anlamına gelir; ödeme onayı, yapılandırılmış sayıda sağlıklı ve tam role uygun sağlayıcı gerektirir (varsayılan 2, isteğe bağlı 1); geçici tarayıcı kullanılabilirliği 6.0.6'dan itibaren fatura oluşturmayı engellemez. balance_ready yalnızca uygulanmış bakiye adaptörlerinde true olur.

scanner_readybooleanher zaman
Derleme zamanı kayıt kontrolleri. scanner_ready ödeme tarayıcısı çalışma ortamının kurulu olduğu anlamına gelir; ödeme onayı, yapılandırılmış sayıda sağlıklı ve tam role uygun sağlayıcı gerektirir (varsayılan 2, isteğe bağlı 1); geçici tarayıcı kullanılabilirliği 6.0.6'dan itibaren fatura oluşturmayı engellemez. balance_ready yalnızca uygulanmış bakiye adaptörlerinde true olur.Ayrıntılar

Derleme zamanı kayıt kontrolleri. scanner_ready ödeme tarayıcısı çalışma ortamının kurulu olduğu anlamına gelir; ödeme onayı, yapılandırılmış sayıda sağlıklı ve tam role uygun sağlayıcı gerektirir (varsayılan 2, isteğe bağlı 1); geçici tarayıcı kullanılabilirliği 6.0.6'dan itibaren fatura oluşturmayı engellemez. balance_ready yalnızca uygulanmış bakiye adaptörlerinde true olur.

balance_readybooleanher zaman
Derleme zamanı kayıt kontrolleri. scanner_ready ödeme tarayıcısı çalışma ortamının kurulu olduğu anlamına gelir; ödeme onayı, yapılandırılmış sayıda sağlıklı ve tam role uygun sağlayıcı gerektirir (varsayılan 2, isteğe bağlı 1); geçici tarayıcı kullanılabilirliği 6.0.6'dan itibaren fatura oluşturmayı engellemez. balance_ready yalnızca uygulanmış bakiye adaptörlerinde true olur.Ayrıntılar

Derleme zamanı kayıt kontrolleri. scanner_ready ödeme tarayıcısı çalışma ortamının kurulu olduğu anlamına gelir; ödeme onayı, yapılandırılmış sayıda sağlıklı ve tam role uygun sağlayıcı gerektirir (varsayılan 2, isteğe bağlı 1); geçici tarayıcı kullanılabilirliği 6.0.6'dan itibaren fatura oluşturmayı engellemez. balance_ready yalnızca uygulanmış bakiye adaptörlerinde true olur.

default_finality_modeconfirmations | finalizedher zaman

Yeni proje politikasının devraldığı varsayılan kesinlik modeli.

default_required_confirmationsintegerher zaman

Varsayılan onay ve izleme politikası.

default_monitoring_minutesintegerher zaman

Varsayılan onay ve izleme politikası.

project_policyobject | nullher zaman

Üst proje politikası.

enabledbooleanzorunlu

Varlığı proje için etkinleştirir veya devre dışı bırakır. Herhangi bir token'dan önce yerel zincir etkin olmalıdır.

finality_modeconfirmations | finalizedzorunlu

Varlık ödeme altyapısının desteklediği kesinlik politikası. finalized, required_confirmations=1 gerektirir.

required_confirmationsintegerzorunlu
Bitcoin ve EVM altyapıları sıfır kabul eder; diğer onay altyapıları en az bir, yalnızca finalized altyapıları tam bir gerektirir. Her transferin işlem yeniden oynatma aralığında kalması için EVM altyapıları 0–48 ile sınırlıdır.Ayrıntılar

Bitcoin ve EVM altyapıları sıfır kabul eder; diğer onay altyapıları en az bir, yalnızca finalized altyapıları tam bir gerektirir. Her transferin işlem yeniden oynatma aralığında kalması için EVM altyapıları 0–48 ile sınırlıdır.

monitoring_minutesintegerzorunlu

Fatura etkinken 1–10.080 dakikalık sorgulama aralığı.

late_monitoring_daysintegerzorunlu

Fatura süresi dolduktan sonra 0–3.650 gün izleme.

selectedbooleanher zaman
Bu yöntemin mağazanın kayıtlı istenen yapılandırmasına dahil olup olmadığı. Proje politikası, cüzdan, kurulu adaptör ve fiyatlandırma geçerliyse sunulur. Geçici tarayıcı kesintileri yöntemi yeni faturalardan çıkarmaz.Ayrıntılar

Bu yöntemin mağazanın kayıtlı istenen yapılandırmasına dahil olup olmadığı. Proje politikası, cüzdan, kurulu adaptör ve fiyatlandırma geçerliyse sunulur. Geçici tarayıcı kesintileri yöntemi yeni faturalardan çıkarmaz.

display_orderinteger | nullher zaman

Seçildiğinde mağaza ödeme sayfasındaki sırası.

confirmation_policyobject | nullher zaman

Projede yapılandırılan varlık için geçerli mağaza politikası. Proje politikası yoksa null.

finality_modeconfirmations | finalizedher zaman

Ödeme tamamlanmasının ayarlanabilir blok sayısına mı, ağ kesinliğine mi dayandığı.

project_required_confirmationsintegerher zaman

Mağazaya özel değer yoksa sonraki faturaların kullanacağı güncel proje varsayılanı.

override_required_confirmationsinteger | nullher zaman

Mağazaya özel sayı veya proje varsayılanını devralmak için null.

effective_required_confirmationsintegerher zaman

Bu mağaza ve varlık için yeni faturaların kaydedeceği sayı.

editablebooleanher zaman

Kesinlik politikası değiştirilemeyen finalized ağlarda false.

minimum_required_confirmationsintegerher zaman

Dahil, zincire uygun alt sınır; 0 yalnızca tespit anında kabulü destekleyen altyapılarda sunulur.

maximum_required_confirmationsintegerher zaman

Dahil, zincire uygun üst sınır.

walletobject | nullher zaman

Yerel ve token varlıklarının paylaştığı zincir cüzdanı.

idUUIDher zaman

Cüzdan, sahibi proje ve zincirin yerel varlık tanımlayıcıları.

project_idUUIDher zaman

Cüzdan, sahibi proje ve zincirin yerel varlık tanımlayıcıları.

native_asset_idUUIDher zaman

Cüzdan, sahibi proje ve zincirin yerel varlık tanımlayıcıları.

chain_slugstringher zaman

Cüzdan zinciri ve ağı.

networkstringher zaman

Cüzdan zinciri ve ağı.

asset_symbolstringher zaman

Zincirin yerel varlığının görüntüleme kimliği.

asset_namestringher zaman

Zincirin yerel varlığının görüntüleme kimliği.

statuspending | active | disabled | errorher zaman

Cüzdanın çalışma durumu.

labelstringher zaman

Operatör etiketi.

public_keystring | nullher zaman

Herkese açık cüzdan kimliği; kurtarma ifadesi veya özel anahtar açığa çıkarılmaz.

primary_addressstring | nullher zaman

Herkese açık cüzdan kimliği; kurtarma ifadesi veya özel anahtar açığa çıkarılmaz.

derivation_schemestring | nullher zaman

Adres politikası ve biçimi.

address_formatstring | nullher zaman

Adres politikası ve biçimi.

backup_confirmed_attimestamp | nullher zaman

Operatör kurtarma yedeğini onayladıktan sonra null değildir.

activation_requiredbooleanher zaman
XRP ve Stellar ortak hesapları, operatör gösterilen adrese fon gönderene ve yapılandırılmış tarayıcı sağlayıcıları tam olarak o hesabı doğrulayana kadar kullanılamaz. Kalıcı kanıtın süresi dolmaz; canlı tarayıcı sağlığı fatura oluşturma için değil, ödeme doğrulaması için ayrı kontrol edilir.Ayrıntılar

XRP ve Stellar ortak hesapları, operatör gösterilen adrese fon gönderene ve yapılandırılmış tarayıcı sağlayıcıları tam olarak o hesabı doğrulayana kadar kullanılamaz. Kalıcı kanıtın süresi dolmaz; canlı tarayıcı sağlığı fatura oluşturma için değil, ödeme doğrulaması için ayrı kontrol edilir.

activation_verified_attimestamp|nullher zaman
XRP ve Stellar ortak hesapları, operatör gösterilen adrese fon gönderene ve yapılandırılmış tarayıcı sağlayıcıları tam olarak o hesabı doğrulayana kadar kullanılamaz. Kalıcı kanıtın süresi dolmaz; canlı tarayıcı sağlığı fatura oluşturma için değil, ödeme doğrulaması için ayrı kontrol edilir.Ayrıntılar

XRP ve Stellar ortak hesapları, operatör gösterilen adrese fon gönderene ve yapılandırılmış tarayıcı sağlayıcıları tam olarak o hesabı doğrulayana kadar kullanılamaz. Kalıcı kanıtın süresi dolmaz; canlı tarayıcı sağlığı fatura oluşturma için değil, ödeme doğrulaması için ayrı kontrol edilir.

receive_readinessobject | null5.5.0+
Cüzdan listelerine dahildir: proje ödeme alma kurulumu ve zincir tarayıcısı ön koşulları. Bakiyelerden, token gas'ından ve gönderime hazır olma durumundan ayrıdır. Diğer cüzdan yanıtlarında null kalabilir.Ayrıntılar

Cüzdan listelerine dahildir: proje ödeme alma kurulumu ve zincir tarayıcısı ön koşulları. Bakiyelerden, token gas'ından ve gönderime hazır olma durumundan ayrıdır. Diğer cüzdan yanıtlarında null kalabilir.

readybooleanher zaman

Ödeme alma kurulum kontrolleri geçti. Harcamaya hazır olmayı, gas'ı, bakiye yenilemeyi veya garantili gelecek teklifi açıklamaz.

invoice_creatableboolean6.0.6+
Yapılandırma geçici tarayıcı uyarılarına rağmen fatura yöntemine izin verir. Para birimi fiyatlandırması oluşturma sırasında kontrol edilir. Bu ödeme doğrulaması değildir: invoice_creatable true iken ready false olabilir. Eksik cüzdanlar, devre dışı politika ve desteklenmeyen adaptörler yine güvenli biçimde başarısız olur.Ayrıntılar

Yapılandırma geçici tarayıcı uyarılarına rağmen fatura yöntemine izin verir. Para birimi fiyatlandırması oluşturma sırasında kontrol edilir. Bu ödeme doğrulaması değildir: invoice_creatable true iken ready false olabilir. Eksik cüzdanlar, devre dışı politika ve desteklenmeyen adaptörler yine güvenli biçimde başarısız olur.

checked_attimestampher zaman

Değerlendirme zamanı. Listeleme ağ isteği veya adres ayırma yapmaz.

issues[]object[]her zaman
Hazırsa boş; aksi halde ödeme alma uyarısı veya yapılandırma engeli. Geçici tarayıcı uyarılarını fatura kurulum hatalarından ayırmak için invoice_creatable kontrol et.Ayrıntılar

Hazırsa boş; aksi halde ödeme alma uyarısı veya yapılandırma engeli. Geçici tarayıcı uyarılarını fatura kurulum hatalarından ayırmak için invoice_creatable kontrol et.

chain_slugstringbiliniyorsa

Etkilenen zinciri ve varlığı tanımlar. Lightning asset_id içermeyebilir.

asset_idUUIDbiliniyorsa

Etkilenen zinciri ve varlığı tanımlar. Lightning asset_id içermeyebilir.

asset_tickerstringbiliniyorsa

Etkilenen zinciri ve varlığı tanımlar. Lightning asset_id içermeyebilir.

reason_codestringher zaman
scanner_provider_quorum, scanner_not_checked, scanner_unavailable, wallet_missing, wallet_disabled, wallet_backup_required, wallet_key_unavailable, wallet_activation_required, monero_binding_unavailable, rate_unavailable, custom_rate_unavailable, lightning_unavailable, project_disabled, store_disabled, chain_disabled, asset_disabled veya asset_not_accepted.Ayrıntılar

scanner_provider_quorum, scanner_not_checked, scanner_unavailable, wallet_missing, wallet_disabled, wallet_backup_required, wallet_key_unavailable, wallet_activation_required, monero_binding_unavailable, rate_unavailable, custom_rate_unavailable, lightning_unavailable, project_disabled, store_disabled, chain_disabled, asset_disabled veya asset_not_accepted.

messagestringvarsa
Satıcıya yönelik açıklama ve eylem tanımlayıcısı: chain_connections, wallets, rates, payment_methods, project_settings veya store_settings. Kimlik bilgisi veya özel sağlayıcı URL'si içermez.Ayrıntılar

Satıcıya yönelik açıklama ve eylem tanımlayıcısı: chain_connections, wallets, rates, payment_methods, project_settings veya store_settings. Kimlik bilgisi veya özel sağlayıcı URL'si içermez.

actionstringvarsa
Satıcıya yönelik açıklama ve eylem tanımlayıcısı: chain_connections, wallets, rates, payment_methods, project_settings veya store_settings. Kimlik bilgisi veya özel sağlayıcı URL'si içermez.Ayrıntılar

Satıcıya yönelik açıklama ve eylem tanımlayıcısı: chain_connections, wallets, rates, payment_methods, project_settings veya store_settings. Kimlik bilgisi veya özel sağlayıcı URL'si içermez.

required_endpoint_rolestring | nullzincir üstü
Tercih edilen tarayıcı API rolü (eski alan). Tam uyumluluk listesi için accepted_endpoint_roles kullan. Temel düğüm sağlığı ödeme geçmişi desteğini kanıtlamaz.Ayrıntılar

Tercih edilen tarayıcı API rolü (eski alan). Tam uyumluluk listesi için accepted_endpoint_roles kullan. Temel düğüm sağlığı ödeme geçmişi desteğini kanıtlamaz.

accepted_endpoint_roles[]string[] | nullzincir üstü
Uyumlu API biçimleri; uç nokta geçmişi veya kapasitesi kanıtı değildir. Ham node-rpc, BTC/BCH/LTC/DOGE/DASH ve şeffaf ZEC (tam çözümlenmiş bloklar, 1–48 onay), solidified yerel TRX, algod üzerinden yerel ALGO, Octez üzerinden XTZ, SCALE meta verileriyle kesinleşmiş Asset Hub DOT ve fatura memo ID'siyle Stellar RPC üzerinden yerel XLM destekler. Budanmış veya eksik geçmiş uygun değildir. Bu ham adaptörler token altyapısı eklemez. İndeksli API'ler alternatif olmaya devam eder; aşağıdaki altyapı tablosuna bak. Karma ham/indeksli kaynaklar sınırlı aralıkları bağımsız doğrular; varsayılan, tek operatörün takma adları değil, iki bağımsız sağlayıcıdır. Temel düğüm yüksekliği, ORDnet zincir bilgisi ve EVM dışı altyapı için EVM rölesi ödeme alma kanıtı değildir. Monero yine projeye bağlı, yalnızca görüntüleme yetkili wallet-RPC gerektirir.Ayrıntılar

Uyumlu API biçimleri; uç nokta geçmişi veya kapasitesi kanıtı değildir. Ham node-rpc, BTC/BCH/LTC/DOGE/DASH ve şeffaf ZEC (tam çözümlenmiş bloklar, 1–48 onay), solidified yerel TRX, algod üzerinden yerel ALGO, Octez üzerinden XTZ, SCALE meta verileriyle kesinleşmiş Asset Hub DOT ve fatura memo ID'siyle Stellar RPC üzerinden yerel XLM destekler. Budanmış veya eksik geçmiş uygun değildir. Bu ham adaptörler token altyapısı eklemez. İndeksli API'ler alternatif olmaya devam eder; aşağıdaki altyapı tablosuna bak. Karma ham/indeksli kaynaklar sınırlı aralıkları bağımsız doğrular; varsayılan, tek operatörün takma adları değil, iki bağımsız sağlayıcıdır. Temel düğüm yüksekliği, ORDnet zincir bilgisi ve EVM dışı altyapı için EVM rölesi ödeme alma kanıtı değildir. Monero yine projeye bağlı, yalnızca görüntüleme yetkili wallet-RPC gerektirir.

healthy_endpointsintegerzincir üstü

Sağlıklı eşleşen uç noktalar; bağımsız sağlayıcı sayısı değildir.

usable_independent_providersintegerzincir üstü
En fazla iki kullanılabilir doğrulama yuvası. required_independent_providers zincir ayarıdır: varsayılan 2, yöneticinin açık seçimiyle 1. İki sağlayıcı modunda farklı sağlayıcı anahtarları VE ana makineler gerekir. Devre dışı, eski (on dakikadan fazla) veya bekleme süresindeki kaynaklar yuva doldurmaz. Lightning kendi bağlantı kurallarını kullanır.Ayrıntılar

En fazla iki kullanılabilir doğrulama yuvası. required_independent_providers zincir ayarıdır: varsayılan 2, yöneticinin açık seçimiyle 1. İki sağlayıcı modunda farklı sağlayıcı anahtarları VE ana makineler gerekir. Devre dışı, eski (on dakikadan fazla) veya bekleme süresindeki kaynaklar yuva doldurmaz. Lightning kendi bağlantı kurallarını kullanır.

required_independent_providersintegerzincir üstü
En fazla iki kullanılabilir doğrulama yuvası. required_independent_providers zincir ayarıdır: varsayılan 2, yöneticinin açık seçimiyle 1. İki sağlayıcı modunda farklı sağlayıcı anahtarları VE ana makineler gerekir. Devre dışı, eski (on dakikadan fazla) veya bekleme süresindeki kaynaklar yuva doldurmaz. Lightning kendi bağlantı kurallarını kullanır.Ayrıntılar

En fazla iki kullanılabilir doğrulama yuvası. required_independent_providers zincir ayarıdır: varsayılan 2, yöneticinin açık seçimiyle 1. İki sağlayıcı modunda farklı sağlayıcı anahtarları VE ana makineler gerekir. Devre dışı, eski (on dakikadan fazla) veya bekleme süresindeki kaynaklar yuva doldurmaz. Lightning kendi bağlantı kurallarını kullanır.

last_checked_attimestamp | nullzincir üstü

Değerlendirme zamanından ayrı, son eşleşen uç nokta sağlık kontrolü.

monero_wallet_rpcMoneroWalletRpcBinding | nullher zaman
Monero için hassas bilgileri ayıklanmış harici, yalnızca görüntüleme yetkili wallet-RPC bağlantı durumu. Uç nokta, kimlik doğrulama modu, account-0 birincil adresi, teknik kanıt işaretleri/yükseklikleri ve operatör beyanı zaman damgaları içerir; kimlik bilgileri, cüzdan anahtarları ve cüzdan dosyaları asla serileştirilmez.Ayrıntılar

Monero için hassas bilgileri ayıklanmış harici, yalnızca görüntüleme yetkili wallet-RPC bağlantı durumu. Uç nokta, kimlik doğrulama modu, account-0 birincil adresi, teknik kanıt işaretleri/yükseklikleri ve operatör beyanı zaman damgaları içerir; kimlik bilgileri, cüzdan anahtarları ve cüzdan dosyaları asla serileştirilmez.

last_secret_revealed_attimestamp|nullher zaman

Konsol tarafı sır gösterimi denetim meta verileri.

secret_reveal_countintegerher zaman

Konsol tarafı sır gösterimi denetim meta verileri.

next_receive_indexintegerher zaman

Sonraki ayrılmış alt adres indeksi.

last_scanned_heightinteger|nullher zaman

Cüzdan tarayıcısı durumu.

last_scanned_attimestamp|nullher zaman

Cüzdan tarayıcısı durumu.

last_errorstring|nullher zaman

Cüzdan tarayıcısı durumu.

balances[]object[]her zaman
30 yerel zincir altyapısının her biri ve doğrulanmış ERC-20 ile SPL varlıkları için önbellekteki bakiyeler. Monero için yapılandırılmış harici, yalnızca görüntüleme yetkili wallet-RPC gerekir.Ayrıntılar

30 yerel zincir altyapısının her biri ve doğrulanmış ERC-20 ile SPL varlıkları için önbellekteki bakiyeler. Monero için yapılandırılmış harici, yalnızca görüntüleme yetkili wallet-RPC gerekir.

wallet_idUUIDher zaman

Cüzdan ve kalıcı varlık kimlikleri.

asset_idUUIDher zaman

Cüzdan ve kalıcı varlık kimlikleri.

project_enabledbooleanher zaman

Bu varlığın şu anda projenin varlık politikasıyla etkin olup olmadığı.

active_store_countintegerher zaman

Şu anda bu varlığı seçen etkin mağaza sayısı. Bu, kabul durumunun görünümüdür; salt okunur bakiye takibi bağımsız kalır.

active_store_ids[]UUID[]her zaman

Bu projede varlığı şu anda kabul eden etkin mağazalar. Başka API isteği olmadan tam yerel mağaza filtrelemesi sağlar.

tracking_activebooleanher zaman
Bu okunabilir cüzdan ve kayıtlı aynı zincir varlığının arka plan bakiye yenilemesine uygun olup olmadığı. Proje ve ödeme yöntemi kabul anahtarları salt okunur takibi duraklatmaz.Ayrıntılar

Bu okunabilir cüzdan ve kayıtlı aynı zincir varlığının arka plan bakiye yenilemesine uygun olup olmadığı. Proje ve ödeme yöntemi kabul anahtarları salt okunur takibi duraklatmaz.

asset_kindnative | tokenher zaman

Yerel para birimi veya doğrulanmış sözleşme/mint varlığı.

contract_addressstring | nullher zaman

Token sözleşmesi veya mint'i; yerel para biriminde null.

symbolstringher zaman

Görüntüleme kimliği ve atomik hassasiyet.

namestringher zaman

Görüntüleme kimliği ve atomik hassasiyet.

decimalsintegerher zaman

Görüntüleme kimliği ve atomik hassasiyet.

coingecko_idstring | nullher zaman

Eşleştirilmişse fiyatlandırma kimliği.

balancedecimal string|nullher zaman

Cüzdanın birincil adresi ve oluşturulmuş fatura adresleri genelindeki tam gösterim ve atomik bakiye. Tam değer bulunamıyorsa null.

balance_atomicinteger string|nullher zaman

Cüzdanın birincil adresi ve oluşturulmuş fatura adresleri genelindeki tam gösterim ve atomik bakiye. Tam değer bulunamıyorsa null.

price_usddecimal string | nullher zaman

Değerleme için kullanılan bilgi amaçlı önbellek USD birim fiyatı.

value_usddecimal string | nullher zaman

Güncel kur varsa bilgi amaçlı itibari para değerlemesi.

statuspending | refreshing | fresh | stale | errorher zaman
Önbellek tarama durumu. refreshing tamamlanmış bakiyeyi koruyabilir: yaşı için checked_at kullan. Pending tamamlanmış görüntü yok demektir. Bu durumların hiçbiri transferin beklediğini veya faturanın tamamlandığını kanıtlamaz.Ayrıntılar

Önbellek tarama durumu. refreshing tamamlanmış bakiyeyi koruyabilir: yaşı için checked_at kullan. Pending tamamlanmış görüntü yok demektir. Bu durumların hiçbiri transferin beklediğini veya faturanın tamamlandığını kanıtlamaz.

checked_attimestamp | nullher zaman

Tamamlanmış bakiye taramasının temsil ettiği zaman.

last_errorstring | nullher zaman

Güvenli operatör teşhisi.

total_value_usddecimal string | nullher zaman

Güncel USD fiyatı bulunan bakiyelerin bilgi amaçlı toplamı.

balance_statuspending | refreshing | fresh | stale | error | unknownher zaman

Birleştirilmiş önbellek güncelliği; unknown temkinli yedek değerdir ve bu durumların hiçbiri fatura ödemesinin tamamlandığını kanıtlamaz.

balance_checked_attimestamp | nullher zaman

Toplamın temsil ettiği en eski ilgili başarılı bakiye kontrolü.

recent_payments[]object[]her zaman

Tam olarak bu cüzdana atfedilen, en yeni en fazla üç geçerli detected, confirming veya final gözlem.

invoice_public_idUUIDher zaman

Gözlemle ilişkili, müşteriye görünen fatura kimliği.

chain_slugstringher zaman

Zincir ve yerel coin veya doğrulanmış token görüntüleme sembolü.

symbolstringher zaman

Zincir ve yerel coin veya doğrulanmış token görüntüleme sembolü.

transaction_idstringher zaman

Kanonik işlem ve transfer olayı kimliği.

event_indexintegerher zaman

Kanonik işlem ve transfer olayı kimliği.

amountdecimal stringher zaman

Kayan nokta dönüşümü yapılmadan gözlenen tam varlık tutarı.

statusdetected | confirming | finalher zaman

Güncel geçerli gözlem durumu. Reorged, replaced ve invalid gözlemler hariç tutulur.

confirmationsintegerher zaman

Son gözlenen onay sayısı.

observed_atRFC 3339 timestampher zaman

Wholly Crypto'nun ödemeyi ilk gözlediği zaman.

created_atRFC 3339 timestampher zaman

Oluşturulma ve son cüzdan güncelleme zamanı.

updated_atRFC 3339 timestampher zaman

Oluşturulma ve son cüzdan güncelleme zamanı.

wallet_readinessreadiness enumher zaman

Yalnızca cüzdan/politika durumu; tarayıcı ön koşulları için receive_readiness kullan.

receive_readinessobject | null5.5.0+
Ortak ödeme alma kurulumu ve mağaza kabulü. Önbellek gözlemlerini kullanır; rezervasyon veya garanti değildir. Oluşturma gereksinimleri ve gerçek fatura kurunu yeniden kontrol eder.Ayrıntılar

Ortak ödeme alma kurulumu ve mağaza kabulü. Önbellek gözlemlerini kullanır; rezervasyon veya garanti değildir. Oluşturma gereksinimleri ve gerçek fatura kurunu yeniden kontrol eder.

readybooleanher zaman

Ödeme alma kurulum kontrolleri geçti. Harcamaya hazır olmayı, gas'ı, bakiye yenilemeyi veya garantili gelecek teklifi açıklamaz.

invoice_creatableboolean6.0.6+
Yapılandırma geçici tarayıcı uyarılarına rağmen fatura yöntemine izin verir. Para birimi fiyatlandırması oluşturma sırasında kontrol edilir. Bu ödeme doğrulaması değildir: invoice_creatable true iken ready false olabilir. Eksik cüzdanlar, devre dışı politika ve desteklenmeyen adaptörler yine güvenli biçimde başarısız olur.Ayrıntılar

Yapılandırma geçici tarayıcı uyarılarına rağmen fatura yöntemine izin verir. Para birimi fiyatlandırması oluşturma sırasında kontrol edilir. Bu ödeme doğrulaması değildir: invoice_creatable true iken ready false olabilir. Eksik cüzdanlar, devre dışı politika ve desteklenmeyen adaptörler yine güvenli biçimde başarısız olur.

checked_attimestampher zaman

Değerlendirme zamanı. Listeleme ağ isteği veya adres ayırma yapmaz.

issues[]object[]her zaman
Hazırsa boş; aksi halde ödeme alma uyarısı veya yapılandırma engeli. Geçici tarayıcı uyarılarını fatura kurulum hatalarından ayırmak için invoice_creatable kontrol et.Ayrıntılar

Hazırsa boş; aksi halde ödeme alma uyarısı veya yapılandırma engeli. Geçici tarayıcı uyarılarını fatura kurulum hatalarından ayırmak için invoice_creatable kontrol et.

chain_slugstringbiliniyorsa

Etkilenen zinciri ve varlığı tanımlar. Lightning asset_id içermeyebilir.

asset_idUUIDbiliniyorsa

Etkilenen zinciri ve varlığı tanımlar. Lightning asset_id içermeyebilir.

asset_tickerstringbiliniyorsa

Etkilenen zinciri ve varlığı tanımlar. Lightning asset_id içermeyebilir.

reason_codestringher zaman
scanner_provider_quorum, scanner_not_checked, scanner_unavailable, wallet_missing, wallet_disabled, wallet_backup_required, wallet_key_unavailable, wallet_activation_required, monero_binding_unavailable, rate_unavailable, custom_rate_unavailable, lightning_unavailable, project_disabled, store_disabled, chain_disabled, asset_disabled veya asset_not_accepted.Ayrıntılar

scanner_provider_quorum, scanner_not_checked, scanner_unavailable, wallet_missing, wallet_disabled, wallet_backup_required, wallet_key_unavailable, wallet_activation_required, monero_binding_unavailable, rate_unavailable, custom_rate_unavailable, lightning_unavailable, project_disabled, store_disabled, chain_disabled, asset_disabled veya asset_not_accepted.

messagestringvarsa
Satıcıya yönelik açıklama ve eylem tanımlayıcısı: chain_connections, wallets, rates, payment_methods, project_settings veya store_settings. Kimlik bilgisi veya özel sağlayıcı URL'si içermez.Ayrıntılar

Satıcıya yönelik açıklama ve eylem tanımlayıcısı: chain_connections, wallets, rates, payment_methods, project_settings veya store_settings. Kimlik bilgisi veya özel sağlayıcı URL'si içermez.

actionstringvarsa
Satıcıya yönelik açıklama ve eylem tanımlayıcısı: chain_connections, wallets, rates, payment_methods, project_settings veya store_settings. Kimlik bilgisi veya özel sağlayıcı URL'si içermez.Ayrıntılar

Satıcıya yönelik açıklama ve eylem tanımlayıcısı: chain_connections, wallets, rates, payment_methods, project_settings veya store_settings. Kimlik bilgisi veya özel sağlayıcı URL'si içermez.

required_endpoint_rolestring | nullzincir üstü
Tercih edilen tarayıcı API rolü (eski alan). Tam uyumluluk listesi için accepted_endpoint_roles kullan. Temel düğüm sağlığı ödeme geçmişi desteğini kanıtlamaz.Ayrıntılar

Tercih edilen tarayıcı API rolü (eski alan). Tam uyumluluk listesi için accepted_endpoint_roles kullan. Temel düğüm sağlığı ödeme geçmişi desteğini kanıtlamaz.

accepted_endpoint_roles[]string[] | nullzincir üstü
Uyumlu API biçimleri; uç nokta geçmişi veya kapasitesi kanıtı değildir. Ham node-rpc, BTC/BCH/LTC/DOGE/DASH ve şeffaf ZEC (tam çözümlenmiş bloklar, 1–48 onay), solidified yerel TRX, algod üzerinden yerel ALGO, Octez üzerinden XTZ, SCALE meta verileriyle kesinleşmiş Asset Hub DOT ve fatura memo ID'siyle Stellar RPC üzerinden yerel XLM destekler. Budanmış veya eksik geçmiş uygun değildir. Bu ham adaptörler token altyapısı eklemez. İndeksli API'ler alternatif olmaya devam eder; aşağıdaki altyapı tablosuna bak. Karma ham/indeksli kaynaklar sınırlı aralıkları bağımsız doğrular; varsayılan, tek operatörün takma adları değil, iki bağımsız sağlayıcıdır. Temel düğüm yüksekliği, ORDnet zincir bilgisi ve EVM dışı altyapı için EVM rölesi ödeme alma kanıtı değildir. Monero yine projeye bağlı, yalnızca görüntüleme yetkili wallet-RPC gerektirir.Ayrıntılar

Uyumlu API biçimleri; uç nokta geçmişi veya kapasitesi kanıtı değildir. Ham node-rpc, BTC/BCH/LTC/DOGE/DASH ve şeffaf ZEC (tam çözümlenmiş bloklar, 1–48 onay), solidified yerel TRX, algod üzerinden yerel ALGO, Octez üzerinden XTZ, SCALE meta verileriyle kesinleşmiş Asset Hub DOT ve fatura memo ID'siyle Stellar RPC üzerinden yerel XLM destekler. Budanmış veya eksik geçmiş uygun değildir. Bu ham adaptörler token altyapısı eklemez. İndeksli API'ler alternatif olmaya devam eder; aşağıdaki altyapı tablosuna bak. Karma ham/indeksli kaynaklar sınırlı aralıkları bağımsız doğrular; varsayılan, tek operatörün takma adları değil, iki bağımsız sağlayıcıdır. Temel düğüm yüksekliği, ORDnet zincir bilgisi ve EVM dışı altyapı için EVM rölesi ödeme alma kanıtı değildir. Monero yine projeye bağlı, yalnızca görüntüleme yetkili wallet-RPC gerektirir.

healthy_endpointsintegerzincir üstü

Sağlıklı eşleşen uç noktalar; bağımsız sağlayıcı sayısı değildir.

usable_independent_providersintegerzincir üstü
En fazla iki kullanılabilir doğrulama yuvası. required_independent_providers zincir ayarıdır: varsayılan 2, yöneticinin açık seçimiyle 1. İki sağlayıcı modunda farklı sağlayıcı anahtarları VE ana makineler gerekir. Devre dışı, eski (on dakikadan fazla) veya bekleme süresindeki kaynaklar yuva doldurmaz. Lightning kendi bağlantı kurallarını kullanır.Ayrıntılar

En fazla iki kullanılabilir doğrulama yuvası. required_independent_providers zincir ayarıdır: varsayılan 2, yöneticinin açık seçimiyle 1. İki sağlayıcı modunda farklı sağlayıcı anahtarları VE ana makineler gerekir. Devre dışı, eski (on dakikadan fazla) veya bekleme süresindeki kaynaklar yuva doldurmaz. Lightning kendi bağlantı kurallarını kullanır.

required_independent_providersintegerzincir üstü
En fazla iki kullanılabilir doğrulama yuvası. required_independent_providers zincir ayarıdır: varsayılan 2, yöneticinin açık seçimiyle 1. İki sağlayıcı modunda farklı sağlayıcı anahtarları VE ana makineler gerekir. Devre dışı, eski (on dakikadan fazla) veya bekleme süresindeki kaynaklar yuva doldurmaz. Lightning kendi bağlantı kurallarını kullanır.Ayrıntılar

En fazla iki kullanılabilir doğrulama yuvası. required_independent_providers zincir ayarıdır: varsayılan 2, yöneticinin açık seçimiyle 1. İki sağlayıcı modunda farklı sağlayıcı anahtarları VE ana makineler gerekir. Devre dışı, eski (on dakikadan fazla) veya bekleme süresindeki kaynaklar yuva doldurmaz. Lightning kendi bağlantı kurallarını kullanır.

last_checked_attimestamp | nullzincir üstü

Değerlendirme zamanından ayrı, son eşleşen uç nokta sağlık kontrolü.

Kullanım notları
  • Mağazaya özel değeri kaldırmak ve sonraki faturalar için güncel proje varsayılanını izlemek üzere {"strategy":"inherit"} kullan.
  • Finalized ağlar editable false döndürür ve Ağ kesinliği kullanır; özel blok sayısı değeri kabul etmez.
  • 0 değeri, ağ onayı ve zincir yeniden yapılanması koruması olmadan tespit anında kabul demektir. Yalnızca minimum_required_confirmations 0 ise kabul edilir.
  • Politika değişiklikleri yalnızca yeni faturaları etkiler. Mevcut faturalar oluşturulma anında kaydedilen proje/mağaza onay politikası görüntüsünü korur.
  • Her güncelleme tek varlıktır; aynı mağaza varlığındaki eş zamanlı düzenlemeleri sırala ve yenilenmiş yanıtı güncel durum olarak kullan.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETProje cüzdanlarını ve bakiyelerini listele/v1/projects/{project_id}/walletsSalt okunur

Herkese açık cüzdan meta verilerini ve cüzdanın tam zincir/ağındaki kayıtlı, bakiyesi okunabilir tüm varlıkları döndürür. 30 yerel zincir altyapısının tamamı kapsanır; doğrulanmış ERC-20 ve SPL varlıkları da izlenir. Varlıklar ilk taramadan önce veya ödeme için kabul edilmese bile hemen görünür. project_enabled ödeme kabulünü; tracking_active bağımsız olarak salt okunur yenileme uygunluğunu bildirir. Monero projeye bağlı harici, yalnızca görüntüleme yetkili wallet-RPC gerektirir. Konsoldaki Bakiyeleri tara, varlık başına ilerleme/hatalarla sınırlı okumaları önceliklendirir; yalnızca tam döngüler güncel toplamları yeniler. Fatura tamamlanması bu önbellek bakiyeleriyle değil, işlem düzeyinde izleme ve onay politikasıyla belirlenir.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MERCHANT_API_TOKEN
Acceptönerilenapplication/json

Yol parametreleri

project_idUUIDzorunlu

Kimlik bilgisine atanmış etkin proje.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/projects/YOUR_PROJECT_ID/wallets" \
  --header "Authorization: Bearer $WHOLLY_TOKEN"

Yanıt 200 application/json

Örnek yanıt
{
  "data": [
    {
      "id": "55555555-5555-4555-8555-555555555555",
      "project_id": "11111111-1111-4111-8111-111111111111",
      "native_asset_id": "10000000-0000-4000-8000-000000000003",
      "chain_slug": "ethereum",
      "network": "mainnet",
      "asset_symbol": "ETH",
      "asset_name": "Ethereum",
      "status": "active",
      "label": "Primary Ethereum wallet",
      "public_key": "0x…",
      "primary_address": "0x…",
      "derivation_scheme": "bip44",
      "address_format": "eip55",
      "backup_confirmed_at": "2026-08-31T17:00:00Z",
      "last_secret_revealed_at": null,
      "secret_reveal_count": 0,
      "next_receive_index": 43,
      "last_scanned_height": 23123456,
      "last_scanned_at": "2026-08-31T18:05:00Z",
      "last_error": null,
      "balances": [
        { "wallet_id": "55555555-5555-4555-8555-555555555555", "asset_id": "10000000-0000-4000-8000-000000000003", "project_enabled": true, "tracking_active": true, "asset_kind": "native", "contract_address": null, "symbol": "ETH", "name": "Ethereum", "decimals": 18, "coingecko_id": "ethereum", "balance": "0.125", "balance_atomic": "125000000000000000", "price_usd": "4500", "value_usd": "562.50", "status": "fresh", "checked_at": "2026-08-31T18:05:00Z", "last_error": null },
        { "wallet_id": "55555555-5555-4555-8555-555555555555", "asset_id": "10000000-0000-4000-8000-000000000099", "project_enabled": false, "tracking_active": true, "asset_kind": "token", "contract_address": "0xA0b86991c6218b36c1d19d4a2e9eb0cE3606eB48", "symbol": "USDC", "name": "USDC", "decimals": 6, "coingecko_id": "usd-coin", "balance": null, "balance_atomic": null, "price_usd": "1", "value_usd": null, "status": "pending", "checked_at": null, "last_error": null }
      ],
      "total_value_usd": "562.50",
      "balance_status": "fresh",
      "balance_checked_at": "2026-08-31T18:05:00Z",
      "recent_payments": [
        { "invoice_public_id": "0a6a98db-d93d-48ee-8c3c-fd45f90c4a50", "chain_slug": "ethereum", "symbol": "USDC", "transaction_id": "0x…", "event_index": 0, "amount": "25", "status": "final", "confirmations": 12, "observed_at": "2026-08-31T18:04:00Z" }
      ],
      "created_at": "2026-08-31T16:00:00Z",
      "updated_at": "2026-08-31T18:05:00Z"
    }
  ]
}

Yanıt alanları

data[]object[]
idUUIDher zaman

Cüzdan, sahibi proje ve zincirin yerel varlık tanımlayıcıları.

project_idUUIDher zaman

Cüzdan, sahibi proje ve zincirin yerel varlık tanımlayıcıları.

native_asset_idUUIDher zaman

Cüzdan, sahibi proje ve zincirin yerel varlık tanımlayıcıları.

chain_slugstringher zaman

Cüzdan zinciri ve ağı.

networkstringher zaman

Cüzdan zinciri ve ağı.

asset_symbolstringher zaman

Zincirin yerel varlığının görüntüleme kimliği.

asset_namestringher zaman

Zincirin yerel varlığının görüntüleme kimliği.

statuspending | active | disabled | errorher zaman

Cüzdanın çalışma durumu.

labelstringher zaman

Operatör etiketi.

public_keystring | nullher zaman

Herkese açık cüzdan kimliği; kurtarma ifadesi veya özel anahtar açığa çıkarılmaz.

primary_addressstring | nullher zaman

Herkese açık cüzdan kimliği; kurtarma ifadesi veya özel anahtar açığa çıkarılmaz.

derivation_schemestring | nullher zaman

Adres politikası ve biçimi.

address_formatstring | nullher zaman

Adres politikası ve biçimi.

backup_confirmed_attimestamp | nullher zaman

Operatör kurtarma yedeğini onayladıktan sonra null değildir.

activation_requiredbooleanher zaman
XRP ve Stellar ortak hesapları, operatör gösterilen adrese fon gönderene ve yapılandırılmış tarayıcı sağlayıcıları tam olarak o hesabı doğrulayana kadar kullanılamaz. Kalıcı kanıtın süresi dolmaz; canlı tarayıcı sağlığı fatura oluşturma için değil, ödeme doğrulaması için ayrı kontrol edilir.Ayrıntılar

XRP ve Stellar ortak hesapları, operatör gösterilen adrese fon gönderene ve yapılandırılmış tarayıcı sağlayıcıları tam olarak o hesabı doğrulayana kadar kullanılamaz. Kalıcı kanıtın süresi dolmaz; canlı tarayıcı sağlığı fatura oluşturma için değil, ödeme doğrulaması için ayrı kontrol edilir.

activation_verified_attimestamp|nullher zaman
XRP ve Stellar ortak hesapları, operatör gösterilen adrese fon gönderene ve yapılandırılmış tarayıcı sağlayıcıları tam olarak o hesabı doğrulayana kadar kullanılamaz. Kalıcı kanıtın süresi dolmaz; canlı tarayıcı sağlığı fatura oluşturma için değil, ödeme doğrulaması için ayrı kontrol edilir.Ayrıntılar

XRP ve Stellar ortak hesapları, operatör gösterilen adrese fon gönderene ve yapılandırılmış tarayıcı sağlayıcıları tam olarak o hesabı doğrulayana kadar kullanılamaz. Kalıcı kanıtın süresi dolmaz; canlı tarayıcı sağlığı fatura oluşturma için değil, ödeme doğrulaması için ayrı kontrol edilir.

receive_readinessobject | null5.5.0+
Cüzdan listelerine dahildir: proje ödeme alma kurulumu ve zincir tarayıcısı ön koşulları. Bakiyelerden, token gas'ından ve gönderime hazır olma durumundan ayrıdır. Diğer cüzdan yanıtlarında null kalabilir.Ayrıntılar

Cüzdan listelerine dahildir: proje ödeme alma kurulumu ve zincir tarayıcısı ön koşulları. Bakiyelerden, token gas'ından ve gönderime hazır olma durumundan ayrıdır. Diğer cüzdan yanıtlarında null kalabilir.

readybooleanher zaman

Ödeme alma kurulum kontrolleri geçti. Harcamaya hazır olmayı, gas'ı, bakiye yenilemeyi veya garantili gelecek teklifi açıklamaz.

invoice_creatableboolean6.0.6+
Yapılandırma geçici tarayıcı uyarılarına rağmen fatura yöntemine izin verir. Para birimi fiyatlandırması oluşturma sırasında kontrol edilir. Bu ödeme doğrulaması değildir: invoice_creatable true iken ready false olabilir. Eksik cüzdanlar, devre dışı politika ve desteklenmeyen adaptörler yine güvenli biçimde başarısız olur.Ayrıntılar

Yapılandırma geçici tarayıcı uyarılarına rağmen fatura yöntemine izin verir. Para birimi fiyatlandırması oluşturma sırasında kontrol edilir. Bu ödeme doğrulaması değildir: invoice_creatable true iken ready false olabilir. Eksik cüzdanlar, devre dışı politika ve desteklenmeyen adaptörler yine güvenli biçimde başarısız olur.

checked_attimestampher zaman

Değerlendirme zamanı. Listeleme ağ isteği veya adres ayırma yapmaz.

issues[]object[]her zaman
Hazırsa boş; aksi halde ödeme alma uyarısı veya yapılandırma engeli. Geçici tarayıcı uyarılarını fatura kurulum hatalarından ayırmak için invoice_creatable kontrol et.Ayrıntılar

Hazırsa boş; aksi halde ödeme alma uyarısı veya yapılandırma engeli. Geçici tarayıcı uyarılarını fatura kurulum hatalarından ayırmak için invoice_creatable kontrol et.

chain_slugstringbiliniyorsa

Etkilenen zinciri ve varlığı tanımlar. Lightning asset_id içermeyebilir.

asset_idUUIDbiliniyorsa

Etkilenen zinciri ve varlığı tanımlar. Lightning asset_id içermeyebilir.

asset_tickerstringbiliniyorsa

Etkilenen zinciri ve varlığı tanımlar. Lightning asset_id içermeyebilir.

reason_codestringher zaman
scanner_provider_quorum, scanner_not_checked, scanner_unavailable, wallet_missing, wallet_disabled, wallet_backup_required, wallet_key_unavailable, wallet_activation_required, monero_binding_unavailable, rate_unavailable, custom_rate_unavailable, lightning_unavailable, project_disabled, store_disabled, chain_disabled, asset_disabled veya asset_not_accepted.Ayrıntılar

scanner_provider_quorum, scanner_not_checked, scanner_unavailable, wallet_missing, wallet_disabled, wallet_backup_required, wallet_key_unavailable, wallet_activation_required, monero_binding_unavailable, rate_unavailable, custom_rate_unavailable, lightning_unavailable, project_disabled, store_disabled, chain_disabled, asset_disabled veya asset_not_accepted.

messagestringvarsa
Satıcıya yönelik açıklama ve eylem tanımlayıcısı: chain_connections, wallets, rates, payment_methods, project_settings veya store_settings. Kimlik bilgisi veya özel sağlayıcı URL'si içermez.Ayrıntılar

Satıcıya yönelik açıklama ve eylem tanımlayıcısı: chain_connections, wallets, rates, payment_methods, project_settings veya store_settings. Kimlik bilgisi veya özel sağlayıcı URL'si içermez.

actionstringvarsa
Satıcıya yönelik açıklama ve eylem tanımlayıcısı: chain_connections, wallets, rates, payment_methods, project_settings veya store_settings. Kimlik bilgisi veya özel sağlayıcı URL'si içermez.Ayrıntılar

Satıcıya yönelik açıklama ve eylem tanımlayıcısı: chain_connections, wallets, rates, payment_methods, project_settings veya store_settings. Kimlik bilgisi veya özel sağlayıcı URL'si içermez.

required_endpoint_rolestring | nullzincir üstü
Tercih edilen tarayıcı API rolü (eski alan). Tam uyumluluk listesi için accepted_endpoint_roles kullan. Temel düğüm sağlığı ödeme geçmişi desteğini kanıtlamaz.Ayrıntılar

Tercih edilen tarayıcı API rolü (eski alan). Tam uyumluluk listesi için accepted_endpoint_roles kullan. Temel düğüm sağlığı ödeme geçmişi desteğini kanıtlamaz.

accepted_endpoint_roles[]string[] | nullzincir üstü
Uyumlu API biçimleri; uç nokta geçmişi veya kapasitesi kanıtı değildir. Ham node-rpc, BTC/BCH/LTC/DOGE/DASH ve şeffaf ZEC (tam çözümlenmiş bloklar, 1–48 onay), solidified yerel TRX, algod üzerinden yerel ALGO, Octez üzerinden XTZ, SCALE meta verileriyle kesinleşmiş Asset Hub DOT ve fatura memo ID'siyle Stellar RPC üzerinden yerel XLM destekler. Budanmış veya eksik geçmiş uygun değildir. Bu ham adaptörler token altyapısı eklemez. İndeksli API'ler alternatif olmaya devam eder; aşağıdaki altyapı tablosuna bak. Karma ham/indeksli kaynaklar sınırlı aralıkları bağımsız doğrular; varsayılan, tek operatörün takma adları değil, iki bağımsız sağlayıcıdır. Temel düğüm yüksekliği, ORDnet zincir bilgisi ve EVM dışı altyapı için EVM rölesi ödeme alma kanıtı değildir. Monero yine projeye bağlı, yalnızca görüntüleme yetkili wallet-RPC gerektirir.Ayrıntılar

Uyumlu API biçimleri; uç nokta geçmişi veya kapasitesi kanıtı değildir. Ham node-rpc, BTC/BCH/LTC/DOGE/DASH ve şeffaf ZEC (tam çözümlenmiş bloklar, 1–48 onay), solidified yerel TRX, algod üzerinden yerel ALGO, Octez üzerinden XTZ, SCALE meta verileriyle kesinleşmiş Asset Hub DOT ve fatura memo ID'siyle Stellar RPC üzerinden yerel XLM destekler. Budanmış veya eksik geçmiş uygun değildir. Bu ham adaptörler token altyapısı eklemez. İndeksli API'ler alternatif olmaya devam eder; aşağıdaki altyapı tablosuna bak. Karma ham/indeksli kaynaklar sınırlı aralıkları bağımsız doğrular; varsayılan, tek operatörün takma adları değil, iki bağımsız sağlayıcıdır. Temel düğüm yüksekliği, ORDnet zincir bilgisi ve EVM dışı altyapı için EVM rölesi ödeme alma kanıtı değildir. Monero yine projeye bağlı, yalnızca görüntüleme yetkili wallet-RPC gerektirir.

healthy_endpointsintegerzincir üstü

Sağlıklı eşleşen uç noktalar; bağımsız sağlayıcı sayısı değildir.

usable_independent_providersintegerzincir üstü
En fazla iki kullanılabilir doğrulama yuvası. required_independent_providers zincir ayarıdır: varsayılan 2, yöneticinin açık seçimiyle 1. İki sağlayıcı modunda farklı sağlayıcı anahtarları VE ana makineler gerekir. Devre dışı, eski (on dakikadan fazla) veya bekleme süresindeki kaynaklar yuva doldurmaz. Lightning kendi bağlantı kurallarını kullanır.Ayrıntılar

En fazla iki kullanılabilir doğrulama yuvası. required_independent_providers zincir ayarıdır: varsayılan 2, yöneticinin açık seçimiyle 1. İki sağlayıcı modunda farklı sağlayıcı anahtarları VE ana makineler gerekir. Devre dışı, eski (on dakikadan fazla) veya bekleme süresindeki kaynaklar yuva doldurmaz. Lightning kendi bağlantı kurallarını kullanır.

required_independent_providersintegerzincir üstü
En fazla iki kullanılabilir doğrulama yuvası. required_independent_providers zincir ayarıdır: varsayılan 2, yöneticinin açık seçimiyle 1. İki sağlayıcı modunda farklı sağlayıcı anahtarları VE ana makineler gerekir. Devre dışı, eski (on dakikadan fazla) veya bekleme süresindeki kaynaklar yuva doldurmaz. Lightning kendi bağlantı kurallarını kullanır.Ayrıntılar

En fazla iki kullanılabilir doğrulama yuvası. required_independent_providers zincir ayarıdır: varsayılan 2, yöneticinin açık seçimiyle 1. İki sağlayıcı modunda farklı sağlayıcı anahtarları VE ana makineler gerekir. Devre dışı, eski (on dakikadan fazla) veya bekleme süresindeki kaynaklar yuva doldurmaz. Lightning kendi bağlantı kurallarını kullanır.

last_checked_attimestamp | nullzincir üstü

Değerlendirme zamanından ayrı, son eşleşen uç nokta sağlık kontrolü.

monero_wallet_rpcMoneroWalletRpcBinding | nullher zaman
Monero için hassas bilgileri ayıklanmış harici, yalnızca görüntüleme yetkili wallet-RPC bağlantı durumu. Uç nokta, kimlik doğrulama modu, account-0 birincil adresi, teknik kanıt işaretleri/yükseklikleri ve operatör beyanı zaman damgaları içerir; kimlik bilgileri, cüzdan anahtarları ve cüzdan dosyaları asla serileştirilmez.Ayrıntılar

Monero için hassas bilgileri ayıklanmış harici, yalnızca görüntüleme yetkili wallet-RPC bağlantı durumu. Uç nokta, kimlik doğrulama modu, account-0 birincil adresi, teknik kanıt işaretleri/yükseklikleri ve operatör beyanı zaman damgaları içerir; kimlik bilgileri, cüzdan anahtarları ve cüzdan dosyaları asla serileştirilmez.

last_secret_revealed_attimestamp|nullher zaman

Konsol tarafı sır gösterimi denetim meta verileri.

secret_reveal_countintegerher zaman

Konsol tarafı sır gösterimi denetim meta verileri.

next_receive_indexintegerher zaman

Sonraki ayrılmış alt adres indeksi.

last_scanned_heightinteger|nullher zaman

Cüzdan tarayıcısı durumu.

last_scanned_attimestamp|nullher zaman

Cüzdan tarayıcısı durumu.

last_errorstring|nullher zaman

Cüzdan tarayıcısı durumu.

balances[]object[]her zaman
30 yerel zincir altyapısının her biri ve doğrulanmış ERC-20 ile SPL varlıkları için önbellekteki bakiyeler. Monero için yapılandırılmış harici, yalnızca görüntüleme yetkili wallet-RPC gerekir.Ayrıntılar

30 yerel zincir altyapısının her biri ve doğrulanmış ERC-20 ile SPL varlıkları için önbellekteki bakiyeler. Monero için yapılandırılmış harici, yalnızca görüntüleme yetkili wallet-RPC gerekir.

wallet_idUUIDher zaman

Cüzdan ve kalıcı varlık kimlikleri.

asset_idUUIDher zaman

Cüzdan ve kalıcı varlık kimlikleri.

project_enabledbooleanher zaman

Bu varlığın şu anda projenin varlık politikasıyla etkin olup olmadığı.

active_store_countintegerher zaman

Şu anda bu varlığı seçen etkin mağaza sayısı. Bu, kabul durumunun görünümüdür; salt okunur bakiye takibi bağımsız kalır.

active_store_ids[]UUID[]her zaman

Bu projede varlığı şu anda kabul eden etkin mağazalar. Başka API isteği olmadan tam yerel mağaza filtrelemesi sağlar.

tracking_activebooleanher zaman
Bu okunabilir cüzdan ve kayıtlı aynı zincir varlığının arka plan bakiye yenilemesine uygun olup olmadığı. Proje ve ödeme yöntemi kabul anahtarları salt okunur takibi duraklatmaz.Ayrıntılar

Bu okunabilir cüzdan ve kayıtlı aynı zincir varlığının arka plan bakiye yenilemesine uygun olup olmadığı. Proje ve ödeme yöntemi kabul anahtarları salt okunur takibi duraklatmaz.

asset_kindnative | tokenher zaman

Yerel para birimi veya doğrulanmış sözleşme/mint varlığı.

contract_addressstring | nullher zaman

Token sözleşmesi veya mint'i; yerel para biriminde null.

symbolstringher zaman

Görüntüleme kimliği ve atomik hassasiyet.

namestringher zaman

Görüntüleme kimliği ve atomik hassasiyet.

decimalsintegerher zaman

Görüntüleme kimliği ve atomik hassasiyet.

coingecko_idstring | nullher zaman

Eşleştirilmişse fiyatlandırma kimliği.

balancedecimal string|nullher zaman

Cüzdanın birincil adresi ve oluşturulmuş fatura adresleri genelindeki tam gösterim ve atomik bakiye. Tam değer bulunamıyorsa null.

balance_atomicinteger string|nullher zaman

Cüzdanın birincil adresi ve oluşturulmuş fatura adresleri genelindeki tam gösterim ve atomik bakiye. Tam değer bulunamıyorsa null.

price_usddecimal string | nullher zaman

Değerleme için kullanılan bilgi amaçlı önbellek USD birim fiyatı.

value_usddecimal string | nullher zaman

Güncel kur varsa bilgi amaçlı itibari para değerlemesi.

statuspending | refreshing | fresh | stale | errorher zaman
Önbellek tarama durumu. refreshing tamamlanmış bakiyeyi koruyabilir: yaşı için checked_at kullan. Pending tamamlanmış görüntü yok demektir. Bu durumların hiçbiri transferin beklediğini veya faturanın tamamlandığını kanıtlamaz.Ayrıntılar

Önbellek tarama durumu. refreshing tamamlanmış bakiyeyi koruyabilir: yaşı için checked_at kullan. Pending tamamlanmış görüntü yok demektir. Bu durumların hiçbiri transferin beklediğini veya faturanın tamamlandığını kanıtlamaz.

checked_attimestamp | nullher zaman

Tamamlanmış bakiye taramasının temsil ettiği zaman.

last_errorstring | nullher zaman

Güvenli operatör teşhisi.

total_value_usddecimal string | nullher zaman

Güncel USD fiyatı bulunan bakiyelerin bilgi amaçlı toplamı.

balance_statuspending | refreshing | fresh | stale | error | unknownher zaman

Birleştirilmiş önbellek güncelliği; unknown temkinli yedek değerdir ve bu durumların hiçbiri fatura ödemesinin tamamlandığını kanıtlamaz.

balance_checked_attimestamp | nullher zaman

Toplamın temsil ettiği en eski ilgili başarılı bakiye kontrolü.

recent_payments[]object[]her zaman

Tam olarak bu cüzdana atfedilen, en yeni en fazla üç geçerli detected, confirming veya final gözlem.

invoice_public_idUUIDher zaman

Gözlemle ilişkili, müşteriye görünen fatura kimliği.

chain_slugstringher zaman

Zincir ve yerel coin veya doğrulanmış token görüntüleme sembolü.

symbolstringher zaman

Zincir ve yerel coin veya doğrulanmış token görüntüleme sembolü.

transaction_idstringher zaman

Kanonik işlem ve transfer olayı kimliği.

event_indexintegerher zaman

Kanonik işlem ve transfer olayı kimliği.

amountdecimal stringher zaman

Kayan nokta dönüşümü yapılmadan gözlenen tam varlık tutarı.

statusdetected | confirming | finalher zaman

Güncel geçerli gözlem durumu. Reorged, replaced ve invalid gözlemler hariç tutulur.

confirmationsintegerher zaman

Son gözlenen onay sayısı.

observed_atRFC 3339 timestampher zaman

Wholly Crypto'nun ödemeyi ilk gözlediği zaman.

created_atRFC 3339 timestampher zaman

Oluşturulma ve son cüzdan güncelleme zamanı.

updated_atRFC 3339 timestampher zaman

Oluşturulma ve son cüzdan güncelleme zamanı.

Kullanım notları
  • Bu bearer rotası asla kurtarma ifadesi, özel anahtar, şifrelenmiş sır veya harcama yöntemi döndürmez.
  • Yeni kayıtlı aynı zincir varlığı ilk tam taramadan önce null bakiyeler ve pending durumuyla döndürülür; uydurma sıfır olarak asla raporlanmaz.
  • Projeyi, ödeme kabulü için cüzdanı, yerel altyapıyı veya tek varlığı kapatmak salt okunur bakiye takibini durdurmaz: birincil adresi olan etkin ve devre dışı cüzdanlar kayıtlı, desteklenen aynı zincir varlıklarını yenilemeye devam eder. Pending ve error cüzdanlar taranmaz.
  • project_enabled yalnızca projenin varlık kabul politikasını bildirir ve tracking_active true kalırken false olabilir.
  • balance ve balance_atomic tam dizelerdir; price_usd, value_usd ve total_value_usd bilgi amaçlıdır ve null olabilir. Güncel bakiye durumu güncel piyasa fiyatını garanti etmez.
  • Değerleme en fazla iki saatlik CoinGecko fiyatlarını tercih eder. Yerel coin'ler ve doğrulanmış kanonik USDC/USDT, önce birincil sağlayıcı olmak üzere etkin Kraken/Binance kaynaklarının en fazla beş dakikalık USD tekliflerine geçebilir. Dolar sabitliği varsayılmaz, özel token fiyatı yalnızca sembolden alınmaz; projenin sabit/DEX fiyatları ayrı kalır. Fatura teklifleri değişmez.
  • Pending durumunda tam görüntü yoktur. Refreshing son tamamlanmış tutarı ve checked_at değerini korur; blokzincir transferi bekliyor demek değildir. Stale/error tutarlar da eski değerleri koruyabilir. Kullanılamayan önbelleği asla sıfır veya eksik ödeme sayma. Rutin EVM/Solana yenilemeleri denetimler arasında yakın zamanda kontrol edilen boş adresleri en fazla 30 dakika yeniden kullanırken, fonlanan, yeni ve değişen adresleri yeniden kontrol eder. Konsolda açıkça Bakiyeleri tara istemek tam tarama yapar.
  • recent_payments cüzdan başına üç gözlemle sınırlıdır ve geçersiz kılınmış geçmişi içermez.

Hatalar

Hata kodları ve yeniden deneme kuralları

POSTFatura oluştur/v1/projects/{project_id}/stores/{store_id}/invoicesOkuma ve yazma

Cüzdan hedefleri, güncel tam teklifler, denetim geçmişi ve bildirim gönderim kuyruğu kayıtlarıyla faturayı atomik oluşturur. Aynı kimlik bilgisi ve Idempotency-Key ile birebir aynı ham gövde baytlarını tekrar göndermek ilk faturayı döndürür.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MERCHANT_API_TOKEN
Idempotency-KeyzorunluBoşluksuz, benzersiz 1–128 görünür ASCII karakteri.
Content-Typeönerilenapplication/json. Mevcut ham gövde işleyicisi medya türünü zorunlu tutmadan JSON ayrıştırır.
Acceptönerilenapplication/json

Yol parametreleri

project_idUUIDzorunlu

Proje API kimliğini Proje → Ayarlar → API kimlikleri bölümünden kopyala. Kimlik bilgisine atanmış olmalıdır; okunabilir proje tanımlayıcısı kabul edilmez.

store_idUUIDzorunlu

Mağaza API kimliğini Proje → Mağazalar → mağaza seç → Temel → API kimlikleri bölümünden kopyala. Varsayılan mağaza için bile zorunludur; mağaza etkin ve project_id'ye ait olmalıdır.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
# Keep this key and the exact body for retries; use a new key for each new invoice.
curl --fail-with-body --max-time 30 \
  --request POST \
  --url "https://api.example.com/v1/projects/YOUR_PROJECT_ID/stores/YOUR_STORE_ID/invoices" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Idempotency-Key: order-1042-attempt-1' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "amount": "49.90",
  "currency": "USD"
}'

İstek gövdesi

amountstringzorunlu
İşaretsiz düz ondalık sayı dizesi; işaret veya üs yok, en fazla 48 tamsayı ve 30 ondalık basamak. Varsayılan olarak pozitif olmalıdır. Mağaza, Mağazalar → Fatura bölümünde sıfır tutarlı faturalara izin verebilir; sıfır toplamlar fon almadan, adres ayırmadan veya işlem ücreti olmadan tamamlanır.Ayrıntılar

İşaretsiz düz ondalık sayı dizesi; işaret veya üs yok, en fazla 48 tamsayı ve 30 ondalık basamak. Varsayılan olarak pozitif olmalıdır. Mağaza, Mağazalar → Fatura bölümünde sıfır tutarlı faturalara izin verebilir; sıfır toplamlar fon almadan, adres ayırmadan veya işlem ücreti olmadan tamamlanır.

currencystring | nullisteğe bağlı
Desteklenen üç harfli itibari para birimi; büyük harfe normalleştirilir. Atlanırsa veya null ise mağazanın fatura para birimini devralır. Oluşturma ayrıca bağımsız olarak kullanılabilir faturalandırma dönüşüm kuru gerektirir.Ayrıntılar

Desteklenen üç harfli itibari para birimi; büyük harfe normalleştirilir. Atlanırsa veya null ise mağazanın fatura para birimini devralır. Oluşturma ayrıca bağımsız olarak kullanılabilir faturalandırma dönüşüm kuru gerektirir.

payment_methods[]object[] | nullisteğe bağlı
Bu fatura için mağazada etkin yöntemleri seç. Merchant 5.4.0+: bilinmeyen/etkin olmayan/kabul edilmeyen seçimler yok sayılır; hiçbiri eşleşmezse mağaza varsayılanları kullanılır. Atlanması/null da mağaza varsayılanını kullanır; [] geçersizdir. Yöntemi asla etkinleştirmez veya mağaza ayarını değiştirmez. Aşağıdaki seçim şemasına bak.Ayrıntılar

Bu fatura için mağazada etkin yöntemleri seç. Merchant 5.4.0+: bilinmeyen/etkin olmayan/kabul edilmeyen seçimler yok sayılır; hiçbiri eşleşmezse mağaza varsayılanları kullanılır. Atlanması/null da mağaza varsayılanını kullanır; [] geçersizdir. Yöntemi asla etkinleştirmez veya mağaza ayarını değiştirmez. Aşağıdaki seçim şemasına bak.

chain_slugstringzorunlu
chain_slug değerini Proje → Mağazalar → Ödeme yöntemleri bölümünden kopyala veya GET /v1/projects/{project_id}/stores/{store_id}/payment-assets yanıtından oku; ör. ethereum, base veya bitcoin. Zincir/ödeme altyapısı çifti yalnızca bir kez bulunabilir.Ayrıntılar

chain_slug değerini Proje → Mağazalar → Ödeme yöntemleri bölümünden kopyala veya GET /v1/projects/{project_id}/stores/{store_id}/payment-assets yanıtından oku; ör. ethereum, base veya bitcoin. Zincir/ödeme altyapısı çifti yalnızca bir kez bulunabilir.

asset_ids[]UUID[] | nullisteğe bağlı
Sözleşme adresleri veya fatura ödeme yöntemi kimlikleri değil, zincir üstü asset.id UUID'leri. Bunu VEYA asset_tickers kullan. Bu zincirde etkin kabul edilen tüm varlıklar için iki seçiciyi de atla. [] ve yinelenen/nil kimlikler geçersizdir. 5.4.0+'da bu mağazada bu zincir için etkin/kabul edilen olmayan kimlikler yok sayılır; tamamen eşleşmeyen seçim mağaza varsayılanını kullanır.Ayrıntılar

Sözleşme adresleri veya fatura ödeme yöntemi kimlikleri değil, zincir üstü asset.id UUID'leri. Bunu VEYA asset_tickers kullan. Bu zincirde etkin kabul edilen tüm varlıklar için iki seçiciyi de atla. [] ve yinelenen/nil kimlikler geçersizdir. 5.4.0+'da bu mağazada bu zincir için etkin/kabul edilen olmayan kimlikler yok sayılır; tamamen eşleşmeyen seçim mağaza varsayılanını kullanır.

asset_tickers[]string[] | nullisteğe bağlı
Merchant 5.3.0+. chain_slug ve bu mağaza kapsamındaki BTC, USDC veya PEPE gibi semboller. 1–64 benzersiz sembol; kenar boşlukları temizlenir ve büyük/küçük harf duyarsızdır; 1–40 ASCII harf/rakam/nokta/alt çizgi/tire. Bunu VEYA asset_ids kullan. 5.4.0+'da bilinmeyen/etkin olmayan/kabul edilmeyen semboller yok sayılır. Belirsiz kabul edilen semboller yine hata verir: asset_ids kullan. Seçili etkin yöntemler geçerli cüzdan ve fiyatlandırma gerektirir; geçici zincir üstü tarayıcı kesintileri 6.0.6'dan itibaren oluşturmayı engellemez. Lightning isteğe bağlı olarak yalnızca BTC kabul eder.Ayrıntılar

Merchant 5.3.0+. chain_slug ve bu mağaza kapsamındaki BTC, USDC veya PEPE gibi semboller. 1–64 benzersiz sembol; kenar boşlukları temizlenir ve büyük/küçük harf duyarsızdır; 1–40 ASCII harf/rakam/nokta/alt çizgi/tire. Bunu VEYA asset_ids kullan. 5.4.0+'da bilinmeyen/etkin olmayan/kabul edilmeyen semboller yok sayılır. Belirsiz kabul edilen semboller yine hata verir: asset_ids kullan. Seçili etkin yöntemler geçerli cüzdan ve fiyatlandırma gerektirir; geçici zincir üstü tarayıcı kesintileri 6.0.6'dan itibaren oluşturmayı engellemez. Lightning isteğe bağlı olarak yalnızca BTC kabul eder.

payment_railonchain | lightningisteğe bağlı
Varsayılan onchain. Bitcoin Lightning seçmek için asset_ids olmadan {chain_slug: bitcoin, payment_rail: lightning} kullan; asset_tickers isteğe bağlı [BTC] olabilir. Zincir üstü Bitcoin, Lightning'i içermez. Mağazanın Lightning bağlantısı zaten etkin ve hazır olmalıdır.Ayrıntılar

Varsayılan onchain. Bitcoin Lightning seçmek için asset_ids olmadan {chain_slug: bitcoin, payment_rail: lightning} kullan; asset_tickers isteğe bağlı [BTC] olabilir. Zincir üstü Bitcoin, Lightning'i içermez. Mağazanın Lightning bağlantısı zaten etkin ve hazır olmalıdır.

order_idstring | nullisteğe bağlı

Satıcı sipariş referansı; kenar boşlukları temizlendikten sonra 1–128 karakter; kontrol karakterleri reddedilir.

emailstring | nullisteğe bağlı

Yalnızca satıcıya açık müşteri e-postası; en fazla 254 karakterli pratik ASCII adrese normalleştirilir. Atlanırsa veya null ise e-posta saklanmaz.

descriptionstring | nullisteğe bağlı

Müşteriye görünen açıklama; 1–500 karakter; satır sonları ve sekmeler kabul edilir.

expires_in_secondsinteger | nullisteğe bağlı

Fatura teklif süresi 300 ile 86.400 saniye arası; atlanırsa veya null ise mağaza politikasını devralır.

exchange_rate_spread_percentdecimal string | nullisteğe bağlı
0–100 arası, en fazla iki ondalık basamaklı teklif fiyat marjı. Atlanırsa veya null ise mağaza varsayılanını devralır; "0" bu fatura için kapatır. Yukarı yuvarlamadan önce uygulanır ve sonra kilitlenir. Faturanın itibari para tutarını veya işlem ücreti temelini değiştirmez.Ayrıntılar

0–100 arası, en fazla iki ondalık basamaklı teklif fiyat marjı. Atlanırsa veya null ise mağaza varsayılanını devralır; "0" bu fatura için kapatır. Yukarı yuvarlamadan önce uygulanır ve sonra kilitlenir. Faturanın itibari para tutarını veya işlem ücreti temelini değiştirmez.

underpayment_tolerance_percentdecimal string | nullisteğe bağlı

0–99.99 arası, en fazla iki ondalık basamaklı kabul edilen eksik ödeme oranı. Atlanırsa veya null ise mağaza varsayılanını devralır.

ipn_urlstring | nullisteğe bağlı

En fazla 2.048 bayt, kimlik bilgisi veya fragment içermeyen herkese açık HTTPS geri çağrısı. Mağaza varsayılanını geçersiz kılar; null/atlanması varsayılanı devralır.

redirect_urlstring | nullisteğe bağlı

Ödeme tamamlandıktan sonra kullanılan, en fazla 2.048 bayt ve gömülü kimlik bilgisi içermeyen HTTPS başarı URL'si. Atlanırsa veya null ise mağaza varsayılanını devralır; onu temizleyemez.

cancel_urlstring | nullisteğe bağlı

Ödeme sayfası başarılı ödeme olmadan sona erdiğinde kullanılan HTTPS dönüş URL'si. Atlanırsa veya null ise mağaza varsayılanını devralır; onu temizleyemez.

redirect_automaticallyboolean | nullisteğe bağlı

Atlanırsa veya null ise mağaza politikasını devralır. true, geçerli redirect_url gerektirir.

languagestring | nullisteğe bağlı
Müşteri dili: en, de, es, pt-BR, it, ru, zh-CN, fr, ko veya ja. pt Brezilya Portekizcesi, zh Basitleştirilmiş Çince demektir. de-DE gibi desteklenen bölgesel etiketler listelenen dile normalleştirilir. Atlanırsa veya null ise mağaza dilini devralır. Konsol dili ayrıdır.Ayrıntılar

Müşteri dili: en, de, es, pt-BR, it, ru, zh-CN, fr, ko veya ja. pt Brezilya Portekizcesi, zh Basitleştirilmiş Çince demektir. de-DE gibi desteklenen bölgesel etiketler listelenen dile normalleştirilir. Atlanırsa veya null ise mağaza dilini devralır. Konsol dili ayrıdır.

checkout_appearanceobject | nullisteğe bağlı
Bu fatura için kısmi görünüm ayarları. Atlanması/null mağazanın güncel tasarımını izler. {} dahil bir nesne, çözümlenen tasarımı ve görselleri oluşturma anında sabitler. Aşağıdaki özel ayar şemasına bak; finansal ayar, HTML, CSS, JavaScript veya uzak görsel URL'si yok.Ayrıntılar

Bu fatura için kısmi görünüm ayarları. Atlanması/null mağazanın güncel tasarımını izler. {} dahil bir nesne, çözümlenen tasarımı ve görselleri oluşturma anında sabitler. Aşağıdaki özel ayar şemasına bak; finansal ayar, HTML, CSS, JavaScript veya uzak görsel URL'si yok.

inherit_default_storebooleanisteğe bağlı
true, temel olarak projenin varsayılan mağaza tasarımını seçer; aksi halde hedef mağazanın geçerli tasarımı kullanılır. Özel ayarlar ardından uygulanıp bağımsız kaydedilir; çözümlenmiş fatura işareti false olur.Ayrıntılar

true, temel olarak projenin varsayılan mağaza tasarımını seçer; aksi halde hedef mağazanın geçerli tasarımı kullanılır. Özel ayarlar ardından uygulanıp bağımsız kaydedilir; çözümlenmiş fatura işareti false olur.

titlestringisteğe bağlı

Ödeme sayfası başlığı; en fazla 120 karakter. Boşsa standart başlık kullanılır.

introstringisteğe bağlı
Düz metin; her biri en fazla 2.000 karakter. Giriş her durumda üstte, Çıkış altta görünür. Satır sonları korunur; güvenli metin URL'leri bağlantıya dönüşür. Boş dize temizler. Eski customer_message, intro takma adı olarak kabul edilir; ikisini birlikte gönderme.Ayrıntılar

Düz metin; her biri en fazla 2.000 karakter. Giriş her durumda üstte, Çıkış altta görünür. Satır sonları korunur; güvenli metin URL'leri bağlantıya dönüşür. Boş dize temizler. Eski customer_message, intro takma adı olarak kabul edilir; ikisini birlikte gönderme.

outrostringisteğe bağlı
Düz metin; her biri en fazla 2.000 karakter. Giriş her durumda üstte, Çıkış altta görünür. Satır sonları korunur; güvenli metin URL'leri bağlantıya dönüşür. Boş dize temizler. Eski customer_message, intro takma adı olarak kabul edilir; ikisini birlikte gönderme.Ayrıntılar

Düz metin; her biri en fazla 2.000 karakter. Giriş her durumda üstte, Çıkış altta görünür. Satır sonları korunur; güvenli metin URL'leri bağlantıya dönüşür. Boş dize temizler. Eski customer_message, intro takma adı olarak kabul edilir; ikisini birlikte gönderme.

intro_font_sizeintegeristeğe bağlı

Piksel: 12, 14, 16, 18, 20 veya 24. Farklı devralınmadıkça varsayılan 16.

outro_font_sizeintegeristeğe bağlı

Piksel: 12, 14, 16, 18, 20 veya 24. Farklı devralınmadıkça varsayılan 16.

themesystem | light | dim | darkisteğe bağlı

Müşteri cihazını izle veya sabit tema kullan.

accent_colorstringisteğe bağlı

#RRGGBB. Otomatik renkler için arka plan, kart ve düğme boş olabilir. Metin kontrastı otomatiktir.

background_colorstringisteğe bağlı

#RRGGBB. Otomatik renkler için arka plan, kart ve düğme boş olabilir. Metin kontrastı otomatiktir.

card_colorstringisteğe bağlı

#RRGGBB. Otomatik renkler için arka plan, kart ve düğme boş olabilir. Metin kontrastı otomatiktir.

button_colorstringisteğe bağlı

#RRGGBB. Otomatik renkler için arka plan, kart ve düğme boş olabilir. Metin kontrastı otomatiktir.

logo_sizestringisteğe bağlı

small, medium veya large; left veya center.

logo_alignmentstringisteğe bağlı

small, medium veya large; left veya center.

imagesobjectisteğe bağlı
Anahtarlar: logo_light, logo_dark, favicon. Atlanan anahtar temel görseli korur; null kaldırır. {store_id: UUID, kind?: logo_light|logo_dark|favicon} nesnesi AYNI projedeki o mağazanın geçerli yüklenmiş görselini kullanır. kind varsayılanı hedef anahtardır. Önce Mağaza → Ödeme sayfası bölümünde yükle; Mağaza API kimliğini Temel → API kimlikleri bölümünden kopyala. Eksik görseller veya farklı proje kimlikleri 400 döndürür. Harici URL veya görsel verisi kabul edilmez.Ayrıntılar

Anahtarlar: logo_light, logo_dark, favicon. Atlanan anahtar temel görseli korur; null kaldırır. {store_id: UUID, kind?: logo_light|logo_dark|favicon} nesnesi AYNI projedeki o mağazanın geçerli yüklenmiş görselini kullanır. kind varsayılanı hedef anahtardır. Önce Mağaza → Ödeme sayfası bölümünde yükle; Mağaza API kimliğini Temel → API kimlikleri bölümünden kopyala. Eksik görseller veya farklı proje kimlikleri 400 döndürür. Harici URL veya görsel verisi kabul edilmez.

logo_lightobject | nullisteğe bağlı
store_idUUIDzorunlu
kindlogo_light | logo_dark | faviconisteğe bağlı
logo_darkobject | nullisteğe bağlı
store_idUUIDzorunlu
kindlogo_light | logo_dark | faviconisteğe bağlı
faviconobject | nullisteğe bağlı
store_idUUIDzorunlu
kindlogo_light | logo_dark | faviconisteğe bağlı
show_order_idbooleanisteğe bağlı

Başlığın altında sipariş kimliği ayrıntılarını ve düz metin açıklamayı göster. details_expanded başlangıçta sipariş kimliği ayrıntılarını açar. Yalnızca görünümü etkiler; verileri gizlemez.

show_descriptionbooleanisteğe bağlı

Başlığın altında sipariş kimliği ayrıntılarını ve düz metin açıklamayı göster. details_expanded başlangıçta sipariş kimliği ayrıntılarını açar. Yalnızca görünümü etkiler; verileri gizlemez.

details_expandedbooleanisteğe bağlı

Başlığın altında sipariş kimliği ayrıntılarını ve düz metin açıklamayı göster. details_expanded başlangıçta sipariş kimliği ayrıntılarını açar. Yalnızca görünümü etkiler; verileri gizlemez.

show_project_namebooleanisteğe bağlı
Merchant 5.6.0+: müşteri ödeme sayfası başlığındaki her adı göster veya gizle. İkisi de varsayılan true. Mağaza → Ödeme sayfası bölümünde de bulunur; diğer görünüm ayarları gibi devralınır ve fatura görüntüsüne kaydedilir. Yalnızca görünümü etkiler; verileri gizlemez.Ayrıntılar

Merchant 5.6.0+: müşteri ödeme sayfası başlığındaki her adı göster veya gizle. İkisi de varsayılan true. Mağaza → Ödeme sayfası bölümünde de bulunur; diğer görünüm ayarları gibi devralınır ve fatura görüntüsüne kaydedilir. Yalnızca görünümü etkiler; verileri gizlemez.

show_store_namebooleanisteğe bağlı
Merchant 5.6.0+: müşteri ödeme sayfası başlığındaki her adı göster veya gizle. İkisi de varsayılan true. Mağaza → Ödeme sayfası bölümünde de bulunur; diğer görünüm ayarları gibi devralınır ve fatura görüntüsüne kaydedilir. Yalnızca görünümü etkiler; verileri gizlemez.Ayrıntılar

Merchant 5.6.0+: müşteri ödeme sayfası başlığındaki her adı göster veya gizle. İkisi de varsayılan true. Mağaza → Ödeme sayfası bölümünde de bulunur; diğer görünüm ayarları gibi devralınır ve fatura görüntüsüne kaydedilir. Yalnızca görünümü etkiler; verileri gizlemez.

featured_chains[]string[]isteğe bağlı
Sıralı zincir kısa adları; en fazla 60 benzersiz değer (küçük harf, rakam, tire; en fazla 64 karakter). [] temizler. Yalnızca kullanılabilir fatura yöntemleri yeniden sıralanır.Ayrıntılar

Sıralı zincir kısa adları; en fazla 60 benzersiz değer (küçük harf, rakam, tire; en fazla 64 karakter). [] temizler. Yalnızca kullanılabilir fatura yöntemleri yeniden sıralanır.

featured_asset_ids[]UUID[]isteğe bağlı
En fazla 100 benzersiz sıralı varlık kimliği; [] temizler. Varsayılan varlık null olabilir. Kimlikler payment-intent kimliklerinden değil, payment-assets'ten gelir. Bunlar yöntemleri asla etkinleştirmez; alınan ödemeler ve geçerli müşteri tercihleri önceliklidir.Ayrıntılar

En fazla 100 benzersiz sıralı varlık kimliği; [] temizler. Varsayılan varlık null olabilir. Kimlikler payment-intent kimliklerinden değil, payment-assets'ten gelir. Bunlar yöntemleri asla etkinleştirmez; alınan ödemeler ve geçerli müşteri tercihleri önceliklidir.

default_asset_idUUID|nullisteğe bağlı
En fazla 100 benzersiz sıralı varlık kimliği; [] temizler. Varsayılan varlık null olabilir. Kimlikler payment-intent kimliklerinden değil, payment-assets'ten gelir. Bunlar yöntemleri asla etkinleştirmez; alınan ödemeler ve geçerli müşteri tercihleri önceliklidir.Ayrıntılar

En fazla 100 benzersiz sıralı varlık kimliği; [] temizler. Varsayılan varlık null olabilir. Kimlikler payment-intent kimliklerinden değil, payment-assets'ten gelir. Bunlar yöntemleri asla etkinleştirmez; alınan ödemeler ve geçerli müşteri tercihleri önceliklidir.

messagesobjectisteğe bağlı
en, de, es, pt-BR, it, ru, zh-CN, fr, ko veya ja anahtarlı dil nesneleri; waiting, confirming, paid, underpaid, expired düz dizeleri içerir (her biri 500 karakter). Yalnızca gönderilen diller/durumlar değişir; {} tüm mesajları, {en:{}} İngilizceyi, boş durum dizesi o durumu temizler. Yedek dil İngilizcedir. Gerçek durumun yerini almaz.Ayrıntılar

en, de, es, pt-BR, it, ru, zh-CN, fr, ko veya ja anahtarlı dil nesneleri; waiting, confirming, paid, underpaid, expired düz dizeleri içerir (her biri 500 karakter). Yalnızca gönderilen diller/durumlar değişir; {} tüm mesajları, {en:{}} İngilizceyi, boş durum dizesi o durumu temizler. Yedek dil İngilizcedir. Gerçek durumun yerini almaz.

enobjectisteğe bağlı
waitingstringisteğe bağlı
confirmingstringisteğe bağlı
paidstringisteğe bağlı
underpaidstringisteğe bağlı
expiredstringisteğe bağlı
deobjectisteğe bağlı
waitingstringisteğe bağlı
confirmingstringisteğe bağlı
paidstringisteğe bağlı
underpaidstringisteğe bağlı
expiredstringisteğe bağlı
esobjectisteğe bağlı
waitingstringisteğe bağlı
confirmingstringisteğe bağlı
paidstringisteğe bağlı
underpaidstringisteğe bağlı
expiredstringisteğe bağlı
pt-BRobjectisteğe bağlı
waitingstringisteğe bağlı
confirmingstringisteğe bağlı
paidstringisteğe bağlı
underpaidstringisteğe bağlı
expiredstringisteğe bağlı
itobjectisteğe bağlı
waitingstringisteğe bağlı
confirmingstringisteğe bağlı
paidstringisteğe bağlı
underpaidstringisteğe bağlı
expiredstringisteğe bağlı
ruobjectisteğe bağlı
waitingstringisteğe bağlı
confirmingstringisteğe bağlı
paidstringisteğe bağlı
underpaidstringisteğe bağlı
expiredstringisteğe bağlı
zh-CNobjectisteğe bağlı
waitingstringisteğe bağlı
confirmingstringisteğe bağlı
paidstringisteğe bağlı
underpaidstringisteğe bağlı
expiredstringisteğe bağlı
frobjectisteğe bağlı
waitingstringisteğe bağlı
confirmingstringisteğe bağlı
paidstringisteğe bağlı
underpaidstringisteğe bağlı
expiredstringisteğe bağlı
koobjectisteğe bağlı
waitingstringisteğe bağlı
confirmingstringisteğe bağlı
paidstringisteğe bağlı
underpaidstringisteğe bağlı
expiredstringisteğe bağlı
jaobjectisteğe bağlı
waitingstringisteğe bağlı
confirmingstringisteğe bağlı
paidstringisteğe bağlı
underpaidstringisteğe bağlı
expiredstringisteğe bağlı
support_emailstringisteğe bağlı

ASCII e-posta; en fazla 254 karakter. Boşsa temizler.

support_urlstringisteğe bağlı

Kimlik bilgisi içermeyen en fazla 2.048 karakterli HTTPS URL'leri. Boşsa temizler. Bağlantılar yeni pencerede açılır.

terms_urlstringisteğe bağlı

Kimlik bilgisi içermeyen en fazla 2.048 karakterli HTTPS URL'leri. Boşsa temizler. Bağlantılar yeni pencerede açılır.

privacy_urlstringisteğe bağlı

Kimlik bilgisi içermeyen en fazla 2.048 karakterli HTTPS URL'leri. Boşsa temizler. Bağlantılar yeni pencerede açılır.

return_button_textstringisteğe bağlı

Etiket en fazla 60 karakter. Fatura davranışı için üst düzey redirect_url/cancel_url/redirect_automatically/language kullan.

show_return_buttonbooleanisteğe bağlı
Son durumlar dahil ödeme sayfasında elle kullanılan Satıcıya dön/iptal düğmesini göster. Mağaza görünümünü devralmak için atla (varsayılan true); false gizler. Faturayı iptal etmez, JSON'daki URL'leri gizlemez veya otomatik başarı yönlendirmelerini kapatmaz. Gerekirse üst düzey redirect_automatically değerini ayrıca false yap. Merchant 8.1.4 veya yenisini gerektirir.Ayrıntılar

Son durumlar dahil ödeme sayfasında elle kullanılan Satıcıya dön/iptal düğmesini göster. Mağaza görünümünü devralmak için atla (varsayılan true); false gizler. Faturayı iptal etmez, JSON'daki URL'leri gizlemez veya otomatik başarı yönlendirmelerini kapatmaz. Gerekirse üst düzey redirect_automatically değerini ayrıca false yap. Merchant 8.1.4 veya yenisini gerektirir.

metadataobject | nullisteğe bağlı
Yalnızca satıcıya açık JSON nesnesi; atlanması veya null, {} olur; en fazla 4.096 kodlanmış bayt ve beş iç içe düzey. firstname, lastname, street, street2, zip, city, country, countryiso2, company ve vatid doğrulanır, normalleştirilir ve müşteri özeti alanlarına aktarılır.Ayrıntılar

Yalnızca satıcıya açık JSON nesnesi; atlanması veya null, {} olur; en fazla 4.096 kodlanmış bayt ve beş iç içe düzey. firstname, lastname, street, street2, zip, city, country, countryiso2, company ve vatid doğrulanır, normalleştirilir ve müşteri özeti alanlarına aktarılır.

firstnamestringisteğe bağlı
lastnamestringisteğe bağlı
streetstringisteğe bağlı
street2stringisteğe bağlı
zipstringisteğe bağlı
citystringisteğe bağlı
countrystringisteğe bağlı
countryiso2stringisteğe bağlı
companystringisteğe bağlı
vatidstringisteğe bağlı
cart_idstring

Yanıt 201 new invoice; 200 exact idempotent replay

Örnek yanıt
{
  "data": {
    "id": "2f798f9f-01f2-42f0-9d10-5581d6116b4c",
    "invoice_id": "0a6a98db-d93d-48ee-8c3c-fd45f90c4a50",
    "project_id": "11111111-1111-4111-8111-111111111111",
    "store_id": "22222222-2222-4222-8222-222222222222",
    "source": "api",
    "order_id": "order-1042",
    "email": "ada@example.com",
    "customer_name": "Ada Lovelace · Example GmbH",
    "customer_address": "Example GmbH · 12 Example Street · Suite 2 · 10115 Berlin · Germany (DE) · VAT DE123456789",
    "description": "Annual plan",
    "amount": "49.9",
    "currency": "USD",
    "exchange_rate_spread_percent": "0.5",
    "underpayment_tolerance_percent": "1",
    "status": "new",
    "amount_status": "none",
    "timing_status": "on_time",
    "resolution": "automatic",
    "sequence": 1,
    "winning_payment_intent_id": null,
    "expires_at": "2026-08-31T18:15:00Z",
    "monitoring_expires_at": "2026-09-07T18:15:00Z",
    "settled_at": null,
    "cancelled_at": null,
    "archived_at": null,
    "created_at": "2026-08-31T18:00:00Z",
    "updated_at": "2026-08-31T18:00:00Z",
    "ipn_url": "https://merchant.example/wholly/ipn",
    "redirect_url": "https://merchant.example/orders/1042",
    "cancel_url": "https://merchant.example/cart",
    "redirect_automatically": true,
    "checkout_language": "en",
    "metadata": { "cart_id": "cart-681", "firstname": "Ada", "lastname": "Lovelace", "street": "12 Example Street", "street2": "Suite 2", "zip": "10115", "city": "Berlin", "country": "Germany", "countryiso2": "DE", "company": "Example GmbH", "vatid": "DE123456789" },
    "payment_intents": [
      {
        "id": "33333333-3333-4333-8333-333333333333",
        "asset_id": "10000000-0000-4000-8000-000000000001",
        "asset_key": "bip122:000000000019d6689c085ae165831e93/slip44:0",
        "chain_slug": "bitcoin",
        "network": "mainnet",
        "caip_network_id": "bip122:000000000019d6689c085ae165831e93",
        "caip_asset_id": "bip122:000000000019d6689c085ae165831e93/slip44:0",
        "symbol": "BTC",
        "asset_decimals": 8,
        "status": "pending",
        "finality_mode": "confirmations",
        "required_confirmations": 1,
        "quote_rate": "0.000009218",
        "quote_details": null,
        "expected_amount": "0.00046",
        "expected_amount_atomic": "46000",
        "minimum_payment_amount": "0.0004554",
        "minimum_payment_amount_atomic": "45540",
        "received_amount": "0",
        "received_amount_atomic": "0",
        "confirmed_amount": "0",
        "confirmed_amount_atomic": "0",
        "destination_address": "bc1q…example",
        "destination_tag": null,
        "derivation_index": 42,
        "quote_expires_at": "2026-08-31T18:15:00Z",
        "monitoring_expires_at": "2026-09-07T18:15:00Z",
        "next_check_at": "2026-08-31T18:00:00Z",
        "last_checked_at": null,
        "last_chain_height": null,
        "last_anchor_hash": null,
        "last_monitor_error": null,
        "first_payment_at": null,
        "fully_paid_at": null,
        "finalized_at": null
      }
    ]
  },
  "links": {
    "checkout": "https://pay.example.com/invoice/0a6a98db-d93d-48ee-8c3c-fd45f90c4a50"
  }
}

Yanıt alanları

dataobject
idUUIDher zaman

Dahili fatura UUID'si. Satıcı ayrıntısı veya ödeme sayfası yollarında kullanma.

invoice_idUUIDher zaman

Satıcı ayrıntısı ve ödeme sayfası yollarında kullanılan herkese açık fatura UUID'si.

project_idUUIDher zaman

Sahibi olan proje.

store_idUUIDher zaman

Sahibi olan mağaza.

sourcemanual | apiher zaman

Faturanın nasıl oluşturulduğu.

order_idstring | nullher zaman

Satıcı sipariş referansı.

emailstring | nullher zaman

Yalnızca satıcıya açık müşteri e-postası. Herkese açık ödeme sayfası asla döndürmez.

customer_namestring | nullher zaman

Özel firstname, lastname ve company meta verilerinden türetilen görünen ad.

customer_addressstring | nullher zaman

Özel company, street, street2, zip, city, country, countryiso2 ve vatid meta verilerinden türetilen tek satırlık satıcı adresi.

descriptionstring | nullher zaman

Müşteriye görünen açıklama.

amountdecimal stringher zaman

Kanonik fatura tutarı.

currencystringher zaman

Normalleştirilmiş fatura para birimi/varlık kodu.

exchange_rate_spread_percentdecimal stringher zaman

Kilitlenmiş teklif fiyat marjı: oluşturmadaki özel değer veya atlandığında mağaza varsayılanı. Yukarı yuvarlamadan önce uygulanır; bu faturada asla değişmez.

underpayment_tolerance_percentdecimal stringher zaman

Fatura oluşturulurken görüntüsü alınmış, değiştirilemez kabul edilen eksik ödeme yüzdesi.

statusinvoice statusher zaman

new, processing, settled, expired, invalid veya cancelled.

amount_statusamount statusher zaman

none, partial, paid veya overpaid. Açıkça izin verilen sıfır tutarlı fatura none ile ve ödeme yöntemi olmadan tamamlanır.

timing_statustiming statusher zaman

on_time veya late.

resolutionresolutionher zaman

automatic, manually_settled veya manually_invalidated.

sequenceintegerher zaman

1'den başlayan, tek yönlü artan fatura durumu sıra numarası.

winning_payment_intent_idUUID | nullher zaman

Seçildiğinde faturayı sonuçlandıran ödeme yöntemi.

expires_atRFC 3339 timestampher zaman

Teklif/ödeme son tarihi.

monitoring_expires_atRFC 3339 timestampher zaman

Ödeme yöntemleri genelinde yapılandırılmış en geç geç ödeme izleme bitişi.

settled_attimestamp | nullher zaman

Ödeme tamamlandıysa tamamlanma zamanı.

cancelled_attimestamp | nullher zaman

İptal edildiyse iptal zamanı.

archived_attimestamp | nullher zaman

Arşivlendiyse arşivleme zamanı.

created_atRFC 3339 timestampher zaman

Oluşturulma zamanı.

updated_atRFC 3339 timestampher zaman

Son durum güncelleme zamanı.

ipn_urlstring | nullher zaman

Faturaya özel geçerli IPN hedefi. Yalnızca satıcı yanıtında bulunur; herkese açık ödeme sayfasından çıkarılır.

redirect_urlstring | nullher zaman

Tamamlanmadan sonra kullanılan geçerli başarı URL'si.

cancel_urlstring | nullher zaman

Ödeme sayfası başarılı ödeme olmadan sona erdiğinde kullanılan geçerli dönüş URL'si.

redirect_automaticallybooleanher zaman

Ödeme sayfasının başarıdan sonra otomatik yönlenip yönlenmeyeceği.

checkout_languagestringher zaman

Geçerli ödeme sayfası dil etiketi.

metadataobjecther zaman
Satıcı meta verileri. Herkese açık ödeme sayfası asla döndürmez. Konsol ödeme araçları payment_tool köken bilgisini ekler (id, kind, title, pricing, requested_amount, request_id); bu ödeme kanıtı değildir. Geri çağrıları doğrula ve invoice.settled için invoice_id başına bir kez siparişi yerine getir.Ayrıntılar

Satıcı meta verileri. Herkese açık ödeme sayfası asla döndürmez. Konsol ödeme araçları payment_tool köken bilgisini ekler (id, kind, title, pricing, requested_amount, request_id); bu ödeme kanıtı değildir. Geri çağrıları doğrula ve invoice.settled için invoice_id başına bir kez siparişi yerine getir.

cart_idstring
firstnamestring
lastnamestring
streetstring
street2string
zipstring
citystring
countrystring
countryiso2string
companystring
vatidstring
payment_intents[]object[]her zaman

Teklif verilen ödeme yöntemleri ve izleme durumu.

idUUIDher zaman

Ödeme isteği tanımlayıcısı; ödeme sayfası QR intent_id olarak da kullanılır.

payment_railonchain | lightningher zaman
Fatura aktarım türü. Zincir üstü Bitcoin ve Lightning aynı asset_id paylaşabilir; yalnızca sembol yerine isteğin id değerini ve bu alanı kullan. Bu, varlık kataloğundaki tarayıcı payment_rail alanından farklıdır.Ayrıntılar

Fatura aktarım türü. Zincir üstü Bitcoin ve Lightning aynı asset_id paylaşabilir; yalnızca sembol yerine isteğin id değerini ve bu alanı kullan. Bu, varlık kataloğundaki tarayıcı payment_rail alanından farklıdır.

bolt11string | nullher zaman

Lightning ödeme isteği; diğer durumlarda null. Bunu Lightning cüzdanıyla öde; ödeme hash'ine asla zincir üstü fon gönderme.

asset_idUUIDher zaman

Yapılandırılmış ödeme varlığı tanımlayıcısı.

asset_keystringher zaman

Kanonik CAIP biçimli varlık anahtarı.

chain_slugstringher zaman

Wholly Crypto zincir tanımlayıcısı.

networkstringher zaman

Yapılandırılmış ağ; desteklenen ödeme varlıkları için şu anda mainnet.

caip_network_idstringher zaman

Kanonik CAIP-2 ağ tanımlayıcısı.

caip_asset_idstring | nullher zaman

Kayıtlı olduğu yerlerde kanonik CAIP-19 tanımlayıcısı.

symbolstringher zaman

Varlık sembolü.

asset_decimalsintegerher zaman

Atomik birim hassasiyeti. Lightning BTC, zincir üstü Bitcoin'in 8 basamağı yerine 11 (millisatoshi) kullanır. Teklifler tam satoshi'dir; tahsilatlar millisatoshi hassasiyetini korur.

statusintent statusher zaman

pending, partial, paid, overpaid, expired veya invalid.

finality_modeconfirmations | finalizedher zaman

Kesinlik politikası.

required_confirmationsintegerher zaman

Uygulanabilir olduğunda gereken onay sayısı.

quote_ratedecimal stringher zaman

Kilitlenmiş fiyat marjı dahil, bir fatura para birimi başına varlık birimi. Örneğin USD başına 1.02 USDC. Ters kur değildir.

quote_detailsobject | nullher zaman
Kilitlenmiş teklif kökeni: fiyat marjı öncesi reference_rate, unrounded_payment_amount, rounding_adjustment, pricing_provider, asset_provider, pricing_fetched_at ve asset_fetched_at. Eski faturalarda null; geçmiş değerler uydurulmaz.Ayrıntılar

Kilitlenmiş teklif kökeni: fiyat marjı öncesi reference_rate, unrounded_payment_amount, rounding_adjustment, pricing_provider, asset_provider, pricing_fetched_at ve asset_fetched_at. Eski faturalarda null; geçmiş değerler uydurulmaz.

expected_amountdecimal stringher zaman
Fiyat marjı ve yukarı yuvarlamadan sonra ödenecek tam kilitli varlık tutarı. 4.1.1'den itibaren tanınan ve doğrulanmış itibari para stablecoin'leri (USDC, USDT, DAI, USDS, EURC gibi) en fazla iki ondalık basamağa yukarı yuvarlanır; 1.321, 1.33 olur, asla 1.32 olmaz. Tolerans sıfır olsa bile beklenen tutar budur. Diğer varlıklar uyarlanabilir hassasiyetini korur. Mevcut faturalar asla yeniden fiyatlandırılmaz.Ayrıntılar

Fiyat marjı ve yukarı yuvarlamadan sonra ödenecek tam kilitli varlık tutarı. 4.1.1'den itibaren tanınan ve doğrulanmış itibari para stablecoin'leri (USDC, USDT, DAI, USDS, EURC gibi) en fazla iki ondalık basamağa yukarı yuvarlanır; 1.321, 1.33 olur, asla 1.32 olmaz. Tolerans sıfır olsa bile beklenen tutar budur. Diğer varlıklar uyarlanabilir hassasiyetini korur. Mevcut faturalar asla yeniden fiyatlandırılmaz.

expected_amount_atomicinteger stringher zaman

Varlığın en küçük biriminde tam tutar.

minimum_payment_amountdecimal stringher zaman

Fatura toleransı uygulandıktan sonra ödendi olarak kabul edilen en küçük tutar.

minimum_payment_amount_atomicinteger stringher zaman

Varlığın en küçük biriminde tam kabul eşiği.

received_amountdecimal stringher zaman

Gözlenen tutar.

received_amount_atomicinteger stringher zaman

Gözlenen atomik tutar.

confirmed_amountdecimal stringher zaman

Onaylanmış/kesinleşmiş tutar.

confirmed_amount_atomicinteger stringher zaman

Onaylanmış/kesinleşmiş atomik tutar.

destination_addressstringher zaman

Zincir üstü ödeme alma adresi veya Lightning için 64 karakterlik ödeme hash'i. Lightning ödemek için bolt11 kullan; hash'i Bitcoin adresi değildir.

destination_tagstring | nullher zaman

Ödeme altyapısı gerektiriyorsa zorunlu herkese açık ödeme referansı: XRP destination tag, Stellar memo ID veya TON fatura açıklaması. Benzersiz adresli altyapılarda null.

derivation_indexintegerher zaman

Ayrılmış cüzdan alt adres indeksi; yalnızca satıcı ayrıntısında.

quote_expires_atRFC 3339 timestampher zaman

Teklifin sona erme zamanı.

monitoring_expires_atRFC 3339 timestampher zaman

Bu yöntem için geç ödeme izlemesinin bitişi.

next_check_attimestamp | nullher zaman

Sonraki zamanlanmış zincir kontrolü.

last_checked_attimestamp | nullher zaman

Son zincir kontrolü.

last_chain_heightinteger | nullher zaman

İzleyicinin gözlediği son güvenilir yükseklik.

last_anchor_hashstring | nullher zaman

Son izleme referansı/blok hash'i.

last_monitor_errorstring | nullher zaman

Operatörler için güvenli izleme teşhisi.

first_payment_attimestamp | nullher zaman

Ödemenin ilk gözlendiği zaman.

fully_paid_attimestamp | nullher zaman

Kabul edilen asgari tutara ilk ulaşılan zaman.

finalized_attimestamp | nullher zaman

Ödemenin kesinlik politikasını karşıladığı zaman.

Kullanım notları
  • payment_methods yalnızca bu fatura için mağazada etkin yöntemleri filtreler. Atlanması/null tüm mağaza yöntemlerini korur; [] geçersizdir. Küçük chain_slug ipucunu ve görünen varlık sembollerini Proje → Mağazalar → Ödeme yöntemleri bölümünde bul. API payment-assets listesi chain_slug, asset.symbol ve asset.id sağlar. Kabul edilen Ethereum token'ları için {chain_slug: ethereum, asset_tickers: [USDC, USDT]} kullan; BTC ve PEPE seçilen zincirlerinde aynı şekilde çalışır. Semboller büyük/küçük harf duyarsız, zincir kapsamlıdır ve yalnızca mağaza içinde çözümlenir. Aynı sembollü kabul edilen iki sözleşme varsa, biri hazır olmasa bile birini seçmek yerine 400 döner; bu durumda asset_ids kullan. Yerel varlıklar, katalog token'ları ve özel token'lar aynı kurallara uyar. Her zincir/altyapı bir kez bulunabilir; sonuçta en fazla 64 yöntem olabilir. Merchant 5.4.0+: bilinmeyen, devre dışı, yanlış zincirli veya kabul edilmeyen seçimler yok sayılır. Tüm seçimde etkin kabul edilen eşleşme yoksa mağaza varsayılanları uygulanır; aksi halde yalnızca eşleşen seçimler kullanılır. Yalnızca zincir içeren girdi, etkin kabul edilen tüm zincir üstü varlıkları kapsar. Etkin seçili yöntemler geçerli cüzdan, kurulu tarayıcı adaptörü ve güvenilir kur gerektirir. 6.0.6'dan itibaren kullanılamayan tarayıcılar, bekleme süreleri ve bekleyen/eski sağlık kontrolleri fatura oluşturmayı engellemez veya yapılandırılmış zincir üstü yöntemleri kaldırmaz. Tespit otomatik yeniden dener; tamamlanma yine sağlayıcı yeter sayısı ve onay gerektirir. receive_readiness izle ve sağlayıcıları kullanılabilir tut: tarayıcılar düzelene kadar fatura doğrulanmadan kalabilir. Monero alt adres ayırma ve Lightning BOLT11 üretimi yine harici cüzdan/düğüm hizmetlerini gerektirir. Hatalar error.message ve error.details.payment_methods içinde chain_slug, asset_ticker, reason_code; tarayıcı teşhisinde ayrıca required_endpoint_role, healthy_endpoints ve required_independent_providers döndürür. TRON indekslenmiş geçmişi veya desteklenen ham solidified yerel blok API'lerini kabul eder; temel sağlık tek başına tarayıcı uyumluluğunu kanıtlamaz. Fiyatlandırma hataları varlığı/para birimini belirtir. Hiçbir şey kabul edilmeyen varlığı etkinleştirmez veya mağaza politikasını değiştirmez. 5.4.0 öncesi satıcı sürümlerinde bilinmeyen/etkin olmayan açık seçimler bunun yerine hata verir. Mağaza ayarları değiştiğinde mevcut fatura yöntemleri asla genişlemez. Lightning ayrı seçilmelidir. Tekrarlar ilk yöntemleri korur; aynı Idempotency-Key ile seçimleri değiştirmek 409 döndürür.
  • checkout_appearance yukarıda listelenen tüm sunum ayarlarını destekler. Atlanan alanlar devralır, diziler değiştirir, iç içe mesaj alanları birleştirilir; boş mesaj nesnesi o kapsamı temizler. Çözümlenen tasarım ve görseller mağazayı düzenlemeden bu fatura için kaydedilir. Sonucu incelemek için herkese açık ödeme sayfası JSON'undan appearance oku. Tüm istek 32 KiB, çözümlenen ayarlar 20 KiB ile sınırlıdır.
  • Aynı Idempotency-Key ile checkout_appearance değiştirmek 409 döndürür; birebir aynı ham baytlarla yeniden dene. Görünüm tutarları, kurları, kabul edilen varlıkları, onay gereksinimlerini, gerçek durumu veya gömme izinlerini değiştirmez. HTML, CSS, betik veya uzak görsel alma yoktur.
  • exchange_rate_spread_percent bu fatura için mağaza varsayılanını değiştirir: devralmak için atla veya null gönder; kapatmak için "0" gönder. Mevcut fatura teklifleri asla değişmez.
  • Fiyat marjı yukarı yuvarlamadan önce uygulanır. Ücretlerin temeli, fiyat marjı hariç faturanın ilk itibari para tutarı olarak kalır.
  • Her zaman döndürülen expected_amount veya expected_amount_atomic değerini gönder. Yuvarlama yukarı yönlüdür; varlık hassasiyeti, tutarın %0.1'i ve itibari paranın bir alt birimiyle sınırlıdır.
  • Yeniden denemeler aynı kimlik bilgisini, Idempotency-Key ve tam gövde baytlarını korumalıdır. Aynı anahtarla fiyat marjını değiştirmek 409 idempotency_conflict döndürür.
  • Tam tekrar kontrolü yeni teklif, geri çağrı DNS'i veya adres hazırlığından önce yapılır. Kimlik bilgisi kapsamı ve proje/mağaza yetkilendirmesi yine her istekte kontrol edilir.
  • Geçerli ipn_url mağaza IPN imzalama sırrını gerektirir. Bilinmeyen gövde alanları reddedilir.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETFaturaları listele/v1/projects/{project_id}/invoicesSalt okunur

Yalnızca satıcıya açık e-posta ve tanınan meta verilerden türetilmiş müşteri alanları dahil, kapsamlı fatura özetlerinin yeniden eskiye sıralı kompakt sayfasını döndürür. Arama, durum ve mağaza filtreleri sunucu tarafında değerlendirilir; öngörülebilir sayfalama için yanıt total ve has_more içerir.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MERCHANT_API_TOKEN
Acceptönerilenapplication/json

Yol parametreleri

project_idUUIDzorunlu

Kimlik bilgisine atanmış etkin proje.

Sorgu parametreleri

store_idUUID

İsteğe bağlı tam mağaza filtresi.

statusenum

İsteğe bağlı new, processing, settled, expired, invalid veya cancelled.

limitinteger

İsteğe bağlı 1–100; varsayılan 50.

offsetinteger

İsteğe bağlı 0–1.000.000; varsayılan 0.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/projects/YOUR_PROJECT_ID/invoices?search=order-1042&status=processing&limit=50&offset=0" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Accept: application/json'

Yanıt 200 application/json

Örnek yanıt
{
  "data": [
    {
      "id": "2f798f9f-01f2-42f0-9d10-5581d6116b4c",
      "invoice_id": "0a6a98db-d93d-48ee-8c3c-fd45f90c4a50",
      "project_id": "11111111-1111-4111-8111-111111111111",
      "store_id": "22222222-2222-4222-8222-222222222222",
      "source": "api",
      "order_id": "order-1042",
      "email": "ada@example.com",
      "customer_name": "Ada Lovelace · Example GmbH",
      "customer_address": "Example GmbH · 12 Example Street · Suite 2 · 10115 Berlin · Germany (DE) · VAT DE123456789",
      "description": "Annual plan",
      "amount": "49.9",
      "currency": "USD",
      "exchange_rate_spread_percent": "0.5",
      "underpayment_tolerance_percent": "1",
      "status": "processing",
      "amount_status": "paid",
      "timing_status": "on_time",
      "resolution": "automatic",
      "sequence": 3,
      "winning_payment_intent_id": "33333333-3333-4333-8333-333333333333",
      "expires_at": "2026-08-31T18:15:00Z",
      "monitoring_expires_at": "2026-09-07T18:15:00Z",
      "settled_at": null,
      "cancelled_at": null,
      "archived_at": null,
      "created_at": "2026-08-31T18:00:00Z",
      "updated_at": "2026-08-31T18:04:10Z"
    }
  ],
  "pagination": {
    "limit": 50,
    "offset": 0,
    "total": 143,
    "has_more": true
  }
}

Yanıt alanları

data[]object[]
idUUIDher zaman

Dahili fatura UUID'si. Satıcı ayrıntısı veya ödeme sayfası yollarında kullanma.

invoice_idUUIDher zaman

Satıcı ayrıntısı ve ödeme sayfası yollarında kullanılan herkese açık fatura UUID'si.

project_idUUIDher zaman

Sahibi olan proje.

store_idUUIDher zaman

Sahibi olan mağaza.

sourcemanual | apiher zaman

Faturanın nasıl oluşturulduğu.

order_idstring | nullher zaman

Satıcı sipariş referansı.

emailstring | nullher zaman

Yalnızca satıcıya açık müşteri e-postası. Herkese açık ödeme sayfası asla döndürmez.

customer_namestring | nullher zaman

Özel firstname, lastname ve company meta verilerinden türetilen görünen ad.

customer_addressstring | nullher zaman

Özel company, street, street2, zip, city, country, countryiso2 ve vatid meta verilerinden türetilen tek satırlık satıcı adresi.

descriptionstring | nullher zaman

Müşteriye görünen açıklama.

amountdecimal stringher zaman

Kanonik fatura tutarı.

currencystringher zaman

Normalleştirilmiş fatura para birimi/varlık kodu.

exchange_rate_spread_percentdecimal stringher zaman

Kilitlenmiş teklif fiyat marjı: oluşturmadaki özel değer veya atlandığında mağaza varsayılanı. Yukarı yuvarlamadan önce uygulanır; bu faturada asla değişmez.

underpayment_tolerance_percentdecimal stringher zaman

Fatura oluşturulurken görüntüsü alınmış, değiştirilemez kabul edilen eksik ödeme yüzdesi.

statusinvoice statusher zaman

new, processing, settled, expired, invalid veya cancelled.

amount_statusamount statusher zaman

none, partial, paid veya overpaid. Açıkça izin verilen sıfır tutarlı fatura none ile ve ödeme yöntemi olmadan tamamlanır.

timing_statustiming statusher zaman

on_time veya late.

resolutionresolutionher zaman

automatic, manually_settled veya manually_invalidated.

sequenceintegerher zaman

1'den başlayan, tek yönlü artan fatura durumu sıra numarası.

winning_payment_intent_idUUID | nullher zaman

Seçildiğinde faturayı sonuçlandıran ödeme yöntemi.

expires_atRFC 3339 timestampher zaman

Teklif/ödeme son tarihi.

monitoring_expires_atRFC 3339 timestampher zaman

Ödeme yöntemleri genelinde yapılandırılmış en geç geç ödeme izleme bitişi.

settled_attimestamp | nullher zaman

Ödeme tamamlandıysa tamamlanma zamanı.

cancelled_attimestamp | nullher zaman

İptal edildiyse iptal zamanı.

archived_attimestamp | nullher zaman

Arşivlendiyse arşivleme zamanı.

created_atRFC 3339 timestampher zaman

Oluşturulma zamanı.

updated_atRFC 3339 timestampher zaman

Son durum güncelleme zamanı.

paginationobject
limitintegerher zaman

Geçerli sayfa boyutu; 1–100.

offsetintegerher zaman

Sıfır tabanlı geçerli satır ofseti; 0–1.000.000.

totalintegerher zaman

Sayfa görüntüsünde proje, mağaza, durum ve arama filtreleriyle eşleşen toplam satır.

has_morebooleanher zaman

offset ile döndürülen satır sayısının toplamı total değerinden küçükse true.

Kullanım notları
  • Önce created_at azalan, ardından dahili id azalan sırayla.
  • Liste öğeleri InvoiceSummary nesneleridir; email, customer_name ve customer_address yalnızca satıcıya açıktır. Ham meta veri ve ödeme istekleri için ayrıntıyı çağır.
  • Yalnızca has_more true ise sonraki sayfa için offset değerini pagination.offset + pagination.limit yap.
  • Sayı ve sayfa tek repeatable-read veritabanı görüntüsünden okunur; eş zamanlı yazmalar sonraki istekte görünür.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETFaturayı getir/v1/projects/{project_id}/invoices/{invoice_id}Salt okunur

Tam satıcı fatura ayrıntısını ve güncel etkin ödeme sayfası URL'sini döndürür. Sorgulama ve mutabakat için bu rotayı kullan.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MERCHANT_API_TOKEN
Acceptönerilenapplication/json

Yol parametreleri

project_idUUIDzorunlu

Kimlik bilgisine atanmış etkin proje.

invoice_idUUIDzorunlu

Dahili id değil, oluşturma/listeleme sırasında döndürülen invoice_id.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/projects/YOUR_PROJECT_ID/invoices/YOUR_PUBLIC_INVOICE_ID" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Accept: application/json'

Yanıt 200 application/json

Örnek yanıt
{
  "data": {
    "id": "2f798f9f-01f2-42f0-9d10-5581d6116b4c",
    "invoice_id": "0a6a98db-d93d-48ee-8c3c-fd45f90c4a50",
    "project_id": "11111111-1111-4111-8111-111111111111",
    "store_id": "22222222-2222-4222-8222-222222222222",
    "source": "api",
    "order_id": "order-1042",
    "email": "ada@example.com",
    "customer_name": "Ada Lovelace · Example GmbH",
    "customer_address": "Example GmbH · 12 Example Street · Suite 2 · 10115 Berlin · Germany (DE) · VAT DE123456789",
    "description": "Annual plan",
    "amount": "49.9",
    "currency": "USD",
    "exchange_rate_spread_percent": "0.5",
    "underpayment_tolerance_percent": "1",
    "status": "settled",
    "amount_status": "paid",
    "timing_status": "on_time",
    "resolution": "automatic",
    "sequence": 4,
    "winning_payment_intent_id": "33333333-3333-4333-8333-333333333333",
    "expires_at": "2026-08-31T18:15:00Z",
    "monitoring_expires_at": "2026-09-07T18:15:00Z",
    "settled_at": "2026-08-31T18:05:00Z",
    "cancelled_at": null,
    "archived_at": null,
    "created_at": "2026-08-31T18:00:00Z",
    "updated_at": "2026-08-31T18:05:00Z",
    "ipn_url": "https://merchant.example/wholly/ipn",
    "redirect_url": "https://merchant.example/orders/1042",
    "cancel_url": "https://merchant.example/cart",
    "redirect_automatically": true,
    "checkout_language": "en",
    "metadata": { "cart_id": "cart-681", "firstname": "Ada", "lastname": "Lovelace", "street": "12 Example Street", "street2": "Suite 2", "zip": "10115", "city": "Berlin", "country": "Germany", "countryiso2": "DE", "company": "Example GmbH", "vatid": "DE123456789" },
    "payment_intents": [
      {
        "id": "33333333-3333-4333-8333-333333333333",
        "asset_id": "10000000-0000-4000-8000-000000000001",
        "asset_key": "bip122:000000000019d6689c085ae165831e93/slip44:0",
        "chain_slug": "bitcoin",
        "network": "mainnet",
        "caip_network_id": "bip122:000000000019d6689c085ae165831e93",
        "caip_asset_id": "bip122:000000000019d6689c085ae165831e93/slip44:0",
        "symbol": "BTC",
        "asset_decimals": 8,
        "status": "paid",
        "finality_mode": "confirmations",
        "required_confirmations": 1,
        "quote_rate": "0.000009218",
        "quote_details": null,
        "expected_amount": "0.00046",
        "expected_amount_atomic": "46000",
        "minimum_payment_amount": "0.0004554",
        "minimum_payment_amount_atomic": "45540",
        "received_amount": "0.0004554",
        "received_amount_atomic": "45540",
        "confirmed_amount": "0.0004554",
        "confirmed_amount_atomic": "45540",
        "destination_address": "bc1q…example",
        "destination_tag": null,
        "derivation_index": 42,
        "quote_expires_at": "2026-08-31T18:15:00Z",
        "monitoring_expires_at": "2026-09-07T18:15:00Z",
        "next_check_at": null,
        "last_checked_at": "2026-08-31T18:05:00Z",
        "last_chain_height": 912345,
        "last_anchor_hash": "000000000000000000example",
        "last_monitor_error": null,
        "first_payment_at": "2026-08-31T18:03:00Z",
        "fully_paid_at": "2026-08-31T18:03:00Z",
        "finalized_at": "2026-08-31T18:05:00Z"
      }
    ]
  },
  "links": {
    "checkout": "https://pay.example.com/invoice/0a6a98db-d93d-48ee-8c3c-fd45f90c4a50"
  }
}

Yanıt alanları

dataobject
idUUIDher zaman

Dahili fatura UUID'si. Satıcı ayrıntısı veya ödeme sayfası yollarında kullanma.

invoice_idUUIDher zaman

Satıcı ayrıntısı ve ödeme sayfası yollarında kullanılan herkese açık fatura UUID'si.

project_idUUIDher zaman

Sahibi olan proje.

store_idUUIDher zaman

Sahibi olan mağaza.

sourcemanual | apiher zaman

Faturanın nasıl oluşturulduğu.

order_idstring | nullher zaman

Satıcı sipariş referansı.

emailstring | nullher zaman

Yalnızca satıcıya açık müşteri e-postası. Herkese açık ödeme sayfası asla döndürmez.

customer_namestring | nullher zaman

Özel firstname, lastname ve company meta verilerinden türetilen görünen ad.

customer_addressstring | nullher zaman

Özel company, street, street2, zip, city, country, countryiso2 ve vatid meta verilerinden türetilen tek satırlık satıcı adresi.

descriptionstring | nullher zaman

Müşteriye görünen açıklama.

amountdecimal stringher zaman

Kanonik fatura tutarı.

currencystringher zaman

Normalleştirilmiş fatura para birimi/varlık kodu.

exchange_rate_spread_percentdecimal stringher zaman

Kilitlenmiş teklif fiyat marjı: oluşturmadaki özel değer veya atlandığında mağaza varsayılanı. Yukarı yuvarlamadan önce uygulanır; bu faturada asla değişmez.

underpayment_tolerance_percentdecimal stringher zaman

Fatura oluşturulurken görüntüsü alınmış, değiştirilemez kabul edilen eksik ödeme yüzdesi.

statusinvoice statusher zaman

new, processing, settled, expired, invalid veya cancelled.

amount_statusamount statusher zaman

none, partial, paid veya overpaid. Açıkça izin verilen sıfır tutarlı fatura none ile ve ödeme yöntemi olmadan tamamlanır.

timing_statustiming statusher zaman

on_time veya late.

resolutionresolutionher zaman

automatic, manually_settled veya manually_invalidated.

sequenceintegerher zaman

1'den başlayan, tek yönlü artan fatura durumu sıra numarası.

winning_payment_intent_idUUID | nullher zaman

Seçildiğinde faturayı sonuçlandıran ödeme yöntemi.

expires_atRFC 3339 timestampher zaman

Teklif/ödeme son tarihi.

monitoring_expires_atRFC 3339 timestampher zaman

Ödeme yöntemleri genelinde yapılandırılmış en geç geç ödeme izleme bitişi.

settled_attimestamp | nullher zaman

Ödeme tamamlandıysa tamamlanma zamanı.

cancelled_attimestamp | nullher zaman

İptal edildiyse iptal zamanı.

archived_attimestamp | nullher zaman

Arşivlendiyse arşivleme zamanı.

created_atRFC 3339 timestampher zaman

Oluşturulma zamanı.

updated_atRFC 3339 timestampher zaman

Son durum güncelleme zamanı.

ipn_urlstring | nullher zaman

Faturaya özel geçerli IPN hedefi. Yalnızca satıcı yanıtında bulunur; herkese açık ödeme sayfasından çıkarılır.

redirect_urlstring | nullher zaman

Tamamlanmadan sonra kullanılan geçerli başarı URL'si.

cancel_urlstring | nullher zaman

Ödeme sayfası başarılı ödeme olmadan sona erdiğinde kullanılan geçerli dönüş URL'si.

redirect_automaticallybooleanher zaman

Ödeme sayfasının başarıdan sonra otomatik yönlenip yönlenmeyeceği.

checkout_languagestringher zaman

Geçerli ödeme sayfası dil etiketi.

metadataobjecther zaman
Satıcı meta verileri. Herkese açık ödeme sayfası asla döndürmez. Konsol ödeme araçları payment_tool köken bilgisini ekler (id, kind, title, pricing, requested_amount, request_id); bu ödeme kanıtı değildir. Geri çağrıları doğrula ve invoice.settled için invoice_id başına bir kez siparişi yerine getir.Ayrıntılar

Satıcı meta verileri. Herkese açık ödeme sayfası asla döndürmez. Konsol ödeme araçları payment_tool köken bilgisini ekler (id, kind, title, pricing, requested_amount, request_id); bu ödeme kanıtı değildir. Geri çağrıları doğrula ve invoice.settled için invoice_id başına bir kez siparişi yerine getir.

cart_idstring
firstnamestring
lastnamestring
streetstring
street2string
zipstring
citystring
countrystring
countryiso2string
companystring
vatidstring
payment_intents[]object[]her zaman

Teklif verilen ödeme yöntemleri ve izleme durumu.

idUUIDher zaman

Ödeme isteği tanımlayıcısı; ödeme sayfası QR intent_id olarak da kullanılır.

payment_railonchain | lightningher zaman
Fatura aktarım türü. Zincir üstü Bitcoin ve Lightning aynı asset_id paylaşabilir; yalnızca sembol yerine isteğin id değerini ve bu alanı kullan. Bu, varlık kataloğundaki tarayıcı payment_rail alanından farklıdır.Ayrıntılar

Fatura aktarım türü. Zincir üstü Bitcoin ve Lightning aynı asset_id paylaşabilir; yalnızca sembol yerine isteğin id değerini ve bu alanı kullan. Bu, varlık kataloğundaki tarayıcı payment_rail alanından farklıdır.

bolt11string | nullher zaman

Lightning ödeme isteği; diğer durumlarda null. Bunu Lightning cüzdanıyla öde; ödeme hash'ine asla zincir üstü fon gönderme.

asset_idUUIDher zaman

Yapılandırılmış ödeme varlığı tanımlayıcısı.

asset_keystringher zaman

Kanonik CAIP biçimli varlık anahtarı.

chain_slugstringher zaman

Wholly Crypto zincir tanımlayıcısı.

networkstringher zaman

Yapılandırılmış ağ; desteklenen ödeme varlıkları için şu anda mainnet.

caip_network_idstringher zaman

Kanonik CAIP-2 ağ tanımlayıcısı.

caip_asset_idstring | nullher zaman

Kayıtlı olduğu yerlerde kanonik CAIP-19 tanımlayıcısı.

symbolstringher zaman

Varlık sembolü.

asset_decimalsintegerher zaman

Atomik birim hassasiyeti. Lightning BTC, zincir üstü Bitcoin'in 8 basamağı yerine 11 (millisatoshi) kullanır. Teklifler tam satoshi'dir; tahsilatlar millisatoshi hassasiyetini korur.

statusintent statusher zaman

pending, partial, paid, overpaid, expired veya invalid.

finality_modeconfirmations | finalizedher zaman

Kesinlik politikası.

required_confirmationsintegerher zaman

Uygulanabilir olduğunda gereken onay sayısı.

quote_ratedecimal stringher zaman

Kilitlenmiş fiyat marjı dahil, bir fatura para birimi başına varlık birimi. Örneğin USD başına 1.02 USDC. Ters kur değildir.

quote_detailsobject | nullher zaman
Kilitlenmiş teklif kökeni: fiyat marjı öncesi reference_rate, unrounded_payment_amount, rounding_adjustment, pricing_provider, asset_provider, pricing_fetched_at ve asset_fetched_at. Eski faturalarda null; geçmiş değerler uydurulmaz.Ayrıntılar

Kilitlenmiş teklif kökeni: fiyat marjı öncesi reference_rate, unrounded_payment_amount, rounding_adjustment, pricing_provider, asset_provider, pricing_fetched_at ve asset_fetched_at. Eski faturalarda null; geçmiş değerler uydurulmaz.

expected_amountdecimal stringher zaman
Fiyat marjı ve yukarı yuvarlamadan sonra ödenecek tam kilitli varlık tutarı. 4.1.1'den itibaren tanınan ve doğrulanmış itibari para stablecoin'leri (USDC, USDT, DAI, USDS, EURC gibi) en fazla iki ondalık basamağa yukarı yuvarlanır; 1.321, 1.33 olur, asla 1.32 olmaz. Tolerans sıfır olsa bile beklenen tutar budur. Diğer varlıklar uyarlanabilir hassasiyetini korur. Mevcut faturalar asla yeniden fiyatlandırılmaz.Ayrıntılar

Fiyat marjı ve yukarı yuvarlamadan sonra ödenecek tam kilitli varlık tutarı. 4.1.1'den itibaren tanınan ve doğrulanmış itibari para stablecoin'leri (USDC, USDT, DAI, USDS, EURC gibi) en fazla iki ondalık basamağa yukarı yuvarlanır; 1.321, 1.33 olur, asla 1.32 olmaz. Tolerans sıfır olsa bile beklenen tutar budur. Diğer varlıklar uyarlanabilir hassasiyetini korur. Mevcut faturalar asla yeniden fiyatlandırılmaz.

expected_amount_atomicinteger stringher zaman

Varlığın en küçük biriminde tam tutar.

minimum_payment_amountdecimal stringher zaman

Fatura toleransı uygulandıktan sonra ödendi olarak kabul edilen en küçük tutar.

minimum_payment_amount_atomicinteger stringher zaman

Varlığın en küçük biriminde tam kabul eşiği.

received_amountdecimal stringher zaman

Gözlenen tutar.

received_amount_atomicinteger stringher zaman

Gözlenen atomik tutar.

confirmed_amountdecimal stringher zaman

Onaylanmış/kesinleşmiş tutar.

confirmed_amount_atomicinteger stringher zaman

Onaylanmış/kesinleşmiş atomik tutar.

destination_addressstringher zaman

Zincir üstü ödeme alma adresi veya Lightning için 64 karakterlik ödeme hash'i. Lightning ödemek için bolt11 kullan; hash'i Bitcoin adresi değildir.

destination_tagstring | nullher zaman

Ödeme altyapısı gerektiriyorsa zorunlu herkese açık ödeme referansı: XRP destination tag, Stellar memo ID veya TON fatura açıklaması. Benzersiz adresli altyapılarda null.

derivation_indexintegerher zaman

Ayrılmış cüzdan alt adres indeksi; yalnızca satıcı ayrıntısında.

quote_expires_atRFC 3339 timestampher zaman

Teklifin sona erme zamanı.

monitoring_expires_atRFC 3339 timestampher zaman

Bu yöntem için geç ödeme izlemesinin bitişi.

next_check_attimestamp | nullher zaman

Sonraki zamanlanmış zincir kontrolü.

last_checked_attimestamp | nullher zaman

Son zincir kontrolü.

last_chain_heightinteger | nullher zaman

İzleyicinin gözlediği son güvenilir yükseklik.

last_anchor_hashstring | nullher zaman

Son izleme referansı/blok hash'i.

last_monitor_errorstring | nullher zaman

Operatörler için güvenli izleme teşhisi.

first_payment_attimestamp | nullher zaman

Ödemenin ilk gözlendiği zaman.

fully_paid_attimestamp | nullher zaman

Kabul edilen asgari tutara ilk ulaşılan zaman.

finalized_attimestamp | nullher zaman

Ödemenin kesinlik politikasını karşıladığı zaman.

Kullanım notları
  • Kapsamlı sorgu, herkese açık kimlik yetkili projede değilse bilinçli olarak invoice_not_found döndürür.
  • links.checkout, Mağaza → Temel → Mağaza alan adlarını kullanır: önce bu mağazanın etkin ödeme ana makinesi, sonra varsayılan mağazasının seçimi, ardından sistem birincil adresi. Kullanımdan kaldırılmış/taslak veya yanlış hizmetli sunucular yok sayılır. Bu oluşturma ve MCP yanıtları için de geçerlidir; bağlantılar idempotent tekrarlar dahil yanıt anında çözümlenir. İmzalı geri çağrı bağlantıları olay oluşumunda sabitlenir, yeniden denemelerde yazılmaz. Bu tercihler yalnızca bağlantı üretir; trafiği yönlendirmez veya IP kısıtlamalarını değiştirmez.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETFatura ödemelerini listele/v1/projects/{project_id}/invoices/{invoice_id}/paymentsSalt okunur

Geçersiz kılınmış gözlemler dahil tam güncel transfer geçmişi. Geri çağrı payments_truncated işaretlediğinde kullan. Eski olayın yeniden oluşturulması değil, güncel durumdur.

Kimlik doğrulama ve üst bilgiler
Üst bilgiGereklilikKural
AuthorizationzorunluBearer YOUR_MERCHANT_API_TOKEN
Acceptönerilenapplication/json

Yol parametreleri

project_idUUIDzorunlu

Bu kimlik bilgisine atanmış proje.

invoice_idUUIDzorunlu

Oluşturma sırasında döndürülen herkese açık invoice_id.

Sorgu parametreleri

payment_method_idUUIDisteğe bağlı

Tek fatura ödeme yöntemiyle sınırla.

limitinteger

1–100; varsayılan 25.

offsetinteger

0–1.000.000; varsayılan 0.

İstek

: "${WHOLLY_TOKEN:?Set WHOLLY_TOKEN to your server-side API token}"
curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/v1/projects/YOUR_PROJECT_ID/invoices/YOUR_PUBLIC_INVOICE_ID/payments?limit=25&offset=0" \
  --header "Authorization: Bearer $WHOLLY_TOKEN" \
  --header 'Accept: application/json'

Yanıt 200 application/json

Örnek yanıt
{
  "invoice_id": "11111111-2222-4333-8444-555555555555",
  "data": [{
    "payment_id": "44444444-4444-4444-8444-444444444444",
    "payment_method_id": "33333333-3333-4333-8333-333333333333",
    "transaction_id": "0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "payment_hash": null,
    "event_index": 12,
    "payment_rail": "onchain",
    "chain_slug": "ethereum",
    "network": "mainnet",
    "asset_id": "55555555-5555-4555-8555-555555555555",
    "asset_key": "eip155:1/erc20:0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
    "caip_asset_id": "eip155:1/erc20:0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
    "symbol": "USDC",
    "asset_decimals": 6,
    "amount": "58.17342",
    "amount_atomic": "58173420",
    "status": "final",
    "counts_towards_received": true,
    "confirmations": 2,
    "block_height": 25975377,
    "observed_at": "2026-09-14T12:03:00Z",
    "chain_time": "2026-09-14T12:02:48Z",
    "finalized_at": "2026-09-14T12:04:00Z",
    "explorer_name": "Etherscan",
    "explorer_url": "https://etherscan.io/tx/0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  }],
  "pagination": {"limit": 25, "offset": 0, "total": 1, "has_more": false}
}

Yanıt alanları

invoice_idstring
data[]object[]
payment_idstring
payment_method_idstring
transaction_idstring
payment_hashJSON | null
event_indexinteger
payment_railstring
chain_slugstring
networkstring
asset_idstring
asset_keystring
caip_asset_idstring
symbolstring
asset_decimalsinteger
amountstring
amount_atomicstring
statusstring
counts_towards_receivedboolean
confirmationsinteger
block_heightinteger
observed_atstring
chain_timestring
finalized_atstring
explorer_namestring
explorer_urlstring
paginationobject
limitinteger
offsetinteger
totalinteger
has_moreboolean
Kullanım notları
  • Gözlem bir token günlüğü, UTXO çıktısı veya başka ödeme altyapısı transferidir; mutlaka benzersiz işlem hash'i değildir. payment_id ile tekilleştir; transaction_id ve event_index birlikte zincir transferini tanımlar.
  • status detected, confirming, final, reorged, replaced veya invalid olabilir. Alınan tutarlara yalnızca counts_towards_received gözlemleri katılır. Farklı varlıkların tutarlarını asla toplama.
  • Lightning kayıtları payment_hash kullanır; transaction_id, confirmations ve gezgin bağlantıları null'dur. BTC hassasiyeti 11'dir (millisatoshi). Preimage, BOLT11 veya cüzdan sırları gösterilmez.
  • Önce observed_at azalan, ardından payment_id azalan sıralanır. Sayı ve sayfa tek repeatable-read görüntüsü kullanır; ödemeler geldikçe sonraki sayfalar değişebilir. Canlı faturayı sayfalarken payment_id ile tekilleştir.
  • Mevcut salt okunur proje kapsamı, IP kısıtlamaları ve kimlik bilgisi başına istek sınırları geçerlidir. Kökeni yapılandırılmış API sunucunla eşleşmedikçe geri çağrının sağladığı bağlantıyı token'ınla asla takip etme.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETÖdeme sayfası kabuğu/Herkese açık

Fatura seçmeden ödeme uygulamasını sunan yönetilen ödeme sunucusu kökü. Müşteri entegrasyonları normalde links.checkout kullanmalıdır.

Kimlik doğrulama ve üst bilgiler

Herkese açık

İstek

curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://pay.example.com/" \
  --output 'checkout.html'

Yanıt 200 text/html

Örnek yanıt
<!doctype html>
<!-- Hosted Wholly Crypto checkout shell -->
Kullanım notları
  • Bearer token gerekmez.
  • Yönetilen ödeme giriş katmanı GET/HEAD kabul eder, diğer yöntemleri reddeder.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETBarındırılan ödeme sayfası/invoice/{invoice_id}Herkese açık

Müşteriye görünen HTML ödeme sayfası. Sayfa aynı ödeme sunucusundan ödeme sayfası için güvenli JSON getirir. Mağaza etkinleştirip üst HTTPS kökenine açıkça izin vermedikçe gömme reddedilir.

Kimlik doğrulama ve üst bilgiler

Herkese açık

Yol parametreleri

invoice_idUUIDzorunlu

Satıcı API'sinin döndürdüğü herkese açık fatura UUID'si.

İstek

curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://pay.example.com/invoice/YOUR_PUBLIC_INVOICE_ID" \
  --output 'checkout.html'

Yanıt 200 text/html

Örnek yanıt
<!doctype html>
<!-- Hosted Wholly Crypto checkout application -->
Kullanım notları
  • Bearer token kabul edilmez ve gerekmez.
  • Fatura yokken bile HTML kabuğu 200 döndürür; ardından ödeme sayfası JSON isteği invoice_not_found alır.
  • Yanıt no-store, noindex ve faturaya özel frame-ancestors CSP içerir.
  • Devre dışı proje/mağaza veya bilinmeyen fatura ödeme sayfası verilerini göstermez.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETÖdeme sayfasında güvenle gösterilebilen fatura/checkout-api/invoices/{invoice_id}Herkese açık

Yalnızca ödeme sayfasını oluşturmak için gereken alanları döndürür. Dahili kimlikleri, müşteri e-postasını ve türetilmiş adres alanlarını, IPN URL'sini, satıcı meta verilerini, cüzdan kimliklerini, türetme yollarını ve izleme teşhislerini bilinçli olarak çıkarır.

Kimlik doğrulama ve üst bilgiler

Herkese açık

Yol parametreleri

invoice_idUUIDzorunlu

Herkese açık fatura UUID'si.

İstek

curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://pay.example.com/checkout-api/invoices/YOUR_PUBLIC_INVOICE_ID" \
  --header 'Accept: application/json'

Yanıt 200 application/json

Örnek yanıt
{
  "data": {
    "invoice_id": "0a6a98db-d93d-48ee-8c3c-fd45f90c4a50",
    "order_id": "order-1042",
    "description": "Annual plan",
    "amount": "49.9",
    "currency": "USD",
    "exchange_rate_spread_percent": "0.5",
    "underpayment_tolerance_percent": "1",
    "status": "processing",
    "amount_status": "partial",
    "timing_status": "on_time",
    "sequence": 3,
    "active_payment_method_id": "33333333-3333-4333-8333-333333333333",
    "payment_method_locked": true,
    "server_time": "2026-08-31T18:10:00Z",
    "expires_at": "2026-08-31T18:15:00Z",
    "expires_in_seconds": 300,
    "payment_open": true,
    "redirect_url": "https://merchant.example/orders/1042",
    "cancel_url": "https://merchant.example/cart",
    "redirect_automatically": true,
    "checkout_language": "en",
    "project": {
      "name": "Example project",
      "checkout_title": "Complete your payment",
      "checkout_description": "Send the exact amount shown.",
      "theme": "system",
      "accent_color": "#42e39b",
      "logo_url": "/checkout-api/invoices/…/logo/…/image.png"
    },
    "store": { "name": "Online shop" },
    "payment_methods": [
      {
        "id": "33333333-3333-4333-8333-333333333333",
        "asset_key": "bip122:000000000019d6689c085ae165831e93/slip44:0",
        "chain_slug": "bitcoin",
        "chain_name": "Bitcoin",
        "network": "mainnet",
        "caip_network_id": "bip122:000000000019d6689c085ae165831e93",
        "caip_asset_id": "bip122:000000000019d6689c085ae165831e93/slip44:0",
        "asset_name": "Bitcoin",
        "symbol": "BTC",
        "asset_icon_url": "/assets/coingecko/bitcoin.png",
        "asset_kind": "native",
        "contract_address": null,
        "token_standard": null,
        "asset_decimals": 8,
        "status": "partial",
        "payable": true,
        "finality_mode": "confirmations",
        "required_confirmations": 1,
        "expected_amount": "0.00046",
        "expected_amount_atomic": "46000",
        "minimum_payment_amount": "0.0004554",
        "minimum_payment_amount_atomic": "45540",
        "received_amount": "0.0002",
        "received_amount_atomic": "20000",
        "remaining_amount": "0.0002554",
        "remaining_amount_atomic": "25540",
        "confirmed_amount": "0",
        "confirmed_amount_atomic": "0",
        "destination_address": "bc1q…example",
        "destination_tag": null,
        "quote_expires_at": "2026-08-31T18:15:00Z",
        "payment_uri": "bitcoin:bc1q…example?amount=0.00026",
        "qr_url": "/checkout-api/invoices/…/payment-methods/…/qr.svg?sequence=3&amount_atomic=26000",
        "address_explorer_name": "mempool.space",
        "address_explorer_url": "https://mempool.space/address/…",
        "transaction_count": 0,
        "transactions_truncated": false,
        "transactions": []
      }
    ]
  }
}

Yanıt alanları

dataobject
invoice_idUUIDher zaman

Herkese açık fatura UUID'si.

order_idstring | nullher zaman

Satıcı sipariş referansı.

descriptionstring | nullher zaman

Müşteriye görünen açıklama.

amountdecimal stringher zaman

Fatura tutarı.

currencystringher zaman

Fatura para birimi.

exchange_rate_spread_percentdecimal stringher zaman

Faturaya özel değer dahil, oluşturma anında kilitlenmiş geçerli teklif fiyat marjı.

underpayment_tolerance_percentdecimal stringher zaman

Bu fatura için kabul edilen eksik ödeme yüzdesi.

statusinvoice statusher zaman

Güncel fatura durumu.

amount_statusamount statusher zaman

none, partial, paid veya overpaid. Açıkça izin verilen sıfır tutarlı fatura none ile ve ödeme yöntemi olmadan tamamlanır.

timing_statustiming statusher zaman

on_time veya late.

sequenceintegerher zaman

Güncel durum sıra numarası.

active_payment_method_idUUID | nullher zaman

Fon almış olan listelenmiş ödeme yöntemi. Eksik ödemenin uyumsuz varlıkla sürdürülmesini önlemek için ödeme sayfası bu yöntemde kalır.

payment_method_lockedbooleanher zaman

Geçerli ödeme active_payment_method_id seçtikten sonra true.

server_timeRFC 3339 timestampher zaman

Bu yanıt için alınan sunucu saati; müşteri cihazı saat sapmasını önlemek için expires_at ile kullan.

expires_atRFC 3339 timestampher zaman

Fatura son tarihi.

expires_in_secondsintegerher zaman

server_time anında kalan tam saniyeler; yukarı yuvarlanır ve sıfırın altına inmez.

payment_openbooleanher zaman

Yalnızca new veya processing fatura son tarihinden önceyse ve kalan tutarı olan en az bir ödenebilir yöntemi varsa true.

redirect_urlstring | nullher zaman

Başarılı tamamlanmadan sonra müşterinin dönüş hedefi.

cancel_urlstring | nullher zaman

Başarılı tamamlanma olmadan ayrılırken müşterinin dönüş hedefi.

redirect_automaticallybooleanher zaman

Otomatik yönlendirme politikası.

checkout_languagestringher zaman

Ödeme sayfası dili.

projectobjecther zaman

name, checkout_title, checkout_description, theme, accent_color ve logo_url.

namestring
checkout_titlestring
checkout_descriptionstring
themestring
accent_colorstring
logo_urlstring
storeobjecther zaman

Herkese açık mağaza adı.

namestring
appearanceobjecther zaman

Geçerli görünüm: sağlanmışsa faturaya özel sabitlenmiş ayar, aksi halde mağazanın güncel tasarımı. Finansal alanları veya güvenlik uyarılarını asla değiştirmez.

inherit_default_storebooleanher zaman

Bu görünümü projenin varsayılan mağazası sağlıyorsa true. Bağımsız mağazalar ve sabit fatura özel ayarlarında false.

invoice_overridebooleanher zaman

Fatura oluştururken checkout_appearance sağlandıysa true. Atlanması/null bunu false tutar.

titlestringher zaman

Düz satıcı başlığı, üst mesaj ve alt mesaj. intro, customer_message yerine geçer; eski kayıtlı metin korunur. Asla işaretleme dili olarak yorumlama.

introstringher zaman

Düz satıcı başlığı, üst mesaj ve alt mesaj. intro, customer_message yerine geçer; eski kayıtlı metin korunur. Asla işaretleme dili olarak yorumlama.

outrostringher zaman

Düz satıcı başlığı, üst mesaj ve alt mesaj. intro, customer_message yerine geçer; eski kayıtlı metin korunur. Asla işaretleme dili olarak yorumlama.

intro_font_sizeintegerher zaman

Piksel cinsinden yazı boyutları: 12, 14, 16, 18, 20 veya 24.

outro_font_sizeintegerher zaman

Piksel cinsinden yazı boyutları: 12, 14, 16, 18, 20 veya 24.

customer_messagestringher zaman

intro için kullanımdan kaldırılmış uyumluluk takma adı. Yeni entegrasyonlarda intro kullan.

themesystem | light | dim | darkher zaman

Müşteri cihazı tercihi veya sabit tema.

accent_colorstringher zaman

Kesin #RRGGBB renkleri. Otomatik değerler için isteğe bağlı renkler boştur; ön plan kontrastı hesaplanır.

background_colorstringher zaman

Kesin #RRGGBB renkleri. Otomatik değerler için isteğe bağlı renkler boştur; ön plan kontrastı hesaplanır.

card_colorstringher zaman

Kesin #RRGGBB renkleri. Otomatik değerler için isteğe bağlı renkler boştur; ön plan kontrastı hesaplanır.

button_colorstringher zaman

Kesin #RRGGBB renkleri. Otomatik değerler için isteğe bağlı renkler boştur; ön plan kontrastı hesaplanır.

logo_sizestringher zaman

small, medium veya large; left veya center. Görseller kırpılmadan sığdırılır.

logo_alignmentstringher zaman

small, medium veya large; left veya center. Görseller kırpılmadan sığdırılır.

imagesobjecther zaman

İsteğe bağlı logo_light, logo_dark ve favicon URL'leri: kapsamlı, aynı kökenli, normalleştirilmiş PNG görseller.

show_order_idbooleanher zaman

Sipariş kimliği görünürlüğü, başlık altı açıklaması ve başlangıçta sipariş kimliği ayrıntılarının açılması. Tutar görünür kalır; bunlar görüntüleme kontrolleridir, veri gizleme değildir.

show_descriptionbooleanher zaman

Sipariş kimliği görünürlüğü, başlık altı açıklaması ve başlangıçta sipariş kimliği ayrıntılarının açılması. Tutar görünür kalır; bunlar görüntüleme kontrolleridir, veri gizleme değildir.

details_expandedbooleanher zaman

Sipariş kimliği görünürlüğü, başlık altı açıklaması ve başlangıçta sipariş kimliği ayrıntılarının açılması. Tutar görünür kalır; bunlar görüntüleme kontrolleridir, veri gizleme değildir.

show_project_namebooleanher zaman

Merchant 5.6.0+: başlıkta ad görünürlüğü. İkisi de varsayılan true. Proje/mağaza kimliği JSON'da kullanılabilir kalır.

show_store_namebooleanher zaman

Merchant 5.6.0+: başlıkta ad görünürlüğü. İkisi de varsayılan true. Proje/mağaza kimliği JSON'da kullanılabilir kalır.

featured_chains[]arrayher zaman

Yalnızca faturada zaten bulunan yöntemlere uygulanan sıralı tercihler. Eksik veya devre dışı yöntemler yok sayılır.

featured_asset_ids[]arrayher zaman

Yalnızca faturada zaten bulunan yöntemlere uygulanan sıralı tercihler. Eksik veya devre dışı yöntemler yok sayılır.

default_asset_idUUID | nullher zaman

Önerilen başlangıç yöntemi. Geçerli hatırlanan müşteri tercihi veya zaten fon alan yöntem önceliklidir.

messagesobjecther zaman
waiting, confirming, paid, underpaid ve expired anahtarlı en, de, es, pt-BR, it, ru, zh-CN, fr, ko ve ja düz metinleri. Eksik satıcı mesajlarında İngilizceye dönülür. Tamamlayıcıdır; gerçek durumun yerini asla almaz. Satıcının yazdığı içerik otomatik çevrilmez.Ayrıntılar

waiting, confirming, paid, underpaid ve expired anahtarlı en, de, es, pt-BR, it, ru, zh-CN, fr, ko ve ja düz metinleri. Eksik satıcı mesajlarında İngilizceye dönülür. Tamamlayıcıdır; gerçek durumun yerini asla almaz. Satıcının yazdığı içerik otomatik çevrilmez.

enobject
waitingstring
confirmingstring
paidstring
underpaidstring
expiredstring
deobject
waitingstring
confirmingstring
paidstring
underpaidstring
expiredstring
esobject
waitingstring
confirmingstring
paidstring
underpaidstring
expiredstring
pt-BRobject
waitingstring
confirmingstring
paidstring
underpaidstring
expiredstring
itobject
waitingstring
confirmingstring
paidstring
underpaidstring
expiredstring
ruobject
waitingstring
confirmingstring
paidstring
underpaidstring
expiredstring
zh-CNobject
waitingstring
confirmingstring
paidstring
underpaidstring
expiredstring
frobject
waitingstring
confirmingstring
paidstring
underpaidstring
expiredstring
koobject
waitingstring
confirmingstring
paidstring
underpaidstring
expiredstring
jaobject
waitingstring
confirmingstring
paidstring
underpaidstring
expiredstring
support_emailstringher zaman

URL kimlik bilgisi içermeyen isteğe bağlı iletişim ve HTTPS bağlantıları. Harici bağlantılar yeni pencerede açılır.

support_urlstringher zaman

URL kimlik bilgisi içermeyen isteğe bağlı iletişim ve HTTPS bağlantıları. Harici bağlantılar yeni pencerede açılır.

terms_urlstringher zaman

URL kimlik bilgisi içermeyen isteğe bağlı iletişim ve HTTPS bağlantıları. Harici bağlantılar yeni pencerede açılır.

privacy_urlstringher zaman

URL kimlik bilgisi içermeyen isteğe bağlı iletişim ve HTTPS bağlantıları. Harici bağlantılar yeni pencerede açılır.

return_button_textstringher zaman

Yalnızca isteğe bağlı etiket. Başarı/iptal hedefleri ve yönlendirme politikası yine faturaya aittir.

show_return_buttonbooleanher zaman

Elle dönüş/iptal düğmesi görünürlüğü; varsayılan true. Otomatik başarı yönlendirmelerine değil, etkin ve son durumlara uygulanır. Merchant 8.1.4'ten itibaren kullanılabilir.

payment_methods[]object[]her zaman

Ödeme sayfasında güvenle gösterilebilen ödeme yöntemleri.

payment_railonchain | lightningher zaman

Lightning, zincir üstü BTC'den ayrı bir Bitcoin yöntemi olarak kalır. Seçimi yalnızca asset_id ile değil, ödeme isteği id'si ve altyapısıyla tanımla.

bolt11string | nullher zaman

İmzalı Lightning isteği; zincir üstü yöntemlerde null. payable false olduktan sonra asla ödeme yapma.

payment_hashstring | nullher zaman

Ödeme alma adresi değil, mutabakat için Lightning ödeme hash'i. Zincir üstü yöntemlerde null.

idUUIDher zaman

Ödeme isteği tanımlayıcısı.

asset_idUUIDher zaman

Görünüm tercihlerinin kullandığı varlık UUID'si; bu faturanın ödeme isteği id'sinden farklıdır.

asset_keystringher zaman

Kanonik varlık anahtarı.

chain_slugstringher zaman

Makine için zincir adı ve görünen zincir adı.

chain_namestringher zaman

Makine için zincir adı ve görünen zincir adı.

networkstringher zaman

Ödeme ağı.

caip_network_idstringher zaman

Seçilen zinciri kesin olarak ayırt etmek için kullanılan kanonik ağ kimliği.

caip_asset_idstring | nullher zaman

Uygulanabilir olduğunda doğrulanmış token sözleşmesi veya mint dahil, kanonik tam varlık kimliği.

asset_namestringher zaman

Ödeme varlığının görünen değerleri.

symbolstringher zaman

Ödeme varlığının görünen değerleri.

asset_icon_urlstring | nullher zaman

Aynı kökenli yerel önbellek varlık simgesi; doğrulanmış CoinGecko eşlemesi yoksa null.

asset_kindnative | tokenher zaman

Yerel para birimini sözleşme/mint ödemesinden ayırır.

contract_addressstring | nullher zaman

Token'lar için kanonik ERC-20 sözleşmesi veya SPL mint'i; yerel para biriminde null.

token_standarderc20 | spl-token | nullher zaman

Doğrulanmış token çalışma ortamı; yerel para biriminde null.

asset_decimalsintegerher zaman

Atomik birim hassasiyeti: Lightning BTC millisatoshi için 11, zincir üstü BTC satoshi için 8.

statusintent statusher zaman

Güncel ödeme yöntemi durumu.

payablebooleanher zaman

Yalnızca tam olarak bu yöntem şu anda ödeme kabul edebiliyorsa true; başka varlık fon aldıktan sonra etkin olmayan yöntemlerde false.

finality_modestringher zaman

Kesinlik politikası.

required_confirmationsintegerher zaman

Kesinlik politikası.

expected_amountdecimalher zaman
Görüntülenen ve gerçek zincir üstü birimlerde kilitlenmiş tam teklif. Tanınan itibari para stablecoin'leri tekliflerde en fazla iki ondalık basamak kullanır ve fiyat marjından sonra hep yukarı yuvarlanır; diğer varlıklar uyarlanabilir hassasiyet kullanır. Gerçek token basamakları, alınan fonlar ve kısmi ödeme kalanları tam kalır. Döndürülen tutarları değiştirmeden kullan.Ayrıntılar

Görüntülenen ve gerçek zincir üstü birimlerde kilitlenmiş tam teklif. Tanınan itibari para stablecoin'leri tekliflerde en fazla iki ondalık basamak kullanır ve fiyat marjından sonra hep yukarı yuvarlanır; diğer varlıklar uyarlanabilir hassasiyet kullanır. Gerçek token basamakları, alınan fonlar ve kısmi ödeme kalanları tam kalır. Döndürülen tutarları değiştirmeden kullan.

expected_amount_atomicinteger stringher zaman
Görüntülenen ve gerçek zincir üstü birimlerde kilitlenmiş tam teklif. Tanınan itibari para stablecoin'leri tekliflerde en fazla iki ondalık basamak kullanır ve fiyat marjından sonra hep yukarı yuvarlanır; diğer varlıklar uyarlanabilir hassasiyet kullanır. Gerçek token basamakları, alınan fonlar ve kısmi ödeme kalanları tam kalır. Döndürülen tutarları değiştirmeden kullan.Ayrıntılar

Görüntülenen ve gerçek zincir üstü birimlerde kilitlenmiş tam teklif. Tanınan itibari para stablecoin'leri tekliflerde en fazla iki ondalık basamak kullanır ve fiyat marjından sonra hep yukarı yuvarlanır; diğer varlıklar uyarlanabilir hassasiyet kullanır. Gerçek token basamakları, alınan fonlar ve kısmi ödeme kalanları tam kalır. Döndürülen tutarları değiştirmeden kullan.

minimum_payment_amountdecimalher zaman

Eksik ödeme toleransı uygulandıktan sonra kabul edilen ödeme tamamlama eşiği.

minimum_payment_amount_atomicinteger stringher zaman

Eksik ödeme toleransı uygulandıktan sonra kabul edilen ödeme tamamlama eşiği.

received_amountdecimalher zaman

Gözlenen tutar.

received_amount_atomicinteger stringher zaman

Gözlenen tutar.

remaining_amountdecimal stringher zaman

Kabul eşiğine ulaşmak için hâlâ gereken tam gösterim tutarı; sıfırın altına inmez.

remaining_amount_atomicinteger stringher zaman

Atomik birimlerde kabul eşiğine kalan eksik tutar. Bu istenen ödeme tutarı değildir: tolerans yalnızca kabulü etkiler.

confirmed_amountdecimalher zaman

Onaylanmış/kesinleşmiş tutar.

confirmed_amount_atomicinteger stringher zaman

Onaylanmış/kesinleşmiş tutar.

destination_addressstringher zaman

Zincir üstü hedef ve isteğe bağlı referans. Lightning'de tag içermeyen ödeme hash'idir; bunun yerine bolt11/payment_uri öde.

destination_tagstring|nullher zaman

Zincir üstü hedef ve isteğe bağlı referans. Lightning'de tag içermeyen ödeme hash'idir; bunun yerine bolt11/payment_uri öde.

quote_expires_atRFC 3339 timestampher zaman

Teklifin sona erme zamanı.

payment_uristring | nullher zaman
Zincire uygun istek: ERC-681, Solana Pay, yerel URI veya lightning:<bolt11>. Tutar içeren istekler tolerans eşiğini değil, tam beklenen tutardan alınan fonlar çıkarıldıktan sonrasını kullanır. Tolerans içindeki eksik ödeme kabul edildikten sonrası dahil, payable false ise null olur. Lightning QR ödeme hash'ini değil, tam Lightning isteğini kodlar.Ayrıntılar

Zincire uygun istek: ERC-681, Solana Pay, yerel URI veya lightning:<bolt11>. Tutar içeren istekler tolerans eşiğini değil, tam beklenen tutardan alınan fonlar çıkarıldıktan sonrasını kullanır. Tolerans içindeki eksik ödeme kabul edildikten sonrası dahil, payable false ise null olur. Lightning QR ödeme hash'ini değil, tam Lightning isteğini kodlar.

qr_urlpath | nullher zaman

Sıra ve tam kalan tutar revizyonlu, aynı kökenli SVG QR yolu; payable false ise null. SVG no-store'dur.

address_explorer_namestring|nullher zaman

Desteklenen yerlerde doğrulanmış mainnet gezgin yedeği.

address_explorer_urlstring|nullher zaman

Desteklenen yerlerde doğrulanmış mainnet gezgin yedeği.

transaction_countintegerher zaman

Bu yöntemde gözlenen benzersiz, herkese açık, geçerli işlemlerin toplamı.

transactions_truncatedbooleanher zaman

transaction_count döndürülen son işlem listesini aşıyorsa true.

transactions[]object[]her zaman

En yeni en fazla 10 herkese açık, geçerli işlem. Alınan tam toplamlar bu görüntüleme sınırından bağımsızdır.

transaction_idstringher zaman

Gözlenen işlem tanımlayıcısı.

statusdetected | confirming | finalher zaman

Herkese açık gözlem durumu.

confirmationsintegerher zaman

Gözlenen onay sayısı.

block_heightinteger | nullher zaman

Gözlenen blok/defter yüksekliği.

explorer_namestringdöndürüldüğünde

Doğrulanmış sabit gezgin adı.

explorer_urlstringdöndürüldüğünde

Doğrulanmış sabit mainnet gezgin URL'si.

Kullanım notları
  • Bearer token gerekmez.
  • Cache-Control no-store'dur ve arama indekslemesi kapalıdır.
  • invoice_id değerini müşteriye yönelik erişim sağlayan veri olarak ele al; gereksiz yayımlama.
  • asset_icon_url aynı kökenli yerel varlıktır; müşteri ödeme sayfası göstermek için CoinGecko'ya bağlanmak zorunda değildir.
  • destination_tag null değilse adresin yanında göster ve kopyala: zorunlu XRP destination tag, Stellar memo ID veya TON fatura açıklamasıdır ve aynen gönderilmelidir.
  • Doğrulanmış token'larda asset_kind token olur; contract_address tam ERC-20 sözleşmesini veya SPL mint'ini, token_standard altyapıyı tanımlar; payment_uri token kimliğini taşır.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETMağaza ödeme sayfası önizlemesi/invoice/preview/{project_id}Herkese açık

Kaydedilen mağaza görünümünü örnek tutar ve gerçek kabul edilen varlık meta verileriyle gösterir. Ödeme oluşturmadan waiting, confirming, paid, underpaid ve expired örnekleri arasında geçiş yap.

Kimlik doğrulama ve üst bilgiler

Herkese açık

Yol parametreleri

project_idUUIDzorunlu

Kimlik doğrulamalı konsolun önizleme bağlantısına kopyaladığı proje UUID'si.

Sorgu parametreleri

store_idUUID,isteğe bağlı

Bu projeye ait mağaza. İlk/varsayılan mağazası için atla.

statestring,isteğe bağlı

waiting, confirming, paid, underpaid veya expired. Yalnızca tarayıcı içi örnek.

İstek

curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://pay.example.com/invoice/preview/YOUR_PROJECT_ID?store_id=YOUR_STORE_ID&state=confirming" \
  --output 'checkout-preview.html'

Yanıt 200 text/html

Örnek yanıt
<!doctype html>
<!-- Hosted branding preview; no invoice is created -->
Kullanım notları
  • Önizleme yalnızca markalama içindir; müşteriye asla ödeme isteği olarak gönderilmemelidir.
  • Ödeme alma adresi, ödenebilir QR, cüzdan işlemi, yönlendirme veya ödeme sorgulaması yok. Örnekler gerçek fatura durumunu değiştirmez.
  • Yanıt no-store, noindex'dir ve gömülemez.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETÖdeme sayfası önizleme verileri/checkout-api/previews/{project_id}Herkese açık

Geçerli mağaza görünümünü ve güvenli kabul edilen varlık meta verilerini döndürür. payment_methods boş kalır; preview_methods ödeme adresi, teklif veya özel cüzdan verisi içermez.

Kimlik doğrulama ve üst bilgiler

Herkese açık

Yol parametreleri

project_idUUIDzorunlu

Konsol önizleme bağlantısındaki proje UUID'si.

Sorgu parametreleri

store_idUUID,isteğe bağlı

Bu projeye ait olmalıdır; eşleşmeyen kimlikler 404 döndürür. Bilinmeyen sorgu alanları reddedilir.

İstek

curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://pay.example.com/checkout-api/previews/YOUR_PROJECT_ID?store_id=YOUR_STORE_ID" \
  --header 'Accept: application/json'

Yanıt 200 application/json

Örnek yanıt
{
  "data": {
    "preview": true,
    "invoice_id": "YOUR_PROJECT_ID",
    "amount": "100.00",
    "currency": "USD",
    "project": {
      "name": "Example project",
      "checkout_title": "Complete your payment",
      "checkout_description": "Choose a network and send the exact amount shown.",
      "theme": "system",
      "accent_color": "#42e39b",
      "logo_url": "/checkout-api/previews/…/logo/…/image.png"
    },
    "appearance": {"inherit_default_store": true, "theme": "system", "accent_color": "#42E39B", "images": {}},
    "preview_methods": [],
    "payment_methods": []
  }
}

Yanıt alanları

dataobject
previewboolean
invoice_idstring
amountstring
currencystring
projectobject
namestring
checkout_titlestring
checkout_descriptionstring
themestring
accent_colorstring
logo_urlstring
appearanceobject
inherit_default_storebooleanher zaman

Bu görünümü projenin varsayılan mağazası sağlıyorsa true. Bağımsız mağazalar ve sabit fatura özel ayarlarında false.

invoice_overridebooleanher zaman

Fatura oluştururken checkout_appearance sağlandıysa true. Atlanması/null bunu false tutar.

titlestringher zaman

Düz satıcı başlığı, üst mesaj ve alt mesaj. intro, customer_message yerine geçer; eski kayıtlı metin korunur. Asla işaretleme dili olarak yorumlama.

introstringher zaman

Düz satıcı başlığı, üst mesaj ve alt mesaj. intro, customer_message yerine geçer; eski kayıtlı metin korunur. Asla işaretleme dili olarak yorumlama.

outrostringher zaman

Düz satıcı başlığı, üst mesaj ve alt mesaj. intro, customer_message yerine geçer; eski kayıtlı metin korunur. Asla işaretleme dili olarak yorumlama.

intro_font_sizeintegerher zaman

Piksel cinsinden yazı boyutları: 12, 14, 16, 18, 20 veya 24.

outro_font_sizeintegerher zaman

Piksel cinsinden yazı boyutları: 12, 14, 16, 18, 20 veya 24.

customer_messagestringher zaman

intro için kullanımdan kaldırılmış uyumluluk takma adı. Yeni entegrasyonlarda intro kullan.

themesystem | light | dim | darkher zaman

Müşteri cihazı tercihi veya sabit tema.

accent_colorstringher zaman

Kesin #RRGGBB renkleri. Otomatik değerler için isteğe bağlı renkler boştur; ön plan kontrastı hesaplanır.

background_colorstringher zaman

Kesin #RRGGBB renkleri. Otomatik değerler için isteğe bağlı renkler boştur; ön plan kontrastı hesaplanır.

card_colorstringher zaman

Kesin #RRGGBB renkleri. Otomatik değerler için isteğe bağlı renkler boştur; ön plan kontrastı hesaplanır.

button_colorstringher zaman

Kesin #RRGGBB renkleri. Otomatik değerler için isteğe bağlı renkler boştur; ön plan kontrastı hesaplanır.

logo_sizestringher zaman

small, medium veya large; left veya center. Görseller kırpılmadan sığdırılır.

logo_alignmentstringher zaman

small, medium veya large; left veya center. Görseller kırpılmadan sığdırılır.

imagesobjecther zaman

İsteğe bağlı logo_light, logo_dark ve favicon URL'leri: kapsamlı, aynı kökenli, normalleştirilmiş PNG görseller.

show_order_idbooleanher zaman

Sipariş kimliği görünürlüğü, başlık altı açıklaması ve başlangıçta sipariş kimliği ayrıntılarının açılması. Tutar görünür kalır; bunlar görüntüleme kontrolleridir, veri gizleme değildir.

show_descriptionbooleanher zaman

Sipariş kimliği görünürlüğü, başlık altı açıklaması ve başlangıçta sipariş kimliği ayrıntılarının açılması. Tutar görünür kalır; bunlar görüntüleme kontrolleridir, veri gizleme değildir.

details_expandedbooleanher zaman

Sipariş kimliği görünürlüğü, başlık altı açıklaması ve başlangıçta sipariş kimliği ayrıntılarının açılması. Tutar görünür kalır; bunlar görüntüleme kontrolleridir, veri gizleme değildir.

show_project_namebooleanher zaman

Merchant 5.6.0+: başlıkta ad görünürlüğü. İkisi de varsayılan true. Proje/mağaza kimliği JSON'da kullanılabilir kalır.

show_store_namebooleanher zaman

Merchant 5.6.0+: başlıkta ad görünürlüğü. İkisi de varsayılan true. Proje/mağaza kimliği JSON'da kullanılabilir kalır.

featured_chains[]arrayher zaman

Yalnızca faturada zaten bulunan yöntemlere uygulanan sıralı tercihler. Eksik veya devre dışı yöntemler yok sayılır.

featured_asset_ids[]arrayher zaman

Yalnızca faturada zaten bulunan yöntemlere uygulanan sıralı tercihler. Eksik veya devre dışı yöntemler yok sayılır.

default_asset_idUUID | nullher zaman

Önerilen başlangıç yöntemi. Geçerli hatırlanan müşteri tercihi veya zaten fon alan yöntem önceliklidir.

messagesobjecther zaman
waiting, confirming, paid, underpaid ve expired anahtarlı en, de, es, pt-BR, it, ru, zh-CN, fr, ko ve ja düz metinleri. Eksik satıcı mesajlarında İngilizceye dönülür. Tamamlayıcıdır; gerçek durumun yerini asla almaz. Satıcının yazdığı içerik otomatik çevrilmez.Ayrıntılar

waiting, confirming, paid, underpaid ve expired anahtarlı en, de, es, pt-BR, it, ru, zh-CN, fr, ko ve ja düz metinleri. Eksik satıcı mesajlarında İngilizceye dönülür. Tamamlayıcıdır; gerçek durumun yerini asla almaz. Satıcının yazdığı içerik otomatik çevrilmez.

enobject
waitingstring
confirmingstring
paidstring
underpaidstring
expiredstring
deobject
waitingstring
confirmingstring
paidstring
underpaidstring
expiredstring
esobject
waitingstring
confirmingstring
paidstring
underpaidstring
expiredstring
pt-BRobject
waitingstring
confirmingstring
paidstring
underpaidstring
expiredstring
itobject
waitingstring
confirmingstring
paidstring
underpaidstring
expiredstring
ruobject
waitingstring
confirmingstring
paidstring
underpaidstring
expiredstring
zh-CNobject
waitingstring
confirmingstring
paidstring
underpaidstring
expiredstring
frobject
waitingstring
confirmingstring
paidstring
underpaidstring
expiredstring
koobject
waitingstring
confirmingstring
paidstring
underpaidstring
expiredstring
jaobject
waitingstring
confirmingstring
paidstring
underpaidstring
expiredstring
support_emailstringher zaman

URL kimlik bilgisi içermeyen isteğe bağlı iletişim ve HTTPS bağlantıları. Harici bağlantılar yeni pencerede açılır.

support_urlstringher zaman

URL kimlik bilgisi içermeyen isteğe bağlı iletişim ve HTTPS bağlantıları. Harici bağlantılar yeni pencerede açılır.

terms_urlstringher zaman

URL kimlik bilgisi içermeyen isteğe bağlı iletişim ve HTTPS bağlantıları. Harici bağlantılar yeni pencerede açılır.

privacy_urlstringher zaman

URL kimlik bilgisi içermeyen isteğe bağlı iletişim ve HTTPS bağlantıları. Harici bağlantılar yeni pencerede açılır.

return_button_textstringher zaman

Yalnızca isteğe bağlı etiket. Başarı/iptal hedefleri ve yönlendirme politikası yine faturaya aittir.

show_return_buttonbooleanher zaman

Elle dönüş/iptal düğmesi görünürlüğü; varsayılan true. Otomatik başarı yönlendirmelerine değil, etkin ve son durumlara uygulanır. Merchant 8.1.4'ten itibaren kullanılabilir.

preview_methods[]array
payment_methods[]array
Kullanım notları
  • Bearer token kabul edilmez ve gerekmez.
  • Fatura, hedef, cüzdan, işlem, IPN, webhook veya satıcı meta verisi döndürülmez.
  • Doğru ödeme alan adı önizleme bağlantısını almak için kimlik doğrulamalı konsolu kullan.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETMağaza ödeme sayfası görseli/checkout-api/invoices/{invoice_id}/appearance-images/{kind}/{revision}/image.pngHerkese açık

Bu faturaya ait normalleştirilmiş mağaza logosu veya favicon döndürür. Ödeme sayfası verilerindeki appearance.images URL'lerini kullan.

Kimlik doğrulama ve üst bilgiler

Herkese açık

Yol parametreleri

invoice_idUUIDzorunlu

Herkese açık fatura UUID'si.

kindenumzorunlu

logo_light, logo_dark veya favicon.

revisionUUIDzorunlu

Güncel görsel revizyonu.

İstek

curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://pay.example.com/checkout-api/invoices/YOUR_PUBLIC_INVOICE_ID/appearance-images/logo_light/YOUR_IMAGE_REVISION/image.png" \
  --output 'store-logo.png'

Yanıt 200 image/png

Örnek yanıt
(binary PNG response)
Kullanım notları
  • Ödeme sayfası JSON'undaki appearance.images kullan. Sabitlenmiş fatura görselleri kaynak mağaza yüklemeyi değiştirse veya kaldırsa da çalışır. Açıkça kaldırılmış, yanlış faturalı, yanlış türde ve bilinmeyen revizyonlar 404 döndürür; görüntü asla güncel mağaza görseline dönmez.
  • Faturaya özel ayar yoksa güncel geçerli mağaza görseli kullanılır; değiştirilmiş/kaldırılmış revizyonlar 404 döndürür. Yalnızca PNG; nosniff ve özel önbellekleme.
  • Mağaza görsel yüklemeleri kimlik doğrulamalı konsolda sınırlandırılmış PNG, JPEG veya WebP kabul eder; SVG, HTML veya uzak görsel URL'si asla kabul edilmez.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETMağaza önizleme görseli/checkout-api/previews/{project_id}/stores/{store_id}/appearance-images/{kind}/{revision}/image.pngHerkese açık

Normalleştirilmiş önizleme görselini yalnızca proje, mağaza, tür ve güncel revizyon eşleştiğinde döndürür.

Kimlik doğrulama ve üst bilgiler

Herkese açık

Yol parametreleri

project_idUUIDzorunlu

Proje UUID'si.

store_idUUIDzorunlu

Projeye ait mağaza.

kindenumzorunlu

logo_light, logo_dark veya favicon.

revisionUUIDzorunlu

Güncel görsel revizyonu.

İstek

curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://pay.example.com/checkout-api/previews/YOUR_PROJECT_ID/stores/YOUR_STORE_ID/appearance-images/logo_light/YOUR_IMAGE_REVISION/image.png" \
  --output 'store-preview-logo.png'

Yanıt 200 image/png

Örnek yanıt
(binary PNG response)
Kullanım notları
  • Önizleme verilerindeki appearance.images kullan. Bilinmeyen veya eşleşmeyen kimlikler 404 döndürür. Cüzdan veya ödeme bilgisi açığa çıkarılmaz.

Hatalar

Hata kodları ve yeniden deneme kuralları

GETÖdeme QR görseli/checkout-api/invoices/{invoice_id}/payment-methods/{intent_id}/qr.svgHerkese açık

Fatura ödeme yönteminin zincire uygun tam ödeme yükü için 512×512 SVG QR üretir.

Kimlik doğrulama ve üst bilgiler

Herkese açık

Yol parametreleri

invoice_idUUIDzorunlu

Herkese açık fatura UUID'si.

intent_idUUIDzorunlu

Ödeme sayfası JSON'undaki ödeme yöntemi id'si.

İstek

curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://pay.example.com/checkout-api/invoices/YOUR_PUBLIC_INVOICE_ID/payment-methods/YOUR_INTENT_ID/qr.svg" \
  --output 'payment-qr.svg'

Yanıt 200 image/svg+xml

Örnek yanıt
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512">…</svg>
Kullanım notları
  • Bearer token gerekmez.
  • Ödeme sayfası JSON'unun döndürdüğü sıra ve kalan tutar revizyonlu qr_url kullan; SVG private ve no-store'dur.
  • Kısmi ödemeden sonra tam kalan tutarı ister ve o varlığa kilitli kalır.
  • Süre dolunca, tamamlanınca veya başka yöntem etkinken 409 döndürür; istek kodlanamayacak kadar büyükse payment_qr_unavailable (422) döner.

Hatalar

Hata kodları ve yeniden deneme kuralları

Wholly Crypto 8.3.2 başvuru kaynağı. Kurulu sürümün için konsolunda Ayarlar → API erişimi → Belgeler bölümünü aç. Sürümleri gör.