DOCUMENTATIE VOOR ONTWIKKELAARS

API-documentatie

Integreer facturen, afrekenen en betalingsmeldingen.

Snelstart

Maak je eerste factuur.

  1. Bereid een winkel voor

    Schakel de betaalmethoden in, configureer providers en maak een back-up van de projectwallets.

  2. Maak een API-referentie

    Kies in de console onder Instellingen → API-toegang voor lezen/schrijven en wijs het project toe.

  3. Verstuur het verzoek

    Gebruik je API-host en kopieer je project- en winkel-ID's. Verstuur decimale bedragen als tekenreeksen.

  4. Afrekenpagina openen

    Leid door naar links.checkout uit het antwoord. Verifieer de voldoening voordat je de bestelling afhandelt.

: "${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"
}'

Voorbeelden gebruiken placeholders en versturen geen verzoeken vanaf deze pagina. Bekijk elk factuurveld en het antwoordformaat →

Project- & winkel-ID's

Waar je YOUR_PROJECT_ID en YOUR_STORE_ID vindt.

Gebruik de UUID's uit je console, niet de namen van projecten of winkels of hun leesbare identificaties.

PlaceholderWaar te vindenGebruikt voor
YOUR_PROJECT_IDProject → Instellingen → API-ID's → Project-API-ID → Kopiëren. Ook zichtbaar op het tabblad Basis van de winkel.Verzoeken op project- en winkelniveau.
YOUR_STORE_IDProject → Winkels → selecteer een winkel → Basis → API-ID's → Store-API-ID → Kopiëren.Factuuraanmaak en verzoeken voor betaalmethoden van de winkel.
  • Een factuur maken vereist beide ID's, ook voor de standaardwinkel. De winkel moet bij dat project horen en de API-referentie moet toegang hebben tot het project.
  • Factuuraanmaak, lijsten, details en afrekenen geven invoice_id terug: dezelfde UUID die in IPN/webhooks wordt verstuurd. Gebruik deze in factuurpaden, niet de interne id of order_id. Sinds merchant 4.0.0 is het oude antwoordveld public_id verwijderd; werk integraties bij voordat je upgradet.
  • De REST-API biedt geen routes om projecten/winkels op te vragen. Kopieer ID's in de console of gebruik de afgebakende MCP-hulpmiddelen list_projects en list_stores in merchant 5.0.0+.
  • Winkel → Basis → Winkeldomeinen selecteert actieve hostnamen voor handelaar, betalen en API. Teruggegeven afrekenlinks en nieuwe callbacklinks kiezen eerst die winkel, daarna de standaardwinkel en dan de systeemstandaarden. Vervallen of niet-geactiveerde namen worden nooit gekozen. Configureer je SDK met de gewenste API-hostnaam; een voorkeur wijzigen leidt andere actieve aliassen niet om.

Authenticatie & bereik

Bewaar inloggegevens op je server en verleen alleen de benodigde toegang.

StandaardhostDoel
merchant.example.comHandelaarsconsole en Instellingen
pay.example.comAfrekenen voor klanten
api.example.comHandelaars-API-verzoeken

Vervang example.com door je domein. Bestaande installaties behouden hun ingestelde namen; beheer aliassen onder Instellingen → Systeem.

Authorization: Bearer YOUR_MERCHANT_API_TOKEN
InstellingZo werkt het
ToegangsniveauAlleen-lezen API-referenties kunnen lijsten en gegevens ophalen. API-referenties met lees-/schrijfrechten kunnen ook facturen maken en het gedocumenteerde activabeleid bijwerken.
ProjectenWijs de projecten toe waartoe de API-referentie toegang mag hebben. Winkel- en factuur-ID's moeten bij een toegewezen project horen.
IP-beperkingenSta optioneel exacte publieke uitgaande IPv4- of IPv6-adressen toe onder Instellingen → API-toegang.
Opslag van inloggegevensBewaar tokens in je backendconfiguratie. Neem nooit een bearerreferentie op in een browser of afrekenlink.

Publieke afrekenroutes gebruiken de publieke ID van de factuur en tonen alleen gegevens die veilig voor afrekenen zijn. Consolesessies en beheerdersfuncties staan los van handelaars-API-referenties.

Activa & wallets

Kies betaalmethoden afzonderlijk voor elke winkel.

  1. Lees betaalactiva van het project en hun gereedheid.
  2. Schakel het netwerk van de eigen munt in en configureer de wallet en providers.
  3. Bekijk kandidaattokens en verifieer het contract of de mint voordat je een token inschakelt.
  4. Selecteer de geordende betaalmethodenvan de winkel. Nieuwe facturen gebruiken de keuzes die gereed zijn.

Tokens delen de wallet van hun eigen blockchain. Walletsaldi geven exacte bedragen in atomaire eenheden en indicatieve fiatwaarden terug. Gebruik de teruggegeven gereedheidsvelden om te bepalen welke methoden betalingen kunnen ontvangen.

Geverifieerde ERC-20-tokens gebruiken de ondersteunde EVM-netwerken; geverifieerde SPL-tokens gebruiken Solana. Betaalmethoden met eigen munten zijn beschikbaar op de 30 geïntegreerde netwerken. Monero gebruikt een externe walletverbinding met alleen inzagerechten, gekoppeld aan het project.

Ontvangst-API's en ondersteuning voor eigen munten/tokens
BetaalrouteOndersteuningBewijsVereisten
Betaalroutes voor eigen muntenondersteundVia transactiescansBTC, SOL, ETH (Ethereum/Base/Arbitrum/OP), BNB, HYPE, AVAX en POL; Bitcoin-outputs, canonieke EVM-transacties/ontvangstbewijzen en geparste Solana-overschrijvingen leveren factuurbewijs.
Betaalroutes voor ERC-20-tokensondersteundVia transactiescansEthereum, Base, BNB Chain, HyperEVM, Avalanche, Polygon, Arbitrum en Optimism vereisen verificatie op de blockchain; geïndexeerde Transfer-logs leveren betalingstoewijzing.
Betaalroutes voor SPL-tokensondersteundVia transactiescansSolana-kandidaten vereisen mainnet- en mintverificatie; exacte wijzigingen in tokensaldi in geparste transacties leveren betalingstoewijzing.
Aanvullende UTXO-routes voor eigen muntenondersteundVia transactiescansBCH/LTC/DOGE gebruiken Esplora; BCH/DOGE accepteren ook Bitcore, LTC/DOGE/DASH accepteren BlockCypher, Dash accepteert Insight en transparante ZEC accepteert zcash-explorer. Alle accepteren ook volledig bewaarde Core-compatibele node-rpc-blokken. Ruwe modus vereist 1–48 bevestigingen, geen mempooldetectie. Afgeschermde Zcash wordt niet ondersteund.
Geïndexeerde accountroutes voor eigen muntenondersteundVia transactiescansTRON gebruikt tron-indexer of definitief bevestigde node-rpc; XRP gebruikt xrpl-jsonrpc; Stellar gebruikt stellar-horizon of bewaarde Stellar node-rpc-grootboeken; Cosmos Hub gebruikt cometbft-jsonrpc; Algorand gebruikt algorand-indexer of algod node-rpc; Hedera vereist hedera-mirror, geen EVM-relay.
Grootboekbetaalroutes voor eigen muntenondersteundVia transactiescansAptos gebruikt aptos-rest; Sui gebruikt sui-graphql; NEAR gebruikt near-jsonrpc; Kaspa gebruikt kaspa-rest. Polkadot Asset Hub accepteert substrate-rest of definitief bevestigde node-rpc met metadataondersteuning; Tezos accepteert tezos-tzkt of volledige Octez node-rpc-operaties. Alleen ontvangsten van eigen munten; voor oudere facturen is archiefbewaring vereist.
Cardano- en TON-routes voor eigen muntenondersteundVia transactiescansCardano vereist cardano-koios en TON vereist toncenter-v3. XRP-tags, Stellar-memo-ID's en TON-factuurcommentaren worden teruggegeven als destination_tag en moeten exact worden meegestuurd.
Integriteit van betalingsvoldoeningondersteundOnafhankelijke verificatieStandaard vereist definitieve voldoening dat twee onafhankelijke providers het eens zijn over de exacte transactie/gebeurtenis, het bedrag, het canonieke blok of slot en de definitieve bevestiging. Ruwe en gedeelde EVM-vensters verifiëren ook volledige dekking. Een beheerder kan voor een blockchain expliciet één vertrouwde provider kiezen; dit verwijdert de onafhankelijke kruiscontrole, niet de controles van identiteit, volledigheid of definitieve bevestiging.
Monero-route voor de eigen muntondersteundAan het project gekoppelde wallet-RPC met alleen inzagerechtenEén afzonderlijke externe wallet-RPC met alleen inzagerechten achter een HTTPS-gateway met methodetoelatingslijst maakt subadressen voor account-0. De ingestelde drempel voor mainnet-daemons (standaard 2 onafhankelijke bronnen, optioneel 1) levert bewijs van voldoening. Native --restricted-rpc is onverenigbaar met create_address; de operator verklaart expliciet dat een walletback-up bestaat en er geen bestedingssleutel aanwezig is, terwijl geen sleutelmateriaal naar Wholly Crypto wordt gestuurd.

Beurssaldi en keuzes per actief om naar een wallet of beurs te sweepen zijn beschikbaar in de console, niet via de publieke v1-API. Bekijk beursconfiguratie.

Factuurlevenscyclus

Betalingsbewijs, voldoening en orderafhandeling.

StatusBetekenis
newWacht op een betaling
processingBetaling waargenomen; geaccepteerd bedrag of definitieve bevestiging ontbreekt nog
settledGeaccepteerd volgens het beleid voor factuurvoldoening of handmatig
expiredDeadline verstreken; controle op late betalingen kan doorgaan
invalidBetaling kan niet automatisch worden geaccepteerd
cancelledGeannuleerd; alleen expliciete afstemming kan de factuur heropenen

amount_status registreert none, partial, paid of overpaid. timing_status maakt onderscheid tussen tijdige en late betalingen. Winkelregels bepalen het vereiste aantal bevestigingen en de geaccepteerde onderbetalingstolerantie.

Gebruik de invoice_id van de factuur met de route voor factuurdetails. Alleen een afrekenomleiding is geen bewijs van voldoening. Beoordeel uitzonderingen via afstemming.

Veilig opnieuw proberen

Factuuraanmaak vereist Idempotency-Key. Probeer na een time-out opnieuw met dezelfde API-referentie, sleutel en exacte requestbody. Gebruik alleen voor een nieuwe factuur een nieuwe sleutel.

EVM-betalingen scannen

Gedeelde detectie van blokken voor eigen munten en ERC-20 groepeert recente facturen afzonderlijk van het inhalen van oudere gegevens. Elke factuur behoudt haar duurzaam opgeslagen geschiedeniscursor. Tokenopvragingen gebruiken maximaal 100 blokken per verzoek en worden kleiner bij strengere providerlimieten. Standaard verifiëren twee onafhankelijke providers elk venster. Onder Instellingen → Blockchainverbindingen → Details kun je voor een blockchain één vertrouwde bron kiezen, zonder onafhankelijke kruiscontrole; controles van canonieke transactie, bedrag en bevestigingen blijven bestaan. Verbindingsdetails onderscheiden scannervertragingen, geschiedenisbeperkingen en quotawachttijden van de basisstatus van de node. Publieke RPC-capaciteit is niet gegarandeerd.

IPN & webhooks

Ontvang en verifieer betalingsgebeurtenissen.

IPN ontvangt elke gegenereerde factuurgebeurtenis op de effectieve ipn_url van de factuur. Webhooks ontvangen alleen de gebeurtenissen die voor elk ingeschakeld winkeleindpunt zijn geselecteerd. Beide versturen via POST dezelfde JSON-momentopname; ze zijn onafhankelijk, dus als je beide inschakelt, kan je applicatie twee meldingen ontvangen.

Stel ipn_url in bij het maken van een factuur of neem de winkelstandaard over. IPN gebruikt het Winkel → IPN geheim; elk Winkel → Webhooks eindpunt heeft een eigen geheim. Geen van beide is je API-sleutel.

Wanneer moet ik een bestelling afhandelen?

Gebruik voor gebeurtenisgestuurde verwerking event_type = invoice.settled samen met status = settled om een bestelcontrole te starten. Verifieer de huidige factuur en handel elke bestelling slechts één keer af.

status is de factuurstatus toen de gebeurtenis werd gemaakt. event_type vertelt wat er is gebeurd. payment.received kan processing of settled bevatten; het betekent geen tweede betaling en is geen zelfstandig signaal voor orderafhandeling.

Welke gebeurtenissen en statussen worden verstuurd?

Gebeurtenis in instellingen/geschiedenisStatus in de bodyBetekenis
invoice.creatednewFactuur gemaakt en wacht op betaling. Ook gebruikt wanneer gecontroleerd heropenen een factuur terugzet naar new.
payment.receivedResulting invoice statusEen betaling is geregistreerd of het ontvangen bedrag is gestegen. Gewoonlijk processing of settled; deze gebeurtenis alleen is geen bewijs van voldoening.
invoice.processingprocessingBetaling gedetecteerd, maar het geaccepteerde bedrag of de vereiste definitieve bevestiging is nog niet bereikt. Omvat deelbetalingen.
invoice.settledsettledVoldoet aan het betalingsbeleid of is handmatig geaccepteerd. Controleer resolution en je bestelling vóór afhandeling.
invoice.expiredexpiredBetalingsdeadline verstreken. Een late betaling kan de status nog wijzigen zolang monitoring doorgaat.
invoice.invalidinvalidKan niet automatisch worden geaccepteerd, betalingsbewijs is verloren gegaan of een handelaar heeft de betaling afgewezen. Beoordeel de factuur.
invoice.cancelledcancelledFactuur geannuleerd. Niet afhandelen; annulering betaalt een blockchainbetaling niet terug.
Waarom Ethereum en Solana verschillende gebeurtenisstromen kunnen versturen

Bevestigingen komen later (Ethereum-voorbeeld)

Volgordeevent_typestatus
1invoice.creatednew
2payment.receivedprocessing
2invoice.processingprocessing
3invoice.settledsettled

Al definitief bij detectie (Solana-voorbeeld)

Volgordeevent_typestatus
1invoice.creatednew
2payment.receivedsettled
2invoice.settledsettled

Deze tonen het maken van gebeurtenissen, geen gegarandeerde bezorgvolgorde. Beide processen kunnen op andere blockchains voorkomen, afhankelijk van detectietijdstip en betalingsbeleid. Vereis geen processing-gebeurtenis vóór settled.

Eén keer afhandelen: ontvangervoorbeeld en bescherming tegen dubbele verwerking
AanpakHoe te verwerken
Gebeurtenisgestuurde ontvangerBewaar afzonderlijke gebeurtenissen op basis van de ondertekende event_id en selecteer daarna invoice.settled met status = settled. Gooi deze gebeurtenis niet weg omdat payment.received met dezelfde sequence eerder aankwam.
SDK-inbox voor bestelstatusDe meegeleverde PHP-, Python- en Node-ontvangervoorbeelden ontdubbelen op project + invoice_id + sequence. Verwerk de opgeslagen status ongeacht event_type, haal de huidige factuur op en handel één keer af als deze settled is. Voeg na deze ontdubbeling geen filter toe dat alleen invoice.settled accepteert.

Een nieuwe poging behoudt event_id en de oorspronkelijke body. Verschillende gebeurtenissen kunnen dezelfde sequence maar verschillende event_id-waarden hebben. Ontdubbel bezorgingen voor gebeurtenisgestuurde verwerking op ondertekende event_id; bescherm orderafhandeling daarnaast afzonderlijk op ingestelde installatie/project + invoice_id en je bestelling. Een latere hervoldoening mag de bestelling niet dubbel crediteren.

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.

Pseudocode, geen direct inzetbare ontvanger.

Alle factuurstatussen en betalingsuitzonderingen
VeldWaardenBetekenis
statusnew, processing, settled, expired, invalid, cancelledFactuurstatus bij het maken van de gebeurtenis; niet noodzakelijk de huidige status bij bezorging.
amount_statusnone, partial, paid, overpaidOntvangen bedrag, inclusief geaccepteerde tolerantie. paid betekent geen definitieve bevestiging.
timing_statuson_time, lateOf de betaling binnen de factuurdeadline viel.
resolutionautomatic, manually_settled, manually_invalidatedOf normale regels of een handmatige acceptatie/afwijzing het resultaat bepaalden.
requires_reviewfalse, trueAanwijzing voor een uitzondering, geen andere factuurstatus of automatische toestemming voor afhandeling/terugbetaling.
SituatieVerwerking
Onderbetaling / tolerantieVolgens automatische regels leidt partial niet tot voldoening. paid kan een geaccepteerd tekort bevatten, maar definitieve bevestiging blijft vereist. Gebruik de factuurstatus, niet alleen een bedragvergelijking.
Overbetalingoverpaid kan samengaan met settled en requires_review = true. Pas je beleid voor te hoge betalingen toe; crediteer de bestelling nooit dubbel en betaal nooit automatisch terug naar een ongeverifieerd adres.
Late betalingexpired kan later wijzigen zolang monitoring doorgaat. timing_status = late geeft aan dat beoordeling nodig is; heropen of verzend een geannuleerde bestelling niet automatisch.
Handmatige acceptatieinvoice.settled kan resolution = manually_settled hebben zonder kwalificerende blockchainmiddelen. Bepaal of je integratie deze handmatige beslissing accepteert; samenvattingsvelden voor de betaling kunnen null zijn.
Reorganisatie / ongeldigverklaringEen nieuwere revisie kan eerder betalingsbewijs ongeldig maken. Haal de huidige status opnieuw op en verwerk de terugdraaiing via afstemming. Negeer die niet omdat de bestelling ooit voldaan was.
Nul bevestigingen / nulbedragVoldoening met nul bevestigingen kan bij detectie plaatsvinden en brengt reorganisatierisico mee. Een expliciet toegestane factuur met nulbedrag wordt zonder betaling voldaan. Geen van beide vereist eerst een payment.received-gebeurtenis.

Gebruik status = settled voor orderafhandeling, niet amount_status = paid en geen afrekenomleiding. Bij nul vereiste bevestigingen kan voldoening bij detectie plaatsvinden; dat brengt reorganisatierisico mee.

Onderbetaald is amount_status = partial; overbetaald is overpaid. paid betekent dat het geaccepteerde minimum, inclusief de onderbetalingstolerantie van de factuur, is ontvangen. Dit zijn bedragstatussen, geen factuurstatussen. late is een timing_status, geen afzonderlijke gebeurtenis.

Een gebruikelijk verloop is new → processing → settled, maar tussenstappen kunnen worden overgeslagen. Een expliciet toegestane factuur met nulbedrag wordt zonder betaling voldaan en behoudt amount_status = none. Handmatige acceptatie wordt gemarkeerd als manually_settled.

Callbacks zijn onwijzigbare momentopnamen, geen live statusantwoorden. Ze kunnen laat, in een andere volgorde of meerdere keren aankomen. Betalings- en statusgebeurtenissen kunnen dezelfde factuur-sequence en factuurstatusvelden delen, maar hebben verschillende ondertekende event_id- en event_type-waarden. Het aantal bevestigingen levert niet gegarandeerd voor elk blok een callback op.

Wat je ontvangt

{
  "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 is het oorspronkelijke factuurtotaal. payment_info beschrijft waargenomen crypto-overschrijvingen, nog ontbrekende bedragen en vastgezette koersen. Versie 2 ondertekent ook de gebeurtenisnaam, gebeurtenis-ID en project-/winkelcontext.

Alle callbackvelden en aanvullende factuurgegevens
VeldTypeBetekenis
invoice_idUUIDPublieke factuur-UUID, gebruikt door de geauthenticeerde route voor factuurdetails
statusstringFactuurstatus in de momentopname: new, processing, settled, expired, invalid, cancelled
amount_statusstringnone, partial, paid of overpaid; paid omvat de geaccepteerde onderbetalingstolerantie, geen definitieve bevestiging
timing_statusstringon_time of late
resolutionstringautomatic, manually_settled of manually_invalidated
sequenceintegerOplopende factuurrevisie; verschillende gebeurtenissen kunnen één revisie delen. Vergelijk zonder precisie van gehele getallen te verliezen
amountdecimal stringOorspronkelijk factuurtotaal, niet het ontvangen cryptobedrag; behoud decimale precisie
currencystringValuta van amount, bijv. EUR voor een EUR-factuur betaald met USDC
order_idstring | nullBestelreferentie van de handelaar
payload_versioninteger2 voor nieuw gegenereerde 4.1.0+-gebeurtenissen; ontbreekt bij bewaarde oudere gebeurtenissen
event_idUUIDOndertekende gebeurtenisidentiteit, ongewijzigd bij nieuwe pogingen en handmatige herbezorging
event_typestringEén van de zeven abonnementsgebeurtenissen
occurred_attimestampWanneer deze onwijzigbare gebeurtenis werd gemaakt, niet de bezorgtijd
project_idUUIDProjectcontext van de handelaar; vergelijk met de ingestelde ontvanger
store_idUUIDWinkelcontext van de handelaar; vergelijk met de ingestelde ontvanger
descriptionstring | nullOorspronkelijke factuuromschrijving
emailstring | nullOptioneel e-mailadres van de klant bij het maken van de gebeurtenis
customerobjectHerkende optionele metadatavelden van de klant; geen geraden of verrijkte persoonsgegevens
metadataobjectOorspronkelijke handelaarsmetadata zoals die bestond bij het maken van de gebeurtenis
created_attimestampAanmaaktijd van de factuur
updated_attimestampTijd van bijwerken van de factuurstatus
expires_attimestampBetalingsdeadline van de factuur
monitoring_expires_attimestampDeadline voor controle op late betalingen
settled_attimestamp | nullTijdstip van voldoening
paid_chainstring | null4.1.2+: blockchain-slug van de bewezen betaalmethode waarmee de factuur is voldaan, bijv. ethereum; null zonder opgeslagen kwalificerende voldoening
paid_assetstring | null4.1.2+: tickersymbool van de eigen munt of token, bijv. BTC, ETH of USDC; een weergavelabel, geen unieke activa-identiteit
paid_asset_amountdecimal string | null5.0.1+: volledig vastgezet gevraagd bedrag in paid_asset-eenheden, vóór aftrek van tolerantie; opgeslagen bij voldoening
paid_asset_amount_receiveddecimal string | null5.0.1+: totaal geldig ontvangen bedrag voor de winnende methode bij voldoening, inclusief geaccepteerde tekorten/overschotten; vastgezet, geen live saldo
paid_payment_method_idUUID | null4.1.2+: ID van de betalingsintentie die tot voldoening leidde; komt overeen met payment_info.methods[].payment_method_id en het exacte netwerk/contract daarvan
settlement_exchange_rateobject | null4.1.2+: bij voldoening opgeslagen marktmomentopname vóór opslag, met expliciete eenheden, valuta, brontijdstempels en kwaliteitsmarkeringen; wordt bij bezorging nooit opnieuw geprijsd
cancelled_attimestamp | nullAnnuleringstijd
exchange_rate_spread_percentdecimal stringVastgezette opslag, niet de huidige winkelstandaard
underpayment_tolerance_percentdecimal stringVastgezette factuurtolerantie; elke methode vermeldt ook haar effectieve tolerantie
reason_codestring | nullMachineleesbare reden voor statusovergang
requires_reviewbooleanAanwijzing voor een betalingsuitzondering; geen toestemming voor automatische afhandeling of terugbetaling
linksobjectURL's voor afrekenen, geauthenticeerde factuur en betalingen bij het maken van de gebeurtenis. Domeinvoorkeuren onder Winkel → Basis gelden eerst, daarna de standaardwinkel en dan de globale primaire host; alleen actieve domeinen met de juiste rol worden gebruikt. Nieuwe pogingen behouden de oorspronkelijke ondertekende links; null als geen actief hostrecord bestaat.
payment_infoobjectWerkelijk waargenomen methoden, exacte bedragen, vastgezette prijsopgave, indicatieve marktmomentopname en begrensde betalingswaarnemingen; zie de veldgroepen hieronder

Samenvatting van voldoening: settlement_exchange_rate

VeldTypeBetekenis
rate / units / currency / symbolstringsEenheden van het actief per één eenheid factuurvaluta, vóór opslag. Decimale tekenreeks, geen betaalbedrag of uitgevoerde transactie.
observed_at / as_oftimestampsRegistratietijdstip van voldoening / oudere brontijdstempel. Behandel gecachte gegevens niet als een live koers.
pricing_provider / asset_provider / pricing_fetched_at / asset_fetched_atstrings / timestampsPrijsbronnen voor fiatgeld en activa en hun ophaaltijden, opgeslagen bij voldoening.
stale / is_fixed / uses_reference_proxy / reference_currencybooleans / stringDezelfde kwaliteitsmarkeringen als market_rate_at_event. Vaste projectprijzen worden aangeduid; referentievaluta is USD.
Missing snapshot or pricenullGeen geraden historische koers. Vóór voldoening zijn alle samenvattingsvelden null; als alleen prijzen ontbreken, blijven bewezen paid_*-identificaties beschikbaar.

Betaalmethoden: payment_info

VeldTypeBetekenis
active_payment_method_idUUID | nullWinnende of geselecteerde waargenomen methode. Null vóór detectie of na ongeldigverklaring; er wordt geen standaardmethode geraden.
method_count / methods_truncatedinteger / booleanTotaal aantal waargenomen methoden en of de ingesloten methodenlijst onvolledig is.
methods[]object[]Maximaal acht waargenomen methoden, met de actieve methode eerst. Geen totalen over verschillende activa.
payment_method_id / payment_railUUID / stringIdentiteit van de factuurintentie en onchain- of lightning-transport.
chain_slug / network / caip_network_idstringNetwerkidentiteit. Koppel tokenidentiteit altijd aan het netwerk.
asset_id / asset_key / caip_asset_idUUID / string / nullable stringGeverifieerde registeridentiteit; symbolen alleen zijn niet uniek.
asset_name / symbol / asset_kindstringWeergavenaam van het actief, tickersymbool en type native of token.
contract_address / token_standardstring | nullTokencontract of mint en standaard; null voor eigen munten.
asset_decimalsintegerAtomaire precisie; Lightning BTC gebruikt 11.
destination_address / destination_tagstring | nullPubliek ontvangstadres en vereist memo/tag. Adres is null voor Lightning; nooit een private sleutel.
statusstringMethodestatus: pending, partial, paid, overpaid, expired of invalid. Paid op zichzelf betekent niet dat de factuur is voldaan.
payment_count / payments_truncated / payments[]integer / boolean / object[]Totaal aantal waarnemingen en de laatste vijf of minder. Elke waarneming wordt hieronder beschreven.
links.paymentsHTTPS URL | nullGeauthenticeerde gepagineerde geschiedenis voor deze methode op de ingestelde API-oorsprong.

Exacte bedragen: methods[].amounts

VeldTypeBetekenis
expected_amountdecimal stringVolledige vastgezette prijsopgave, na opslag en afronding naar boven.
received_amount / confirmed_amountdecimal stringsGeldig gedetecteerd geld / geld dat voldoet aan het bevestigings- of finaliteitsbeleid van deze methode.
unconfirmed_amountdecimal stringmax(received - confirmed, 0). Geen extra bedrag om te versturen.
minimum_payment_amountdecimal stringGeaccepteerde drempel na tolerantie. Kan lager zijn dan de volledige prijsopgave.
remaining_amountdecimal stringmax(minimum accepted - received, 0). Extra geld dat nodig is om de geaccepteerde drempel te bereiken, geen bevestigingsvoortgang.
remaining_to_full_amountdecimal stringmax(full quote - received, 0), zonder rekening te houden met tolerantie.
overpaid_amountdecimal stringmax(received - full quote, 0). Geeft geen toestemming voor automatische terugbetaling.
Every amount's *_atomic companioninteger stringExacte weergave in de kleinste eenheid. Gebruik bibliotheken voor decimalen of gehele getallen; nooit float of JavaScript Number voor geld.

Bevestigingsbeleid: methods[].acceptance

VeldTypeBetekenis
finality_mode / required_confirmationsstring / integerVastgezet aantal bevestigingen of finalized-beleid. Nul bevestigingen is expliciet toegestaan door het handelaarsbeleid, geen universele netwerkfinaliteit.
observed_confirmationsinteger | nullMinimum over geldige waarnemingen, niet alleen de nieuwste overschrijving. Null voor Lightning of als er geen geldige waarnemingen zijn.
underpayment_tolerance_percentdecimal stringEffectieve tolerantie van de methode. Lightning gebruikt nul, ook wanneer de factuur een niet-nultolerantie voor blockchainbetalingen heeft.

Koersen: methods[].quote en market_rate_at_event

VeldTypeBetekenis
quote.effective_rate / units / currency / symbolstringsVastgezette asset_per_invoice_currency-koers inclusief opslag; valuta en symbool geven de richting expliciet aan.
quote.exchange_rate_spread_percent / quote_expires_atdecimal string / timestampVastgezette opslag en vervaltijd van de prijsopgave. Worden nooit vervangen door huidige winkelinstellingen.
quote.reference_rate / unrounded_payment_amount / rounding_adjustmentdecimal string | nullReferentie vóór opslag, betaalbedrag vóór afronding en verhoging door afronding in eenheden van het actief.
quote.pricing_provider / asset_provider / pricing_fetched_at / asset_fetched_atstring or timestamp | nullOorspronkelijke prijsbronnen/tijdstippen voor valuta en actief. Geen API-sleutels of providerinloggegevens.
quote.provenance_available / roundingboolean / stringFalse voor oude facturen zonder opgeslagen bronmomentopname; afronding is up.
market_rate_at_eventobject | nullIndicatieve gecachte marktmomentopname bij het maken van deze gebeurtenis. Ontbrekende gegevens blijven null; deze wijzigt factuurbedragen nooit en wacht niet op een netwerkopvraging.
market_rate_at_event.rate / units / currency / symbolstringsMarktkoers vóór opslag, met dezelfde expliciete richting als quote.
market_rate_at_event.observed_at / as_of / pricing_fetched_at / asset_fetched_attimestampsTijdstip van gebeurtenismomentopname / oudste van de twee brontijdstippen / elk brontijdstip.
market_rate_at_event.pricing_provider / asset_providerstringsGecachte valuta- en activabronnen, inclusief ingestelde prijzen voor eigen tokens.
market_rate_at_event.stale / is_fixed / uses_reference_proxy / reference_currencybooleans / stringOf de cache verouderd is, de tokenprijs vaststaat of de USD-referentie een stablecoin als benadering gebruikt. Referentievaluta is USD. Stale is indicatief, nooit een actuele prijsopgave.

Overschrijvingsrecords: methods[].payments[] en GET …/payments

VeldTypeBetekenis
payment_id / payment_method_idUUIDWaarnemingsidentiteit / identiteit van de bovenliggende intentie. Gebruik payment_id om geschiedenis te ontdubbelen.
transaction_id / payment_hash / event_indexstring | null / integerBlockchainhash en transfer-/log-/outputindex, of Lightning-hash. Lightning heeft geen transactie- of explorerlink.
payment_rail / chain_slug / network / asset_id / asset_key / caip_asset_id / symbol / asset_decimalsstrings / UUID / integerDezelfde activa- en netwerkidentificaties als de omvattende methode.
amount / amount_atomicdecimal / integer stringsDe exacte waarde van deze overschrijving, nooit een fiatconversie.
status / counts_towards_receivedstring / booleandetected, confirming en final tellen mee; reorged, replaced en invalid niet. Bewaar ongeldig verklaarde geschiedenis voor afstemming.
confirmations / block_heightinteger | nullBlokgegevens van de waarneming; confirmations is null voor Lightning.
observed_at / chain_time / finalized_attimestamp | nullLokaal voor het eerst gezien, vertrouwd blockchaintijdstip indien beschikbaar en tijdstip waarop het bevestigingsbeleid is bereikt, indien van toepassing.
explorer_name / explorer_urlstring | nullGevalideerde verwijzing naar een publieke blockexplorer, waar ondersteund.

Merchant 5.13.3 sluit geverifieerde interne gasfinancieringsoverschrijvingen uit van klantbetalingstotalen, payment_info, de factuurbetalingen-API, terugbetalingslimieten en payment.received-gebeurtenissen. Hun blockchain-/treasuryrecords blijven beschikbaar voor walletboekhouding. Gewone overschrijvingen en echte overbetalingen blijven meetellen. Bestaande ondertekende callbackbody's worden nooit herschreven. Als een historische voldoening afhankelijk was van interne financiering in plaats van klantgeld, geeft afstemming invoice.invalid af met reason_code internal_gas_funding_excluded; beoordeel deze in plaats van opnieuw af te handelen.

Merchant 4.1.0 voegt payload_version 2 toe zonder de oorspronkelijke negen velden te verplaatsen of wijzigen. Eerder in de wachtrij geplaatste gebeurtenissen behouden hun oorspronkelijke body en kunnen geen payload_version hebben. event_id, event_type en project-/winkel-ID's staan nu in de ondertekende body; transportheaders voor gebeurtenis/bezorging blijven ongetekend.

payment_info beschrijft waargenomen betalingen, niet elke aangeboden afrekenoptie. Vóór detectie is active_payment_method_id null en methods leeg. Waarnemingen met reorganisatie of ongeldigverklaring kunnen in methods blijven staan nadat de actieve methode null is geworden. Tel bedragen van verschillende activa of netwerken nooit bij elkaar op.

Alle bedragen, atomaire gehele getallen, koersen en percentages zijn tekenreeksen. received_amount omvat geldig geld dat nog op bevestiging wacht; confirmed_amount voldoet aan het finaliteitsbeleid van die methode. remaining_amount is max(minimum_payment_amount minus received_amount, 0); remaining_to_full_amount is max(expected_amount minus received_amount, 0). Voorbeeld: 100 USDC verwacht, 99 ontvangen en 1% tolerantie geeft remaining_amount 0 en remaining_to_full_amount 1. Definitieve bevestiging blijft vereist.

quote is de vastgezette factuurberekening: eenheden van het actief per één eenheid factuurvaluta. Opslag wordt vóór afronding naar boven toegepast. Gebruik expected_amount_atomic voor exacte betaalvergelijking; een weergegeven koers alleen reproduceert de afronding naar boven mogelijk niet. Oude facturen zonder opgeslagen bronherkomst tonen null voor bron-/referentie-/afrondingsvelden en provenance_available false, nooit gegevens van vandaag als historische prijsopgave.

market_rate_at_event is indicatieve gecachte data vóór opslag, vastgezet bij het maken van de gebeurtenis. Deze bevat brontijdstippen en markeringen voor veroudering en referentiebenadering; de waarde is null als er geen bruikbaar gecacht paar bestaat. Een live koersverzoek blokkeert nooit een melding en deze marktwaarneming wijzigt het verschuldigde bedrag nooit. Eigen tokens met vaste prijs zijn gemarkeerd met is_fixed; DEX-tokens gebruiken hun projectspecifieke bron, geen token met hetzelfde symbool.

De velden paid_chain, paid_asset, paid_payment_method_id en settlement_exchange_rate op het hoogste niveau (4.1.2+) identificeren na voldoening de bewezen winnende methode, geen geselecteerde afrekenoptie of som van verschillende methoden. Vóór voldoening, na ongeldigverklaring, bij oudere voldoeningen zonder momentopname of bij handmatige acceptatie zonder kwalificerende middelen die aan het bevestigingsbeleid voldoen, zijn de samenvattingsvelden null. Symbolen zijn weergavelabels: volg de methode-ID voor de exacte netwerk-/activa-/contractidentiteit.

Merchant 5.0.1 voegt paid_asset_amount en paid_asset_amount_received toe als exacte decimale tekenreeksen in paid_asset-eenheden; payload_version blijft 2. paid_asset_amount is de volledige vastgezette prijsopgave, inclusief opslag en afronding naar boven, nooit de tolerantiedrempel of een resterend saldo. paid_asset_amount_received is de totale geldige ontvangst van de winnende methode bij voldoening, inclusief geld dat op bevestiging wacht en eventuele geaccepteerde tekorten of overschotten. Voorbeeld: 100 USDC opgegeven, 99 ontvangen en geaccepteerd met tolerantie geeft 100 en 99, niet 99 en 99. Beide worden vastgezet bij de momentopname van voldoening; gebruik payment_info.methods[].amounts voor ontvangsten bij elke gebeurtenis of de betalingen-API voor actuele records. Ze zijn null zonder kwalificerende momentopname en bij momentopnamen van vóór 5.0.1; oude gebeurtenisbody's in de wachtrij blijven ongewijzigd. Zet exacte decimale tekenreeksen voor de boekhouding nooit om naar drijvendekommagetallen.

settlement_exchange_rate is de gecachte marktwaarneming vóór opslag, vastgelegd bij voldoening, niet de vastgezette factuurprijsopgave of een uitgevoerde beurstransactie. De structuur komt overeen met market_rate_at_event; 1.17 asset_per_invoice_currency met EUR/USDC betekent 1 EUR = 1.17 USDC. Brontijdstempels en stale-/fixed-/proxy-markeringen beschrijven de kwaliteit. Bij een ontbrekend paar blijft de koers null, maar een bewezen methode behoudt paid_*-velden. Deze wijzigt het verschuldigde bedrag nooit en wacht niet op een live provideraanroep. Latere betalingen met dezelfde methode, nieuwe pogingen en herbezorging kunnen de opgeslagen momentopname niet vervangen, ook niet een opgeslagen null-koers. Echte hervoldoening of een gewijzigde methode van voldoening legt een nieuwe momentopname vast; observed_at identificeert die vastlegging, terwijl settled_at het eerste voldoeningstijdstip kan behouden. Oude gebeurtenisbody's blijven ongewijzigd.

Er worden maximaal acht waargenomen methoden en de vijf recentste betalingswaarnemingen per methode opgenomen, met aantallen en afkapmarkeringen. Het payloadbudget kan die arrays verder verkleinen. Een betalingswaarneming is één overschrijving/log/UTXO-output, niet noodzakelijk een unieke transactiehash. Gebruik GET /v1/projects/YOUR_PROJECT_ID/invoices/{invoice_id}/payments met payment_method_id, limit en offset voor de volledige actuele geschiedenis. De factuurdetails behouden elke geoffreerde methode en de bijbehorende quote_details. API-links vereisen je ingestelde host en inloggegevens; stuur nooit een bearertoken door naar een willekeurige URL die via een callback wordt aangeleverd.

Lightning gebruikt payment_hash in plaats van transaction_id; ontvangstadres, explorer en waargenomen bevestigingen zijn null. Het exacte BTC-bedrag gebruikt 11 decimalen (millisatoshi's) en de effectieve tolerantie is nul. Er wordt geen BOLT11-betalingspreimage, walletsleutel, ondertekeningsgeheim of providerreferentie opgenomen. Klant-/metadatavelden horen alleen in handelaarsantwoorden en ondertekende callbacks, nooit in publiek afrekenen; zet geen inloggegevens in metadata.

Gepagineerde betaalgeschiedenis →

Veilig ontvangen

  1. Verifieer de exacte onbewerkte body met het bijbehorende geheim vóór verwerking. Winkel → IPN levert het IPN-geheim, ook voor bezorgingen naar een eigen ipn_url. Elk eindpunt onder Winkel → Webhooks heeft een eigen geheim. Geen van beide is je API-token; één vernieuwen vernieuwt de andere niet.
  2. Controleer de ondertekende tijdstempel (SDK-standaard: vijf minuten in beide richtingen) en vergelijk ondertekende project-/winkel-ID's, wanneer aanwezig, met je ontvangerconfiguratie. Plaats duurzaam in de wachtrij voordat je HTTP 2xx teruggeeft. Voor verwerking per gebeurtenis is event_id in v2 ondertekend; alleen header-ID's beschermen niet tegen herhaling omdat die headers niet ondertekend zijn. Ontdubbel voor bestelstatusinboxen op invoice_id en sequence en vergelijk de oorspronkelijke factuurstatusvelden, niet de volledige v2-body: verschillende gebeurtenistypen/-ID's kunnen één revisie delen.
  3. Haal in een worker de huidige factuur op vanaf je ingestelde API-oorsprong, niet via een willekeurige callbacklink. Vergelijk de opgeslagen bestelling, project/winkel, bedrag en valuta, vereis de huidige status settled en pas je beleid voor handmatige acceptatie en uitzonderingen toe. Vergrendel de bestelling en handel één keer af binnen een databasetransactie, onafhankelijk van gebeurtenisontdubbeling.
  4. Pas nooit een oudere sequence over een nieuwere toe. Verschillende gebeurtenissen kunnen een revisie delen; combineer ontdubbeling op revisieniveau niet met een filter voor alleen invoice.settled. Heropenen/afstemming kan de status wijzigen; sequence, niet een vaste statusrangorde, bepaalt de volgorde van updates. Registreer terugdraaiingen voor beoordeling in plaats van opnieuw af te handelen.

Ontvangervoorbeelden: PHP · Python · Node.js / TypeScript.

Handtekeningverificatie & bezorgregels
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);
}
BezorgregelDetails
HeadersWholly-Signature, Wholly-Event-Id en Wholly-Delivery-Id; Content-Type is application/json.
HandtekeningHMAC-SHA256 over <unix timestamp>.<exact raw body>; headerformaat t=<timestamp>,v1=<64 lowercase hex>.
SuccesElk HTTP 2xx-antwoord. Omleidingen worden niet gevolgd; niet-2xx-antwoorden gelden als mislukt.
Time-outsVerbindingstime-out van 5 seconden en totale verzoektime-out van 10 seconden.
Schema voor nieuwe pogingenMaximaal 8 pogingen voor fouten waarbij opnieuw proberen mogelijk is: onmiddellijk, daarna met vertragingen van 10s, 1m, 5m, 15m, 1h, 6h en 24h nadat de vorige poging is voltooid. IPN probeert automatisch opnieuw; automatisch opnieuw proberen voor webhooks kan per eindpunt worden uitgeschakeld.
Veiligheid van bestemmingenAlleen publieke HTTPS. DNS wordt opnieuw gevalideerd en vastgezet voor bezorging; lokale/private/gereserveerde bestemmingen worden afgewezen.
Bewaartermijn voor gebeurtenissenPayloads van meldingsgebeurtenissen en bezorggegevens worden volgens planning 90 dagen bewaard; bewaarde details worden in begrensde batches verwijderd.
OntdubbelingBewaar de ondertekende invoice_id en sequence binnen het ingestelde project. Wholly-Event-Id identificeert een gebeurtenis; Wholly-Delivery-Id identificeert een bezorgrecord (nieuwe pogingen hergebruiken dit; handmatige herbezorging maakt een ander record). Geen van beide ID-headers is ondertekend.
Naamgeving van gebeurtenissenVersie 2 ondertekent event_id en event_type in de body. Oudere gebeurtenissen in de wachtrij hebben geen van beide. Verschillende gebeurtenistypen kunnen een factuur-sequence delen; stem factuurstatus per revisie af of ontdubbel afzonderlijke gebeurtenissen op ondertekende event_id.
Geheimen vernieuwenVernieuwing heeft geen overlap of versieheader en wijzigt onmiddellijk handtekeningen voor bezorgingen in de wachtrij, nieuwe pogingen en handmatige bezorgingen.
Gepauzeerde bezorgingenOnvoldoende verwerkingstegoed pauzeert IPN/webhooks, inclusief nieuwe pogingen. Inkomende betalingen gaan door; meldingen in de wachtrij worden na opwaarderen hervat binnen hun payloadbewaartermijn.

AI-assistenten · MCP

Verbind een assistent met je handelaarsinstallatie.

Merchant 5.0.0 bevat een optionele MCP-server op je ingestelde API-domein. Deze draait binnen je installatie, niet via een gedeelde Wholly Crypto-relay.

  1. Open Instellingen → API-toegang. Maak een afzonderlijke API-referentie, wijs alleen de projecten toe die de assistent nodig heeft en begin met alleen-lezen toegang. Bij een door een operator gehost account schakelt de operator eerst de MCP-service van de installatie in; jij beheert alleen je eigen API-referenties en toestemmingen.
  2. Schakel onder AI-verbindingen · MCP MCP in, selecteer de API-referentie en sla de MCP-toegang op. Bestaande API-referenties hebben pas MCP-toegang nadat die expliciet is ingeschakeld.
  3. Kopieer de MCP-server-URL naar de instellingen voor externe HTTP-servers van je client. Log met OAuth in op je handelaarsconsole, controleer de clientnaam en het terugkeeradres, kies een API-referentie en geef toestemming. Je bestaande Basic Auth- en TOTP-beveiliging blijven gelden.
  4. Factuuraanmaak vereist daarnaast een API-referentie met lees-/schrijfrechten, Lezen + facturen maken in het MCP-beleid, het OAuth-bereik mcp:invoice:create en expliciete toestemming. Een OAuth-verbinding krijgt nooit toegang tot projecten die na de goedkeuring aan een API-referentie worden toegevoegd.
{
  "mcpServers": {
    "whollycrypto": {
      "url": "https://api.example.com/mcp"
    }
  }
}

MCP-installatiehandleiding →

HulpmiddelToegangDoel
list_projectsLeesIngeschakelde projecten die aan de verbinding zijn toegewezen; paginering met limit/offset.
list_storesLeesWinkels, ID's en ingeschakelde status binnen project_id; paginering met limit/offset.
list_payment_methodsLeesIngestelde blockchain-, token- en Lightning-methoden voor project_id + store_id.
get_wallet_balancesLeesOntvangstadressen en gecachte saldi, met velden voor actualiteit/beschikbaarheid; nooit walletgeheimen.
list_invoicesLeesProjectfacturen, gefilterd op winkel, status of zoekterm; paginering met limit/offset.
get_invoiceLeesVolledige factuurdetails en afrekenlink met project_id + invoice_id.
get_delivery_historyLeesIPN-/webhookstatussen van de winkel, pogingen en HTTP-resultaten. Optionele filters invoice_id/kind; geen geheimen of callbackbody's.
convert_amountLeesGecachte referentieomrekening met from, to en een decimale tekenreeks voor amount; geen factuurprijsopgave.
create_invoiceExpliciet schrijvenproject_id, store_id, idempotency_key en invoice (de bestaande body voor factuuraanmaak). invoice.payment_methods filtert ingeschakelde winkelmethoden; 5.4.0+ negeert inactieve/niet-geaccepteerde keuzes en valt terug op winkelstandaarden als niets overeenkomt. Alleen een blockchain kiezen selecteert alle actieve geaccepteerde activa. Tot een blockchain beperkte asset_tickers worden vanaf 5.3.0 ondersteund. Geeft het normale factuurantwoord terug.
Protocol, OAuth & veiligheid

Gebruik Streamable HTTP via HTTPS. Onderhandel over een geadverteerde protocolversie en voeg MCP-Protocol-Version toe aan volgende POST-verzoeken. Verstuur Content-Type: application/json en Accept: application/json, text/event-stream. Antwoorden zijn eindige JSON; opnieuw verbinden vereist geen MCP-sessie-ID.

OAuth gebruikt kortlevende toegangstokens (15 minuten), eenmalige S256 PKCE-codes (5 minuten) en roterende vernieuwingstokens (verbindingsduur 30 dagen). Een al gebruikt vernieuwingstoken opnieuw gebruiken trekt die verbinding in. Verbind opnieuw na verloop, vernieuwing van API-referenties, beleidswijzigingen of een wijziging van het canonieke API-domein.

OAuth-discovery is alleen publiek als MCP is ingeschakeld. De resource-parameter moet gelijk zijn aan de canonieke URL die discovery teruggeeft, inclusief /mcp. Dynamische registratie wordt ondersteund; externe metadata-documenten voor client-ID's en clientgeheimen niet.

Voor clients die eigen Authorization-headers ondersteunen, kan in plaats daarvan een handelaars-API-token met ingeschakelde MCP als Bearer worden gebruikt. Dit behoudt zijn afzonderlijke REST-rechten; gebruik bij voorkeur OAuth voor een verbinding die tot MCP is beperkt. Plak inloggegevens nooit in chat, URL's, hulpmiddelargumenten of versiebeheer.

MCP deelt het REST-quotum per minuut en de exacte bron-IP-beperkingen van de API-referentie, plus de IP-beperkingen van de API-host. OAuth omzeilt geen toelatingslijst. Sta voor externe AI-clients hun gedocumenteerde uitgaande IP-adressen toe of laat deze beperking bewust uit. Pas geen webbeveiligingschallenge of caching toe op MCP-/OAuth-routes.

HTTP-fouten: 401 vereist authenticatie, 403 weigert oorsprong/IP/rechten, 404 betekent dat MCP uitstaat of de verkeerde host wordt gebruikt, 405 betekent dat je POST moet gebruiken, 413 duidt op de bodylimiet van 32 KiB en 429 bevat Retry-After. JSON-RPC-fouten gebruiken error.code; fouten op hulpmiddelniveau gebruiken result.isError=true, ook met HTTP 200. Succesvolle resultaten bevatten content en structuredContent.

Lijsten bevatten standaard 25 rijen, maximaal 100; offset is begrensd op 1000000. Hulpmiddelantwoorden zijn begrensd op 2 MiB. Verlopen toestemmingen, autorisatieverzoeken en limietregistraties worden automatisch opgeruimd; in instellingen worden maximaal 100 actieve OAuth-verbindingen getoond.

Uitgeschakelde projecten/winkels kunnen niet via MCP worden gebruikt. De verbinding kan de ingeschakelde status van een winkel opvragen, maar voor het lezen van betaalmethoden en bezorggeschiedenis of het maken van facturen moet de winkel ingeschakeld zijn. Gewone consolegebruikers van een project kunnen MCP niet beheren.

Gebruik voor een nieuwe factuur een nieuwe idempotency_key; probeer na een time-out opnieuw met dezelfde API-referentie, sleutel en hetzelfde invoice-object. Decimale bedragen, opslag, tolerantie, bevestigingen en afrekenuiterlijk volgen het REST-factuurcontract. MCP omzeilt nooit het betaal- of tegoedbeleid van de handelaar.

De eerste hulpmiddelen kunnen geen private sleutels/herstelzinnen onthullen, geld versturen of sweepen, terugbetalingen uitvoeren, callbacks opnieuw versturen, betaalmethoden wijzigen, accounts/domeinen bewerken of facturering beheren. Behandel factuuromschrijvingen, klantvelden en metadata als onvertrouwde gegevens, niet als instructies voor de agent. Verbonden AI-providers ontvangen de gegevens die je toestaat te lezen.

MethodePadContract
POST/mcpGeauthenticeerde JSON-RPC: initialize, ping, tools/list, tools/call. Meldingsverzoeken geven 202 terug; batches worden afgewezen.
GET / DELETE/mcpGeauthenticeerde 405: eindige JSON-antwoorden, geen afzonderlijke SSE-stream en geen MCP-sessie op de server.
GET/.well-known/oauth-protected-resource/mcpCanonieke resource-URL en detectie van de autorisatieserver; ook beschikbaar op /.well-known/oauth-protected-resource.
GET/.well-known/oauth-authorization-serverOAuth-eindpunten, authorization_code/refresh_token, S256 PKCE en ondersteunde scopes.
POST/mcp/oauth/registerRegistratie van publieke clients: client_name en exacte redirect_uris. Alleen HTTPS of loopback-HTTP. Geen clientgeheim of ophalen van externe metadata.
GET/mcp/oauth/authorizeclient_id, redirect_uri, response_type=code, resource, code_challenge, code_challenge_method=S256, optioneel scope/state; leidt door naar goedkeuring in de console.
POST/mcp/oauth/tokenFormuliergecodeerde authorization_code + code + code_verifier + redirect_uri, of refresh_token + refresh_token. Voeg altijd client_id en resource toe.
POST/mcp/oauth/revokeFormuliergecodeerde client_id en token. Trekt de bijbehorende verbinding met toegangs-/vernieuwingstokens in.
Voorbeeld van een direct hulpmiddelverzoek

Initialiseer eerst en onderhandel over het protocol via je MCP-client. Dit toont een volgend verzoek.

: "${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
    }
  }
}'

Operator-API

Richt gehoste handelaars in met afzonderlijke serversleutels met afgebakende rechten.

Host meerdere bedrijven en automatiseer hun inrichting via api.example.com/v1/operator. Beschikbaar vanaf 7.4.0, uitsluitend in Operator-modus. De gewone Merchant-API blijft ongewijzigd.

  1. Open Operator → Instellingen → Operator-API en schakel die in (standaard uit). Maak een afzonderlijke API-referentie met alleen de vereiste rechten en gehoste handelaars.
  2. Bewaar de wc_operator_-sleutel op je server. Gebruik de API-hostnaam, niet de hostnaam van het Operator-paneel of een handelaarssleutel.
  3. Sla vóór elke Operator-POST een Idempotency-Key en de exacte requestbody duurzaam op. Lees na een onzeker resultaat het account terug; vervang de sleutel nooit alleen om opnieuw te proberen.
  4. Maak een handelaar met onboarding: direct en een wachtwoord, of onboarding: invitation zonder wachtwoord. Maak daarna projecten/winkels en geef een tot het project beperkte handelaarssleutel uit voor de afrekenintegratie.
BereikToegang
merchants.read / merchants.writeGehoste handelaars opvragen/lezen en maken/bijwerken.
users.read / users.write / users.securityGebruikers lezen/maken/bijwerken; afzonderlijk wachtwoorden wijzigen of sessies intrekken. Maakt nooit een operatorbeheerder.
invitations.read / invitations.writeEenmalige uitnodigings-/herstellinks opvragen/lezen, maken, vervangen en intrekken. Nieuwe gebruikers vereisen ook users.write; herstel vereist ook users.security.
credits.read / credits.write / fees.writeSaldi/grootboek lezen; lokaal tegoed toekennen of corrigeren; toekomstige tarieven instellen. Niet-nul starttegoed vereist credits.write.
topups.read / topups.writeAfrekenverzoeken voor tegoed van gehoste handelaars lezen of maken. Geen API-actie kan er één als betaald markeren.
projects.read / projects.write / reports.readProjecten, winkels, uiterlijk en betaalinstellingen van handelaars inrichten; facturen, walletsaldi en financiële rapporten lezen.
merchant_credentials.read / merchant_credentials.writeGewone afgebakende handelaarssleutels beheren. Krachtig: die sleutels handelen na uitgifte onafhankelijk.
events.read / webhooks.write / audit.read / health.readLevenscyclusgeschiedenis lezen; ondertekende levenscycluscallbacks instellen; audit/mogelijkheden/nodestatus lezen.
Aansluiting, tegoed, rechten en veilig opnieuw proberen
OnderwerpRegel
API-referentiesOptionele vervaldatum en exacte IPv4-/IPv6-toelatingslijst; standaard 60 verzoeken/minuut, instelbaar van 1–600. Elk verzoek controleert de uitgevende beheerder en de huidige scopes. HTTP 429 bevat Retry-After.
ScheidingSleutels hebben alleen toegang tot hun toegewezen gehoste handelaars. Handelaars maken en rapporten voor de hele installatie bekijken vereisen toegang tot alle handelaars. Het eigen bedrijf van de operator is uitgesloten.
Eerste aanmeldingDirect aangemaakte accounts erkennen dat de host toegang heeft tot hun walletsleutels. require_password_change voegt een wachtwoordwijziging bij de eerste aanmelding toe. Een uitnodiging accepteren vereist expliciete erkenning van het sleutelbeheer, gevolgd door normaal aanmelden. Basic Auth en bestaande TOTP blijven van kracht.
UitnodigingenLinks voor nieuwe gebruikers zijn 48 uur geldig; wachtwoordherstellinks één uur. Tokens werken één keer. Opnieuw uitgeven trekt de oude link in. Acceptatie door SMTP garandeert geen bezorging in de inbox; bekijk email_delivery.
Veilig opnieuw proberenElke Operator-POST vereist een sleutel van 16–128 tekens (letters, cijfers, -, _ of .). Dezelfde sleutel en exacte URL/body geven het opgeslagen resultaat terug. Andere bytes geven 409 terug. Geheimen/links worden bij herhaling weggelaten; vernieuw of geef ze zo nodig opnieuw uit via een nieuwe expliciete actie.
Onzekere resultatenoperator_request_in_progress betekent dat een actie loopt of werd onderbroken voordat het resultaatbewijs was opgeslagen. Bekijk de resource en audit; dien niet blind een nieuwe sleutel in. Voltooide resultaatbewijzen worden na 30 dagen compact opgeslagen; oude sleutels kunnen nog steeds niet opnieuw worden uitgevoerd.
Tegoed en kostenDecimale tekenreeksen, maximaal zes decimalen. starting_credit is een eenmalige lokale toekenning. Aanpassingen vereisen een bedrag met teken, notitie en request_id, plus de HTTP-sleutel voor nieuwe pogingen. fee_bps=100 betekent 1%; wijzigingen gelden voor toekomstige facturen. Toekenningen vullen het eigen vooruitbetaalde saldo van de installatie niet aan.
Pauzerenenabled=false schakelt een gehost account uit en trekt consolesessies in. payments_paused=true stopt nieuwe facturen. Bestaande betalingsmonitoring gaat door. Project-/winkelaanmaak en automatisering behouden het tegoedbeleid van de installatie.
Niet beschikbaar via de APIGeen walletgeheimen, ondertekening, verzenden, terugbetalingen, definitieve verwijdering, TOTP-reset, domeinwijzigingen of serverconfiguratie. Gewone factuurverzoeken blijven een handelaarssleutel en de Merchant-API gebruiken.

Operator-levenscycluswebhooks

GebeurtenisGegevens
merchant.created / merchant.updatedmerchant_id, enabled, payments_paused, fee_bps.
user.created / user.updatedmerchant_id, user_id, enabled. De updategebeurtenis omvat wijzigingen van e-mailadres, ingeschakelde status en beheerdersrol.
invitation.accepted / password_reset.completedmerchant_id, user_id, invitation_id.
topup.settled / credit.balance_changedmerchant_id, ledger_id, kind, amount en balance. Lees bij afstemming de tegoedvaluta van de handelaar of de grootboekdetails.

Operator-levenscyclusgebeurtenissen staan los van factuur-IPN/winkelwebhooks. Een abonnement hoort bij de Operator-API-referentie die het heeft gemaakt, met maximaal 10 eindpunten per sleutel. Alleen toekomstige overeenkomende gebeurtenissen worden in de wachtrij geplaatst; gebruik GET /events voor bewaarde geschiedenis.

De body bevat event_id, event_type, merchant_id, occurred_at en data. Verifieer Wholly-Signature op de exacte onbewerkte body met de eenmalig getoonde signing_secret van het eindpunt: HMAC-SHA256(secret, timestamp + '.' + raw_body), header t=...,v1=.... Hanteer een korte tijdstempeltolerantie.

Gebruik de algemene handtekeningverificatie van de SDK, niet de parser voor factuurmeldingen. Valideer daarna merchant_id en event_type, sla event_id binnen een transactie op en ontdubbel erop, en geef pas na duurzame acceptatie 2xx terug. Wholly-Event-Id moet overeenkomen met de ondertekende body. Behandel niet-ondertekende headers niet als bedrijfsgegevens.

Bezorging vindt minstens één keer plaats, kan buiten volgorde aankomen en wordt maximaal 8 keer geprobeerd. Lees huidige resources om af te stemmen; occurred_at is geen monotoon oplopende sequence. Bereik en instellingen voor ingeschakeld/verval worden vóór bezorging opnieuw gecontroleerd. Uitgeschakelde abonnementen pauzeren bestaand werk in de wachtrij, maar zetten tijdens uitschakeling geen nieuwe gebeurtenissen in de wachtrij.

Gebeurtenissen en bezorggeschiedenis worden 30 dagen bewaard. Het automatiseringsbeleid van de installatie kan bezorging pauzeren. GET /webhooks/{id}/deliveries toont het resultaat en de onwijzigbare payload; de publieke API bezorgt een verlopen record niet geforceerd.

{
  "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
  }
}

Een handelaar maken → · Een uitnodiging accepteren →

Marketplace-API

Eén afrekenpagina met beschermde verkopersaandelen en gecontroleerde uitbetalingen.

Eén klantfactuur, exacte verkopersaandelen en gecontroleerde uitbetalingen in hetzelfde actief. Schakel per project in. Versie 8.0.0 ondersteunt Bitcoin-mainnet en ingestelde ondersteunde EVM-eigen munten / standaard ERC-20-tokens, niet alle ontvangstnetwerken.

  1. Schakel Marketplace in het project in, kies deelnemende winkels en houd uitbetalingen gepauzeerd tijdens de configuratie.
  2. Registreer verkopers en verifieer hun uitbetalingsadressen onafhankelijk. Nieuwe bestemmingen zijn in afwachting; goedkeuring vereist destinations.approve.
  3. Maak een afzonderlijke Marketplace-API-referentie onder Instellingen → API-toegang. Gewone Merchant-, Operator- en MCP-referenties kunnen geen Marketplace-geld besteden.
  4. Maak een factuur met 1–100 positieve toewijzingen als decimale tekenreeksen, waarvan de som exact gelijk is aan het factuurbedrag. Elke verkoper heeft een goedgekeurde bestemming nodig op een gemeenschappelijk ondersteund winkelnetwerk.
  5. Wacht op geverifieerde beschikbaarheid van toewijzingen. Bereid een uitbetaling voor, lees de onwijzigbare ontvangers en kostenlimieten en keur vervolgens de revisie en exacte plan_hash goed. Vraag de uitbetalingsstatus op of verifieer ondertekende gebeurtenissen.
OnderwerpRegel
BewaringKlantgeld komt eerst in wallets onder beheer van het project. De eigenaar van de marktplaats/server beheert die sleutels totdat verkopers zijn betaald. Dit is geen directe betaling van klant aan verkoper, escrow of aanmeldsysteem voor verkopers.
Drie verkopersEen factuur van 300 USD met drie aandelen van 100 USD en 4% commissie wijst aan elke verkoper de tegenwaarde van 96 USD in de geoffreerde crypto toe en behoudt de tegenwaarde van 12 USD als brutocommissie. Het plan garandeert atomaire crypto-eenheden, geen toekomstige fiatwaarde.
KostenDe bestaande verwerkingsvergoeding geldt één keer voor het oorspronkelijke voldane factuurbedrag/de factuurvaluta. Bij een ingesteld tarief van 1% is dat 3 USD aan vooruitbetaald tegoed, waardoor vóór blockchainkosten een commissie ter waarde van 9 USD overblijft. Uitbetalingen aan verkopers veroorzaken geen extra verkoopkosten voor klantverkopen.
ToewijzingToewijzing volgens de grootste rest bewaart elke atomaire eenheid. Commissie wordt naar beneden afgerond; het verkopersnetto is de rest. Afwijkende instellingen per toewijzing, factuur en verkoper en winkel-/projectstandaarden worden vastgelegd in een momentopname. Bij uitbetaling wordt geen nieuwe wisselkoers toegepast.
Beschermd geldGewone verzendingen, sweeps, beursstortingen en automatische tegoedopwaarderingen sluiten Marketplace-ontvangstadressen uit. Netwerkkosten en tokengas vereisen afzonderlijke vrij beschikbare eigen munten. Gecachte walletwaarden zijn indicatief; onafhankelijke actuele dekking wordt vóór ondertekening gecontroleerd.
Definitieve bevestigingEen positieve blockchainondergrens en twee onafhankelijke compatibele providers zijn vereist voor bewijs van Marketplace-uitbetaling, ook als afrekenen nul bevestigingen of één scanner accepteert. Providerwachttijden stellen betalingsverificatie/uitbetaling uit, niet het maken van verder geldige facturen.
UitzonderingenOnderbetalingen die volgens de gewone afrekentolerantie worden geaccepteerd, worden vastgehouden en niet oververdeeld. Een bevoegde vrijgave kan een exact kleinere, volledig gedekte verdeling goedkeuren. Overbetaling alleen blokkeert de geoffreerde verkopersverdeling nooit bij BTC of ondersteunde EVM-eigen munten/ERC-20-methoden. Het overschot blijft afzonderlijk vastgehouden. Bitcoin stuurt beschermd wisselgeld terug naar het factuuradres; afzonderlijke projectmiddelen dekken kosten en eventuele aanvulling tot de dust-ondergrens. Gemengde methoden, late/onduidelijke/gereorganiseerde betalingen en ontbrekende dekking vereisen beoordeling.
TerugbetalingenBereid een volledige terugbetaling in hetzelfde actief voor van één ondubbelzinnige bevestigde ontvangstmethode en keur die daarna afzonderlijk als uitbetaling goed. Onbetaalde toewijzingen en commissie worden teruggedraaid. Zodra alle verkopers zijn betaald, moet je het primaire walletadres afzonderlijk financieren; er is geen terugvordering. Gedeeltelijke verkopersbatches en terugbetalingen met gemengde activa vereisen eerst afstemming. Terugbetalingen van deelbedragen en commissieopnames zijn niet beschikbaar in 8.0.0.
Nieuwe pogingenElke POST vereist een duurzaam opgeslagen Idempotency-Key van 16–128 tekens (letters, cijfers, -, _ of .). Hergebruik na een time-out dezelfde sleutel en JSON-instructies. Andere instructies geven 409 terug. Voltooide antwoorden worden 30 dagen bewaard; oude sleutels worden blijvend gemarkeerd als niet herbruikbaar. Wijzig een sleutel nooit alleen om een onzeker resultaat te omzeilen.
RevisiesWijzigbare records vereisen hun huidige revision. Goedkeuren/hervatten vereist ook expected_plan_hash en confirm:true. Voorbereiding reserveert geld gedurende 15 minuten; goedkeuring geeft één uur. Verlopen niet-ondertekend werk wordt veilig vrijgegeven. Ondertekende/onzekere overschrijvingen behouden hun identiteiten en reserveringen.
Automatische uitbetalingenStandaard uit. Beleid per actief autoriseert goedgekeurde bestemmingen, een positief minimum, limieten voor hoofdsom per uitbetaling/voortschrijdende 24 uur en voor kosten/gas in de eigen munt, interval en bevestigingen. Toestemming wijzigen/intrekken stopt niet-verzonden werk; waarneming gaat door. Limieten omvatten gereserveerde en onzekere plannen. Beleid dat wegens facturering is gepauzeerd, wordt eerlijk opnieuw ingepland. Een ongeldige factuur wordt vastgehouden voor beoordeling zonder andere geschikte factuurgroepen te blokkeren.
Pauzeren en herstellenEen laag tegoed en veiligheidscontroles voor overschrijvingen blijven bestedingen pauzeren. Monitoring en grootboekafstemming gaan door. Hervatten beoordeelt hetzelfde bewaarde plan. Een canonieke EVM-revert die door twee onafhankelijke providers is bewezen, kan na expliciete goedkeuring binnen het resterende kostenbudget worden vervangen; oorspronkelijke hashes en kosten blijven geregistreerd. Onbekende resultaten of afwijkende tokenlevering blijven vastgehouden. Maak een back-up van de volledige database en sleutels; stem na herstel ingediende hashes af voordat je uitbetalingen toestaat.
Identificaties en pagineringGebruik de project-UUID uit Projectinstellingen en de winkel-UUID uit Winkels → Basis → API-ID's. Verkopers-/uitbetalings-/activa-ID's worden door deze API teruggegeven. invoice_id is de publieke factuur-UUID. Gepagineerde resources geven data en pagination {page,per_page,total,pages} terug; standaard 1/25, maximaal 100 rijen. Exacte geldwaarden zijn tekenreeksen.
Bereik van API-referentiesSleutels hebben projectlijsten, optionele beperkingen voor factuurwinkels, een vervaldatum, IP-toelatingslijst en een quotum van 1–600/minuut (standaard 60). HTTP 429 bevat Retry-After. Sleutels die tot winkels zijn beperkt, kunnen geen verkopers, projectsaldi, grootboek, uitbetalingen of instellingen zien. Bewaar bestedingsreferenties uitsluitend op vertrouwde servers, nooit in browsers of uitgeleverde mobiele apps.

Marketplace-rechten

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

Toewijzingsstatussen

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

Uitbetalingsstatussen

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

Marketplace-gebeurtenissen

Afzonderlijk Marketplace-ondertekeningsgeheim, met dezelfde Wholly-handtekeningheaders en hetzelfde HMAC-verificatiealgoritme voor de onbewerkte body als factuurcallbacks. Verifieer tijdstempel/handtekening, ontdubbel op event_id en geef snel 2xx terug. Bezorging vindt minstens één keer plaats, met maximaal acht pogingen; via de geschiedenis kan dezelfde gebeurtenis opnieuw worden bezorgd. Wijzigingen aan een eindpunt annuleren oude niet-verzonden bezorgingen in plaats van klantgegevens om te leiden. Factuurvoldoening betekent niet dat verkopersuitbetaling is voltooid. Verstuur nooit geld uitsluitend omdat een externe callback dat opdraagt.

  • 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"
      }
    ]
  }
}

Betalingen voor meerdere verkopers instellen · Een Marketplace-factuur maken

Fouten & limieten

Verwerk validatie, quota en nieuwe pogingen voorspelbaar.

Controleer HTTP-status en Content-Type voordat je een antwoord verwerkt. Wacht bij een 429minstens de Retry-After duur voordat je opnieuw probeert.

LimietDetails
VerzoekfrequentieQuotum per API-referentie: standaard 120 verzoeken per UTC-minuut, instelbaar van 1 tot 6000 onder Instellingen → API. Alle geauthenticeerde v1-lees- en schrijfacties, inclusief idempotente nieuwe pogingen en autorisatie-/validatiefouten na authenticatie, delen het budget over domeinen, projecten en processen. Ongeldige API-referenties, consoleroutes en publiek afrekenen verbruiken dit niet.
Headers voor aanvraaglimietenGeauthenticeerde v1-antwoorden bevatten X-RateLimit-Limit, X-RateLimit-Remaining en X-RateLimit-Reset (Unix-seconden op de grens van de volgende UTC-minuut). Te veel verzoeken geven JSON 429 rate_limit_exceeded en Retry-After in gehele seconden terug. Wacht minstens zo lang en voeg willekeurige spreiding aan nieuwe pogingen toe. Vaste vensters staan pieken rond minuutgrenzen toe; dit is geen garantie voor verzoeken per seconde.
HandelaarsbodyMaximaal 32 KiB bij de applicatierouter. De randserver kan een te groot verzoek afwijzen voordat een JSON-foutomhulsel wordt gemaakt.
Factuurlijstlimit is standaard 50 en accepteert 1–100; offset accepteert 0–1,000,000. Een zoekterm is maximaal 100 tekens. Resultaten staan van nieuw naar oud en bevatten total/has_more-metadata.
WinkelmethodenMaximaal 64 activakeuzes per winkel, genoeg voor alle 30 eigen blockchains plus de begrensde catalogus van geverifieerde tokens. Projectbeleid, scannermogelijkheden en een gereedstaande blockchainwallet met back-up blijven voorwaarden voor factuuraanmaak.
TokendetectieDe kandidaatlimiet is standaard 50 en accepteert 1–100. Ontdekte resultaten zijn pas betaalactiva als verificatie op de blockchain slaagt.
Geregistreerde projecttokensMaximaal 20 blijvende tokenactiva per project. Al geregistreerde activa kunnen worden hergebruikt zonder een extra plek te verbruiken.
IdempotentieVereist voor factuuraanmaak. 1–128 zichtbare ASCII-tekens zonder spaties; sleutels zijn uniek per winkel en herhaling moet de oorspronkelijke API-referentie en exacte onbewerkte body gebruiken.
MetadataAlleen een JSON-object, maximaal 4,096 gecodeerde bytes en vijf nestingsniveaus.
CallbacksPublieke HTTPS-URL tot 2,048 bytes. Bodies van meldingsverzoeken zijn begrensd op 256 KiB; bewaarde payloads van factuurgebeurtenissen zijn begrensd op 64 KiB met begrensde betalingsgeschiedenissen.
AfrekenbestandenQR-SVG-antwoorden zijn private en no-store omdat een onderbetaling het exacte resterende bedrag wijzigt. PNG-logo's met revisie worden één jaar publiek gecacht en zijn onwijzigbaar.
API-randserverBeheerde upstream-API-verzoeken hebben een leestime-out van 30 seconden. Ontwerp clients met expliciete time-outs die korter zijn dan hun taakbudget.
Fouten buiten JSONOngeldige UUID-/queryverwerking, verkeerde methoden en de lengtegrens van 32 KiB kunnen frameworktekst of lege antwoorden teruggeven. Onbekende /v1-paden geven momenteel 404-console-HTML terug; valideer status en Content-Type vóór verwerking.

Foutreferentie

HTTPFoutcodeBetekenis
400invalid_reconciliation_actionEen uitzonderingsstatus, reden, zoekterm of filter voor een geschiedenispagina is ongeldig.
500reconciliation_unavailableDe uitzonderingswachtrij of het bewijs kon niet worden geladen. Probeer de leesactie opnieuw met oplopende wachttijd.
402billing_requiredEen geverifieerd gekoppeld tegoedaccount en actuele autorisatie zijn vereist voor elke nieuwe factuur. Onvoldoende vooruitbetaald tegoed blokkeert aanmaak of inkomende betalingen niet: IPN, webhooks en Sweep worden in plaats daarvan gepauzeerd, terwijl kosten blijven oplopen. Aanmaak blijft geblokkeerd bij geschorste accounts, verlopen/ongeldige factureringsverificatie, een onbereikbare tegoeddienst of een niet-toegestane fiatbasis van de factuur. Kosten gebruiken het oorspronkelijke fiatbedrag van de factuur, niet de ontvangen crypto, opslag, overbetaling of netwerkkosten. Dat bedrag en de onafhankelijke omrekening worden geregistreerd voordat de afrekenpagina wordt gemaakt. Bestaande monitoring en het ophalen van facturen gaan door tijdens storingen. Na opwaarderen worden meldingen in de wachtrij binnen hun normale payloadbewaartermijn hervat en ingeschakelde sweepregels hervat. Controleer Instellingen → Kosten en probeer mislukte aanmaak opnieuw met dezelfde Idempotency-Key.
400invalid_jsonOngeldige JSON, een onbekend veld of een body die niet overeenkomt met het gedocumenteerde verzoek.
400idempotency_key_requiredBij factuuraanmaak ontbreekt Idempotency-Key.
400invalid_idempotency_keyDe sleutel is leeg, langer dan 128 bytes, niet-ASCII, bevat witruimte of een stuurbyte.
400invalid_payment_requestEen gevalideerd veld of geselecteerde actieve methode is mislukt. Lees error.message en error.details.payment_methods (PaymentMethodIssue[]) voor de exacte blokkade. SDK 2.4.0+ voegt veilige, bruikbare uitzonderingssamenvattingen en hulpmiddelen voor problemen toe; oudere PHP-SDK's bieden getApiMessage().
400invalid_invoice_statusDe lijststatus valt buiten de zes gedocumenteerde factuurstatussen.
400invalid_callback_urlDe effectieve IPN-bestemming is afgewezen bij HTTPS-, publiek-adres-, DNS- of SSRF-validatie.
400invalid_wallet_requestInvoer voor het voorbereiden van een wallet/adres is ongeldig.
400invalid_token_assetTokenblockchain, kandidaatquery, CoinGecko-identiteit, catalogusmetadata of contract-/mintinvoer is ongeldig.
401authentication_requiredBearertoken ontbreekt, is ongeldig gevormd, uitgeschakeld, vernieuwd of onbekend.
403source_ip_deniedDe IP-beperking van de API-referentie bevat het exacte publieke bronadres van het verzoek niet.
403source_ip_not_allowedDe bron-IP-beperking van de hostnaam sluit deze client uit. Een beheerder kan toelatingslijsten van actieve hosts beheren onder Instellingen → Systeem; deze gelden naast de IP-beperkingen van API-referenties.
503source_access_unavailableVerificatie van hostnaamtoegang is tijdelijk niet beschikbaar. Probeer later opnieuw; bij fouten blijft toegang geblokkeerd.
403 / 409 / 500merchant_api_access_deniedAutorisatie mislukt: rechten/projectbereik kunnen 403 geven, een uitgeschakeld project/winkel kan 409 geven en een fout in de autorisatiebackend kan 500 geven. Ontvangstwallets van operators zijn gereserveerd voor het Operator-paneel, niet voor handelaars-API-referenties of MCP, ook niet met een oudere expliciete projecttoestemming.
403project_access_deniedEen transactionele hercontrole bij aanmaak stelde vast dat de API-referentie geen toegang meer heeft tot het project.
404invoice_not_foundEr bestaat geen factuur met die publieke ID in het geautoriseerde project, of afrekenen kan die niet tonen.
404payment_resource_not_foundEen project, winkel, actief of wallet die nodig is bij het voorbereiden van de factuur bestaat niet meer.
404token_candidate_not_foundHet project is niet beschikbaar of de token staat niet meer in de huidige overeenkomende detectiecatalogus.
409idempotency_conflictDe tot de winkel beperkte sleutel bestaat al en de API-referentie of de exacte onbewerkte verzoekbytes verschillen.
409store_unavailableProject/winkel is uitgeschakeld of niet beschikbaar.
409no_ready_payment_methodsGeen winkelmethode is gereed. Lees error.message en error.details.payment_methods voor chain_slug, asset_ticker en reason_code. Walletback-up/-activering, geïnstalleerde adapter en prijsbepaling moeten geldig zijn. Vanaf 6.0.6 blokkeren scannerwachttijden, mislukte of verouderde gezondheidscontroles en een ontbrekend providerquorum de aanmaak niet.
409payment_method_unavailableEen geselecteerde methode werd onbeschikbaar tijdens de atomaire hercontrole bij aanmaak.
409store_payment_method_not_selectedEr is een afwijkend winkelbevestigingsbeleid aangevraagd voor een actief dat momenteel niet door die winkel is geselecteerd.
409wallet_unavailableEen betaalwallet werd onbeschikbaar tijdens de atomaire hercontrole bij aanmaak.
409ipn_secret_requiredEr bestaat een effectieve IPN-URL, maar de winkel heeft geen IPN-ondertekeningsgeheim.
409payment_resource_not_readyEen vereist betaalactief of vereiste wallet is uitgeschakeld, heeft geen back-up, wacht op activeringsbewijs voor een gedeeld account, is uitgeput of is anderszins niet gereed.
409account_activation_unverifiedActivering van het XRP Ledger- of Stellar-account kon niet worden bewezen via het ingestelde aantal gezonde mainneteindpunten (standaard 2, optioneel 1); stort op het exacte account en probeer verificatie opnieuw.
400invalid_monero_wallet_rpcHet HTTPS-eindpunt, exacte primaire mainnetadres, label of de volledige Digest-/Basic-/headerauthenticatie-invoer is ongeldig.
404monero_wallet_rpc_not_foundDe projectspecifieke Monero-wallet-RPC-koppeling bestaat niet.
409monero_wallet_rpc_not_readyHet Monero-actief, quorum van twee daemons, onwijzigbare koppeling of expliciete verklaring over back-up/alleen inzage is niet gereed.
409monero_wallet_rpc_unavailableFactuuraanmaak vereist een actieve, geverifieerde en bevestigde Monero-wallet-RPC-koppeling voor het project met geldige serverinloggegevens.
503lightning_unavailableDe enige gereedstaande methode van de winkel is Lightning en de wallet of prijsopgave kon niet worden geverifieerd. Probeer opnieuw met dezelfde idempotentiesleutel. Als er een andere gereedstaande blockchainmethode bestaat, wordt de niet-beschikbare Lightning-methode in plaats daarvan weggelaten.
422monero_wallet_rpc_verification_failedVerificatie van de exacte wallet, HTTPS-pinning, synchronisatie, mainnet-daemonquorum of bewijs van methodenweigering door de gateway is mislukt.
503monero_wallet_rpc_failedDe externe wallet-RPC met alleen inzagerechten kon het factuursubadres niet veilig aanmaken en opnieuw uitlezen; er wordt geen uitwijkadres verzonnen.
409token_chain_not_readyHet eigen blockchainactief is uitgeschakeld, de detectiekoppeling is tijdens verificatie gewijzigd of het project heeft al het huidige maximum van 20 geregistreerde tokenactiva.
503dex_price_unavailableDEX-provider niet beschikbaar, bezet, begrensd, verouderd antwoord of ongeldige gegevens. Probeer na één minuut opnieuw; vaste prijsbepaling blijft beschikbaar.
422invalid_dex_priceOngeldige combinatie van prijsmodi of de geselecteerde pool kan geen kwalificerende prijs voor het exacte contract leveren. Kies een andere pool of vaste USD-prijsbepaling.
422token_verification_failedElke geschikte node faalde bij verificatie van blockchainidentiteit, contractcode, decimalen, saldo-opvraging of mint.
422invalid_store_confirmation_policyDe afwijkende winkelinstelling is niet beschikbaar voor deze finaliteitsmodus, valt buiten de teruggegeven blockchainspecifieke grenzen of vraagt om niet-ondersteunde acceptatie met nul bevestigingen.
409invoice_not_payableDe afrekenfactuur heeft een eindstatus of de betalingsdeadline is verstreken.
409invoice_payment_method_lockedEen geldige betaling heeft al een ander actief geselecteerd; ga verder met active_payment_method_id.
409payment_method_not_payableDe geselecteerde methode is afgerond of accepteert geen extra betaling meer.
422payment_qr_unavailableHet betaalverzoek op de afrekenpagina is te groot om als SVG-QR-afbeelding te coderen.
503payment_rates_unavailableVoor geen enkele gereedstaande betaalmethode is een actuele betrouwbare prijsopgave beschikbaar.
500authentication_unavailableBearerauthenticatie kon de opgeslagen API-referentie niet veilig lezen of valideren.
429rate_limit_exceededDeze API-referentie heeft haar huidige UTC-minuutbudget opgebruikt. Wacht minstens Retry-After seconden; probeer factuuraanmaak opnieuw met dezelfde idempotentiesleutel.
500database_error / internal_errorTijdelijke serverfout; probeer veilig opnieuw met dezelfde idempotentiesleutel.

API-overzicht

Kies een eindpunt voor de velden, voorbeelden en het antwoord.

Facturen

POSTFactuur maken/v1/projects/{project_id}/stores/{store_id}/invoicesGETFacturen opvragen/v1/projects/{project_id}/invoicesGETFactuur ophalen/v1/projects/{project_id}/invoices/{invoice_id}GETFactuurbetalingen opvragen/v1/projects/{project_id}/invoices/{invoice_id}/payments

Betaalmethoden

GETBetaalactiva van project opvragen/v1/projects/{project_id}/payment-assetsPUTActivabeleid van project bijwerken/v1/projects/{project_id}/payment-assets/{asset_id}GETKandidaat-betaaltokens bekijken/v1/projects/{project_id}/payment-token-candidatesPOSTToken verifiëren en registreren/v1/projects/{project_id}/payment-token-assetsGETDEX-pools voor eigen token zoeken/v1/projects/{project_id}/payment-token-dex-poolsPOSTEigen token toevoegen of prijs wijzigen/v1/projects/{project_id}/payment-token-assets/customGETBetaalmethoden van winkel opvragen/v1/projects/{project_id}/stores/{store_id}/payment-assetsPUTBetaalmethoden van winkel vervangen/v1/projects/{project_id}/stores/{store_id}/payment-assetsPUTBevestigingsbeleid van winkel instellen/v1/projects/{project_id}/stores/{store_id}/payment-assets/{asset_id}/confirmation-policy

Wallets

GETProjectwallets en saldi opvragen/v1/projects/{project_id}/wallets

Afstemming

GETBetalingsuitzonderingen opvragen/v1/projects/{project_id}/reconciliationGETAfstemmingsbewijs lezen/v1/projects/{project_id}/reconciliation/{invoice_id}

Marketplace-API

GETMogelijkheden/v1/marketplace/capabilitiesGETMarketplace-rapport/v1/marketplace/overviewGETProjectinstellingen/v1/marketplace/settingsPOSTProjectinstellingen opslaan/v1/marketplace/settingsGETVerkopers opvragen/v1/marketplace/vendorsPOSTVerkoper maken/v1/marketplace/vendorsGETVerkoper ophalen/v1/marketplace/vendors/{vendor_id}POSTVerkoper bijwerken/v1/marketplace/vendors/{vendor_id}/updatePOSTVerkoper archiveren/v1/marketplace/vendors/{vendor_id}/archiveGETVerkopersbestemmingen/v1/marketplace/vendors/{vendor_id}/destinationsPOSTUitbetalingsbestemming toevoegen/v1/marketplace/vendors/{vendor_id}/destinationsPOSTBestemming goedkeuren/v1/marketplace/vendors/{vendor_id}/destinations/{destination_id}/approvePOSTBestemming uitschakelen/v1/marketplace/vendors/{vendor_id}/destinations/{destination_id}/disableGETVerkoperssaldi/v1/marketplace/vendors/{vendor_id}/balancesGETMarketplace-facturen/v1/marketplace/invoicesPOSTFactuur voor meerdere verkopers maken/v1/marketplace/invoicesGETFactuur en toewijzingen/v1/marketplace/invoices/{invoice_id}GETBetalingsbewijs van factuur/v1/marketplace/invoices/{invoice_id}/paymentsGETFactuurtoewijzingen/v1/marketplace/invoices/{invoice_id}/allocationsPOSTOnbetaalde factuur annuleren/v1/marketplace/invoices/{invoice_id}/cancelPOSTToewijzingen vasthouden/v1/marketplace/invoices/{invoice_id}/allocations/holdPOSTToewijzingen beoordelen en vrijgeven/v1/marketplace/invoices/{invoice_id}/allocations/releasePOSTOnbetaalde bestemming opnieuw koppelen/v1/marketplace/invoices/{invoice_id}/allocations/{allocation_id}/destinationPOSTVolledige terugbetaling voorbereiden/v1/marketplace/invoices/{invoice_id}/refundGETUitbetalingstoewijzingen zoeken/v1/marketplace/allocationsGETGrootboeksaldi van project/v1/marketplace/balancesGETOnwijzigbaar journaal/v1/marketplace/ledgerGETUitbetalingsgeschiedenis/v1/marketplace/payoutsPOSTToewijzingsplan vooraf bekijken/v1/marketplace/payouts/previewPOSTUitbetaling voorbereiden/v1/marketplace/payoutsGETUitbetalingsdetails/v1/marketplace/payouts/{payout_id}POSTGoedkeuren en verzenden/v1/marketplace/payouts/{payout_id}/approvePOSTUitbetaling beoordelen en hervatten/v1/marketplace/payouts/{payout_id}/resumePOSTNiet-ondertekend werk annuleren/v1/marketplace/payouts/{payout_id}/cancelGETAutomatisch uitbetalingsbeleid/v1/marketplace/policiesPOSTUitbetalingsbeleid autoriseren/v1/marketplace/policiesGETMarketplace-webhooks/v1/marketplace/webhooksPOSTMarketplace-webhook maken/v1/marketplace/webhooksPOSTMarketplace-webhook bijwerken/v1/marketplace/webhooks/{webhook_id}/updatePOSTMarketplace-webhook uitschakelen/v1/marketplace/webhooks/{webhook_id}/disableGETMarketplace-gebeurtenissen/v1/marketplace/eventsGETBewaarde gebeurtenis lezen/v1/marketplace/events/{event_id}GETMarketplace-bezorggeschiedenis/v1/marketplace/webhook-deliveriesGETBezorgdetails/v1/marketplace/webhook-deliveries/{delivery_id}POSTDezelfde gebeurtenis opnieuw bezorgen/v1/marketplace/webhook-deliveries/{delivery_id}/resend

Operator-API

GETMogelijkheden/v1/operator/capabilitiesGETGezondheid/v1/operator/healthGETHandelaars opvragen/v1/operator/merchantsPOSTHandelaar maken/v1/operator/merchantsGETHandelaar ophalen/v1/operator/merchants/{merchant_id}POSTHandelaar bijwerken/v1/operator/merchants/{merchant_id}GETGebruikers opvragen/v1/operator/merchants/{merchant_id}/usersPOSTGebruiker maken/v1/operator/merchants/{merchant_id}/usersGETGebruiker ophalen/v1/operator/merchants/{merchant_id}/users/{user_id}POSTGebruiker bijwerken/v1/operator/merchants/{merchant_id}/users/{user_id}POSTGebruikerswachtwoord instellen/v1/operator/merchants/{merchant_id}/users/{user_id}/passwordPOSTGebruikerssessies intrekken/v1/operator/merchants/{merchant_id}/users/{user_id}/revoke-sessionsGETUitnodigingen opvragen/v1/operator/merchants/{merchant_id}/invitationsPOSTUitnodiging maken/v1/operator/merchants/{merchant_id}/invitationsGETUitnodiging ophalen/v1/operator/invitations/{invitation_id}POSTUitnodiging opnieuw versturen/v1/operator/invitations/{invitation_id}/resendPOSTUitnodiging intrekken/v1/operator/invitations/{invitation_id}/revokeGETTegoed ophalen/v1/operator/merchants/{merchant_id}/creditsGETTegoedgrootboek opvragen/v1/operator/merchants/{merchant_id}/credits/ledgerPOSTTegoed aanpassen/v1/operator/merchants/{merchant_id}/credits/adjustmentsGETOpwaarderingen opvragen/v1/operator/merchants/{merchant_id}/topupsPOSTOpwaardering maken/v1/operator/merchants/{merchant_id}/topupsGETOpwaardering ophalen/v1/operator/merchants/{merchant_id}/topups/{topup_id}GETRapporten/v1/operator/reportsGETAuditlog opvragen/v1/operator/auditGETGebeurtenissen opvragen/v1/operator/eventsGETWebhooks opvragen/v1/operator/webhooksPOSTWebhook maken/v1/operator/webhooksPOSTWebhook bijwerken/v1/operator/webhooks/{webhook_id}POSTWebhookgeheim vernieuwen/v1/operator/webhooks/{webhook_id}/rotateGETWebhookbezorgingen opvragen/v1/operator/webhooks/{webhook_id}/deliveriesGETProjecten opvragen/v1/operator/merchants/{merchant_id}/projectsPOSTProject maken/v1/operator/merchants/{merchant_id}/projectsGETProject ophalen/v1/operator/merchants/{merchant_id}/projects/{project_id}POSTProject bijwerken/v1/operator/merchants/{merchant_id}/projects/{project_id}GETWinkels opvragen/v1/operator/merchants/{merchant_id}/projects/{project_id}/storesPOSTWinkel maken/v1/operator/merchants/{merchant_id}/projects/{project_id}/storesGETWinkel ophalen/v1/operator/merchants/{merchant_id}/projects/{project_id}/stores/{store_id}POSTWinkel bijwerken/v1/operator/merchants/{merchant_id}/projects/{project_id}/stores/{store_id}GETWinkeluiterlijk ophalen/v1/operator/merchants/{merchant_id}/projects/{project_id}/stores/{store_id}/checkout-appearancePOSTWinkeluiterlijk bijwerken/v1/operator/merchants/{merchant_id}/projects/{project_id}/stores/{store_id}/checkout-appearanceGETBetaalactiva van winkel opvragen/v1/operator/merchants/{merchant_id}/projects/{project_id}/stores/{store_id}/payment-assetsPOSTBetaalactiva van winkel bijwerken/v1/operator/merchants/{merchant_id}/projects/{project_id}/stores/{store_id}/payment-assetsGETWinkelwebhooks opvragen/v1/operator/merchants/{merchant_id}/projects/{project_id}/stores/{store_id}/webhooksPOSTWinkelwebhook maken/v1/operator/merchants/{merchant_id}/projects/{project_id}/stores/{store_id}/webhooksPOSTWinkelwebhook bijwerken/v1/operator/merchants/{merchant_id}/projects/{project_id}/stores/{store_id}/webhooks/{webhook_id}GETFacturen opvragen/v1/operator/merchants/{merchant_id}/projects/{project_id}/invoicesGETFactuur ophalen/v1/operator/merchants/{merchant_id}/projects/{project_id}/invoices/{invoice_id}GETWallets opvragen/v1/operator/merchants/{merchant_id}/projects/{project_id}/walletsGETWalletadressen opvragen/v1/operator/merchants/{merchant_id}/projects/{project_id}/wallets/{wallet_id}/addressesGETHandelaars-API-referenties opvragen/v1/operator/merchants/{merchant_id}/api-credentialsPOSTHandelaars-API-referentie maken/v1/operator/merchants/{merchant_id}/api-credentialsPOSTHandelaars-API-referentie bijwerken/v1/operator/merchants/{merchant_id}/api-credentials/{credential_id}POSTHandelaars-API-referentie vernieuwen/v1/operator/merchants/{merchant_id}/api-credentials/{credential_id}/rotatePOSTHandelaars-API-referentie intrekken/v1/operator/merchants/{merchant_id}/api-credentials/{credential_id}/revokePOSTUitnodigingstoken controleren/v1/onboarding/invitations/checkPOSTUitnodiging of wachtwoordherstel accepteren/v1/onboarding/invitations/accept

Afrekenen

GETAfrekenbasis/GETGehoste afrekenpagina/invoice/{invoice_id}GETFactuur met gegevens die veilig op de afrekenpagina kunnen worden getoond/checkout-api/invoices/{invoice_id}GETVoorbeeld van winkelafrekenpagina/invoice/preview/{project_id}GETGegevens voor afrekenvoorbeeld/checkout-api/previews/{project_id}GETAfbeelding voor winkelafrekenpagina/checkout-api/invoices/{invoice_id}/appearance-images/{kind}/{revision}/image.pngGETAfbeelding voor winkelvoorbeeld/checkout-api/previews/{project_id}/stores/{store_id}/appearance-images/{kind}/{revision}/image.pngGETVoorbeeldlogo met revisie/checkout-api/previews/{project_id}/logo/{revision}/image.pngGETAfbeelding van betalings-QR-code/checkout-api/invoices/{invoice_id}/payment-methods/{intent_id}/qr.svgGETAfrekenlogo met revisie/checkout-api/invoices/{invoice_id}/logo/{revision}/image.png

Dienst

GETAPI-servicedetectie/GETServicestatus/healthz
GETMogelijkheden/v1/operator/capabilitiesAlleen-lezen

Beheer of bekijk de genoemde resource van een gehoste handelaar met een afzonderlijke Operator-API-referentie.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "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
}

Antwoordvelden

api_versionstring
operator_versionstring
scopes[]array
all_merchantsboolean
merchant_ids[]array
onboarding[]array
write_methods[]array
idempotency_requiredboolean
Gebruiksopmerkingen
  • Vereist health.read; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETGezondheid/v1/operator/healthAlleen-lezen

Beheer of bekijk de genoemde resource van een gehoste handelaar met een afzonderlijke Operator-API-referentie.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "version": "7.4.0",
  "nodes": []
}

Antwoordvelden

versionstring
nodes[]array
Gebruiksopmerkingen
  • Vereist health.read; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETHandelaars opvragen/v1/operator/merchantsAlleen-lezen

Beheer of bekijk de genoemde resource van een gehoste handelaar met een afzonderlijke Operator-API-referentie.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN

Queryparameters

pageoptioneel
Paginanummering vanaf 1, 25 items per pagina. Zoeken wordt ondersteund voor handelaars, gebruikers, projecten, winkels, wallets, API-referenties en webhooks; oorspronkelijke gebeurtenislijsten gebruiken hun specifieke filters.Details

Paginanummering vanaf 1, 25 items per pagina. Zoeken wordt ondersteund voor handelaars, gebruikers, projecten, winkels, wallets, API-referenties en webhooks; oorspronkelijke gebeurtenislijsten gebruiken hun specifieke filters.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": [],
  "page": 1,
  "page_size": 25,
  "total": 0
}

Antwoordvelden

data[]array
pageinteger
page_sizeinteger
totalinteger
Gebruiksopmerkingen
  • Vereist merchants.read; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTHandelaar maken/v1/operator/merchantsLezen + schrijven

Maak een gehoste handelaar en eerste beheerder atomair aan, rechtstreeks met een wachtwoord of via uitnodiging.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN
Idempotency-Keyvereist16–128 letters, cijfers, -, _ of .; duurzaam opgeslagen voor deze actie

Verzoek

: "${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"
}'

Requestbody

namestringvereist

Handelaarsnaam en wereldwijd uniek e-mailadres van de eerste beheerder.

emailstringvereist

Handelaarsnaam en wereldwijd uniek e-mailadres van de eerste beheerder.

onboardingdirect | invitationvereist

direct vereist password en verstuurt geen uitnodigingsmail. invitation laat password weg.

passwordstring · direct only

12–128 tekens (maximaal 512 UTF-8-bytes); wordt nooit teruggegeven of gemaild. Gebruik require_password_change voor tijdelijke wachtwoorden.

require_password_changebooleanoptioneel

Vereist een nieuw wachtwoord bij de eerste aanmelding. Elk rechtstreeks aangemaakt account moet het beheer van gehoste wallets erkennen.

currencyfiat codeoptioneel

Valuta van het vooruitbetaalde account; standaard de regionale valuta en kan daarna niet worden gewijzigd.

fee_bpsintegeroptioneel

0–10000; 100 betekent 1%. Gebruikt bij weglaten de operatorstandaard. Vereist fees.write.

starting_creditdecimal stringoptioneel

Exacte eenmalige lokale toekenning. Niet-nul vereist credits.write. Vult het installatiesaldo van de operator niet aan.

external_idstringoptioneel

Unieke integratiereferentie, 1–120 tekens.

default_timezoneIANA timezoneoptioneel

Standaard de regionale tijdzone van de installatie.

send_invitation_emailbooleanoptioneel

Alleen uitnodiging. Vereist ingestelde SMTP; het antwoord onderscheidt acceptatie door de relay van accountaanmaak.

Antwoord 201 or 200 application/json

Voorbeeldantwoord
{
  "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
}

Antwoordvelden

merchant_idstring
user_idstring
merchantobject
idstring
namestring
currencystring
balancestring
onboardingstring
email_deliveryobject
statusstring
custody_acceptance_requiredboolean
Gebruiksopmerkingen
  • Vereist merchants.write; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Sla vóór verzenden een unieke Idempotency-Key en de exacte body duurzaam op. Nieuwe pogingen herhalen nooit een vastgelegde actie. Geheime velden worden bij herhaling weggelaten; als een antwoord met een geheim verloren is gegaan, bekijk dan de gemaakte resource en vernieuw/geef het expliciet opnieuw uit. Een 409 operator_request_in_progress kan duiden op een onderbroken verzoek met onbekend resultaat: bekijk resource/audit; probeer niet blind opnieuw met een nieuwe sleutel.
  • Globale handelaarstoegang vereist. Expliciete tariefafwijkingen vereisen ook fees.write; niet-nul starting_credit vereist credits.write. Aansluiting via uitnodiging vereist ook invitations.write. Geen automatische aanmelding, geen omzeiling van Basic Auth, geen achteraf toegekend tegoed bij opnieuw proberen.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETHandelaar ophalen/v1/operator/merchants/{merchant_id}Alleen-lezen

Beheer of bekijk de genoemde resource van een gehoste handelaar met een afzonderlijke Operator-API-referentie.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN

Padparameters

merchant_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "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"
}

Antwoordvelden

idstring
namestring
currencystring
balancestring
fee_bpsinteger
enabledboolean
payments_pausedboolean
external_idstring
Gebruiksopmerkingen
  • Vereist merchants.read; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTHandelaar bijwerken/v1/operator/merchants/{merchant_id}Lezen + schrijven

Beheer of bekijk de genoemde resource van een gehoste handelaar met een afzonderlijke Operator-API-referentie.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN
Idempotency-Keyvereist16–128 letters, cijfers, -, _ of .; duurzaam opgeslagen voor deze actie

Padparameters

merchant_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

Verzoek

: "${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
}'

Requestbody

namefieldsoptioneel
Uitschakelen trekt sessies in. payments_paused blokkeert nieuwe facturen, niet het scannen van bestaande betalingen. Tariefwijzigingen vereisen fees.write en gelden voor toekomstige facturen; accountvaluta kan niet veranderen.Details

Uitschakelen trekt sessies in. payments_paused blokkeert nieuwe facturen, niet het scannen van bestaande betalingen. Tariefwijzigingen vereisen fees.write en gelden voor toekomstige facturen; accountvaluta kan niet veranderen.

enabledfieldsoptioneel
Uitschakelen trekt sessies in. payments_paused blokkeert nieuwe facturen, niet het scannen van bestaande betalingen. Tariefwijzigingen vereisen fees.write en gelden voor toekomstige facturen; accountvaluta kan niet veranderen.Details

Uitschakelen trekt sessies in. payments_paused blokkeert nieuwe facturen, niet het scannen van bestaande betalingen. Tariefwijzigingen vereisen fees.write en gelden voor toekomstige facturen; accountvaluta kan niet veranderen.

payments_pausedfieldsoptioneel
Uitschakelen trekt sessies in. payments_paused blokkeert nieuwe facturen, niet het scannen van bestaande betalingen. Tariefwijzigingen vereisen fees.write en gelden voor toekomstige facturen; accountvaluta kan niet veranderen.Details

Uitschakelen trekt sessies in. payments_paused blokkeert nieuwe facturen, niet het scannen van bestaande betalingen. Tariefwijzigingen vereisen fees.write en gelden voor toekomstige facturen; accountvaluta kan niet veranderen.

fee_bpsfieldsoptioneel
Uitschakelen trekt sessies in. payments_paused blokkeert nieuwe facturen, niet het scannen van bestaande betalingen. Tariefwijzigingen vereisen fees.write en gelden voor toekomstige facturen; accountvaluta kan niet veranderen.Details

Uitschakelen trekt sessies in. payments_paused blokkeert nieuwe facturen, niet het scannen van bestaande betalingen. Tariefwijzigingen vereisen fees.write en gelden voor toekomstige facturen; accountvaluta kan niet veranderen.

external_idfieldsoptioneel
Uitschakelen trekt sessies in. payments_paused blokkeert nieuwe facturen, niet het scannen van bestaande betalingen. Tariefwijzigingen vereisen fees.write en gelden voor toekomstige facturen; accountvaluta kan niet veranderen.Details

Uitschakelen trekt sessies in. payments_paused blokkeert nieuwe facturen, niet het scannen van bestaande betalingen. Tariefwijzigingen vereisen fees.write en gelden voor toekomstige facturen; accountvaluta kan niet veranderen.

Antwoord 200 application/json

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

Antwoordvelden

idstring
namestring
currencystring
balancestring
fee_bpsinteger
enabledboolean
payments_pausedboolean
Gebruiksopmerkingen
  • Vereist merchants.write; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Sla vóór verzenden een unieke Idempotency-Key en de exacte body duurzaam op. Nieuwe pogingen herhalen nooit een vastgelegde actie. Geheime velden worden bij herhaling weggelaten; als een antwoord met een geheim verloren is gegaan, bekijk dan de gemaakte resource en vernieuw/geef het expliciet opnieuw uit. Een 409 operator_request_in_progress kan duiden op een onderbroken verzoek met onbekend resultaat: bekijk resource/audit; probeer niet blind opnieuw met een nieuwe sleutel.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETGebruikers opvragen/v1/operator/merchants/{merchant_id}/usersAlleen-lezen

Beheer of bekijk de genoemde resource van een gehoste handelaar met een afzonderlijke Operator-API-referentie.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN

Padparameters

merchant_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

Queryparameters

pageoptioneel
Paginanummering vanaf 1, 25 items per pagina. Zoeken wordt ondersteund voor handelaars, gebruikers, projecten, winkels, wallets, API-referenties en webhooks; oorspronkelijke gebeurtenislijsten gebruiken hun specifieke filters.Details

Paginanummering vanaf 1, 25 items per pagina. Zoeken wordt ondersteund voor handelaars, gebruikers, projecten, winkels, wallets, API-referenties en webhooks; oorspronkelijke gebeurtenislijsten gebruiken hun specifieke filters.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": [],
  "page": 1,
  "page_size": 25,
  "total": 0
}

Antwoordvelden

data[]array
pageinteger
page_sizeinteger
totalinteger
Gebruiksopmerkingen
  • Vereist users.read; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTGebruiker maken/v1/operator/merchants/{merchant_id}/usersLezen + schrijven

Voeg een handelaarsbeheerder toe of een gebruiker met toegang tot geselecteerde projecten.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN
Idempotency-Keyvereist16–128 letters, cijfers, -, _ of .; duurzaam opgeslagen voor deze actie

Padparameters

merchant_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

Verzoek

: "${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
}'

Requestbody

emailstringsvereist

E-mailadres is uniek binnen de installatie.

display_namestringsvereist

E-mailadres is uniek binnen de installatie.

onboardingsame as merchant creation

Uitnodigingen maken vereist daarnaast invitations.write.

passwordsame as merchant creation

Uitnodigingen maken vereist daarnaast invitations.write.

require_password_changesame as merchant creation

Uitnodigingen maken vereist daarnaast invitations.write.

send_invitation_emailsame as merchant creation

Uitnodigingen maken vereist daarnaast invitations.write.

access_leveladmin | projectsoptioneel

admin is alleen de beheerder van deze handelaar, nooit de installatie-/operatorbeheerder.

project_ids[]UUID[]

Alleen projecten van de handelaar. Verplichte selectie voor projectbeperkte toegang; nooit over handelaarsgrenzen heen.

default_timezoneIANA timezoneoptioneel

Regionale standaard bij weglaten.

Antwoord 201 or 200 application/json

Voorbeeldantwoord
{
  "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"
}

Antwoordvelden

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
Gebruiksopmerkingen
  • Vereist users.write; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Sla vóór verzenden een unieke Idempotency-Key en de exacte body duurzaam op. Nieuwe pogingen herhalen nooit een vastgelegde actie. Geheime velden worden bij herhaling weggelaten; als een antwoord met een geheim verloren is gegaan, bekijk dan de gemaakte resource en vernieuw/geef het expliciet opnieuw uit. Een 409 operator_request_in_progress kan duiden op een onderbroken verzoek met onbekend resultaat: bekijk resource/audit; probeer niet blind opnieuw met een nieuwe sleutel.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETGebruiker ophalen/v1/operator/merchants/{merchant_id}/users/{user_id}Alleen-lezen

Beheer of bekijk de genoemde resource van een gehoste handelaar met een afzonderlijke Operator-API-referentie.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN

Padparameters

merchant_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

user_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "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
}

Antwoordvelden

idstring
merchant_idstring
emailstring
display_namestring
access_levelstring
project_ids[]array
enabledboolean
password_setup_requiredboolean
custody_acceptance_requiredboolean
password_change_requiredboolean
Gebruiksopmerkingen
  • Vereist users.read; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTGebruiker bijwerken/v1/operator/merchants/{merchant_id}/users/{user_id}Lezen + schrijven

Beheer of bekijk de genoemde resource van een gehoste handelaar met een afzonderlijke Operator-API-referentie.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN
Idempotency-Keyvereist16–128 letters, cijfers, -, _ of .; duurzaam opgeslagen voor deze actie

Padparameters

merchant_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

user_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

Verzoek

: "${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"
}'

Requestbody

emailfieldsoptioneel

Werkt aangeleverde velden bij; bescherming van de laatste beheerder blijft gelden. Wachtwoorden hebben een afzonderlijke users.security-actie.

display_namefieldsoptioneel

Werkt aangeleverde velden bij; bescherming van de laatste beheerder blijft gelden. Wachtwoorden hebben een afzonderlijke users.security-actie.

enabledfieldsoptioneel

Werkt aangeleverde velden bij; bescherming van de laatste beheerder blijft gelden. Wachtwoorden hebben een afzonderlijke users.security-actie.

access_levelfieldsoptioneel

Werkt aangeleverde velden bij; bescherming van de laatste beheerder blijft gelden. Wachtwoorden hebben een afzonderlijke users.security-actie.

project_idsfieldsoptioneel

Werkt aangeleverde velden bij; bescherming van de laatste beheerder blijft gelden. Wachtwoorden hebben een afzonderlijke users.security-actie.

default_timezonefieldsoptioneel

Werkt aangeleverde velden bij; bescherming van de laatste beheerder blijft gelden. Wachtwoorden hebben een afzonderlijke users.security-actie.

Antwoord 200 application/json

Voorbeeldantwoord
{
  "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
}

Antwoordvelden

idstring
merchant_idstring
emailstring
display_namestring
access_levelstring
project_ids[]array
enabledboolean
password_setup_requiredboolean
custody_acceptance_requiredboolean
password_change_requiredboolean
Gebruiksopmerkingen
  • Vereist users.write; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Sla vóór verzenden een unieke Idempotency-Key en de exacte body duurzaam op. Nieuwe pogingen herhalen nooit een vastgelegde actie. Geheime velden worden bij herhaling weggelaten; als een antwoord met een geheim verloren is gegaan, bekijk dan de gemaakte resource en vernieuw/geef het expliciet opnieuw uit. Een 409 operator_request_in_progress kan duiden op een onderbroken verzoek met onbekend resultaat: bekijk resource/audit; probeer niet blind opnieuw met een nieuwe sleutel.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTGebruikerswachtwoord instellen/v1/operator/merchants/{merchant_id}/users/{user_id}/passwordLezen + schrijven

Stel een wachtwoord voor een gehost account in en trek sessies in. Bestaande TOTP blijft behouden.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN
Idempotency-Keyvereist16–128 letters, cijfers, -, _ of .; duurzaam opgeslagen voor deze actie

Padparameters

merchant_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

user_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

Verzoek

: "${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
}'

Requestbody

passwordstringvereist

Wijzigt het wachtwoord en trekt sessies in, met behoud van TOTP. Vereist users.security.

require_password_changebooleanoptioneel

De gebruiker moet bij de volgende succesvolle aanmelding een eigen wachtwoord instellen.

Antwoord 200 application/json

Voorbeeldantwoord
{
  "user_id": "11111111-1111-4111-8111-111111111111",
  "sessions_revoked": true,
  "totp_preserved": true
}

Antwoordvelden

user_idstring
sessions_revokedboolean
totp_preservedboolean
Gebruiksopmerkingen
  • Vereist users.security; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Sla vóór verzenden een unieke Idempotency-Key en de exacte body duurzaam op. Nieuwe pogingen herhalen nooit een vastgelegde actie. Geheime velden worden bij herhaling weggelaten; als een antwoord met een geheim verloren is gegaan, bekijk dan de gemaakte resource en vernieuw/geef het expliciet opnieuw uit. Een 409 operator_request_in_progress kan duiden op een onderbroken verzoek met onbekend resultaat: bekijk resource/audit; probeer niet blind opnieuw met een nieuwe sleutel.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTGebruikerssessies intrekken/v1/operator/merchants/{merchant_id}/users/{user_id}/revoke-sessionsLezen + schrijven

Beheer of bekijk de genoemde resource van een gehoste handelaar met een afzonderlijke Operator-API-referentie.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN
Idempotency-Keyvereist16–128 letters, cijfers, -, _ of .; duurzaam opgeslagen voor deze actie

Padparameters

merchant_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

user_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

Verzoek

: "${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 '{}'

Antwoord 200 application/json

Voorbeeldantwoord
{
  "user_id": "11111111-1111-4111-8111-111111111111",
  "sessions_revoked": true,
  "totp_preserved": true
}

Antwoordvelden

user_idstring
sessions_revokedboolean
totp_preservedboolean
Gebruiksopmerkingen
  • Vereist users.security; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Sla vóór verzenden een unieke Idempotency-Key en de exacte body duurzaam op. Nieuwe pogingen herhalen nooit een vastgelegde actie. Geheime velden worden bij herhaling weggelaten; als een antwoord met een geheim verloren is gegaan, bekijk dan de gemaakte resource en vernieuw/geef het expliciet opnieuw uit. Een 409 operator_request_in_progress kan duiden op een onderbroken verzoek met onbekend resultaat: bekijk resource/audit; probeer niet blind opnieuw met een nieuwe sleutel.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETUitnodigingen opvragen/v1/operator/merchants/{merchant_id}/invitationsAlleen-lezen

Beheer of bekijk de genoemde resource van een gehoste handelaar met een afzonderlijke Operator-API-referentie.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN

Padparameters

merchant_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

Queryparameters

pageoptioneel
Paginanummering vanaf 1, 25 items per pagina. Zoeken wordt ondersteund voor handelaars, gebruikers, projecten, winkels, wallets, API-referenties en webhooks; oorspronkelijke gebeurtenislijsten gebruiken hun specifieke filters.Details

Paginanummering vanaf 1, 25 items per pagina. Zoeken wordt ondersteund voor handelaars, gebruikers, projecten, winkels, wallets, API-referenties en webhooks; oorspronkelijke gebeurtenislijsten gebruiken hun specifieke filters.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": [],
  "page": 1,
  "page_size": 25,
  "total": 0
}

Antwoordvelden

data[]array
pageinteger
page_sizeinteger
totalinteger
Gebruiksopmerkingen
  • Vereist invitations.read; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTUitnodiging maken/v1/operator/merchants/{merchant_id}/invitationsLezen + schrijven

Maak of vervang een eenmalige uitnodigings- of wachtwoordherstellink.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN
Idempotency-Keyvereist16–128 letters, cijfers, -, _ of .; duurzaam opgeslagen voor deze actie

Padparameters

merchant_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

Verzoek

: "${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
}'

Requestbody

user_idUUID, boolean

Geef een eenmalige link voor een bestaand account uit of vervang die. Geactiveerde gebruikers ontvangen een herstellink voor één uur en vereisen users.security.

send_emailUUID, boolean

Geef een eenmalige link voor een bestaand account uit of vervang die. Geactiveerde gebruikers ontvangen een herstellink voor één uur en vereisen users.security.

new user fieldsalternative to user_id

Gebruik email, display_name, access_level en project_ids om een uitgenodigde gebruiker te maken; vereist users.write.

Antwoord 201 or 200 application/json

Voorbeeldantwoord
{
  "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"
}

Antwoordvelden

user_idstring
emailstring
kindstring
expires_atstring
urlstring
Gebruiksopmerkingen
  • Vereist invitations.write; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Sla vóór verzenden een unieke Idempotency-Key en de exacte body duurzaam op. Nieuwe pogingen herhalen nooit een vastgelegde actie. Geheime velden worden bij herhaling weggelaten; als een antwoord met een geheim verloren is gegaan, bekijk dan de gemaakte resource en vernieuw/geef het expliciet opnieuw uit. Een 409 operator_request_in_progress kan duiden op een onderbroken verzoek met onbekend resultaat: bekijk resource/audit; probeer niet blind opnieuw met een nieuwe sleutel.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETUitnodiging ophalen/v1/operator/invitations/{invitation_id}Alleen-lezen

Beheer of bekijk de genoemde resource van een gehoste handelaar met een afzonderlijke Operator-API-referentie.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN

Padparameters

invitation_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "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"
}

Antwoordvelden

idstring
user_idstring
merchant_idstring
kindstring
statusstring
created_atstring
expires_atstring
Gebruiksopmerkingen
  • Vereist invitations.read; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTUitnodiging opnieuw versturen/v1/operator/invitations/{invitation_id}/resendLezen + schrijven

Beheer of bekijk de genoemde resource van een gehoste handelaar met een afzonderlijke Operator-API-referentie.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN
Idempotency-Keyvereist16–128 letters, cijfers, -, _ of .; duurzaam opgeslagen voor deze actie

Padparameters

invitation_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

Verzoek

: "${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
}'

Requestbody

send_emailbooleanoptioneel

Vervangt het vorige token en voegt nooit tegoed toe. Geeft een nieuw gegenereerde link één keer terug. Een al geactiveerd account vereist users.security.

Antwoord 200 application/json

Voorbeeldantwoord
{
  "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"
}

Antwoordvelden

user_idstring
emailstring
kindstring
expires_atstring
urlstring
Gebruiksopmerkingen
  • Vereist invitations.write; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Sla vóór verzenden een unieke Idempotency-Key en de exacte body duurzaam op. Nieuwe pogingen herhalen nooit een vastgelegde actie. Geheime velden worden bij herhaling weggelaten; als een antwoord met een geheim verloren is gegaan, bekijk dan de gemaakte resource en vernieuw/geef het expliciet opnieuw uit. Een 409 operator_request_in_progress kan duiden op een onderbroken verzoek met onbekend resultaat: bekijk resource/audit; probeer niet blind opnieuw met een nieuwe sleutel.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTUitnodiging intrekken/v1/operator/invitations/{invitation_id}/revokeLezen + schrijven

Beheer of bekijk de genoemde resource van een gehoste handelaar met een afzonderlijke Operator-API-referentie.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN
Idempotency-Keyvereist16–128 letters, cijfers, -, _ of .; duurzaam opgeslagen voor deze actie

Padparameters

invitation_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

Verzoek

: "${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 '{}'

Antwoord 200 application/json

Voorbeeldantwoord
{
  "revoked": true,
  "invitation_id": "44444444-4444-4444-8444-444444444444"
}

Antwoordvelden

revokedboolean
invitation_idstring
Gebruiksopmerkingen
  • Vereist invitations.write; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Sla vóór verzenden een unieke Idempotency-Key en de exacte body duurzaam op. Nieuwe pogingen herhalen nooit een vastgelegde actie. Geheime velden worden bij herhaling weggelaten; als een antwoord met een geheim verloren is gegaan, bekijk dan de gemaakte resource en vernieuw/geef het expliciet opnieuw uit. Een 409 operator_request_in_progress kan duiden op een onderbroken verzoek met onbekend resultaat: bekijk resource/audit; probeer niet blind opnieuw met een nieuwe sleutel.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETTegoed ophalen/v1/operator/merchants/{merchant_id}/creditsAlleen-lezen

Beheer of bekijk de genoemde resource van een gehoste handelaar met een afzonderlijke Operator-API-referentie.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN

Padparameters

merchant_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "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"
}

Antwoordvelden

idstring
namestring
currencystring
balancestring
fee_bpsinteger
enabledboolean
payments_pausedboolean
external_idstring
Gebruiksopmerkingen
  • Vereist credits.read; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETTegoedgrootboek opvragen/v1/operator/merchants/{merchant_id}/credits/ledgerAlleen-lezen

Beheer of bekijk de genoemde resource van een gehoste handelaar met een afzonderlijke Operator-API-referentie.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN

Padparameters

merchant_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

Queryparameters

pageoptioneel
Paginanummering vanaf 1, 25 items per pagina. Zoeken wordt ondersteund voor handelaars, gebruikers, projecten, winkels, wallets, API-referenties en webhooks; oorspronkelijke gebeurtenislijsten gebruiken hun specifieke filters.Details

Paginanummering vanaf 1, 25 items per pagina. Zoeken wordt ondersteund voor handelaars, gebruikers, projecten, winkels, wallets, API-referenties en webhooks; oorspronkelijke gebeurtenislijsten gebruiken hun specifieke filters.

qoptioneel
Paginanummering vanaf 1, 25 items per pagina. Zoeken wordt ondersteund voor handelaars, gebruikers, projecten, winkels, wallets, API-referenties en webhooks; oorspronkelijke gebeurtenislijsten gebruiken hun specifieke filters.Details

Paginanummering vanaf 1, 25 items per pagina. Zoeken wordt ondersteund voor handelaars, gebruikers, projecten, winkels, wallets, API-referenties en webhooks; oorspronkelijke gebeurtenislijsten gebruiken hun specifieke filters.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": [],
  "page": 1,
  "page_size": 25,
  "total": 0
}

Antwoordvelden

data[]array
pageinteger
page_sizeinteger
totalinteger
Gebruiksopmerkingen
  • Vereist credits.read; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTTegoed aanpassen/v1/operator/merchants/{merchant_id}/credits/adjustmentsLezen + schrijven

Voeg een toekenning of correctie met reden toe aan het vooruitbetaalde grootboek van deze handelaar.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN
Idempotency-Keyvereist16–128 letters, cijfers, -, _ of .; duurzaam opgeslagen voor deze actie

Padparameters

merchant_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

Verzoek

: "${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"
}'

Requestbody

amountsigned decimal stringvereist

Positieve toekenning of negatieve correctie, maximaal zes decimalen in de tegoedvaluta van de handelaar. Geen blockchainoverschrijving.

notestringvereist

Reden bewaard in het grootboek waaraan alleen kan worden toegevoegd.

request_idUUIDvereist

Sla samen met bedrag en reden duurzaam op, naast de HTTP-Idempotency-Key.

Antwoord 200 application/json

Voorbeeldantwoord
{
  "balance": "25"
}

Antwoordvelden

balancestring
Gebruiksopmerkingen
  • Vereist credits.write; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Sla vóór verzenden een unieke Idempotency-Key en de exacte body duurzaam op. Nieuwe pogingen herhalen nooit een vastgelegde actie. Geheime velden worden bij herhaling weggelaten; als een antwoord met een geheim verloren is gegaan, bekijk dan de gemaakte resource en vernieuw/geef het expliciet opnieuw uit. Een 409 operator_request_in_progress kan duiden op een onderbroken verzoek met onbekend resultaat: bekijk resource/audit; probeer niet blind opnieuw met een nieuwe sleutel.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETOpwaarderingen opvragen/v1/operator/merchants/{merchant_id}/topupsAlleen-lezen

Beheer of bekijk de genoemde resource van een gehoste handelaar met een afzonderlijke Operator-API-referentie.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN

Padparameters

merchant_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

Queryparameters

pageoptioneel
Paginanummering vanaf 1, 25 items per pagina. Zoeken wordt ondersteund voor handelaars, gebruikers, projecten, winkels, wallets, API-referenties en webhooks; oorspronkelijke gebeurtenislijsten gebruiken hun specifieke filters.Details

Paginanummering vanaf 1, 25 items per pagina. Zoeken wordt ondersteund voor handelaars, gebruikers, projecten, winkels, wallets, API-referenties en webhooks; oorspronkelijke gebeurtenislijsten gebruiken hun specifieke filters.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": [],
  "page": 1,
  "page_size": 25,
  "total": 0
}

Antwoordvelden

data[]array
pageinteger
page_sizeinteger
totalinteger
Gebruiksopmerkingen
  • Vereist topups.read; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTOpwaardering maken/v1/operator/merchants/{merchant_id}/topupsLezen + schrijven

Maak een afrekenpagina voor vooruitbetaald tegoed; markeer deze nooit handmatig als betaald.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN
Idempotency-Keyvereist16–128 letters, cijfers, -, _ of .; duurzaam opgeslagen voor deze actie

Padparameters

merchant_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

Verzoek

: "${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"
}'

Requestbody

amountdecimal stringvereist

Minstens één eenheid van de tegoedvaluta van de handelaar. Vereist een gereedstaande Operator-ontvangstwinkel.

request_idUUIDvereist

Bewaar bij nieuwe pogingen. Geeft de bestaande factuur terug als die al is gemaakt. Tegoed wordt pas bijgeschreven na waargenomen voldoening.

Antwoord 201 or 200 application/json

Voorbeeldantwoord
{
  "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"
}

Antwoordvelden

idstring
invoice_idstring
checkout_urlstring
Gebruiksopmerkingen
  • Vereist topups.write; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Sla vóór verzenden een unieke Idempotency-Key en de exacte body duurzaam op. Nieuwe pogingen herhalen nooit een vastgelegde actie. Geheime velden worden bij herhaling weggelaten; als een antwoord met een geheim verloren is gegaan, bekijk dan de gemaakte resource en vernieuw/geef het expliciet opnieuw uit. Een 409 operator_request_in_progress kan duiden op een onderbroken verzoek met onbekend resultaat: bekijk resource/audit; probeer niet blind opnieuw met een nieuwe sleutel.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETOpwaardering ophalen/v1/operator/merchants/{merchant_id}/topups/{topup_id}Alleen-lezen

Beheer of bekijk de genoemde resource van een gehoste handelaar met een afzonderlijke Operator-API-referentie.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN

Padparameters

merchant_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

topup_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "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"
}

Antwoordvelden

idstring
merchant_idstring
invoice_idstring
amountstring
currencystring
statusstring
invoice_statusstring
checkout_urlstring
Gebruiksopmerkingen
  • Vereist topups.read; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETRapporten/v1/operator/reportsAlleen-lezen

Lees het financiële Operator-overzicht. Vereist toegang tot alle gehoste handelaars.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN

Queryparameters

periodoptioneel

Financiële filters. period is standaard last30; gebruik custom met start/end in YYYY-MM-DD. Alleen API-referenties voor alle handelaars.

startoptioneel

Financiële filters. period is standaard last30; gebruik custom met start/end in YYYY-MM-DD. Alleen API-referenties voor alle handelaars.

endoptioneel

Financiële filters. period is standaard last30; gebruik custom met start/end in YYYY-MM-DD. Alleen API-referenties voor alle handelaars.

currencyoptioneel

Financiële filters. period is standaard last30; gebruik custom met start/end in YYYY-MM-DD. Alleen API-referenties voor alle handelaars.

merchant_idoptioneel

Financiële filters. period is standaard last30; gebruik custom met start/end in YYYY-MM-DD. Alleen API-referenties voor alle handelaars.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "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"
}

Antwoordvelden

summaryobject
feesstring
costsstring
marginstring
creditsstring
pendinginteger
missing_ratesinteger
merchants[]array
filtersobject
periodstring
currencystring
timezonestring
basisstring
Gebruiksopmerkingen
  • Vereist reports.read; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Rijen, kosten en aantallen van het eigen bedrijf worden uitgesloten voordat totalen worden berekend. Een merchant_id-filter voor het eigen bedrijf geeft 404 terug. Rapportage gebruikt de tijdzone van de installatie.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETAuditlog opvragen/v1/operator/auditAlleen-lezen

Beheer of bekijk de genoemde resource van een gehoste handelaar met een afzonderlijke Operator-API-referentie.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN

Queryparameters

merchant_idoptioneel

Filter op toegestane handelaar, exact gebeurtenistype (events) of actietekst (audit). Gebeurtenissen worden 30 dagen bewaard.

pageoptioneel
Paginanummering vanaf 1, 25 items per pagina. Zoeken wordt ondersteund voor handelaars, gebruikers, projecten, winkels, wallets, API-referenties en webhooks; oorspronkelijke gebeurtenislijsten gebruiken hun specifieke filters.Details

Paginanummering vanaf 1, 25 items per pagina. Zoeken wordt ondersteund voor handelaars, gebruikers, projecten, winkels, wallets, API-referenties en webhooks; oorspronkelijke gebeurtenislijsten gebruiken hun specifieke filters.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": [],
  "page": 1,
  "page_size": 25,
  "total": 0
}

Antwoordvelden

data[]array
pageinteger
page_sizeinteger
totalinteger
Gebruiksopmerkingen
  • Vereist audit.read; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETGebeurtenissen opvragen/v1/operator/eventsAlleen-lezen

Beheer of bekijk de genoemde resource van een gehoste handelaar met een afzonderlijke Operator-API-referentie.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN

Queryparameters

merchant_idoptioneel

Filter op toegestane handelaar, exact gebeurtenistype (events) of actietekst (audit). Gebeurtenissen worden 30 dagen bewaard.

event_typeoptioneel

Filter op toegestane handelaar, exact gebeurtenistype (events) of actietekst (audit). Gebeurtenissen worden 30 dagen bewaard.

pageoptioneel
Paginanummering vanaf 1, 25 items per pagina. Zoeken wordt ondersteund voor handelaars, gebruikers, projecten, winkels, wallets, API-referenties en webhooks; oorspronkelijke gebeurtenislijsten gebruiken hun specifieke filters.Details

Paginanummering vanaf 1, 25 items per pagina. Zoeken wordt ondersteund voor handelaars, gebruikers, projecten, winkels, wallets, API-referenties en webhooks; oorspronkelijke gebeurtenislijsten gebruiken hun specifieke filters.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": [],
  "page": 1,
  "page_size": 25,
  "total": 0
}

Antwoordvelden

data[]array
pageinteger
page_sizeinteger
totalinteger
Gebruiksopmerkingen
  • Vereist events.read; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETWebhooks opvragen/v1/operator/webhooksAlleen-lezen

Beheer of bekijk de genoemde resource van een gehoste handelaar met een afzonderlijke Operator-API-referentie.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN

Queryparameters

pageoptioneel
Paginanummering vanaf 1, 25 items per pagina. Zoeken wordt ondersteund voor handelaars, gebruikers, projecten, winkels, wallets, API-referenties en webhooks; oorspronkelijke gebeurtenislijsten gebruiken hun specifieke filters.Details

Paginanummering vanaf 1, 25 items per pagina. Zoeken wordt ondersteund voor handelaars, gebruikers, projecten, winkels, wallets, API-referenties en webhooks; oorspronkelijke gebeurtenislijsten gebruiken hun specifieke filters.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": [],
  "page": 1,
  "page_size": 25,
  "total": 0
}

Antwoordvelden

data[]array
pageinteger
page_sizeinteger
totalinteger
Gebruiksopmerkingen
  • Vereist events.read; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTWebhook maken/v1/operator/webhooksLezen + schrijven

Abonneer je op toekomstige Operator-levenscyclusgebeurtenissen. Geen betalingswebhook van een winkel.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN
Idempotency-Keyvereist16–128 letters, cijfers, -, _ of .; duurzaam opgeslagen voor deze actie

Verzoek

: "${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
}'

Requestbody

urlpublic HTTPS URLvereist

Geen inloggegevens, private IP-adressen of omleidingen. DNS/IP wordt bij bezorging opnieuw gecontroleerd.

events[]string[]vereist

Kies levenscyclusgebeurtenissen uit de Operator-handleiding, geen factuurcallbacks.

merchant_ids[]UUID[]optioneel

Leeg betekent alle handelaars die door deze API-referentie zijn toegestaan. Actuele bereikbeperkingen worden opnieuw gecontroleerd.

enabledbooleanoptioneel

Gepauzeerde eindpunten bewaren bezorgingen in de wachtrij; opnieuw inschakelen hervat geldig bewaard werk.

Antwoord 201 or 200 application/json

Voorbeeldantwoord
{
  "id": "11111111-1111-4111-8111-111111111111",
  "signing_secret": "wco_whsec_EXAMPLE_ONLY_SAVE_ONCE"
}

Antwoordvelden

idstring
signing_secretstring
Gebruiksopmerkingen
  • Vereist webhooks.write + events.read; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Sla vóór verzenden een unieke Idempotency-Key en de exacte body duurzaam op. Nieuwe pogingen herhalen nooit een vastgelegde actie. Geheime velden worden bij herhaling weggelaten; als een antwoord met een geheim verloren is gegaan, bekijk dan de gemaakte resource en vernieuw/geef het expliciet opnieuw uit. Een 409 operator_request_in_progress kan duiden op een onderbroken verzoek met onbekend resultaat: bekijk resource/audit; probeer niet blind opnieuw met een nieuwe sleutel.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTWebhook bijwerken/v1/operator/webhooks/{webhook_id}Lezen + schrijven

Beheer of bekijk de genoemde resource van een gehoste handelaar met een afzonderlijke Operator-API-referentie.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN
Idempotency-Keyvereist16–128 letters, cijfers, -, _ of .; duurzaam opgeslagen voor deze actie

Padparameters

webhook_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

Verzoek

: "${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
}'

Requestbody

urlpublic HTTPS URLvereist

Geen inloggegevens, private IP-adressen of omleidingen. DNS/IP wordt bij bezorging opnieuw gecontroleerd.

events[]string[]vereist

Kies levenscyclusgebeurtenissen uit de Operator-handleiding, geen factuurcallbacks.

merchant_ids[]UUID[]optioneel

Leeg betekent alle handelaars die door deze API-referentie zijn toegestaan. Actuele bereikbeperkingen worden opnieuw gecontroleerd.

enabledbooleanoptioneel

Gepauzeerde eindpunten bewaren bezorgingen in de wachtrij; opnieuw inschakelen hervat geldig bewaard werk.

Antwoord 200 application/json

Voorbeeldantwoord
{
  "id": "44444444-4444-4444-8444-444444444444",
  "signing_secret": null
}

Antwoordvelden

idstring
signing_secretJSON | null
Gebruiksopmerkingen
  • Vereist webhooks.write + events.read; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Sla vóór verzenden een unieke Idempotency-Key en de exacte body duurzaam op. Nieuwe pogingen herhalen nooit een vastgelegde actie. Geheime velden worden bij herhaling weggelaten; als een antwoord met een geheim verloren is gegaan, bekijk dan de gemaakte resource en vernieuw/geef het expliciet opnieuw uit. Een 409 operator_request_in_progress kan duiden op een onderbroken verzoek met onbekend resultaat: bekijk resource/audit; probeer niet blind opnieuw met een nieuwe sleutel.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTWebhookgeheim vernieuwen/v1/operator/webhooks/{webhook_id}/rotateLezen + schrijven

Beheer of bekijk de genoemde resource van een gehoste handelaar met een afzonderlijke Operator-API-referentie.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN
Idempotency-Keyvereist16–128 letters, cijfers, -, _ of .; duurzaam opgeslagen voor deze actie

Padparameters

webhook_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

Verzoek

: "${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 '{}'

Antwoord 200 application/json

Voorbeeldantwoord
{
  "id": "11111111-1111-4111-8111-111111111111",
  "signing_secret": "wco_whsec_EXAMPLE_ONLY_SAVE_ONCE"
}

Antwoordvelden

idstring
signing_secretstring
Gebruiksopmerkingen
  • Vereist webhooks.write + events.read; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Sla vóór verzenden een unieke Idempotency-Key en de exacte body duurzaam op. Nieuwe pogingen herhalen nooit een vastgelegde actie. Geheime velden worden bij herhaling weggelaten; als een antwoord met een geheim verloren is gegaan, bekijk dan de gemaakte resource en vernieuw/geef het expliciet opnieuw uit. Een 409 operator_request_in_progress kan duiden op een onderbroken verzoek met onbekend resultaat: bekijk resource/audit; probeer niet blind opnieuw met een nieuwe sleutel.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETWebhookbezorgingen opvragen/v1/operator/webhooks/{webhook_id}/deliveriesAlleen-lezen

Beheer of bekijk de genoemde resource van een gehoste handelaar met een afzonderlijke Operator-API-referentie.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN

Padparameters

webhook_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

Queryparameters

pageoptioneel
Paginanummering vanaf 1, 25 items per pagina. Zoeken wordt ondersteund voor handelaars, gebruikers, projecten, winkels, wallets, API-referenties en webhooks; oorspronkelijke gebeurtenislijsten gebruiken hun specifieke filters.Details

Paginanummering vanaf 1, 25 items per pagina. Zoeken wordt ondersteund voor handelaars, gebruikers, projecten, winkels, wallets, API-referenties en webhooks; oorspronkelijke gebeurtenislijsten gebruiken hun specifieke filters.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": [],
  "page": 1,
  "page_size": 25,
  "total": 0
}

Antwoordvelden

data[]array
pageinteger
page_sizeinteger
totalinteger
Gebruiksopmerkingen
  • Vereist events.read; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETProjecten opvragen/v1/operator/merchants/{merchant_id}/projectsAlleen-lezen

Beheer of bekijk de genoemde resource van een gehoste handelaar met een afzonderlijke Operator-API-referentie.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN

Padparameters

merchant_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

Queryparameters

pageoptioneel
Paginanummering vanaf 1, 25 items per pagina. Zoeken wordt ondersteund voor handelaars, gebruikers, projecten, winkels, wallets, API-referenties en webhooks; oorspronkelijke gebeurtenislijsten gebruiken hun specifieke filters.Details

Paginanummering vanaf 1, 25 items per pagina. Zoeken wordt ondersteund voor handelaars, gebruikers, projecten, winkels, wallets, API-referenties en webhooks; oorspronkelijke gebeurtenislijsten gebruiken hun specifieke filters.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": [],
  "page": 1,
  "page_size": 25,
  "total": 0
}

Antwoordvelden

data[]array
pageinteger
page_sizeinteger
totalinteger
Gebruiksopmerkingen
  • Vereist projects.read; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTProject maken/v1/operator/merchants/{merchant_id}/projectsLezen + schrijven

Beheer of bekijk de genoemde resource van een gehoste handelaar met een afzonderlijke Operator-API-referentie.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN
Idempotency-Keyvereist16–128 letters, cijfers, -, _ of .; duurzaam opgeslagen voor deze actie

Padparameters

merchant_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

Verzoek

: "${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
}'

Requestbody

namestringsvereist

Naam en unieke stabiele projectidentificatie. Maakt lokale wallets via de bestaande projectinitialisatie en verstuurt nooit geld.

slugstringsvereist

Naam en unieke stabiele projectidentificatie. Maakt lokale wallets via de bestaande projectinitialisatie en verstuurt nooit geld.

enabledoptioneel

enabled is standaard true; aanbevolen is om gepauzeerd aan te maken en eerst een winkel in te stellen.

reporting_timezoneoptioneel

enabled is standaard true; aanbevolen is om gepauzeerd aan te maken en eerst een winkel in te stellen.

checkout_titleoptioneel

enabled is standaard true; aanbevolen is om gepauzeerd aan te maken en eerst een winkel in te stellen.

checkout_descriptionoptioneel

enabled is standaard true; aanbevolen is om gepauzeerd aan te maken en eerst een winkel in te stellen.

checkout_themeoptioneel

enabled is standaard true; aanbevolen is om gepauzeerd aan te maken en eerst een winkel in te stellen.

checkout_accent_coloroptioneel

enabled is standaard true; aanbevolen is om gepauzeerd aan te maken en eerst een winkel in te stellen.

Antwoord 201 or 200 application/json

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

Antwoordvelden

idstring
slugstring
namestring
enabledboolean
reporting_currencystring
reporting_timezonestring
stores[]array
Gebruiksopmerkingen
  • Vereist projects.write; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Sla vóór verzenden een unieke Idempotency-Key en de exacte body duurzaam op. Nieuwe pogingen herhalen nooit een vastgelegde actie. Geheime velden worden bij herhaling weggelaten; als een antwoord met een geheim verloren is gegaan, bekijk dan de gemaakte resource en vernieuw/geef het expliciet opnieuw uit. Een 409 operator_request_in_progress kan duiden op een onderbroken verzoek met onbekend resultaat: bekijk resource/audit; probeer niet blind opnieuw met een nieuwe sleutel.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETProject ophalen/v1/operator/merchants/{merchant_id}/projects/{project_id}Alleen-lezen

Beheer of bekijk de genoemde resource van een gehoste handelaar met een afzonderlijke Operator-API-referentie.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN

Padparameters

merchant_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

project_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

Verzoek

: "${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"

Antwoord 200 application/json

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

Antwoordvelden

idstring
slugstring
namestring
enabledboolean
reporting_currencystring
reporting_timezonestring
stores[]array
Gebruiksopmerkingen
  • Vereist projects.read; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTProject bijwerken/v1/operator/merchants/{merchant_id}/projects/{project_id}Lezen + schrijven

Beheer of bekijk de genoemde resource van een gehoste handelaar met een afzonderlijke Operator-API-referentie.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN
Idempotency-Keyvereist16–128 letters, cijfers, -, _ of .; duurzaam opgeslagen voor deze actie

Padparameters

merchant_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

project_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

Verzoek

: "${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
}'

Requestbody

nameoptioneel

Gedeeltelijke update. Identificatie en eigendom door de handelaar kunnen niet veranderen.

enabledoptioneel

Gedeeltelijke update. Identificatie en eigendom door de handelaar kunnen niet veranderen.

reporting_currencyoptioneel

Gedeeltelijke update. Identificatie en eigendom door de handelaar kunnen niet veranderen.

reporting_timezoneoptioneel

Gedeeltelijke update. Identificatie en eigendom door de handelaar kunnen niet veranderen.

checkout_titleoptioneel

Gedeeltelijke update. Identificatie en eigendom door de handelaar kunnen niet veranderen.

checkout_descriptionoptioneel

Gedeeltelijke update. Identificatie en eigendom door de handelaar kunnen niet veranderen.

checkout_themeoptioneel

Gedeeltelijke update. Identificatie en eigendom door de handelaar kunnen niet veranderen.

checkout_accent_coloroptioneel

Gedeeltelijke update. Identificatie en eigendom door de handelaar kunnen niet veranderen.

Antwoord 200 application/json

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

Antwoordvelden

idstring
slugstring
namestring
enabledboolean
reporting_currencystring
reporting_timezonestring
stores[]array
Gebruiksopmerkingen
  • Vereist projects.write; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Sla vóór verzenden een unieke Idempotency-Key en de exacte body duurzaam op. Nieuwe pogingen herhalen nooit een vastgelegde actie. Geheime velden worden bij herhaling weggelaten; als een antwoord met een geheim verloren is gegaan, bekijk dan de gemaakte resource en vernieuw/geef het expliciet opnieuw uit. Een 409 operator_request_in_progress kan duiden op een onderbroken verzoek met onbekend resultaat: bekijk resource/audit; probeer niet blind opnieuw met een nieuwe sleutel.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETWinkels opvragen/v1/operator/merchants/{merchant_id}/projects/{project_id}/storesAlleen-lezen

Beheer of bekijk de genoemde resource van een gehoste handelaar met een afzonderlijke Operator-API-referentie.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN

Padparameters

merchant_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

project_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

Queryparameters

pageoptioneel
Paginanummering vanaf 1, 25 items per pagina. Zoeken wordt ondersteund voor handelaars, gebruikers, projecten, winkels, wallets, API-referenties en webhooks; oorspronkelijke gebeurtenislijsten gebruiken hun specifieke filters.Details

Paginanummering vanaf 1, 25 items per pagina. Zoeken wordt ondersteund voor handelaars, gebruikers, projecten, winkels, wallets, API-referenties en webhooks; oorspronkelijke gebeurtenislijsten gebruiken hun specifieke filters.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": [],
  "page": 1,
  "page_size": 25,
  "total": 0
}

Antwoordvelden

data[]array
pageinteger
page_sizeinteger
totalinteger
Gebruiksopmerkingen
  • Vereist projects.read; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTWinkel maken/v1/operator/merchants/{merchant_id}/projects/{project_id}/storesLezen + schrijven

Beheer of bekijk de genoemde resource van een gehoste handelaar met een afzonderlijke Operator-API-referentie.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN
Idempotency-Keyvereist16–128 letters, cijfers, -, _ of .; duurzaam opgeslagen voor deze actie

Padparameters

merchant_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

project_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

Verzoek

: "${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
}'

Requestbody

namestringsvereist

Winkelnaam en stabiele identificatie.

slugstringsvereist

Winkelnaam en stabiele identificatie.

default_currencyoptioneel

Gebruik decimale tekenreeksen voor percentages. Nieuwe winkels nemen het uiterlijk van de standaardwinkel van het project over.

invoice_expiry_minutesoptioneel

Gebruik decimale tekenreeksen voor percentages. Nieuwe winkels nemen het uiterlijk van de standaardwinkel van het project over.

exchange_rate_spread_percentoptioneel

Gebruik decimale tekenreeksen voor percentages. Nieuwe winkels nemen het uiterlijk van de standaardwinkel van het project over.

underpayment_tolerance_percentoptioneel

Gebruik decimale tekenreeksen voor percentages. Nieuwe winkels nemen het uiterlijk van de standaardwinkel van het project over.

enabledoptioneel

Stel geaccepteerde activa in met payment-assets; facturen met nulbedrag staan standaard uit.

is_defaultoptioneel

Stel geaccepteerde activa in met payment-assets; facturen met nulbedrag staan standaard uit.

allow_zero_amount_invoicesoptioneel

Stel geaccepteerde activa in met payment-assets; facturen met nulbedrag staan standaard uit.

allow_underpaymentsoptioneel

Stel geaccepteerde activa in met payment-assets; facturen met nulbedrag staan standaard uit.

allow_overpaymentsoptioneel

Stel geaccepteerde activa in met payment-assets; facturen met nulbedrag staan standaard uit.

allowed_chain_slugsoptioneel

Stel geaccepteerde activa in met payment-assets; facturen met nulbedrag staan standaard uit.

ipn_enabledoptioneel

IPN- en terugkeer-URL's volgen bestaande URL-validatie. Geen willekeurige HTML/JavaScript.

default_ipn_urloptioneel

IPN- en terugkeer-URL's volgen bestaande URL-validatie. Geen willekeurige HTML/JavaScript.

default_redirect_urloptioneel

IPN- en terugkeer-URL's volgen bestaande URL-validatie. Geen willekeurige HTML/JavaScript.

default_cancel_urloptioneel

IPN- en terugkeer-URL's volgen bestaande URL-validatie. Geen willekeurige HTML/JavaScript.

redirect_automaticallyoptioneel

IPN- en terugkeer-URL's volgen bestaande URL-validatie. Geen willekeurige HTML/JavaScript.

checkout_languageoptioneel

Gebruik een ondersteunde taal en actieve roldomeinen; stel toegestane oorsprongen voor inbedden expliciet in.

embed_enabledoptioneel

Gebruik een ondersteunde taal en actieve roldomeinen; stel toegestane oorsprongen voor inbedden expliciet in.

allowed_embed_originsoptioneel

Gebruik een ondersteunde taal en actieve roldomeinen; stel toegestane oorsprongen voor inbedden expliciet in.

domainsoptioneel

Gebruik een ondersteunde taal en actieve roldomeinen; stel toegestane oorsprongen voor inbedden expliciet in.

Antwoord 201 or 200 application/json

Voorbeeldantwoord
{
  "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
}

Antwoordvelden

idstring
project_idstring
slugstring
namestring
enabledboolean
default_currencystring
invoice_expiry_minutesinteger
Gebruiksopmerkingen
  • Vereist projects.write; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Sla vóór verzenden een unieke Idempotency-Key en de exacte body duurzaam op. Nieuwe pogingen herhalen nooit een vastgelegde actie. Geheime velden worden bij herhaling weggelaten; als een antwoord met een geheim verloren is gegaan, bekijk dan de gemaakte resource en vernieuw/geef het expliciet opnieuw uit. Een 409 operator_request_in_progress kan duiden op een onderbroken verzoek met onbekend resultaat: bekijk resource/audit; probeer niet blind opnieuw met een nieuwe sleutel.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETWinkel ophalen/v1/operator/merchants/{merchant_id}/projects/{project_id}/stores/{store_id}Alleen-lezen

Beheer of bekijk de genoemde resource van een gehoste handelaar met een afzonderlijke Operator-API-referentie.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN

Padparameters

merchant_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

project_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

store_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "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
}

Antwoordvelden

idstring
project_idstring
slugstring
namestring
enabledboolean
default_currencystring
invoice_expiry_minutesinteger
Gebruiksopmerkingen
  • Vereist projects.read; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTWinkel bijwerken/v1/operator/merchants/{merchant_id}/projects/{project_id}/stores/{store_id}Lezen + schrijven

Beheer of bekijk de genoemde resource van een gehoste handelaar met een afzonderlijke Operator-API-referentie.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN
Idempotency-Keyvereist16–128 letters, cijfers, -, _ of .; duurzaam opgeslagen voor deze actie

Padparameters

merchant_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

project_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

store_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

Verzoek

: "${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
}'

Requestbody

store fieldsoptioneel

Dezelfde wijzigbare instellingen als bij winkelaanmaak, behalve slug. Alleen aangeleverde velden veranderen.

enabledboolean

Antwoord 200 application/json

Voorbeeldantwoord
{
  "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
}

Antwoordvelden

idstring
project_idstring
slugstring
namestring
enabledboolean
default_currencystring
invoice_expiry_minutesinteger
Gebruiksopmerkingen
  • Vereist projects.write; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Sla vóór verzenden een unieke Idempotency-Key en de exacte body duurzaam op. Nieuwe pogingen herhalen nooit een vastgelegde actie. Geheime velden worden bij herhaling weggelaten; als een antwoord met een geheim verloren is gegaan, bekijk dan de gemaakte resource en vernieuw/geef het expliciet opnieuw uit. Een 409 operator_request_in_progress kan duiden op een onderbroken verzoek met onbekend resultaat: bekijk resource/audit; probeer niet blind opnieuw met een nieuwe sleutel.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETWinkeluiterlijk ophalen/v1/operator/merchants/{merchant_id}/projects/{project_id}/stores/{store_id}/checkout-appearanceAlleen-lezen

Beheer of bekijk de genoemde resource van een gehoste handelaar met een afzonderlijke Operator-API-referentie.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN

Padparameters

merchant_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

project_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

store_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "revision": 1,
  "settings": {
    "inherit_default_store": true
  },
  "effective": {
    "title": "Pay securely"
  }
}

Antwoordvelden

revisioninteger
settingsobject
inherit_default_storeboolean
effectiveobject
titlestring
Gebruiksopmerkingen
  • Vereist projects.read; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTWinkeluiterlijk bijwerken/v1/operator/merchants/{merchant_id}/projects/{project_id}/stores/{store_id}/checkout-appearanceLezen + schrijven

Sla een gevalideerd winkelontwerp met revisiebescherming op.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN
Idempotency-Keyvereist16–128 letters, cijfers, -, _ of .; duurzaam opgeslagen voor deze actie

Padparameters

merchant_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

project_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

store_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

Verzoek

: "${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"
  }
}'

Requestbody

revisionintegervereist

Lees eerst de huidige revisie met GET. Een verouderde revisie wordt geweigerd zonder de wijzigingen van een andere bewerker te overschrijven.

settingsobjectvereist
Gevalideerd afrekenuiterlijk, inclusief inherit_default_store, huisstijl, intro/outro, lettergroottes en zichtbaarheid. Geen willekeurige HTML/JavaScript. Afbeeldingsbytes uploaden kan alleen via de console.Details

Gevalideerd afrekenuiterlijk, inclusief inherit_default_store, huisstijl, intro/outro, lettergroottes en zichtbaarheid. Geen willekeurige HTML/JavaScript. Afbeeldingsbytes uploaden kan alleen via de console.

inherit_default_storeboolean
titlestring
themestring

Antwoord 200 application/json

Voorbeeldantwoord
{
  "settings": {
    "inherit_default_store": false,
    "title": "Pay securely",
    "theme": "light"
  },
  "revision": 2
}

Antwoordvelden

settingsobject
inherit_default_storeboolean
titlestring
themestring
revisioninteger
Gebruiksopmerkingen
  • Vereist projects.write; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Sla vóór verzenden een unieke Idempotency-Key en de exacte body duurzaam op. Nieuwe pogingen herhalen nooit een vastgelegde actie. Geheime velden worden bij herhaling weggelaten; als een antwoord met een geheim verloren is gegaan, bekijk dan de gemaakte resource en vernieuw/geef het expliciet opnieuw uit. Een 409 operator_request_in_progress kan duiden op een onderbroken verzoek met onbekend resultaat: bekijk resource/audit; probeer niet blind opnieuw met een nieuwe sleutel.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETBetaalactiva van winkel opvragen/v1/operator/merchants/{merchant_id}/projects/{project_id}/stores/{store_id}/payment-assetsAlleen-lezen

Beheer of bekijk de genoemde resource van een gehoste handelaar met een afzonderlijke Operator-API-referentie.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN

Padparameters

merchant_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

project_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

store_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": []
}

Antwoordvelden

data[]array
Gebruiksopmerkingen
  • Vereist projects.read; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTBetaalactiva van winkel bijwerken/v1/operator/merchants/{merchant_id}/projects/{project_id}/stores/{store_id}/payment-assetsLezen + schrijven

Beheer of bekijk de genoemde resource van een gehoste handelaar met een afzonderlijke Operator-API-referentie.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN
Idempotency-Keyvereist16–128 letters, cijfers, -, _ of .; duurzaam opgeslagen voor deze actie

Padparameters

merchant_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

project_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

store_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

Verzoek

: "${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
    }
  ]
}'

Requestbody

assets[]object[]vereist
Volledige vervanging van blockchainmethoden: asset_id-UUID en display_order. [] wist geaccepteerde blockchainactiva. Alleen geverifieerde projectactiva; configureert Lightning niet.Details

Volledige vervanging van blockchainmethoden: asset_id-UUID en display_order. [] wist geaccepteerde blockchainactiva. Alleen geverifieerde projectactiva; configureert Lightning niet.

asset_idstring
display_orderinteger

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": []
}

Antwoordvelden

data[]array
Gebruiksopmerkingen
  • Vereist projects.write; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Sla vóór verzenden een unieke Idempotency-Key en de exacte body duurzaam op. Nieuwe pogingen herhalen nooit een vastgelegde actie. Geheime velden worden bij herhaling weggelaten; als een antwoord met een geheim verloren is gegaan, bekijk dan de gemaakte resource en vernieuw/geef het expliciet opnieuw uit. Een 409 operator_request_in_progress kan duiden op een onderbroken verzoek met onbekend resultaat: bekijk resource/audit; probeer niet blind opnieuw met een nieuwe sleutel.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETWinkelwebhooks opvragen/v1/operator/merchants/{merchant_id}/projects/{project_id}/stores/{store_id}/webhooksAlleen-lezen

Beheer of bekijk de genoemde resource van een gehoste handelaar met een afzonderlijke Operator-API-referentie.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN

Padparameters

merchant_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

project_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

store_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

Queryparameters

pageoptioneel
Paginanummering vanaf 1, 25 items per pagina. Zoeken wordt ondersteund voor handelaars, gebruikers, projecten, winkels, wallets, API-referenties en webhooks; oorspronkelijke gebeurtenislijsten gebruiken hun specifieke filters.Details

Paginanummering vanaf 1, 25 items per pagina. Zoeken wordt ondersteund voor handelaars, gebruikers, projecten, winkels, wallets, API-referenties en webhooks; oorspronkelijke gebeurtenislijsten gebruiken hun specifieke filters.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": [],
  "page": 1,
  "page_size": 25,
  "total": 0
}

Antwoordvelden

data[]array
pageinteger
page_sizeinteger
totalinteger
Gebruiksopmerkingen
  • Vereist projects.read; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTWinkelwebhook maken/v1/operator/merchants/{merchant_id}/projects/{project_id}/stores/{store_id}/webhooksLezen + schrijven

Beheer of bekijk de genoemde resource van een gehoste handelaar met een afzonderlijke Operator-API-referentie.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN
Idempotency-Keyvereist16–128 letters, cijfers, -, _ of .; duurzaam opgeslagen voor deze actie

Padparameters

merchant_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

project_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

store_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

Verzoek

: "${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
}'

Requestbody

namestrings / arrayvereist

Publieke HTTPS-ontvanger en factuurgebeurtenisnamen uit de IPN- en webhookdocumentatie.

urlstrings / arrayvereist

Publieke HTTPS-ontvanger en factuurgebeurtenisnamen uit de IPN- en webhookdocumentatie.

event_types[]strings / arrayvereist

Publieke HTTPS-ontvanger en factuurgebeurtenisnamen uit de IPN- en webhookdocumentatie.

enabledbooleansoptioneel

Aanmaken geeft het ondertekeningsgeheim één keer terug. Dit zijn betalingscallbacks van winkels, geen Operator-levenscyclusgebeurtenissen.

automatic_redeliverybooleansoptioneel

Aanmaken geeft het ondertekeningsgeheim één keer terug. Dit zijn betalingscallbacks van winkels, geen Operator-levenscyclusgebeurtenissen.

Antwoord 201 or 200 application/json

Voorbeeldantwoord
{
  "signing_secret": "EXAMPLE_ONLY_SAVE_ONCE",
  "endpoint": {
    "id": "44444444-4444-4444-8444-444444444444",
    "name": "Orders",
    "enabled": true
  },
  "secret_visible_once": true
}

Antwoordvelden

signing_secretstring
endpointobject
idstring
namestring
enabledboolean
secret_visible_onceboolean
Gebruiksopmerkingen
  • Vereist projects.write; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Sla vóór verzenden een unieke Idempotency-Key en de exacte body duurzaam op. Nieuwe pogingen herhalen nooit een vastgelegde actie. Geheime velden worden bij herhaling weggelaten; als een antwoord met een geheim verloren is gegaan, bekijk dan de gemaakte resource en vernieuw/geef het expliciet opnieuw uit. Een 409 operator_request_in_progress kan duiden op een onderbroken verzoek met onbekend resultaat: bekijk resource/audit; probeer niet blind opnieuw met een nieuwe sleutel.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTWinkelwebhook bijwerken/v1/operator/merchants/{merchant_id}/projects/{project_id}/stores/{store_id}/webhooks/{webhook_id}Lezen + schrijven

Beheer of bekijk de genoemde resource van een gehoste handelaar met een afzonderlijke Operator-API-referentie.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN
Idempotency-Keyvereist16–128 letters, cijfers, -, _ of .; duurzaam opgeslagen voor deze actie

Padparameters

merchant_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

project_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

store_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

webhook_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

Verzoek

: "${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
}'

Requestbody

namestrings / arrayvereist

Publieke HTTPS-ontvanger en factuurgebeurtenisnamen uit de IPN- en webhookdocumentatie.

urlstrings / arrayvereist

Publieke HTTPS-ontvanger en factuurgebeurtenisnamen uit de IPN- en webhookdocumentatie.

event_types[]strings / arrayvereist

Publieke HTTPS-ontvanger en factuurgebeurtenisnamen uit de IPN- en webhookdocumentatie.

enabledbooleansoptioneel

Aanmaken geeft het ondertekeningsgeheim één keer terug. Dit zijn betalingscallbacks van winkels, geen Operator-levenscyclusgebeurtenissen.

automatic_redeliverybooleansoptioneel

Aanmaken geeft het ondertekeningsgeheim één keer terug. Dit zijn betalingscallbacks van winkels, geen Operator-levenscyclusgebeurtenissen.

Antwoord 200 application/json

Voorbeeldantwoord
{
  "id": "44444444-4444-4444-8444-444444444444",
  "name": "Orders",
  "enabled": true
}

Antwoordvelden

idstring
namestring
enabledboolean
Gebruiksopmerkingen
  • Vereist projects.write; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Sla vóór verzenden een unieke Idempotency-Key en de exacte body duurzaam op. Nieuwe pogingen herhalen nooit een vastgelegde actie. Geheime velden worden bij herhaling weggelaten; als een antwoord met een geheim verloren is gegaan, bekijk dan de gemaakte resource en vernieuw/geef het expliciet opnieuw uit. Een 409 operator_request_in_progress kan duiden op een onderbroken verzoek met onbekend resultaat: bekijk resource/audit; probeer niet blind opnieuw met een nieuwe sleutel.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETFacturen opvragen/v1/operator/merchants/{merchant_id}/projects/{project_id}/invoicesAlleen-lezen

Beheer of bekijk de genoemde resource van een gehoste handelaar met een afzonderlijke Operator-API-referentie.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN

Padparameters

merchant_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

project_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

Queryparameters

limitoptioneel

Factuurpaginering en filters, hetzelfde als de projectfactuurlijst.

offsetoptioneel

Factuurpaginering en filters, hetzelfde als de projectfactuurlijst.

statusoptioneel

Factuurpaginering en filters, hetzelfde als de projectfactuurlijst.

store_idoptioneel

Factuurpaginering en filters, hetzelfde als de projectfactuurlijst.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": [],
  "pagination": {
    "limit": 25,
    "offset": 0,
    "total": 0,
    "has_more": false
  }
}

Antwoordvelden

data[]array
paginationobject
limitinteger
offsetinteger
totalinteger
has_moreboolean
Gebruiksopmerkingen
  • Vereist reports.read; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETFactuur ophalen/v1/operator/merchants/{merchant_id}/projects/{project_id}/invoices/{invoice_id}Alleen-lezen

Beheer of bekijk de genoemde resource van een gehoste handelaar met een afzonderlijke Operator-API-referentie.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN

Padparameters

merchant_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

project_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

invoice_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

Verzoek

: "${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"

Antwoord 200 application/json

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

Antwoordvelden

invoice_idstring
project_idstring
amountstring
currencystring
statusstring
metadataobject
payment_intents[]array
Gebruiksopmerkingen
  • Vereist reports.read; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.
  • invoice_id is de publieke factuur-ID die bij aanmaak en in callbacks wordt teruggegeven, niet de interne id.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETWallets opvragen/v1/operator/merchants/{merchant_id}/projects/{project_id}/walletsAlleen-lezen

Lees gecachte publieke walletsaldi, nooit private sleutels of herstelzinnen.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN

Padparameters

merchant_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

project_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

Queryparameters

pageoptioneel
Paginanummering vanaf 1, 25 items per pagina. Zoeken wordt ondersteund voor handelaars, gebruikers, projecten, winkels, wallets, API-referenties en webhooks; oorspronkelijke gebeurtenislijsten gebruiken hun specifieke filters.Details

Paginanummering vanaf 1, 25 items per pagina. Zoeken wordt ondersteund voor handelaars, gebruikers, projecten, winkels, wallets, API-referenties en webhooks; oorspronkelijke gebeurtenislijsten gebruiken hun specifieke filters.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": [],
  "page": 1,
  "page_size": 25,
  "total": 0
}

Antwoordvelden

data[]array
pageinteger
page_sizeinteger
totalinteger
Gebruiksopmerkingen
  • Vereist reports.read; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Saldi zijn gecachte waarnemingen met actualiteitsvelden, geen garantie van een besteedbaar saldo. Verzenden en sleutelexport zijn niet beschikbaar via deze API.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETWalletadressen opvragen/v1/operator/merchants/{merchant_id}/projects/{project_id}/wallets/{wallet_id}/addressesAlleen-lezen

Beheer of bekijk de genoemde resource van een gehoste handelaar met een afzonderlijke Operator-API-referentie.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN

Padparameters

merchant_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

project_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

wallet_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

Queryparameters

limitoptioneel
Limiet 1–50, standaard 25. Geef voor de volgende pagina next_cursor mee als before. Laat before weg voor pagina 1. has_balance=false en hide_small_balances=false nemen lege/kleine saldi mee.Details

Limiet 1–50, standaard 25. Geef voor de volgende pagina next_cursor mee als before. Laat before weg voor pagina 1. has_balance=false en hide_small_balances=false nemen lege/kleine saldi mee.

beforeoptioneel
Limiet 1–50, standaard 25. Geef voor de volgende pagina next_cursor mee als before. Laat before weg voor pagina 1. has_balance=false en hide_small_balances=false nemen lege/kleine saldi mee.Details

Limiet 1–50, standaard 25. Geef voor de volgende pagina next_cursor mee als before. Laat before weg voor pagina 1. has_balance=false en hide_small_balances=false nemen lege/kleine saldi mee.

has_balanceoptioneel
Limiet 1–50, standaard 25. Geef voor de volgende pagina next_cursor mee als before. Laat before weg voor pagina 1. has_balance=false en hide_small_balances=false nemen lege/kleine saldi mee.Details

Limiet 1–50, standaard 25. Geef voor de volgende pagina next_cursor mee als before. Laat before weg voor pagina 1. has_balance=false en hide_small_balances=false nemen lege/kleine saldi mee.

hide_small_balancesoptioneel
Limiet 1–50, standaard 25. Geef voor de volgende pagina next_cursor mee als before. Laat before weg voor pagina 1. has_balance=false en hide_small_balances=false nemen lege/kleine saldi mee.Details

Limiet 1–50, standaard 25. Geef voor de volgende pagina next_cursor mee als before. Laat before weg voor pagina 1. has_balance=false en hide_small_balances=false nemen lege/kleine saldi mee.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "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"
  }
}

Antwoordvelden

walletobject
idstring
chain_slugstring
items[]array
totalinteger
total_pagesinteger
next_cursorJSON | null
reporting_currencystring
has_balanceboolean
hide_small_balancesboolean
small_balance_thresholdobject
amountstring
currencystring
Gebruiksopmerkingen
  • Vereist reports.read; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETHandelaars-API-referenties opvragen/v1/operator/merchants/{merchant_id}/api-credentialsAlleen-lezen

Beheer of bekijk de genoemde resource van een gehoste handelaar met een afzonderlijke Operator-API-referentie.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN

Padparameters

merchant_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

Queryparameters

pageoptioneel
Paginanummering vanaf 1, 25 items per pagina. Zoeken wordt ondersteund voor handelaars, gebruikers, projecten, winkels, wallets, API-referenties en webhooks; oorspronkelijke gebeurtenislijsten gebruiken hun specifieke filters.Details

Paginanummering vanaf 1, 25 items per pagina. Zoeken wordt ondersteund voor handelaars, gebruikers, projecten, winkels, wallets, API-referenties en webhooks; oorspronkelijke gebeurtenislijsten gebruiken hun specifieke filters.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": [],
  "page": 1,
  "page_size": 25,
  "total": 0
}

Antwoordvelden

data[]array
pageinteger
page_sizeinteger
totalinteger
Gebruiksopmerkingen
  • Vereist merchant_credentials.read; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTHandelaars-API-referentie maken/v1/operator/merchants/{merchant_id}/api-credentialsLezen + schrijven

Beheer of bekijk de genoemde resource van een gehoste handelaar met een afzonderlijke Operator-API-referentie.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN
Idempotency-Keyvereist16–128 letters, cijfers, -, _ of .; duurzaam opgeslagen voor deze actie

Padparameters

merchant_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

Verzoek

: "${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"
  ]
}'

Requestbody

namestringvereist

Label voor een nieuwe gewone handelaarssleutel, geen Operator-sleutel.

access_levelread_only | read_writeoptioneel

Lezen/schrijven schakelt het bestaande handelaars-API-contract in.

project_ids[]UUID[]

Alleen projecten van de geselecteerde handelaar; een lege lijst volgt het bestaande beleid voor alle handelaarsprojecten.

enabledoptioneel

Bestaande instellingen voor handelaarssleutels. Geheim wordt slechts één keer teruggegeven; vereist merchant_credentials.write.

ip_restriction_enabledoptioneel

Bestaande instellingen voor handelaarssleutels. Geheim wordt slechts één keer teruggegeven; vereist merchant_credentials.write.

allowed_ips[]optioneel

Bestaande instellingen voor handelaarssleutels. Geheim wordt slechts één keer teruggegeven; vereist merchant_credentials.write.

requests_per_minuteoptioneel

Bestaande instellingen voor handelaarssleutels. Geheim wordt slechts één keer teruggegeven; vereist merchant_credentials.write.

Antwoord 201 or 200 application/json

Voorbeeldantwoord
{
  "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"
}

Antwoordvelden

credentialobject
idstring
namestring
access_levelstring
project_ids[]array
enabledboolean
tokenstring
Gebruiksopmerkingen
  • Vereist merchant_credentials.write; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Sla vóór verzenden een unieke Idempotency-Key en de exacte body duurzaam op. Nieuwe pogingen herhalen nooit een vastgelegde actie. Geheime velden worden bij herhaling weggelaten; als een antwoord met een geheim verloren is gegaan, bekijk dan de gemaakte resource en vernieuw/geef het expliciet opnieuw uit. Een 409 operator_request_in_progress kan duiden op een onderbroken verzoek met onbekend resultaat: bekijk resource/audit; probeer niet blind opnieuw met een nieuwe sleutel.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTHandelaars-API-referentie bijwerken/v1/operator/merchants/{merchant_id}/api-credentials/{credential_id}Lezen + schrijven

Beheer of bekijk de genoemde resource van een gehoste handelaar met een afzonderlijke Operator-API-referentie.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN
Idempotency-Keyvereist16–128 letters, cijfers, -, _ of .; duurzaam opgeslagen voor deze actie

Padparameters

merchant_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

credential_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

Verzoek

: "${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"
  ]
}'

Requestbody

namefieldsvereist

Verstuur de volledige huidige configuratie van de API-referentie met wijzigingen. project_ids is standaard []; requests_per_minute is standaard het handelaars-API-quotum.

access_levelfieldsvereist

Verstuur de volledige huidige configuratie van de API-referentie met wijzigingen. project_ids is standaard []; requests_per_minute is standaard het handelaars-API-quotum.

enabledfieldsvereist

Verstuur de volledige huidige configuratie van de API-referentie met wijzigingen. project_ids is standaard []; requests_per_minute is standaard het handelaars-API-quotum.

ip_restriction_enabledfieldsvereist

Verstuur de volledige huidige configuratie van de API-referentie met wijzigingen. project_ids is standaard []; requests_per_minute is standaard het handelaars-API-quotum.

allowed_ips[]fieldsvereist

Verstuur de volledige huidige configuratie van de API-referentie met wijzigingen. project_ids is standaard []; requests_per_minute is standaard het handelaars-API-quotum.

project_ids[]array

Antwoord 200 application/json

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

Antwoordvelden

idstring
namestring
access_levelstring
project_ids[]array
enabledboolean
Gebruiksopmerkingen
  • Vereist merchant_credentials.write; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Sla vóór verzenden een unieke Idempotency-Key en de exacte body duurzaam op. Nieuwe pogingen herhalen nooit een vastgelegde actie. Geheime velden worden bij herhaling weggelaten; als een antwoord met een geheim verloren is gegaan, bekijk dan de gemaakte resource en vernieuw/geef het expliciet opnieuw uit. Een 409 operator_request_in_progress kan duiden op een onderbroken verzoek met onbekend resultaat: bekijk resource/audit; probeer niet blind opnieuw met een nieuwe sleutel.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTHandelaars-API-referentie vernieuwen/v1/operator/merchants/{merchant_id}/api-credentials/{credential_id}/rotateLezen + schrijven

Beheer of bekijk de genoemde resource van een gehoste handelaar met een afzonderlijke Operator-API-referentie.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN
Idempotency-Keyvereist16–128 letters, cijfers, -, _ of .; duurzaam opgeslagen voor deze actie

Padparameters

merchant_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

credential_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

Verzoek

: "${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 '{}'

Antwoord 200 application/json

Voorbeeldantwoord
{
  "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"
}

Antwoordvelden

credentialobject
idstring
namestring
access_levelstring
project_ids[]array
enabledboolean
tokenstring
Gebruiksopmerkingen
  • Vereist merchant_credentials.write; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Sla vóór verzenden een unieke Idempotency-Key en de exacte body duurzaam op. Nieuwe pogingen herhalen nooit een vastgelegde actie. Geheime velden worden bij herhaling weggelaten; als een antwoord met een geheim verloren is gegaan, bekijk dan de gemaakte resource en vernieuw/geef het expliciet opnieuw uit. Een 409 operator_request_in_progress kan duiden op een onderbroken verzoek met onbekend resultaat: bekijk resource/audit; probeer niet blind opnieuw met een nieuwe sleutel.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTHandelaars-API-referentie intrekken/v1/operator/merchants/{merchant_id}/api-credentials/{credential_id}/revokeLezen + schrijven

Beheer of bekijk de genoemde resource van een gehoste handelaar met een afzonderlijke Operator-API-referentie.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_OPERATOR_API_TOKEN
Idempotency-Keyvereist16–128 letters, cijfers, -, _ of .; duurzaam opgeslagen voor deze actie

Padparameters

merchant_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

credential_idUUIDvereist

Canonieke resource-UUID in kleine letters; moet binnen het handelaarsbereik van de API-referentie vallen.

Verzoek

: "${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 '{}'

Antwoord 200 application/json

Voorbeeldantwoord
{
  "revoked": true
}

Antwoordvelden

revokedboolean
Gebruiksopmerkingen
  • Vereist merchant_credentials.write; alleen toegestane gehoste handelaars. Operator-sleutels hebben geen toegang tot de werkruimte van het eigen bedrijf van de eigenaar.
  • Sla vóór verzenden een unieke Idempotency-Key en de exacte body duurzaam op. Nieuwe pogingen herhalen nooit een vastgelegde actie. Geheime velden worden bij herhaling weggelaten; als een antwoord met een geheim verloren is gegaan, bekijk dan de gemaakte resource en vernieuw/geef het expliciet opnieuw uit. Een 409 operator_request_in_progress kan duiden op een onderbroken verzoek met onbekend resultaat: bekijk resource/audit; probeer niet blind opnieuw met een nieuwe sleutel.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTUitnodigingstoken controleren/v1/onboarding/invitations/checkPubliek

Aansluiting uitsluitend met token. Accepteert geen Operator-sleutel en meldt niet automatisch aan. Consoleaanmelding vereist nog steeds Basic Auth van de site en bestaande TOTP.

Authenticatie & headers

Publiek

Verzoek

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"
}'

Requestbody

tokenstringvereist

Geheim uit het URL-fragment van de uitnodiging. Log dit nooit.

Antwoord 200 application/json

Voorbeeldantwoord
{
  "kind": "invitation",
  "email": "admin@example.test",
  "merchant_name": "Example shop"
}

Antwoordvelden

kindstring
emailstring
merchant_namestring
Gebruiksopmerkingen
  • Uitnodiging voor 48 uur; wachtwoordherstellink voor één uur. Eenmalige gehashte tokens. Opnieuw uitgeven trekt de eerdere link in. Acceptatie behoudt TOTP en trekt oude sessies in.
  • Geen automatische nieuwe pogingen. Controleer bij een time-out tijdens acceptatie de linkstatus en probeer in te loggen; neem niet aan dat het mislukt is. Aanvraaglimiet op basis van waargenomen bron-IP. De ontvanger moet zelf het sleutelbeheer erkennen.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTUitnodiging of wachtwoordherstel accepteren/v1/onboarding/invitations/acceptPubliek

Aansluiting uitsluitend met token. Accepteert geen Operator-sleutel en meldt niet automatisch aan. Consoleaanmelding vereist nog steeds Basic Auth van de site en bestaande TOTP.

Authenticatie & headers

Publiek

Verzoek

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
}'

Requestbody

tokenstringvereist

Geheim uit het URL-fragment van de uitnodiging. Log dit nooit.

passwordstringvereist

Nieuw wachtwoord, 12–128 tekens (maximaal 512 UTF-8-bytes).

custody_acknowledgedboolean

Moet true zijn bij het accepteren van een nieuwe uitnodiging voor een gehoste wallet.

Antwoord 200 application/json

Voorbeeldantwoord
{
  "password_set": true
}

Antwoordvelden

password_setboolean
Gebruiksopmerkingen
  • Uitnodiging voor 48 uur; wachtwoordherstellink voor één uur. Eenmalige gehashte tokens. Opnieuw uitgeven trekt de eerdere link in. Acceptatie behoudt TOTP en trekt oude sessies in.
  • Geen automatische nieuwe pogingen. Controleer bij een time-out tijdens acceptatie de linkstatus en probeer in te loggen; neem niet aan dat het mislukt is. Aanvraaglimiet op basis van waargenomen bron-IP. De ontvanger moet zelf het sleutelbeheer erkennen.
  • Antwoordvoorbeelden tonen geselecteerde velden. Beschouw aanvullende antwoordvelden als uitbreidingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETMogelijkheden/v1/marketplace/capabilitiesAlleen-lezen

Deelnemende winkels, ingestelde activa, ondersteunde uitbetalingsroutes, eigen munt voor kosten en redenen voor gereedheid. Tijdelijke scannerbeschikbaarheid vergroot de toegestane activaverzameling niet.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MARKETPLACE_API_TOKEN
ParameterType / locatieRegel
permissioncredential scopemarketplace.read

Queryparameters

project_idUUIDvereist

Een geautoriseerd project. Vereist bij elk verzoek, inclusief item-URL's.

pageoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

per_pageoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

qoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

statusoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

store_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

vendor_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

asset_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

fromoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

tooptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": {}
}

Antwoordvelden

dataobject
Gebruiksopmerkingen
  • Vereist marketplace.read. Antwoordvoorbeelden tonen geselecteerde velden; gebruik GET op de resource voor het volledige bewaarde bewijs.
  • Elke POST vereist een duurzaam opgeslagen Idempotency-Key van 16–128 tekens (letters, cijfers, -, _ of .). Hergebruik na een time-out dezelfde sleutel en JSON-instructies. Andere instructies geven 409 terug. Voltooide antwoorden worden 30 dagen bewaard; oude sleutels worden blijvend gemarkeerd als niet herbruikbaar. Wijzig een sleutel nooit alleen om een onzeker resultaat te omzeilen.
  • Sleutels hebben projectlijsten, optionele beperkingen voor factuurwinkels, een vervaldatum, IP-toelatingslijst en een quotum van 1–600/minuut (standaard 60). HTTP 429 bevat Retry-After. Sleutels die tot winkels zijn beperkt, kunnen geen verkopers, projectsaldi, grootboek, uitbetalingen of instellingen zien. Bewaar bestedingsreferenties uitsluitend op vertrouwde servers, nooit in browsers of uitgeleverde mobiele apps.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETMarketplace-rapport/v1/marketplace/overviewAlleen-lezen

Filter store_id, asset_id, from en to (inclusief YYYY-MM-DD, UTC; standaard de laatste 30 dagen; maximaal tien jaar). Exacte accountsaldi op de einddatum en wijzigingen in de periode. Geen geschatte fiatinkomsten. Een winkelfilter sluit projectbrede kosten zonder factuur uit.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MARKETPLACE_API_TOKEN
ParameterType / locatieRegel
permissioncredential scopemarketplace.read

Queryparameters

project_idUUIDvereist

Een geautoriseerd project. Vereist bij elk verzoek, inclusief item-URL's.

pageoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

per_pageoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

qoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

statusoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

store_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

vendor_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

asset_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

fromoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

tooptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": {}
}

Antwoordvelden

dataobject
Gebruiksopmerkingen
  • Vereist marketplace.read. Antwoordvoorbeelden tonen geselecteerde velden; gebruik GET op de resource voor het volledige bewaarde bewijs.
  • Elke POST vereist een duurzaam opgeslagen Idempotency-Key van 16–128 tekens (letters, cijfers, -, _ of .). Hergebruik na een time-out dezelfde sleutel en JSON-instructies. Andere instructies geven 409 terug. Voltooide antwoorden worden 30 dagen bewaard; oude sleutels worden blijvend gemarkeerd als niet herbruikbaar. Wijzig een sleutel nooit alleen om een onzeker resultaat te omzeilen.
  • Sleutels hebben projectlijsten, optionele beperkingen voor factuurwinkels, een vervaldatum, IP-toelatingslijst en een quotum van 1–600/minuut (standaard 60). HTTP 429 bevat Retry-After. Sleutels die tot winkels zijn beperkt, kunnen geen verkopers, projectsaldi, grootboek, uitbetalingen of instellingen zien. Bewaar bestedingsreferenties uitsluitend op vertrouwde servers, nooit in browsers of uitgeleverde mobiele apps.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETProjectinstellingen/v1/marketplace/settingsAlleen-lezen

Geeft enabled, payouts_paused, commission_percent, revision en deelnemende winkels terug.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MARKETPLACE_API_TOKEN
ParameterType / locatieRegel
permissioncredential scopemarketplace.read

Queryparameters

project_idUUIDvereist

Een geautoriseerd project. Vereist bij elk verzoek, inclusief item-URL's.

pageoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

per_pageoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

qoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

statusoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

store_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

vendor_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

asset_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

fromoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

tooptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": {}
}

Antwoordvelden

dataobject
Gebruiksopmerkingen
  • Vereist marketplace.read. Antwoordvoorbeelden tonen geselecteerde velden; gebruik GET op de resource voor het volledige bewaarde bewijs.
  • Elke POST vereist een duurzaam opgeslagen Idempotency-Key van 16–128 tekens (letters, cijfers, -, _ of .). Hergebruik na een time-out dezelfde sleutel en JSON-instructies. Andere instructies geven 409 terug. Voltooide antwoorden worden 30 dagen bewaard; oude sleutels worden blijvend gemarkeerd als niet herbruikbaar. Wijzig een sleutel nooit alleen om een onzeker resultaat te omzeilen.
  • Sleutels hebben projectlijsten, optionele beperkingen voor factuurwinkels, een vervaldatum, IP-toelatingslijst en een quotum van 1–600/minuut (standaard 60). HTTP 429 bevat Retry-After. Sleutels die tot winkels zijn beperkt, kunnen geen verkopers, projectsaldi, grootboek, uitbetalingen of instellingen zien. Bewaar bestedingsreferenties uitsluitend op vertrouwde servers, nooit in browsers of uitgeleverde mobiele apps.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTProjectinstellingen opslaan/v1/marketplace/settingsLezen + schrijven

Vervang de selectie van deelnemende winkels. revision 0 initialiseert instellingen; latere wijzigingen vereisen de teruggegeven revision. Commissie is een decimaal percentage, 0–100 met maximaal twee decimalen.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MARKETPLACE_API_TOKEN
Idempotency-Keyvereist16–128 letters, cijfers, -, _ of .; sla duurzaam op bij dit exacte verzoek
ParameterType / locatieRegel
permissioncredential scopepolicies.write

Verzoek

: "${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
    }
  ]
}'

Requestbody

project_idUUIDvereist

Een geautoriseerd project. Vereist bij elk verzoek, inclusief item-URL's.

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

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": {}
}

Antwoordvelden

dataobject
Gebruiksopmerkingen
  • Vereist policies.write. Antwoordvoorbeelden tonen geselecteerde velden; gebruik GET op de resource voor het volledige bewaarde bewijs.
  • Elke POST vereist een duurzaam opgeslagen Idempotency-Key van 16–128 tekens (letters, cijfers, -, _ of .). Hergebruik na een time-out dezelfde sleutel en JSON-instructies. Andere instructies geven 409 terug. Voltooide antwoorden worden 30 dagen bewaard; oude sleutels worden blijvend gemarkeerd als niet herbruikbaar. Wijzig een sleutel nooit alleen om een onzeker resultaat te omzeilen.
  • Sleutels hebben projectlijsten, optionele beperkingen voor factuurwinkels, een vervaldatum, IP-toelatingslijst en een quotum van 1–600/minuut (standaard 60). HTTP 429 bevat Retry-After. Sleutels die tot winkels zijn beperkt, kunnen geen verkopers, projectsaldi, grootboek, uitbetalingen of instellingen zien. Bewaar bestedingsreferenties uitsluitend op vertrouwde servers, nooit in browsers of uitgeleverde mobiele apps.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETVerkopers opvragen/v1/marketplace/vendorsAlleen-lezen

Gepagineerde verkopers. Zoek met q op naam, externe ID of e-mail; status active, suspended of archived.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MARKETPLACE_API_TOKEN
ParameterType / locatieRegel
permissioncredential scopemarketplace.read

Queryparameters

project_idUUIDvereist

Een geautoriseerd project. Vereist bij elk verzoek, inclusief item-URL's.

pageoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

per_pageoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

qoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

statusoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

store_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

vendor_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

asset_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

fromoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

tooptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": [],
  "pagination": {
    "page": 1,
    "per_page": 25,
    "total": 0,
    "pages": 1
  }
}

Antwoordvelden

data[]array
paginationobject
pageinteger
per_pageinteger
totalinteger
pagesinteger
Gebruiksopmerkingen
  • Vereist marketplace.read. Antwoordvoorbeelden tonen geselecteerde velden; gebruik GET op de resource voor het volledige bewaarde bewijs.
  • Elke POST vereist een duurzaam opgeslagen Idempotency-Key van 16–128 tekens (letters, cijfers, -, _ of .). Hergebruik na een time-out dezelfde sleutel en JSON-instructies. Andere instructies geven 409 terug. Voltooide antwoorden worden 30 dagen bewaard; oude sleutels worden blijvend gemarkeerd als niet herbruikbaar. Wijzig een sleutel nooit alleen om een onzeker resultaat te omzeilen.
  • Sleutels hebben projectlijsten, optionele beperkingen voor factuurwinkels, een vervaldatum, IP-toelatingslijst en een quotum van 1–600/minuut (standaard 60). HTTP 429 bevat Retry-After. Sleutels die tot winkels zijn beperkt, kunnen geen verkopers, projectsaldi, grootboek, uitbetalingen of instellingen zien. Bewaar bestedingsreferenties uitsluitend op vertrouwde servers, nooit in browsers of uitgeleverde mobiele apps.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTVerkoper maken/v1/marketplace/vendorsLezen + schrijven

Naam vereist (160 tekens); external_id optioneel en uniek binnen het project (128); email optioneel (254); description maximaal 2000. commission_percent null neemt de winkelinstelling over. Een afwijking anders dan null vereist ook commissions.override. Verkopers zijn geen gehoste handelaarsaccounts.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MARKETPLACE_API_TOKEN
Idempotency-Keyvereist16–128 letters, cijfers, -, _ of .; sla duurzaam op bij dit exacte verzoek
ParameterType / locatieRegel
permissioncredential scopevendors.write

Verzoek

: "${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
}'

Requestbody

project_idUUIDvereist

Een geautoriseerd project. Vereist bij elk verzoek, inclusief item-URL's.

name

"Example vendor"

external_id

"vendor-1042"

email

"vendor@example.com"

description

""

status

"active"

commission_percent

null

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": {}
}

Antwoordvelden

dataobject
Gebruiksopmerkingen
  • Vereist vendors.write. Antwoordvoorbeelden tonen geselecteerde velden; gebruik GET op de resource voor het volledige bewaarde bewijs.
  • Elke POST vereist een duurzaam opgeslagen Idempotency-Key van 16–128 tekens (letters, cijfers, -, _ of .). Hergebruik na een time-out dezelfde sleutel en JSON-instructies. Andere instructies geven 409 terug. Voltooide antwoorden worden 30 dagen bewaard; oude sleutels worden blijvend gemarkeerd als niet herbruikbaar. Wijzig een sleutel nooit alleen om een onzeker resultaat te omzeilen.
  • Sleutels hebben projectlijsten, optionele beperkingen voor factuurwinkels, een vervaldatum, IP-toelatingslijst en een quotum van 1–600/minuut (standaard 60). HTTP 429 bevat Retry-After. Sleutels die tot winkels zijn beperkt, kunnen geen verkopers, projectsaldi, grootboek, uitbetalingen of instellingen zien. Bewaar bestedingsreferenties uitsluitend op vertrouwde servers, nooit in browsers of uitgeleverde mobiele apps.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETVerkoper ophalen/v1/marketplace/vendors/{vendor_id}Alleen-lezen

Geef één verkoper, revisie en afwijkende commissie terug.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MARKETPLACE_API_TOKEN
ParameterType / locatieRegel
permissioncredential scopemarketplace.read

Queryparameters

project_idUUIDvereist

Een geautoriseerd project. Vereist bij elk verzoek, inclusief item-URL's.

pageoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

per_pageoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

qoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

statusoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

store_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

vendor_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

asset_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

fromoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

tooptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": {}
}

Antwoordvelden

dataobject
Gebruiksopmerkingen
  • Vereist marketplace.read. Antwoordvoorbeelden tonen geselecteerde velden; gebruik GET op de resource voor het volledige bewaarde bewijs.
  • Elke POST vereist een duurzaam opgeslagen Idempotency-Key van 16–128 tekens (letters, cijfers, -, _ of .). Hergebruik na een time-out dezelfde sleutel en JSON-instructies. Andere instructies geven 409 terug. Voltooide antwoorden worden 30 dagen bewaard; oude sleutels worden blijvend gemarkeerd als niet herbruikbaar. Wijzig een sleutel nooit alleen om een onzeker resultaat te omzeilen.
  • Sleutels hebben projectlijsten, optionele beperkingen voor factuurwinkels, een vervaldatum, IP-toelatingslijst en een quotum van 1–600/minuut (standaard 60). HTTP 429 bevat Retry-After. Sleutels die tot winkels zijn beperkt, kunnen geen verkopers, projectsaldi, grootboek, uitbetalingen of instellingen zien. Bewaar bestedingsreferenties uitsluitend op vertrouwde servers, nooit in browsers of uitgeleverde mobiele apps.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTVerkoper bijwerken/v1/marketplace/vendors/{vendor_id}/updateLezen + schrijven

Werk verkoperdetails bij; status active of suspended. commission_percent wijzigen of verwijderen vereist ook commissions.override; ongewijzigde waarden vereisen alleen vendors.write. Een gearchiveerde verkoper herstellen vereist ook reconciliation.write. Financiële wijzigingen via de console vereisen herauthenticatie van het account. Bestaande toewijzingen behouden hun oorspronkelijke commissie en bestemmingen.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MARKETPLACE_API_TOKEN
Idempotency-Keyvereist16–128 letters, cijfers, -, _ of .; sla duurzaam op bij dit exacte verzoek
ParameterType / locatieRegel
permissioncredential scopevendors.write

Verzoek

: "${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
}'

Requestbody

project_idUUIDvereist

Een geautoriseerd project. Vereist bij elk verzoek, inclusief item-URL's.

name

"Example vendor"

external_id

"vendor-1042"

email

"vendor@example.com"

description

""

status

"active"

commission_percent

null

revision

1

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": {}
}

Antwoordvelden

dataobject
Gebruiksopmerkingen
  • Vereist vendors.write. Antwoordvoorbeelden tonen geselecteerde velden; gebruik GET op de resource voor het volledige bewaarde bewijs.
  • Elke POST vereist een duurzaam opgeslagen Idempotency-Key van 16–128 tekens (letters, cijfers, -, _ of .). Hergebruik na een time-out dezelfde sleutel en JSON-instructies. Andere instructies geven 409 terug. Voltooide antwoorden worden 30 dagen bewaard; oude sleutels worden blijvend gemarkeerd als niet herbruikbaar. Wijzig een sleutel nooit alleen om een onzeker resultaat te omzeilen.
  • Sleutels hebben projectlijsten, optionele beperkingen voor factuurwinkels, een vervaldatum, IP-toelatingslijst en een quotum van 1–600/minuut (standaard 60). HTTP 429 bevat Retry-After. Sleutels die tot winkels zijn beperkt, kunnen geen verkopers, projectsaldi, grootboek, uitbetalingen of instellingen zien. Bewaar bestedingsreferenties uitsluitend op vertrouwde servers, nooit in browsers of uitgeleverde mobiele apps.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTVerkoper archiveren/v1/marketplace/vendors/{vendor_id}/archiveLezen + schrijven

Archiveer pas nadat onbetaalde en openstaande factuurverplichtingen zijn opgelost; anders volgt 409 vendor_has_obligations. Geschiedenis blijft bewaard. Gebruik tijdelijk de status suspended of herstel een oude gearchiveerde verkoper via de updateroute en reconciliation.write.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MARKETPLACE_API_TOKEN
Idempotency-Keyvereist16–128 letters, cijfers, -, _ of .; sla duurzaam op bij dit exacte verzoek
ParameterType / locatieRegel
permissioncredential scopevendors.write

Verzoek

: "${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
}'

Requestbody

project_idUUIDvereist

Een geautoriseerd project. Vereist bij elk verzoek, inclusief item-URL's.

revision

1

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": {}
}

Antwoordvelden

dataobject
Gebruiksopmerkingen
  • Vereist vendors.write. Antwoordvoorbeelden tonen geselecteerde velden; gebruik GET op de resource voor het volledige bewaarde bewijs.
  • Elke POST vereist een duurzaam opgeslagen Idempotency-Key van 16–128 tekens (letters, cijfers, -, _ of .). Hergebruik na een time-out dezelfde sleutel en JSON-instructies. Andere instructies geven 409 terug. Voltooide antwoorden worden 30 dagen bewaard; oude sleutels worden blijvend gemarkeerd als niet herbruikbaar. Wijzig een sleutel nooit alleen om een onzeker resultaat te omzeilen.
  • Sleutels hebben projectlijsten, optionele beperkingen voor factuurwinkels, een vervaldatum, IP-toelatingslijst en een quotum van 1–600/minuut (standaard 60). HTTP 429 bevat Retry-After. Sleutels die tot winkels zijn beperkt, kunnen geen verkopers, projectsaldi, grootboek, uitbetalingen of instellingen zien. Bewaar bestedingsreferenties uitsluitend op vertrouwde servers, nooit in browsers of uitgeleverde mobiele apps.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETVerkopersbestemmingen/v1/marketplace/vendors/{vendor_id}/destinationsAlleen-lezen

Bestemmingen met versies en statussen pending/approved/disabled. Goedkeuring bewijst geen eigendom.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MARKETPLACE_API_TOKEN
ParameterType / locatieRegel
permissioncredential scopemarketplace.read

Queryparameters

project_idUUIDvereist

Een geautoriseerd project. Vereist bij elk verzoek, inclusief item-URL's.

pageoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

per_pageoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

qoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

statusoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

store_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

vendor_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

asset_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

fromoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

tooptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": [],
  "pagination": {
    "page": 1,
    "per_page": 25,
    "total": 0,
    "pages": 1
  }
}

Antwoordvelden

data[]array
paginationobject
pageinteger
per_pageinteger
totalinteger
pagesinteger
Gebruiksopmerkingen
  • Vereist marketplace.read. Antwoordvoorbeelden tonen geselecteerde velden; gebruik GET op de resource voor het volledige bewaarde bewijs.
  • Elke POST vereist een duurzaam opgeslagen Idempotency-Key van 16–128 tekens (letters, cijfers, -, _ of .). Hergebruik na een time-out dezelfde sleutel en JSON-instructies. Andere instructies geven 409 terug. Voltooide antwoorden worden 30 dagen bewaard; oude sleutels worden blijvend gemarkeerd als niet herbruikbaar. Wijzig een sleutel nooit alleen om een onzeker resultaat te omzeilen.
  • Sleutels hebben projectlijsten, optionele beperkingen voor factuurwinkels, een vervaldatum, IP-toelatingslijst en een quotum van 1–600/minuut (standaard 60). HTTP 429 bevat Retry-After. Sleutels die tot winkels zijn beperkt, kunnen geen verkopers, projectsaldi, grootboek, uitbetalingen of instellingen zien. Bewaar bestedingsreferenties uitsluitend op vertrouwde servers, nooit in browsers of uitgeleverde mobiele apps.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTUitbetalingsbestemming toevoegen/v1/marketplace/vendors/{vendor_id}/destinationsLezen + schrijven

Registreer een geldig mainnet-BTC-adres of ondersteund EVM-adres, in afwachting van goedkeuring. Adressen van het project, verkeerde netwerken en nuladressen op EVM worden afgewezen.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MARKETPLACE_API_TOKEN
Idempotency-Keyvereist16–128 letters, cijfers, -, _ of .; sla duurzaam op bij dit exacte verzoek
ParameterType / locatieRegel
permissioncredential scopedestinations.write

Verzoek

: "${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"
}'

Requestbody

project_idUUIDvereist

Een geautoriseerd project. Vereist bij elk verzoek, inclusief item-URL's.

chain_slug

"bitcoin"

network

"mainnet"

address

"VERIFIED_VENDOR_BTC_ADDRESS"

label

"Vendor BTC"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": {}
}

Antwoordvelden

dataobject
Gebruiksopmerkingen
  • Vereist destinations.write. Antwoordvoorbeelden tonen geselecteerde velden; gebruik GET op de resource voor het volledige bewaarde bewijs.
  • Elke POST vereist een duurzaam opgeslagen Idempotency-Key van 16–128 tekens (letters, cijfers, -, _ of .). Hergebruik na een time-out dezelfde sleutel en JSON-instructies. Andere instructies geven 409 terug. Voltooide antwoorden worden 30 dagen bewaard; oude sleutels worden blijvend gemarkeerd als niet herbruikbaar. Wijzig een sleutel nooit alleen om een onzeker resultaat te omzeilen.
  • Sleutels hebben projectlijsten, optionele beperkingen voor factuurwinkels, een vervaldatum, IP-toelatingslijst en een quotum van 1–600/minuut (standaard 60). HTTP 429 bevat Retry-After. Sleutels die tot winkels zijn beperkt, kunnen geen verkopers, projectsaldi, grootboek, uitbetalingen of instellingen zien. Bewaar bestedingsreferenties uitsluitend op vertrouwde servers, nooit in browsers of uitgeleverde mobiele apps.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTBestemming goedkeuren/v1/marketplace/vendors/{vendor_id}/destinations/{destination_id}/approveLezen + schrijven

Verifieer eigendom eerst onafhankelijk. Schakel eerst een bestaande goedgekeurde bestemming voor deze verkoper/dit netwerk uit; oude momentopnamen worden niet omgeleid.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MARKETPLACE_API_TOKEN
Idempotency-Keyvereist16–128 letters, cijfers, -, _ of .; sla duurzaam op bij dit exacte verzoek
ParameterType / locatieRegel
permissioncredential scopedestinations.approve

Verzoek

: "${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
}'

Requestbody

project_idUUIDvereist

Een geautoriseerd project. Vereist bij elk verzoek, inclusief item-URL's.

revision

1

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": {}
}

Antwoordvelden

dataobject
Gebruiksopmerkingen
  • Vereist destinations.approve. Antwoordvoorbeelden tonen geselecteerde velden; gebruik GET op de resource voor het volledige bewaarde bewijs.
  • Elke POST vereist een duurzaam opgeslagen Idempotency-Key van 16–128 tekens (letters, cijfers, -, _ of .). Hergebruik na een time-out dezelfde sleutel en JSON-instructies. Andere instructies geven 409 terug. Voltooide antwoorden worden 30 dagen bewaard; oude sleutels worden blijvend gemarkeerd als niet herbruikbaar. Wijzig een sleutel nooit alleen om een onzeker resultaat te omzeilen.
  • Sleutels hebben projectlijsten, optionele beperkingen voor factuurwinkels, een vervaldatum, IP-toelatingslijst en een quotum van 1–600/minuut (standaard 60). HTTP 429 bevat Retry-After. Sleutels die tot winkels zijn beperkt, kunnen geen verkopers, projectsaldi, grootboek, uitbetalingen of instellingen zien. Bewaar bestedingsreferenties uitsluitend op vertrouwde servers, nooit in browsers of uitgeleverde mobiele apps.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTBestemming uitschakelen/v1/marketplace/vendors/{vendor_id}/destinations/{destination_id}/disableLezen + schrijven

Stop nieuw/niet-verzonden werk met deze versie. Een ondertekende transactie kan niet worden ingetrokken.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MARKETPLACE_API_TOKEN
Idempotency-Keyvereist16–128 letters, cijfers, -, _ of .; sla duurzaam op bij dit exacte verzoek
ParameterType / locatieRegel
permissioncredential scopedestinations.approve

Verzoek

: "${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
}'

Requestbody

project_idUUIDvereist

Een geautoriseerd project. Vereist bij elk verzoek, inclusief item-URL's.

revision

1

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": {}
}

Antwoordvelden

dataobject
Gebruiksopmerkingen
  • Vereist destinations.approve. Antwoordvoorbeelden tonen geselecteerde velden; gebruik GET op de resource voor het volledige bewaarde bewijs.
  • Elke POST vereist een duurzaam opgeslagen Idempotency-Key van 16–128 tekens (letters, cijfers, -, _ of .). Hergebruik na een time-out dezelfde sleutel en JSON-instructies. Andere instructies geven 409 terug. Voltooide antwoorden worden 30 dagen bewaard; oude sleutels worden blijvend gemarkeerd als niet herbruikbaar. Wijzig een sleutel nooit alleen om een onzeker resultaat te omzeilen.
  • Sleutels hebben projectlijsten, optionele beperkingen voor factuurwinkels, een vervaldatum, IP-toelatingslijst en een quotum van 1–600/minuut (standaard 60). HTTP 429 bevat Retry-After. Sleutels die tot winkels zijn beperkt, kunnen geen verkopers, projectsaldi, grootboek, uitbetalingen of instellingen zien. Bewaar bestedingsreferenties uitsluitend op vertrouwde servers, nooit in browsers of uitgeleverde mobiele apps.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETVerkoperssaldi/v1/marketplace/vendors/{vendor_id}/balancesAlleen-lezen

Exacte bewaarde grootboekbedragen, gegroepeerd op onwijzigbare activa-identiteit en accounttype; geen live besteedbare walletsaldi.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MARKETPLACE_API_TOKEN
ParameterType / locatieRegel
permissioncredential scopemarketplace.read

Queryparameters

project_idUUIDvereist

Een geautoriseerd project. Vereist bij elk verzoek, inclusief item-URL's.

pageoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

per_pageoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

qoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

statusoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

store_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

vendor_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

asset_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

fromoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

tooptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": {}
}

Antwoordvelden

dataobject
Gebruiksopmerkingen
  • Vereist marketplace.read. Antwoordvoorbeelden tonen geselecteerde velden; gebruik GET op de resource voor het volledige bewaarde bewijs.
  • Elke POST vereist een duurzaam opgeslagen Idempotency-Key van 16–128 tekens (letters, cijfers, -, _ of .). Hergebruik na een time-out dezelfde sleutel en JSON-instructies. Andere instructies geven 409 terug. Voltooide antwoorden worden 30 dagen bewaard; oude sleutels worden blijvend gemarkeerd als niet herbruikbaar. Wijzig een sleutel nooit alleen om een onzeker resultaat te omzeilen.
  • Sleutels hebben projectlijsten, optionele beperkingen voor factuurwinkels, een vervaldatum, IP-toelatingslijst en een quotum van 1–600/minuut (standaard 60). HTTP 429 bevat Retry-After. Sleutels die tot winkels zijn beperkt, kunnen geen verkopers, projectsaldi, grootboek, uitbetalingen of instellingen zien. Bewaar bestedingsreferenties uitsluitend op vertrouwde servers, nooit in browsers of uitgeleverde mobiele apps.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETMarketplace-facturen/v1/marketplace/invoicesAlleen-lezen

Gepagineerde facturen; q zoekt op bestelling, e-mail, omschrijving, metadata en factuur-UUID. Filter op store_id, vendor_id en Marketplace-status. Gewone facturen zijn uitgesloten.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MARKETPLACE_API_TOKEN
ParameterType / locatieRegel
permissioncredential scopemarketplace.read

Queryparameters

project_idUUIDvereist

Een geautoriseerd project. Vereist bij elk verzoek, inclusief item-URL's.

pageoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

per_pageoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

qoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

statusoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

store_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

vendor_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

asset_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

fromoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

tooptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": [],
  "pagination": {
    "page": 1,
    "per_page": 25,
    "total": 0,
    "pages": 1
  }
}

Antwoordvelden

data[]array
paginationobject
pageinteger
per_pageinteger
totalinteger
pagesinteger
Gebruiksopmerkingen
  • Vereist marketplace.read. Antwoordvoorbeelden tonen geselecteerde velden; gebruik GET op de resource voor het volledige bewaarde bewijs.
  • Elke POST vereist een duurzaam opgeslagen Idempotency-Key van 16–128 tekens (letters, cijfers, -, _ of .). Hergebruik na een time-out dezelfde sleutel en JSON-instructies. Andere instructies geven 409 terug. Voltooide antwoorden worden 30 dagen bewaard; oude sleutels worden blijvend gemarkeerd als niet herbruikbaar. Wijzig een sleutel nooit alleen om een onzeker resultaat te omzeilen.
  • Sleutels hebben projectlijsten, optionele beperkingen voor factuurwinkels, een vervaldatum, IP-toelatingslijst en een quotum van 1–600/minuut (standaard 60). HTTP 429 bevat Retry-After. Sleutels die tot winkels zijn beperkt, kunnen geen verkopers, projectsaldi, grootboek, uitbetalingen of instellingen zien. Bewaar bestedingsreferenties uitsluitend op vertrouwde servers, nooit in browsers of uitgeleverde mobiele apps.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTFactuur voor meerdere verkopers maken/v1/marketplace/invoicesLezen + schrijven

Hergebruik normale InvoiceCreateInput-velden, plus store_id en allocations. Elke verkoper komt één keer voor, 1–100 positieve aandelen, som exact gelijk aan amount. Optionele commission_percent per factuur/toewijzing vereist commissions.override en herauthenticatie in de console voor sessieverzoeken. Geeft data.invoice_id en links.checkout terug. Zonder compatibele gemeenschappelijke methode volgt een gedetailleerde fout; er wordt niet teruggevallen op een onverenigbaar actief.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MARKETPLACE_API_TOKEN
Idempotency-Keyvereist16–128 letters, cijfers, -, _ of .; sla duurzaam op bij dit exacte verzoek
ParameterType / locatieRegel
permissioncredential scopeinvoices.write

Verzoek

: "${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"
    }
  ]
}'

Requestbody

amountstringvereist
Gewone decimale tekenreeks zonder teken; geen teken of exponent, maximaal 48 cijfers vóór en 30 na de komma. Moet standaard positief zijn. Een winkel kan facturen met nulbedrag toestaan onder Winkels → Factuur; nultotalen worden voldaan zonder geld te ontvangen, adressen toe te wijzen of verwerkingskosten.Details

Gewone decimale tekenreeks zonder teken; geen teken of exponent, maximaal 48 cijfers vóór en 30 na de komma. Moet standaard positief zijn. Een winkel kan facturen met nulbedrag toestaan onder Winkels → Factuur; nultotalen worden voldaan zonder geld te ontvangen, adressen toe te wijzen of verwerkingskosten.

currencystring | nulloptioneel
Ondersteunde fiatvaluta met drie letters, genormaliseerd naar hoofdletters. Weggelaten of null neemt de factuurvaluta van de winkel over. Aanmaak vereist ook een onafhankelijk beschikbare omrekenkoers voor facturering.Details

Ondersteunde fiatvaluta met drie letters, genormaliseerd naar hoofdletters. Weggelaten of null neemt de factuurvaluta van de winkel over. Aanmaak vereist ook een onafhankelijk beschikbare omrekenkoers voor facturering.

payment_methods[]object[] | nulloptioneel
Selecteer voor deze factuur methoden die in de winkel zijn ingeschakeld. Merchant 5.4.0+: negeer onbekende/inactieve/niet-geaccepteerde keuzes; als niets overeenkomt, gebruik de winkelstandaarden. Weggelaten/null gebruikt ook de winkelstandaarden; [] is ongeldig. Schakelt nooit een methode in en wijzigt geen winkelinstellingen. Zie het selectieschema hieronder.Details

Selecteer voor deze factuur methoden die in de winkel zijn ingeschakeld. Merchant 5.4.0+: negeer onbekende/inactieve/niet-geaccepteerde keuzes; als niets overeenkomt, gebruik de winkelstandaarden. Weggelaten/null gebruikt ook de winkelstandaarden; [] is ongeldig. Schakelt nooit een methode in en wijzigt geen winkelinstellingen. Zie het selectieschema hieronder.

chain_slugstringvereist
Kopieer chain_slug in Project → Winkels → Betaalmethoden of lees deze uit GET /v1/projects/{project_id}/stores/{store_id}/payment-assets, zoals ethereum, base of bitcoin. Een blockchain-/betaalroutepaar mag maar één keer voorkomen.Details

Kopieer chain_slug in Project → Winkels → Betaalmethoden of lees deze uit GET /v1/projects/{project_id}/stores/{store_id}/payment-assets, zoals ethereum, base of bitcoin. Een blockchain-/betaalroutepaar mag maar één keer voorkomen.

asset_ids[]UUID[] | nulloptioneel
asset.id-UUID's van blockchainactiva, geen contractadressen of factuur-betaalmethode-ID's. Gebruik dit OF asset_tickers. Laat beide selectoren weg voor alle actieve geaccepteerde activa op deze blockchain. [] en dubbele/nul-ID's zijn ongeldig. Negeer op 5.4.0+ ID's die op deze blockchain in deze winkel niet actief/geaccepteerd zijn; een volledig niet-overeenkomende selectie gebruikt winkelstandaarden.Details

asset.id-UUID's van blockchainactiva, geen contractadressen of factuur-betaalmethode-ID's. Gebruik dit OF asset_tickers. Laat beide selectoren weg voor alle actieve geaccepteerde activa op deze blockchain. [] en dubbele/nul-ID's zijn ongeldig. Negeer op 5.4.0+ ID's die op deze blockchain in deze winkel niet actief/geaccepteerd zijn; een volledig niet-overeenkomende selectie gebruikt winkelstandaarden.

asset_tickers[]string[] | nulloptioneel
Merchant 5.3.0+. Symbolen zoals BTC, USDC of PEPE, beperkt tot chain_slug en deze winkel. 1–64 unieke tickersymbolen; witruimte aan uiteinden verwijderd/hoofdletterongevoelig, 1–40 ASCII-letters/cijfers/punt/underscore/koppelteken. Gebruik dit OF asset_ids. Negeer op 5.4.0+ onbekende/inactieve/niet-geaccepteerde tickersymbolen. Dubbelzinnige geaccepteerde symbolen blijven een fout geven: gebruik asset_ids. Actieve geselecteerde methoden hebben geldige wallets en prijsbepaling nodig; tijdelijke storingen van blockchainscanners blokkeren aanmaak vanaf 6.0.6 niet. Lightning accepteert optioneel alleen BTC.Details

Merchant 5.3.0+. Symbolen zoals BTC, USDC of PEPE, beperkt tot chain_slug en deze winkel. 1–64 unieke tickersymbolen; witruimte aan uiteinden verwijderd/hoofdletterongevoelig, 1–40 ASCII-letters/cijfers/punt/underscore/koppelteken. Gebruik dit OF asset_ids. Negeer op 5.4.0+ onbekende/inactieve/niet-geaccepteerde tickersymbolen. Dubbelzinnige geaccepteerde symbolen blijven een fout geven: gebruik asset_ids. Actieve geselecteerde methoden hebben geldige wallets en prijsbepaling nodig; tijdelijke storingen van blockchainscanners blokkeren aanmaak vanaf 6.0.6 niet. Lightning accepteert optioneel alleen BTC.

payment_railonchain | lightningoptioneel
Standaard onchain. Gebruik om Bitcoin Lightning te kiezen {chain_slug: bitcoin, payment_rail: lightning} zonder asset_ids; asset_tickers mag optioneel [BTC] zijn. Bitcoin op de blockchain omvat Lightning niet. De Lightning-verbinding van de winkel moet al ingeschakeld en gereed zijn.Details

Standaard onchain. Gebruik om Bitcoin Lightning te kiezen {chain_slug: bitcoin, payment_rail: lightning} zonder asset_ids; asset_tickers mag optioneel [BTC] zijn. Bitcoin op de blockchain omvat Lightning niet. De Lightning-verbinding van de winkel moet al ingeschakeld en gereed zijn.

order_idstring | nulloptioneel

Bestelreferentie van de handelaar, 1–128 tekens na verwijderen van witruimte aan de uiteinden; stuurtekens worden afgewezen.

emailstring | nulloptioneel

E-mailadres van de klant, alleen voor de handelaar, genormaliseerd naar een praktisch ASCII-adres van maximaal 254 tekens. Weggelaten of null slaat geen e-mailadres op.

descriptionstring | nulloptioneel

Omschrijving voor de klant, 1–500 tekens; regeleinden en tabs zijn toegestaan.

expires_in_secondsinteger | nulloptioneel

Geldigheidsduur van de factuurprijsopgave van 300 tot en met 86,400 seconden; weggelaten of null neemt het winkelbeleid over.

exchange_rate_spread_percentdecimal string | nulloptioneel
Prijsopslag van 0 tot en met 100, met maximaal twee decimalen. Weggelaten of null neemt de winkelstandaard over; "0" schakelt deze uit voor deze factuur. Wordt vóór afronding naar boven toegepast en daarna vastgezet. Verandert het fiatbedrag van de factuur of de basis voor de verwerkingsvergoeding niet.Details

Prijsopslag van 0 tot en met 100, met maximaal twee decimalen. Weggelaten of null neemt de winkelstandaard over; "0" schakelt deze uit voor deze factuur. Wordt vóór afronding naar boven toegepast en daarna vastgezet. Verandert het fiatbedrag van de factuur of de basis voor de verwerkingsvergoeding niet.

underpayment_tolerance_percentdecimal string | nulloptioneel

Geaccepteerd tekort van 0 tot en met 99.99 met maximaal twee decimalen. Weggelaten of null neemt de winkelstandaard over.

ipn_urlstring | nulloptioneel

Publieke HTTPS-callback, maximaal 2,048 bytes en zonder inloggegevens of fragment. Overschrijft de winkelstandaard; null/weggelaten neemt die over.

redirect_urlstring | nulloptioneel

HTTPS-succes-URL die na voldoening wordt gebruikt, maximaal 2,048 bytes en zonder ingebedde inloggegevens. Weggelaten of null neemt de winkelstandaard over en kan die niet wissen.

cancel_urlstring | nulloptioneel

HTTPS-terugkeer-URL die wordt gebruikt als afrekenen zonder succesvolle betaling eindigt. Weggelaten of null neemt de winkelstandaard over en kan die niet wissen.

redirect_automaticallyboolean | nulloptioneel

Weggelaten of null neemt het winkelbeleid over. true vereist een effectieve redirect_url.

languagestring | nulloptioneel
Klanttaal: en, de, es, pt-BR, it, ru, zh-CN, fr, ko of ja. pt betekent Braziliaans Portugees en zh betekent vereenvoudigd Chinees. Ondersteunde regionale tags zoals de-DE worden genormaliseerd naar de vermelde taal. Weggelaten of null neemt de winkeltaal over. De consoletaal staat hier los van.Details

Klanttaal: en, de, es, pt-BR, it, ru, zh-CN, fr, ko of ja. pt betekent Braziliaans Portugees en zh betekent vereenvoudigd Chinees. Ondersteunde regionale tags zoals de-DE worden genormaliseerd naar de vermelde taal. Weggelaten of null neemt de winkeltaal over. De consoletaal staat hier los van.

checkout_appearanceobject | nulloptioneel
Gedeeltelijke presentatie-instellingen voor deze factuur. Weggelaten/null volgt het huidige winkelontwerp. Een object, inclusief {}, zet het berekende ontwerp en de afbeeldingen bij aanmaak vast. Zie het afwijkingsschema hieronder; geen financiële instellingen, HTML, CSS, JavaScript of externe afbeeldings-URL's.Details

Gedeeltelijke presentatie-instellingen voor deze factuur. Weggelaten/null volgt het huidige winkelontwerp. Een object, inclusief {}, zet het berekende ontwerp en de afbeeldingen bij aanmaak vast. Zie het afwijkingsschema hieronder; geen financiële instellingen, HTML, CSS, JavaScript of externe afbeeldings-URL's.

inherit_default_storebooleanoptioneel
true kiest het ontwerp van de standaardwinkel van het project als basis; gebruik anders het effectieve ontwerp van de doelwinkel. Afwijkingen worden daarna toegepast en onafhankelijk opgeslagen; de uiteindelijke factuurvlag is false.Details

true kiest het ontwerp van de standaardwinkel van het project als basis; gebruik anders het effectieve ontwerp van de doelwinkel. Afwijkingen worden daarna toegepast en onafhankelijk opgeslagen; de uiteindelijke factuurvlag is false.

titlestringoptioneel

Afrekenkop, maximaal 120 tekens. Leeg gebruikt de standaardkop.

introstringoptioneel
Platte tekst, elk maximaal 2,000 tekens. Intro verschijnt bovenaan, Outro onderaan in elke status. Regeleinden blijven behouden; veilige tekst-URL's worden links. Een lege tekenreeks wist. Het oudere customer_message wordt als alias voor intro geaccepteerd; verstuur niet beide.Details

Platte tekst, elk maximaal 2,000 tekens. Intro verschijnt bovenaan, Outro onderaan in elke status. Regeleinden blijven behouden; veilige tekst-URL's worden links. Een lege tekenreeks wist. Het oudere customer_message wordt als alias voor intro geaccepteerd; verstuur niet beide.

outrostringoptioneel
Platte tekst, elk maximaal 2,000 tekens. Intro verschijnt bovenaan, Outro onderaan in elke status. Regeleinden blijven behouden; veilige tekst-URL's worden links. Een lege tekenreeks wist. Het oudere customer_message wordt als alias voor intro geaccepteerd; verstuur niet beide.Details

Platte tekst, elk maximaal 2,000 tekens. Intro verschijnt bovenaan, Outro onderaan in elke status. Regeleinden blijven behouden; veilige tekst-URL's worden links. Een lege tekenreeks wist. Het oudere customer_message wordt als alias voor intro geaccepteerd; verstuur niet beide.

intro_font_sizeintegeroptioneel

Pixels: 12, 14, 16, 18, 20 of 24. Standaard 16 tenzij anders overgenomen.

outro_font_sizeintegeroptioneel

Pixels: 12, 14, 16, 18, 20 of 24. Standaard 16 tenzij anders overgenomen.

themesystem | light | dim | darkoptioneel

Volg het apparaat van de klant of gebruik een vast thema.

accent_colorstringoptioneel

#RRGGBB. Achtergrond, kaart en knop mogen leeg zijn voor automatische kleuren. Tekstcontrast is automatisch.

background_colorstringoptioneel

#RRGGBB. Achtergrond, kaart en knop mogen leeg zijn voor automatische kleuren. Tekstcontrast is automatisch.

card_colorstringoptioneel

#RRGGBB. Achtergrond, kaart en knop mogen leeg zijn voor automatische kleuren. Tekstcontrast is automatisch.

button_colorstringoptioneel

#RRGGBB. Achtergrond, kaart en knop mogen leeg zijn voor automatische kleuren. Tekstcontrast is automatisch.

logo_sizestringoptioneel

small, medium of large; left of center.

logo_alignmentstringoptioneel

small, medium of large; left of center.

imagesobjectoptioneel
Sleutels logo_light, logo_dark, favicon. Een weggelaten sleutel behoudt de basisafbeelding; null verwijdert die. Een object {store_id: UUID, kind?: logo_light|logo_dark|favicon} hergebruikt de effectieve geüploade afbeelding van die winkel in HETZELFDE project. kind is standaard de doelsleutel. Upload eerst onder Winkel → Afrekenen; kopieer de Store-API-ID uit Basis → API-ID's. Ontbrekende afbeeldingen of ID's uit andere projecten geven 400 terug. Geen externe URL's of afbeeldingsgegevens toegestaan.Details

Sleutels logo_light, logo_dark, favicon. Een weggelaten sleutel behoudt de basisafbeelding; null verwijdert die. Een object {store_id: UUID, kind?: logo_light|logo_dark|favicon} hergebruikt de effectieve geüploade afbeelding van die winkel in HETZELFDE project. kind is standaard de doelsleutel. Upload eerst onder Winkel → Afrekenen; kopieer de Store-API-ID uit Basis → API-ID's. Ontbrekende afbeeldingen of ID's uit andere projecten geven 400 terug. Geen externe URL's of afbeeldingsgegevens toegestaan.

logo_lightobject | nulloptioneel
store_idUUIDvereist
kindlogo_light | logo_dark | faviconoptioneel
logo_darkobject | nulloptioneel
store_idUUIDvereist
kindlogo_light | logo_dark | faviconoptioneel
faviconobject | nulloptioneel
store_idUUIDvereist
kindlogo_light | logo_dark | faviconoptioneel
show_order_idbooleanoptioneel

Toon bestel-ID-details en een platte-tekstomschrijving onder de titel. details_expanded opent bestel-ID-details standaard. Alleen weergave, geen afscherming van gegevens.

show_descriptionbooleanoptioneel

Toon bestel-ID-details en een platte-tekstomschrijving onder de titel. details_expanded opent bestel-ID-details standaard. Alleen weergave, geen afscherming van gegevens.

details_expandedbooleanoptioneel

Toon bestel-ID-details en een platte-tekstomschrijving onder de titel. details_expanded opent bestel-ID-details standaard. Alleen weergave, geen afscherming van gegevens.

show_project_namebooleanoptioneel
Merchant 5.6.0+: toon of verberg elke naam in de kop van de klantafrekenpagina. Beide zijn standaard true. Ook beschikbaar onder Winkel → Afrekenen; overgenomen en vastgelegd per factuur zoals andere uiterlijkinstellingen. Alleen weergave, geen afscherming van gegevens.Details

Merchant 5.6.0+: toon of verberg elke naam in de kop van de klantafrekenpagina. Beide zijn standaard true. Ook beschikbaar onder Winkel → Afrekenen; overgenomen en vastgelegd per factuur zoals andere uiterlijkinstellingen. Alleen weergave, geen afscherming van gegevens.

show_store_namebooleanoptioneel
Merchant 5.6.0+: toon of verberg elke naam in de kop van de klantafrekenpagina. Beide zijn standaard true. Ook beschikbaar onder Winkel → Afrekenen; overgenomen en vastgelegd per factuur zoals andere uiterlijkinstellingen. Alleen weergave, geen afscherming van gegevens.Details

Merchant 5.6.0+: toon of verberg elke naam in de kop van de klantafrekenpagina. Beide zijn standaard true. Ook beschikbaar onder Winkel → Afrekenen; overgenomen en vastgelegd per factuur zoals andere uiterlijkinstellingen. Alleen weergave, geen afscherming van gegevens.

featured_chains[]string[]optioneel
Geordende blockchain-slugs, maximaal 60 unieke waarden (kleine letters, cijfers, koppeltekens; maximaal 64 tekens). [] wist. Alleen beschikbare factuurmethoden worden opnieuw geordend.Details

Geordende blockchain-slugs, maximaal 60 unieke waarden (kleine letters, cijfers, koppeltekens; maximaal 64 tekens). [] wist. Alleen beschikbare factuurmethoden worden opnieuw geordend.

featured_asset_ids[]UUID[]optioneel
Maximaal 100 unieke geordende activa-ID's; [] wist. Het standaardactief mag null zijn. ID's komen uit payment-assets, niet uit betalingsintenties. Deze schakelen nooit methoden in; ontvangen betalingen en geldige klantvoorkeuren hebben voorrang.Details

Maximaal 100 unieke geordende activa-ID's; [] wist. Het standaardactief mag null zijn. ID's komen uit payment-assets, niet uit betalingsintenties. Deze schakelen nooit methoden in; ontvangen betalingen en geldige klantvoorkeuren hebben voorrang.

default_asset_idUUID|nulloptioneel
Maximaal 100 unieke geordende activa-ID's; [] wist. Het standaardactief mag null zijn. ID's komen uit payment-assets, niet uit betalingsintenties. Deze schakelen nooit methoden in; ontvangen betalingen en geldige klantvoorkeuren hebben voorrang.Details

Maximaal 100 unieke geordende activa-ID's; [] wist. Het standaardactief mag null zijn. ID's komen uit payment-assets, niet uit betalingsintenties. Deze schakelen nooit methoden in; ontvangen betalingen en geldige klantvoorkeuren hebben voorrang.

messagesobjectoptioneel
Taalobjecten met sleutels en, de, es, pt-BR, it, ru, zh-CN, fr, ko of ja, met gewone tekenreeksen waiting, confirming, paid, underpaid, expired (elk 500 tekens). Alleen aangeleverde talen/statussen veranderen; {} wist alle berichten, {en:{}} wist Engels en een lege statustekenreeks wist die status. Engels is de terugvaltaal. Vervangt de werkelijke status niet.Details

Taalobjecten met sleutels en, de, es, pt-BR, it, ru, zh-CN, fr, ko of ja, met gewone tekenreeksen waiting, confirming, paid, underpaid, expired (elk 500 tekens). Alleen aangeleverde talen/statussen veranderen; {} wist alle berichten, {en:{}} wist Engels en een lege statustekenreeks wist die status. Engels is de terugvaltaal. Vervangt de werkelijke status niet.

enobjectoptioneel
waitingstringoptioneel
confirmingstringoptioneel
paidstringoptioneel
underpaidstringoptioneel
expiredstringoptioneel
deobjectoptioneel
waitingstringoptioneel
confirmingstringoptioneel
paidstringoptioneel
underpaidstringoptioneel
expiredstringoptioneel
esobjectoptioneel
waitingstringoptioneel
confirmingstringoptioneel
paidstringoptioneel
underpaidstringoptioneel
expiredstringoptioneel
pt-BRobjectoptioneel
waitingstringoptioneel
confirmingstringoptioneel
paidstringoptioneel
underpaidstringoptioneel
expiredstringoptioneel
itobjectoptioneel
waitingstringoptioneel
confirmingstringoptioneel
paidstringoptioneel
underpaidstringoptioneel
expiredstringoptioneel
ruobjectoptioneel
waitingstringoptioneel
confirmingstringoptioneel
paidstringoptioneel
underpaidstringoptioneel
expiredstringoptioneel
zh-CNobjectoptioneel
waitingstringoptioneel
confirmingstringoptioneel
paidstringoptioneel
underpaidstringoptioneel
expiredstringoptioneel
frobjectoptioneel
waitingstringoptioneel
confirmingstringoptioneel
paidstringoptioneel
underpaidstringoptioneel
expiredstringoptioneel
koobjectoptioneel
waitingstringoptioneel
confirmingstringoptioneel
paidstringoptioneel
underpaidstringoptioneel
expiredstringoptioneel
jaobjectoptioneel
waitingstringoptioneel
confirmingstringoptioneel
paidstringoptioneel
underpaidstringoptioneel
expiredstringoptioneel
support_emailstringoptioneel

ASCII-e-mailadres, maximaal 254 tekens. Leeg wist.

support_urlstringoptioneel

HTTPS-URL's tot 2,048 tekens, zonder inloggegevens. Leeg wist. Links openen in een nieuw venster.

terms_urlstringoptioneel

HTTPS-URL's tot 2,048 tekens, zonder inloggegevens. Leeg wist. Links openen in een nieuw venster.

privacy_urlstringoptioneel

HTTPS-URL's tot 2,048 tekens, zonder inloggegevens. Leeg wist. Links openen in een nieuw venster.

return_button_textstringoptioneel

Label tot 60 tekens. Gebruik redirect_url/cancel_url/redirect_automatically/language op het hoogste niveau voor factuurgedrag.

show_return_buttonbooleanoptioneel
Toon de handmatige knop Terug naar handelaar/annuleren op de afrekenpagina, inclusief eindstatussen. Laat weg om het winkeluiterlijk over te nemen (standaard true); false verbergt de knop. Annuleert geen factuur, verbergt geen URL's in JSON en schakelt automatische succesomleidingen niet uit. Stel zo nodig redirect_automatically op het hoogste niveau afzonderlijk in op false. Vereist merchant 8.1.4 of nieuwer.Details

Toon de handmatige knop Terug naar handelaar/annuleren op de afrekenpagina, inclusief eindstatussen. Laat weg om het winkeluiterlijk over te nemen (standaard true); false verbergt de knop. Annuleert geen factuur, verbergt geen URL's in JSON en schakelt automatische succesomleidingen niet uit. Stel zo nodig redirect_automatically op het hoogste niveau afzonderlijk in op false. Vereist merchant 8.1.4 of nieuwer.

metadataobject | nulloptioneel
JSON-object alleen voor de handelaar; weggelaten of null wordt {}, maximaal 4,096 gecodeerde bytes en vijf nestingsniveaus. firstname, lastname, street, street2, zip, city, country, countryiso2, company en vatid worden gevalideerd, genormaliseerd en overgenomen in samenvattingsvelden van de klant.Details

JSON-object alleen voor de handelaar; weggelaten of null wordt {}, maximaal 4,096 gecodeerde bytes en vijf nestingsniveaus. firstname, lastname, street, street2, zip, city, country, countryiso2, company en vatid worden gevalideerd, genormaliseerd en overgenomen in samenvattingsvelden van de klant.

firstnamestringoptioneel
lastnamestringoptioneel
streetstringoptioneel
street2stringoptioneel
zipstringoptioneel
citystringoptioneel
countrystringoptioneel
countryiso2stringoptioneel
companystringoptioneel
vatidstringoptioneel
project_idUUIDvereist

Een geautoriseerd project. Vereist bij elk verzoek, inclusief item-URL's.

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"}]Details

[{"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

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": {
    "invoice_id": "YOUR_INVOICE_ID",
    "status": "new",
    "marketplace": {
      "state": "pending",
      "allocations": []
    }
  },
  "links": {
    "checkout": "https://pay.example.com/invoice/YOUR_INVOICE_ID"
  }
}

Antwoordvelden

dataobject
invoice_idstring
statusstring
marketplaceobject
statestring
allocations[]array
Gebruiksopmerkingen
  • Vereist invoices.write. Antwoordvoorbeelden tonen geselecteerde velden; gebruik GET op de resource voor het volledige bewaarde bewijs.
  • Elke POST vereist een duurzaam opgeslagen Idempotency-Key van 16–128 tekens (letters, cijfers, -, _ of .). Hergebruik na een time-out dezelfde sleutel en JSON-instructies. Andere instructies geven 409 terug. Voltooide antwoorden worden 30 dagen bewaard; oude sleutels worden blijvend gemarkeerd als niet herbruikbaar. Wijzig een sleutel nooit alleen om een onzeker resultaat te omzeilen.
  • Sleutels hebben projectlijsten, optionele beperkingen voor factuurwinkels, een vervaldatum, IP-toelatingslijst en een quotum van 1–600/minuut (standaard 60). HTTP 429 bevat Retry-After. Sleutels die tot winkels zijn beperkt, kunnen geen verkopers, projectsaldi, grootboek, uitbetalingen of instellingen zien. Bewaar bestedingsreferenties uitsluitend op vertrouwde servers, nooit in browsers of uitgeleverde mobiele apps.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETFactuur en toewijzingen/v1/marketplace/invoices/{invoice_id}Alleen-lezen

Normale factuurdetails plus Marketplace-status, revision, hold_reason, vastgezette toewijzingen, beleidsmomentopname, de laatste 200 betalingen en laatste 100 gerelateerde uitbetalingen met afkapmarkeringen. Publiek afrekenen toont geen verkopersgegevens.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MARKETPLACE_API_TOKEN
ParameterType / locatieRegel
permissioncredential scopemarketplace.read

Queryparameters

project_idUUIDvereist

Een geautoriseerd project. Vereist bij elk verzoek, inclusief item-URL's.

pageoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

per_pageoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

qoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

statusoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

store_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

vendor_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

asset_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

fromoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

tooptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": {}
}

Antwoordvelden

dataobject
Gebruiksopmerkingen
  • Vereist marketplace.read. Antwoordvoorbeelden tonen geselecteerde velden; gebruik GET op de resource voor het volledige bewaarde bewijs.
  • Elke POST vereist een duurzaam opgeslagen Idempotency-Key van 16–128 tekens (letters, cijfers, -, _ of .). Hergebruik na een time-out dezelfde sleutel en JSON-instructies. Andere instructies geven 409 terug. Voltooide antwoorden worden 30 dagen bewaard; oude sleutels worden blijvend gemarkeerd als niet herbruikbaar. Wijzig een sleutel nooit alleen om een onzeker resultaat te omzeilen.
  • Sleutels hebben projectlijsten, optionele beperkingen voor factuurwinkels, een vervaldatum, IP-toelatingslijst en een quotum van 1–600/minuut (standaard 60). HTTP 429 bevat Retry-After. Sleutels die tot winkels zijn beperkt, kunnen geen verkopers, projectsaldi, grootboek, uitbetalingen of instellingen zien. Bewaar bestedingsreferenties uitsluitend op vertrouwde servers, nooit in browsers of uitgeleverde mobiele apps.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETBetalingsbewijs van factuur/v1/marketplace/invoices/{invoice_id}/paymentsAlleen-lezen

Normaal betalingsbewijs met page/per_page. Waarnemingen zijn geen verkopersuitbetalingen.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MARKETPLACE_API_TOKEN
ParameterType / locatieRegel
permissioncredential scopemarketplace.read

Queryparameters

project_idUUIDvereist

Een geautoriseerd project. Vereist bij elk verzoek, inclusief item-URL's.

pageoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

per_pageoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

qoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

statusoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

store_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

vendor_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

asset_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

fromoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

tooptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": {}
}

Antwoordvelden

dataobject
Gebruiksopmerkingen
  • Vereist marketplace.read. Antwoordvoorbeelden tonen geselecteerde velden; gebruik GET op de resource voor het volledige bewaarde bewijs.
  • Elke POST vereist een duurzaam opgeslagen Idempotency-Key van 16–128 tekens (letters, cijfers, -, _ of .). Hergebruik na een time-out dezelfde sleutel en JSON-instructies. Andere instructies geven 409 terug. Voltooide antwoorden worden 30 dagen bewaard; oude sleutels worden blijvend gemarkeerd als niet herbruikbaar. Wijzig een sleutel nooit alleen om een onzeker resultaat te omzeilen.
  • Sleutels hebben projectlijsten, optionele beperkingen voor factuurwinkels, een vervaldatum, IP-toelatingslijst en een quotum van 1–600/minuut (standaard 60). HTTP 429 bevat Retry-After. Sleutels die tot winkels zijn beperkt, kunnen geen verkopers, projectsaldi, grootboek, uitbetalingen of instellingen zien. Bewaar bestedingsreferenties uitsluitend op vertrouwde servers, nooit in browsers of uitgeleverde mobiele apps.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETFactuurtoewijzingen/v1/marketplace/invoices/{invoice_id}/allocationsAlleen-lezen

Onwijzigbare momentopnamen van aandeel/commissie/bestemming en exacte bruto-, commissie- en netto-atoomwaarden na kwalificerende voldoening.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MARKETPLACE_API_TOKEN
ParameterType / locatieRegel
permissioncredential scopemarketplace.read

Queryparameters

project_idUUIDvereist

Een geautoriseerd project. Vereist bij elk verzoek, inclusief item-URL's.

pageoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

per_pageoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

qoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

statusoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

store_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

vendor_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

asset_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

fromoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

tooptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": {}
}

Antwoordvelden

dataobject
Gebruiksopmerkingen
  • Vereist marketplace.read. Antwoordvoorbeelden tonen geselecteerde velden; gebruik GET op de resource voor het volledige bewaarde bewijs.
  • Elke POST vereist een duurzaam opgeslagen Idempotency-Key van 16–128 tekens (letters, cijfers, -, _ of .). Hergebruik na een time-out dezelfde sleutel en JSON-instructies. Andere instructies geven 409 terug. Voltooide antwoorden worden 30 dagen bewaard; oude sleutels worden blijvend gemarkeerd als niet herbruikbaar. Wijzig een sleutel nooit alleen om een onzeker resultaat te omzeilen.
  • Sleutels hebben projectlijsten, optionele beperkingen voor factuurwinkels, een vervaldatum, IP-toelatingslijst en een quotum van 1–600/minuut (standaard 60). HTTP 429 bevat Retry-After. Sleutels die tot winkels zijn beperkt, kunnen geen verkopers, projectsaldi, grootboek, uitbetalingen of instellingen zien. Bewaar bestedingsreferenties uitsluitend op vertrouwde servers, nooit in browsers of uitgeleverde mobiele apps.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTOnbetaalde factuur annuleren/v1/marketplace/invoices/{invoice_id}/cancelLezen + schrijven

Alleen een onbetaalde factuur met status new of expired. Late ontvangsten worden vastgehouden voor beoordeling. Revision is de Marketplace-factuurrevisie.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MARKETPLACE_API_TOKEN
Idempotency-Keyvereist16–128 letters, cijfers, -, _ of .; sla duurzaam op bij dit exacte verzoek
ParameterType / locatieRegel
permissioncredential scopeinvoices.write

Verzoek

: "${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
}'

Requestbody

project_idUUIDvereist

Een geautoriseerd project. Vereist bij elk verzoek, inclusief item-URL's.

revision

1

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": {}
}

Antwoordvelden

dataobject
Gebruiksopmerkingen
  • Vereist invoices.write. Antwoordvoorbeelden tonen geselecteerde velden; gebruik GET op de resource voor het volledige bewaarde bewijs.
  • Elke POST vereist een duurzaam opgeslagen Idempotency-Key van 16–128 tekens (letters, cijfers, -, _ of .). Hergebruik na een time-out dezelfde sleutel en JSON-instructies. Andere instructies geven 409 terug. Voltooide antwoorden worden 30 dagen bewaard; oude sleutels worden blijvend gemarkeerd als niet herbruikbaar. Wijzig een sleutel nooit alleen om een onzeker resultaat te omzeilen.
  • Sleutels hebben projectlijsten, optionele beperkingen voor factuurwinkels, een vervaldatum, IP-toelatingslijst en een quotum van 1–600/minuut (standaard 60). HTTP 429 bevat Retry-After. Sleutels die tot winkels zijn beperkt, kunnen geen verkopers, projectsaldi, grootboek, uitbetalingen of instellingen zien. Bewaar bestedingsreferenties uitsluitend op vertrouwde servers, nooit in browsers of uitgeleverde mobiele apps.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTToewijzingen vasthouden/v1/marketplace/invoices/{invoice_id}/allocations/holdLezen + schrijven

Houd niet-ondertekende toewijzingen vast zonder verplichtingen te wissen. Ondertekende of onzekere uitbetalingen blijven gevolgd worden.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MARKETPLACE_API_TOKEN
Idempotency-Keyvereist16–128 letters, cijfers, -, _ of .; sla duurzaam op bij dit exacte verzoek
ParameterType / locatieRegel
permissioncredential scopereconciliation.write

Verzoek

: "${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"
}'

Requestbody

project_idUUIDvereist

Een geautoriseerd project. Vereist bij elk verzoek, inclusief item-URL's.

revision

1

reason

"Verify customer request"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": {}
}

Antwoordvelden

dataobject
Gebruiksopmerkingen
  • Vereist reconciliation.write. Antwoordvoorbeelden tonen geselecteerde velden; gebruik GET op de resource voor het volledige bewaarde bewijs.
  • Elke POST vereist een duurzaam opgeslagen Idempotency-Key van 16–128 tekens (letters, cijfers, -, _ of .). Hergebruik na een time-out dezelfde sleutel en JSON-instructies. Andere instructies geven 409 terug. Voltooide antwoorden worden 30 dagen bewaard; oude sleutels worden blijvend gemarkeerd als niet herbruikbaar. Wijzig een sleutel nooit alleen om een onzeker resultaat te omzeilen.
  • Sleutels hebben projectlijsten, optionele beperkingen voor factuurwinkels, een vervaldatum, IP-toelatingslijst en een quotum van 1–600/minuut (standaard 60). HTTP 429 bevat Retry-After. Sleutels die tot winkels zijn beperkt, kunnen geen verkopers, projectsaldi, grootboek, uitbetalingen of instellingen zien. Bewaar bestedingsreferenties uitsluitend op vertrouwde servers, nooit in browsers of uitgeleverde mobiele apps.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTToewijzingen beoordelen en vrijgeven/v1/marketplace/invoices/{invoice_id}/allocations/releaseLezen + schrijven

Controleer dekking/finaliteit opnieuw. Optioneel approved_amount_atomic accepteert expliciet een kleinere, volledig gedekte verdeling voordat toewijzingen worden vastgezet; verzint nooit ontvangen geld.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MARKETPLACE_API_TOKEN
Idempotency-Keyvereist16–128 letters, cijfers, -, _ of .; sla duurzaam op bij dit exacte verzoek
ParameterType / locatieRegel
permissioncredential scopereconciliation.write

Verzoek

: "${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"
}'

Requestbody

project_idUUIDvereist

Een geautoriseerd project. Vereist bij elk verzoek, inclusief item-URL's.

revision

1

reason

"Verified payment evidence"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": {}
}

Antwoordvelden

dataobject
Gebruiksopmerkingen
  • Vereist reconciliation.write. Antwoordvoorbeelden tonen geselecteerde velden; gebruik GET op de resource voor het volledige bewaarde bewijs.
  • Elke POST vereist een duurzaam opgeslagen Idempotency-Key van 16–128 tekens (letters, cijfers, -, _ of .). Hergebruik na een time-out dezelfde sleutel en JSON-instructies. Andere instructies geven 409 terug. Voltooide antwoorden worden 30 dagen bewaard; oude sleutels worden blijvend gemarkeerd als niet herbruikbaar. Wijzig een sleutel nooit alleen om een onzeker resultaat te omzeilen.
  • Sleutels hebben projectlijsten, optionele beperkingen voor factuurwinkels, een vervaldatum, IP-toelatingslijst en een quotum van 1–600/minuut (standaard 60). HTTP 429 bevat Retry-After. Sleutels die tot winkels zijn beperkt, kunnen geen verkopers, projectsaldi, grootboek, uitbetalingen of instellingen zien. Bewaar bestedingsreferenties uitsluitend op vertrouwde servers, nooit in browsers of uitgeleverde mobiele apps.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTOnbetaalde bestemming opnieuw koppelen/v1/marketplace/invoices/{invoice_id}/allocations/{allocation_id}/destinationLezen + schrijven

Toewijzingsrevisie vereist. Alleen niet-gereserveerd/niet-ondertekend werk en een afzonderlijk goedgekeurde versie voor dezelfde verkoper op het oorspronkelijke netwerk. Geaudit; ondertekend werk kan niet veranderen.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MARKETPLACE_API_TOKEN
Idempotency-Keyvereist16–128 letters, cijfers, -, _ of .; sla duurzaam op bij dit exacte verzoek
ParameterType / locatieRegel
permissioncredential scopereconciliation.write

Verzoek

: "${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"
}'

Requestbody

project_idUUIDvereist

Een geautoriseerd project. Vereist bij elk verzoek, inclusief item-URL's.

revision

1

destination_id

"YOUR_DESTINATION_ID"

reason

"Vendor verified replacement address"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": {}
}

Antwoordvelden

dataobject
Gebruiksopmerkingen
  • Vereist reconciliation.write. Antwoordvoorbeelden tonen geselecteerde velden; gebruik GET op de resource voor het volledige bewaarde bewijs.
  • Elke POST vereist een duurzaam opgeslagen Idempotency-Key van 16–128 tekens (letters, cijfers, -, _ of .). Hergebruik na een time-out dezelfde sleutel en JSON-instructies. Andere instructies geven 409 terug. Voltooide antwoorden worden 30 dagen bewaard; oude sleutels worden blijvend gemarkeerd als niet herbruikbaar. Wijzig een sleutel nooit alleen om een onzeker resultaat te omzeilen.
  • Sleutels hebben projectlijsten, optionele beperkingen voor factuurwinkels, een vervaldatum, IP-toelatingslijst en een quotum van 1–600/minuut (standaard 60). HTTP 429 bevat Retry-After. Sleutels die tot winkels zijn beperkt, kunnen geen verkopers, projectsaldi, grootboek, uitbetalingen of instellingen zien. Bewaar bestedingsreferenties uitsluitend op vertrouwde servers, nooit in browsers of uitgeleverde mobiele apps.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTVolledige terugbetaling voorbereiden/v1/marketplace/invoices/{invoice_id}/refundLezen + schrijven

Bereid een afzonderlijk goed te keuren volledige terugbetaling van het ontvangen bedrag in hetzelfde actief voor. Reserveer vóór verkopersuitbetaling de onbetaalde middelen en draai commissie bij bevestiging terug. Gebruik na alle verkopersuitbetalingen afzonderlijke vrije middelen van het primaire adres. Leid het terugbetalingsadres van de klant nooit af van de afzender.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MARKETPLACE_API_TOKEN
Idempotency-Keyvereist16–128 letters, cijfers, -, _ of .; sla duurzaam op bij dit exacte verzoek
ParameterType / locatieRegel
permissioncredential scopereconciliation.write

Verzoek

: "${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"
}'

Requestbody

project_idUUIDvereist

Een geautoriseerd project. Vereist bij elk verzoek, inclusief item-URL's.

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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": {}
}

Antwoordvelden

dataobject
Gebruiksopmerkingen
  • Vereist reconciliation.write. Antwoordvoorbeelden tonen geselecteerde velden; gebruik GET op de resource voor het volledige bewaarde bewijs.
  • Elke POST vereist een duurzaam opgeslagen Idempotency-Key van 16–128 tekens (letters, cijfers, -, _ of .). Hergebruik na een time-out dezelfde sleutel en JSON-instructies. Andere instructies geven 409 terug. Voltooide antwoorden worden 30 dagen bewaard; oude sleutels worden blijvend gemarkeerd als niet herbruikbaar. Wijzig een sleutel nooit alleen om een onzeker resultaat te omzeilen.
  • Sleutels hebben projectlijsten, optionele beperkingen voor factuurwinkels, een vervaldatum, IP-toelatingslijst en een quotum van 1–600/minuut (standaard 60). HTTP 429 bevat Retry-After. Sleutels die tot winkels zijn beperkt, kunnen geen verkopers, projectsaldi, grootboek, uitbetalingen of instellingen zien. Bewaar bestedingsreferenties uitsluitend op vertrouwde servers, nooit in browsers of uitgeleverde mobiele apps.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETUitbetalingstoewijzingen zoeken/v1/marketplace/allocationsAlleen-lezen

Gepagineerde kandidaten; filter op status (available enz.), asset_id, vendor_id, store_id en q (verkoper/bestelling/factuur).

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MARKETPLACE_API_TOKEN
ParameterType / locatieRegel
permissioncredential scopemarketplace.read

Queryparameters

project_idUUIDvereist

Een geautoriseerd project. Vereist bij elk verzoek, inclusief item-URL's.

pageoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

per_pageoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

qoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

statusoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

store_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

vendor_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

asset_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

fromoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

tooptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": [],
  "pagination": {
    "page": 1,
    "per_page": 25,
    "total": 0,
    "pages": 1
  }
}

Antwoordvelden

data[]array
paginationobject
pageinteger
per_pageinteger
totalinteger
pagesinteger
Gebruiksopmerkingen
  • Vereist marketplace.read. Antwoordvoorbeelden tonen geselecteerde velden; gebruik GET op de resource voor het volledige bewaarde bewijs.
  • Elke POST vereist een duurzaam opgeslagen Idempotency-Key van 16–128 tekens (letters, cijfers, -, _ of .). Hergebruik na een time-out dezelfde sleutel en JSON-instructies. Andere instructies geven 409 terug. Voltooide antwoorden worden 30 dagen bewaard; oude sleutels worden blijvend gemarkeerd als niet herbruikbaar. Wijzig een sleutel nooit alleen om een onzeker resultaat te omzeilen.
  • Sleutels hebben projectlijsten, optionele beperkingen voor factuurwinkels, een vervaldatum, IP-toelatingslijst en een quotum van 1–600/minuut (standaard 60). HTTP 429 bevat Retry-After. Sleutels die tot winkels zijn beperkt, kunnen geen verkopers, projectsaldi, grootboek, uitbetalingen of instellingen zien. Bewaar bestedingsreferenties uitsluitend op vertrouwde servers, nooit in browsers of uitgeleverde mobiele apps.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETGrootboeksaldi van project/v1/marketplace/balancesAlleen-lezen

Exacte gegroepeerde activa-/accounttotalen inclusief vastgehouden, beschikbaar, gereserveerd, betaald, commissie, terugbetalingen en netwerkkosten. De externe tegenrekening is uitgesloten.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MARKETPLACE_API_TOKEN
ParameterType / locatieRegel
permissioncredential scopemarketplace.read

Queryparameters

project_idUUIDvereist

Een geautoriseerd project. Vereist bij elk verzoek, inclusief item-URL's.

pageoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

per_pageoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

qoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

statusoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

store_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

vendor_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

asset_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

fromoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

tooptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": {}
}

Antwoordvelden

dataobject
Gebruiksopmerkingen
  • Vereist marketplace.read. Antwoordvoorbeelden tonen geselecteerde velden; gebruik GET op de resource voor het volledige bewaarde bewijs.
  • Elke POST vereist een duurzaam opgeslagen Idempotency-Key van 16–128 tekens (letters, cijfers, -, _ of .). Hergebruik na een time-out dezelfde sleutel en JSON-instructies. Andere instructies geven 409 terug. Voltooide antwoorden worden 30 dagen bewaard; oude sleutels worden blijvend gemarkeerd als niet herbruikbaar. Wijzig een sleutel nooit alleen om een onzeker resultaat te omzeilen.
  • Sleutels hebben projectlijsten, optionele beperkingen voor factuurwinkels, een vervaldatum, IP-toelatingslijst en een quotum van 1–600/minuut (standaard 60). HTTP 429 bevat Retry-After. Sleutels die tot winkels zijn beperkt, kunnen geen verkopers, projectsaldi, grootboek, uitbetalingen of instellingen zien. Bewaar bestedingsreferenties uitsluitend op vertrouwde servers, nooit in browsers of uitgeleverde mobiele apps.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETOnwijzigbaar journaal/v1/marketplace/ledgerAlleen-lezen

Gepagineerde boekingen waaraan alleen kan worden toegevoegd; filters q voor referentie/account, asset_id en vendor_id. Bedragen gebruiken atomaire tekenreeksen; geen boeking kan worden bewerkt of handmatig als betaald gemarkeerd.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MARKETPLACE_API_TOKEN
ParameterType / locatieRegel
permissioncredential scopemarketplace.read

Queryparameters

project_idUUIDvereist

Een geautoriseerd project. Vereist bij elk verzoek, inclusief item-URL's.

pageoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

per_pageoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

qoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

statusoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

store_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

vendor_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

asset_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

fromoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

tooptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": [],
  "pagination": {
    "page": 1,
    "per_page": 25,
    "total": 0,
    "pages": 1
  }
}

Antwoordvelden

data[]array
paginationobject
pageinteger
per_pageinteger
totalinteger
pagesinteger
Gebruiksopmerkingen
  • Vereist marketplace.read. Antwoordvoorbeelden tonen geselecteerde velden; gebruik GET op de resource voor het volledige bewaarde bewijs.
  • Elke POST vereist een duurzaam opgeslagen Idempotency-Key van 16–128 tekens (letters, cijfers, -, _ of .). Hergebruik na een time-out dezelfde sleutel en JSON-instructies. Andere instructies geven 409 terug. Voltooide antwoorden worden 30 dagen bewaard; oude sleutels worden blijvend gemarkeerd als niet herbruikbaar. Wijzig een sleutel nooit alleen om een onzeker resultaat te omzeilen.
  • Sleutels hebben projectlijsten, optionele beperkingen voor factuurwinkels, een vervaldatum, IP-toelatingslijst en een quotum van 1–600/minuut (standaard 60). HTTP 429 bevat Retry-After. Sleutels die tot winkels zijn beperkt, kunnen geen verkopers, projectsaldi, grootboek, uitbetalingen of instellingen zien. Bewaar bestedingsreferenties uitsluitend op vertrouwde servers, nooit in browsers of uitgeleverde mobiele apps.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETUitbetalingsgeschiedenis/v1/marketplace/payoutsAlleen-lezen

Gepagineerde bovenliggende records; filter op state, asset_id, vendor_id of q voor ID/symbool. Paid betekent onafhankelijke bevestiging, niet alleen uitzending.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MARKETPLACE_API_TOKEN
ParameterType / locatieRegel
permissioncredential scopemarketplace.read

Queryparameters

project_idUUIDvereist

Een geautoriseerd project. Vereist bij elk verzoek, inclusief item-URL's.

pageoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

per_pageoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

qoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

statusoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

store_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

vendor_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

asset_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

fromoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

tooptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": [],
  "pagination": {
    "page": 1,
    "per_page": 25,
    "total": 0,
    "pages": 1
  }
}

Antwoordvelden

data[]array
paginationobject
pageinteger
per_pageinteger
totalinteger
pagesinteger
Gebruiksopmerkingen
  • Vereist marketplace.read. Antwoordvoorbeelden tonen geselecteerde velden; gebruik GET op de resource voor het volledige bewaarde bewijs.
  • Elke POST vereist een duurzaam opgeslagen Idempotency-Key van 16–128 tekens (letters, cijfers, -, _ of .). Hergebruik na een time-out dezelfde sleutel en JSON-instructies. Andere instructies geven 409 terug. Voltooide antwoorden worden 30 dagen bewaard; oude sleutels worden blijvend gemarkeerd als niet herbruikbaar. Wijzig een sleutel nooit alleen om een onzeker resultaat te omzeilen.
  • Sleutels hebben projectlijsten, optionele beperkingen voor factuurwinkels, een vervaldatum, IP-toelatingslijst en een quotum van 1–600/minuut (standaard 60). HTTP 429 bevat Retry-After. Sleutels die tot winkels zijn beperkt, kunnen geen verkopers, projectsaldi, grootboek, uitbetalingen of instellingen zien. Bewaar bestedingsreferenties uitsluitend op vertrouwde servers, nooit in browsers of uitgeleverde mobiele apps.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTToewijzingsplan vooraf bekijken/v1/marketplace/payouts/previewLezen + schrijven

Boekhoudplan met alleen-lezen toegang, geen reservering of bestedingsbevoegdheid. Maximale kosten zijn een gebruikerslimiet, geen schatting van werkelijke kosten. Voorbereiding voert later actuele controles uit.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MARKETPLACE_API_TOKEN
Idempotency-Keyvereist16–128 letters, cijfers, -, _ of .; sla duurzaam op bij dit exacte verzoek
ParameterType / locatieRegel
permissioncredential scopepayouts.write

Verzoek

: "${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"
}'

Requestbody

project_idUUIDvereist

Een geautoriseerd project. Vereist bij elk verzoek, inclusief item-URL's.

allocation_ids[]

["YOUR_ALLOCATION_ID"]

maximum_network_fee_atomic

"10000"

maximum_gas_funding_atomic

"0"

fee_tier

"medium"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": {}
}

Antwoordvelden

dataobject
Gebruiksopmerkingen
  • Vereist payouts.write. Antwoordvoorbeelden tonen geselecteerde velden; gebruik GET op de resource voor het volledige bewaarde bewijs.
  • Elke POST vereist een duurzaam opgeslagen Idempotency-Key van 16–128 tekens (letters, cijfers, -, _ of .). Hergebruik na een time-out dezelfde sleutel en JSON-instructies. Andere instructies geven 409 terug. Voltooide antwoorden worden 30 dagen bewaard; oude sleutels worden blijvend gemarkeerd als niet herbruikbaar. Wijzig een sleutel nooit alleen om een onzeker resultaat te omzeilen.
  • Sleutels hebben projectlijsten, optionele beperkingen voor factuurwinkels, een vervaldatum, IP-toelatingslijst en een quotum van 1–600/minuut (standaard 60). HTTP 429 bevat Retry-After. Sleutels die tot winkels zijn beperkt, kunnen geen verkopers, projectsaldi, grootboek, uitbetalingen of instellingen zien. Bewaar bestedingsreferenties uitsluitend op vertrouwde servers, nooit in browsers of uitgeleverde mobiele apps.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTUitbetaling voorbereiden/v1/marketplace/payoutsLezen + schrijven

Reserveer 1–100 beschikbare toewijzings-ID's in één actief/wallet. BTC vereist alle onbetaalde aandelen van elke geselecteerde factuur in één batch met meerdere outputs. Budgetten zijn atomaire tekenreeksen in de eigen munt voor kosten. Maakt een awaiting_approval-plan en zendt niets uit.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MARKETPLACE_API_TOKEN
Idempotency-Keyvereist16–128 letters, cijfers, -, _ of .; sla duurzaam op bij dit exacte verzoek
ParameterType / locatieRegel
permissioncredential scopepayouts.write

Verzoek

: "${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"
}'

Requestbody

project_idUUIDvereist

Een geautoriseerd project. Vereist bij elk verzoek, inclusief item-URL's.

allocation_ids[]

["YOUR_ALLOCATION_ID"]

maximum_network_fee_atomic

"10000"

maximum_gas_funding_atomic

"0"

fee_tier

"medium"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "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": []
  }
}

Antwoordvelden

dataobject
idstring
statestring
revisioninteger
plan_hashstring
planobject
amount_atomicstring
maximum_network_fee_atomicstring
maximum_gas_funding_atomicstring
items[]array
transactions[]array
Gebruiksopmerkingen
  • Vereist payouts.write. Antwoordvoorbeelden tonen geselecteerde velden; gebruik GET op de resource voor het volledige bewaarde bewijs.
  • Elke POST vereist een duurzaam opgeslagen Idempotency-Key van 16–128 tekens (letters, cijfers, -, _ of .). Hergebruik na een time-out dezelfde sleutel en JSON-instructies. Andere instructies geven 409 terug. Voltooide antwoorden worden 30 dagen bewaard; oude sleutels worden blijvend gemarkeerd als niet herbruikbaar. Wijzig een sleutel nooit alleen om een onzeker resultaat te omzeilen.
  • Sleutels hebben projectlijsten, optionele beperkingen voor factuurwinkels, een vervaldatum, IP-toelatingslijst en een quotum van 1–600/minuut (standaard 60). HTTP 429 bevat Retry-After. Sleutels die tot winkels zijn beperkt, kunnen geen verkopers, projectsaldi, grootboek, uitbetalingen of instellingen zien. Bewaar bestedingsreferenties uitsluitend op vertrouwde servers, nooit in browsers of uitgeleverde mobiele apps.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETUitbetalingsdetails/v1/marketplace/payouts/{payout_id}Alleen-lezen

Onwijzigbaar plan/hash, revision, vervaldatum, ontvangeritems, bewaarde onderliggende pogingen, voortgang, exacte kosten en explorerlinks. Nooit private sleutels of ondertekende bytes.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MARKETPLACE_API_TOKEN
ParameterType / locatieRegel
permissioncredential scopemarketplace.read

Queryparameters

project_idUUIDvereist

Een geautoriseerd project. Vereist bij elk verzoek, inclusief item-URL's.

pageoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

per_pageoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

qoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

statusoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

store_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

vendor_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

asset_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

fromoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

tooptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "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": []
  }
}

Antwoordvelden

dataobject
idstring
statestring
revisioninteger
plan_hashstring
planobject
amount_atomicstring
maximum_network_fee_atomicstring
maximum_gas_funding_atomicstring
items[]array
transactions[]array
Gebruiksopmerkingen
  • Vereist marketplace.read. Antwoordvoorbeelden tonen geselecteerde velden; gebruik GET op de resource voor het volledige bewaarde bewijs.
  • Elke POST vereist een duurzaam opgeslagen Idempotency-Key van 16–128 tekens (letters, cijfers, -, _ of .). Hergebruik na een time-out dezelfde sleutel en JSON-instructies. Andere instructies geven 409 terug. Voltooide antwoorden worden 30 dagen bewaard; oude sleutels worden blijvend gemarkeerd als niet herbruikbaar. Wijzig een sleutel nooit alleen om een onzeker resultaat te omzeilen.
  • Sleutels hebben projectlijsten, optionele beperkingen voor factuurwinkels, een vervaldatum, IP-toelatingslijst en een quotum van 1–600/minuut (standaard 60). HTTP 429 bevat Retry-After. Sleutels die tot winkels zijn beperkt, kunnen geen verkopers, projectsaldi, grootboek, uitbetalingen of instellingen zien. Bewaar bestedingsreferenties uitsluitend op vertrouwde servers, nooit in browsers of uitgeleverde mobiele apps.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTGoedkeuren en verzenden/v1/marketplace/payouts/{payout_id}/approveLezen + schrijven

Geef binnen de geldigheidsduur expliciet toestemming voor het exacte bewaarde plan. Zet begrensde gasfinanciering en verkoperstransacties op de achtergrond in de wachtrij.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MARKETPLACE_API_TOKEN
Idempotency-Keyvereist16–128 letters, cijfers, -, _ of .; sla duurzaam op bij dit exacte verzoek
ParameterType / locatieRegel
permissioncredential scopepayouts.approve

Verzoek

: "${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
}'

Requestbody

project_idUUIDvereist

Een geautoriseerd project. Vereist bij elk verzoek, inclusief item-URL's.

revision

1

expected_plan_hash

"COPY_EXACT_PLAN_HASH_FROM_PREPARE"

confirm

true

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": {}
}

Antwoordvelden

dataobject
Gebruiksopmerkingen
  • Vereist payouts.approve. Antwoordvoorbeelden tonen geselecteerde velden; gebruik GET op de resource voor het volledige bewaarde bewijs.
  • Elke POST vereist een duurzaam opgeslagen Idempotency-Key van 16–128 tekens (letters, cijfers, -, _ of .). Hergebruik na een time-out dezelfde sleutel en JSON-instructies. Andere instructies geven 409 terug. Voltooide antwoorden worden 30 dagen bewaard; oude sleutels worden blijvend gemarkeerd als niet herbruikbaar. Wijzig een sleutel nooit alleen om een onzeker resultaat te omzeilen.
  • Sleutels hebben projectlijsten, optionele beperkingen voor factuurwinkels, een vervaldatum, IP-toelatingslijst en een quotum van 1–600/minuut (standaard 60). HTTP 429 bevat Retry-After. Sleutels die tot winkels zijn beperkt, kunnen geen verkopers, projectsaldi, grootboek, uitbetalingen of instellingen zien. Bewaar bestedingsreferenties uitsluitend op vertrouwde servers, nooit in browsers of uitgeleverde mobiele apps.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTUitbetaling beoordelen en hervatten/v1/marketplace/payouts/{payout_id}/resumeLezen + schrijven

Alleen needs_attention. Hergebruik het bewaarde plan/hash; bevestigde ontvangers krijgen nooit opnieuw geld. Twee onafhankelijke providers moeten een canonieke, voldoende bevestigde EVM-revert bewijzen voordat een mislukte onderliggende transactie kan worden vervangen. Eerdere kosten blijven het goedgekeurde budget verbruiken en alle hashes blijven in de geschiedenis. Onbekende/gedeeltelijke tokenlevering geeft payout_recovery_unverified terug; reserveringen blijven vastgehouden.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MARKETPLACE_API_TOKEN
Idempotency-Keyvereist16–128 letters, cijfers, -, _ of .; sla duurzaam op bij dit exacte verzoek
ParameterType / locatieRegel
permissioncredential scopepayouts.approve

Verzoek

: "${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
}'

Requestbody

project_idUUIDvereist

Een geautoriseerd project. Vereist bij elk verzoek, inclusief item-URL's.

revision

1

expected_plan_hash

"COPY_EXACT_PLAN_HASH_FROM_PREPARE"

confirm

true

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": {}
}

Antwoordvelden

dataobject
Gebruiksopmerkingen
  • Vereist payouts.approve. Antwoordvoorbeelden tonen geselecteerde velden; gebruik GET op de resource voor het volledige bewaarde bewijs.
  • Elke POST vereist een duurzaam opgeslagen Idempotency-Key van 16–128 tekens (letters, cijfers, -, _ of .). Hergebruik na een time-out dezelfde sleutel en JSON-instructies. Andere instructies geven 409 terug. Voltooide antwoorden worden 30 dagen bewaard; oude sleutels worden blijvend gemarkeerd als niet herbruikbaar. Wijzig een sleutel nooit alleen om een onzeker resultaat te omzeilen.
  • Sleutels hebben projectlijsten, optionele beperkingen voor factuurwinkels, een vervaldatum, IP-toelatingslijst en een quotum van 1–600/minuut (standaard 60). HTTP 429 bevat Retry-After. Sleutels die tot winkels zijn beperkt, kunnen geen verkopers, projectsaldi, grootboek, uitbetalingen of instellingen zien. Bewaar bestedingsreferenties uitsluitend op vertrouwde servers, nooit in browsers of uitgeleverde mobiele apps.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTNiet-ondertekend werk annuleren/v1/marketplace/payouts/{payout_id}/cancelLezen + schrijven

Geef alleen reserveringen vrij waarvan vaststaat dat ze niet ondertekend/ingediend zijn. Bevestigde ontvangers en audit blijven behouden. Ondertekend/onzeker werk kan niet worden geannuleerd. Een expliciet herstelde, bewezen revert blokkeert het annuleren van resterend niet-ondertekend werk niet langer.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MARKETPLACE_API_TOKEN
Idempotency-Keyvereist16–128 letters, cijfers, -, _ of .; sla duurzaam op bij dit exacte verzoek
ParameterType / locatieRegel
permissioncredential scopepayouts.write

Verzoek

: "${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
}'

Requestbody

project_idUUIDvereist

Een geautoriseerd project. Vereist bij elk verzoek, inclusief item-URL's.

revision

1

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": {}
}

Antwoordvelden

dataobject
Gebruiksopmerkingen
  • Vereist payouts.write. Antwoordvoorbeelden tonen geselecteerde velden; gebruik GET op de resource voor het volledige bewaarde bewijs.
  • Elke POST vereist een duurzaam opgeslagen Idempotency-Key van 16–128 tekens (letters, cijfers, -, _ of .). Hergebruik na een time-out dezelfde sleutel en JSON-instructies. Andere instructies geven 409 terug. Voltooide antwoorden worden 30 dagen bewaard; oude sleutels worden blijvend gemarkeerd als niet herbruikbaar. Wijzig een sleutel nooit alleen om een onzeker resultaat te omzeilen.
  • Sleutels hebben projectlijsten, optionele beperkingen voor factuurwinkels, een vervaldatum, IP-toelatingslijst en een quotum van 1–600/minuut (standaard 60). HTTP 429 bevat Retry-After. Sleutels die tot winkels zijn beperkt, kunnen geen verkopers, projectsaldi, grootboek, uitbetalingen of instellingen zien. Bewaar bestedingsreferenties uitsluitend op vertrouwde servers, nooit in browsers of uitgeleverde mobiele apps.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETAutomatisch uitbetalingsbeleid/v1/marketplace/policiesAlleen-lezen

Lees beleid per actief, revision, next_attempt_at, last_checked_at en een veilige last_error wanneer voorbereiding of autorisatie aandacht nodig heeft.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MARKETPLACE_API_TOKEN
ParameterType / locatieRegel
permissioncredential scopemarketplace.read

Queryparameters

project_idUUIDvereist

Een geautoriseerd project. Vereist bij elk verzoek, inclusief item-URL's.

pageoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

per_pageoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

qoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

statusoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

store_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

vendor_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

asset_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

fromoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

tooptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": []
}

Antwoordvelden

data[]array
Gebruiksopmerkingen
  • Vereist marketplace.read. Antwoordvoorbeelden tonen geselecteerde velden; gebruik GET op de resource voor het volledige bewaarde bewijs.
  • Elke POST vereist een duurzaam opgeslagen Idempotency-Key van 16–128 tekens (letters, cijfers, -, _ of .). Hergebruik na een time-out dezelfde sleutel en JSON-instructies. Andere instructies geven 409 terug. Voltooide antwoorden worden 30 dagen bewaard; oude sleutels worden blijvend gemarkeerd als niet herbruikbaar. Wijzig een sleutel nooit alleen om een onzeker resultaat te omzeilen.
  • Sleutels hebben projectlijsten, optionele beperkingen voor factuurwinkels, een vervaldatum, IP-toelatingslijst en een quotum van 1–600/minuut (standaard 60). HTTP 429 bevat Retry-After. Sleutels die tot winkels zijn beperkt, kunnen geen verkopers, projectsaldi, grootboek, uitbetalingen of instellingen zien. Bewaar bestedingsreferenties uitsluitend op vertrouwde servers, nooit in browsers of uitgeleverde mobiele apps.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTUitbetalingsbeleid autoriseren/v1/marketplace/policiesLezen + schrijven

Exacte atomaire tekenreeksen; minimum <= transfer <= dagelijkse hoofdsom, kosten-/gaslimieten <= hun dagbudgetten. interval_seconds 60–604800; minimum_confirmations 1–100000 afhankelijk van de blockchainondergrens. Revision 0 maakt aan. Ingeschakeld beleid kan zonder extra klikken verzenden; houd false totdat het is beoordeeld.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MARKETPLACE_API_TOKEN
Idempotency-Keyvereist16–128 letters, cijfers, -, _ of .; sla duurzaam op bij dit exacte verzoek
ParameterType / locatieRegel
permissioncredential scopepolicies.write

Verzoek

: "${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
}'

Requestbody

project_idUUIDvereist

Een geautoriseerd project. Vereist bij elk verzoek, inclusief item-URL's.

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

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": {}
}

Antwoordvelden

dataobject
Gebruiksopmerkingen
  • Vereist policies.write. Antwoordvoorbeelden tonen geselecteerde velden; gebruik GET op de resource voor het volledige bewaarde bewijs.
  • Elke POST vereist een duurzaam opgeslagen Idempotency-Key van 16–128 tekens (letters, cijfers, -, _ of .). Hergebruik na een time-out dezelfde sleutel en JSON-instructies. Andere instructies geven 409 terug. Voltooide antwoorden worden 30 dagen bewaard; oude sleutels worden blijvend gemarkeerd als niet herbruikbaar. Wijzig een sleutel nooit alleen om een onzeker resultaat te omzeilen.
  • Sleutels hebben projectlijsten, optionele beperkingen voor factuurwinkels, een vervaldatum, IP-toelatingslijst en een quotum van 1–600/minuut (standaard 60). HTTP 429 bevat Retry-After. Sleutels die tot winkels zijn beperkt, kunnen geen verkopers, projectsaldi, grootboek, uitbetalingen of instellingen zien. Bewaar bestedingsreferenties uitsluitend op vertrouwde servers, nooit in browsers of uitgeleverde mobiele apps.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETMarketplace-webhooks/v1/marketplace/webhooksAlleen-lezen

Maximaal 20 eindpunten plus ondersteunde event_types. Geeft nooit versleutelde of onversleutelde ondertekeningsgeheimen terug.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MARKETPLACE_API_TOKEN
ParameterType / locatieRegel
permissioncredential scopemarketplace.read

Queryparameters

project_idUUIDvereist

Een geautoriseerd project. Vereist bij elk verzoek, inclusief item-URL's.

pageoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

per_pageoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

qoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

statusoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

store_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

vendor_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

asset_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

fromoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

tooptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "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"
    ]
  }
}

Antwoordvelden

dataobject
endpoints[]array
event_types[]array
Gebruiksopmerkingen
  • Vereist marketplace.read. Antwoordvoorbeelden tonen geselecteerde velden; gebruik GET op de resource voor het volledige bewaarde bewijs.
  • Elke POST vereist een duurzaam opgeslagen Idempotency-Key van 16–128 tekens (letters, cijfers, -, _ of .). Hergebruik na een time-out dezelfde sleutel en JSON-instructies. Andere instructies geven 409 terug. Voltooide antwoorden worden 30 dagen bewaard; oude sleutels worden blijvend gemarkeerd als niet herbruikbaar. Wijzig een sleutel nooit alleen om een onzeker resultaat te omzeilen.
  • Sleutels hebben projectlijsten, optionele beperkingen voor factuurwinkels, een vervaldatum, IP-toelatingslijst en een quotum van 1–600/minuut (standaard 60). HTTP 429 bevat Retry-After. Sleutels die tot winkels zijn beperkt, kunnen geen verkopers, projectsaldi, grootboek, uitbetalingen of instellingen zien. Bewaar bestedingsreferenties uitsluitend op vertrouwde servers, nooit in browsers of uitgeleverde mobiele apps.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTMarketplace-webhook maken/v1/marketplace/webhooksLezen + schrijven

Alleen publieke HTTPS, geen inloggegevens, private bestemmingen of omleidingen. Geeft signing_secret één keer terug per bewaard idempotent aanmaakantwoord; bewaar veilig. Staat los van het IPN-geheim van de winkel.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MARKETPLACE_API_TOKEN
Idempotency-Keyvereist16–128 letters, cijfers, -, _ of .; sla duurzaam op bij dit exacte verzoek
ParameterType / locatieRegel
permissioncredential scopewebhooks.write

Verzoek

: "${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"
  ]
}'

Requestbody

project_idUUIDvereist

Een geautoriseerd project. Vereist bij elk verzoek, inclusief item-URL's.

url

"https://shop.example.com/marketplace-events"

enabled

true

events[]

["marketplace.payout.confirmed","marketplace.payout.failed"]

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": {}
}

Antwoordvelden

dataobject
Gebruiksopmerkingen
  • Vereist webhooks.write. Antwoordvoorbeelden tonen geselecteerde velden; gebruik GET op de resource voor het volledige bewaarde bewijs.
  • Elke POST vereist een duurzaam opgeslagen Idempotency-Key van 16–128 tekens (letters, cijfers, -, _ of .). Hergebruik na een time-out dezelfde sleutel en JSON-instructies. Andere instructies geven 409 terug. Voltooide antwoorden worden 30 dagen bewaard; oude sleutels worden blijvend gemarkeerd als niet herbruikbaar. Wijzig een sleutel nooit alleen om een onzeker resultaat te omzeilen.
  • Sleutels hebben projectlijsten, optionele beperkingen voor factuurwinkels, een vervaldatum, IP-toelatingslijst en een quotum van 1–600/minuut (standaard 60). HTTP 429 bevat Retry-After. Sleutels die tot winkels zijn beperkt, kunnen geen verkopers, projectsaldi, grootboek, uitbetalingen of instellingen zien. Bewaar bestedingsreferenties uitsluitend op vertrouwde servers, nooit in browsers of uitgeleverde mobiele apps.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTMarketplace-webhook bijwerken/v1/marketplace/webhooks/{webhook_id}/updateLezen + schrijven

Wijzigingen annuleren oude niet-verzonden bezorgingen. Het geheim blijft ongewijzigd; oude onwijzigbare payloads worden nooit omgeleid naar een nieuwe URL.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MARKETPLACE_API_TOKEN
Idempotency-Keyvereist16–128 letters, cijfers, -, _ of .; sla duurzaam op bij dit exacte verzoek
ParameterType / locatieRegel
permissioncredential scopewebhooks.write

Verzoek

: "${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"
  ]
}'

Requestbody

project_idUUIDvereist

Een geautoriseerd project. Vereist bij elk verzoek, inclusief item-URL's.

revision

1

url

"https://shop.example.com/marketplace-events"

enabled

true

events[]

["marketplace.payout.confirmed"]

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": {}
}

Antwoordvelden

dataobject
Gebruiksopmerkingen
  • Vereist webhooks.write. Antwoordvoorbeelden tonen geselecteerde velden; gebruik GET op de resource voor het volledige bewaarde bewijs.
  • Elke POST vereist een duurzaam opgeslagen Idempotency-Key van 16–128 tekens (letters, cijfers, -, _ of .). Hergebruik na een time-out dezelfde sleutel en JSON-instructies. Andere instructies geven 409 terug. Voltooide antwoorden worden 30 dagen bewaard; oude sleutels worden blijvend gemarkeerd als niet herbruikbaar. Wijzig een sleutel nooit alleen om een onzeker resultaat te omzeilen.
  • Sleutels hebben projectlijsten, optionele beperkingen voor factuurwinkels, een vervaldatum, IP-toelatingslijst en een quotum van 1–600/minuut (standaard 60). HTTP 429 bevat Retry-After. Sleutels die tot winkels zijn beperkt, kunnen geen verkopers, projectsaldi, grootboek, uitbetalingen of instellingen zien. Bewaar bestedingsreferenties uitsluitend op vertrouwde servers, nooit in browsers of uitgeleverde mobiele apps.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTMarketplace-webhook uitschakelen/v1/marketplace/webhooks/{webhook_id}/disableLezen + schrijven

Stop nieuwe bezorgingen; bewaarde gebeurtenisgeschiedenis blijft bestaan.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MARKETPLACE_API_TOKEN
Idempotency-Keyvereist16–128 letters, cijfers, -, _ of .; sla duurzaam op bij dit exacte verzoek
ParameterType / locatieRegel
permissioncredential scopewebhooks.write

Verzoek

: "${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
}'

Requestbody

project_idUUIDvereist

Een geautoriseerd project. Vereist bij elk verzoek, inclusief item-URL's.

revision

1

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": {}
}

Antwoordvelden

dataobject
Gebruiksopmerkingen
  • Vereist webhooks.write. Antwoordvoorbeelden tonen geselecteerde velden; gebruik GET op de resource voor het volledige bewaarde bewijs.
  • Elke POST vereist een duurzaam opgeslagen Idempotency-Key van 16–128 tekens (letters, cijfers, -, _ of .). Hergebruik na een time-out dezelfde sleutel en JSON-instructies. Andere instructies geven 409 terug. Voltooide antwoorden worden 30 dagen bewaard; oude sleutels worden blijvend gemarkeerd als niet herbruikbaar. Wijzig een sleutel nooit alleen om een onzeker resultaat te omzeilen.
  • Sleutels hebben projectlijsten, optionele beperkingen voor factuurwinkels, een vervaldatum, IP-toelatingslijst en een quotum van 1–600/minuut (standaard 60). HTTP 429 bevat Retry-After. Sleutels die tot winkels zijn beperkt, kunnen geen verkopers, projectsaldi, grootboek, uitbetalingen of instellingen zien. Bewaar bestedingsreferenties uitsluitend op vertrouwde servers, nooit in browsers of uitgeleverde mobiele apps.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETMarketplace-gebeurtenissen/v1/marketplace/eventsAlleen-lezen

Gepagineerde onwijzigbare gebeurtenisreferenties. q zoekt op type/referentie; status filtert event_type.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MARKETPLACE_API_TOKEN
ParameterType / locatieRegel
permissioncredential scopemarketplace.read

Queryparameters

project_idUUIDvereist

Een geautoriseerd project. Vereist bij elk verzoek, inclusief item-URL's.

pageoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

per_pageoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

qoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

statusoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

store_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

vendor_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

asset_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

fromoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

tooptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": [],
  "pagination": {
    "page": 1,
    "per_page": 25,
    "total": 0,
    "pages": 1
  }
}

Antwoordvelden

data[]array
paginationobject
pageinteger
per_pageinteger
totalinteger
pagesinteger
Gebruiksopmerkingen
  • Vereist marketplace.read. Antwoordvoorbeelden tonen geselecteerde velden; gebruik GET op de resource voor het volledige bewaarde bewijs.
  • Elke POST vereist een duurzaam opgeslagen Idempotency-Key van 16–128 tekens (letters, cijfers, -, _ of .). Hergebruik na een time-out dezelfde sleutel en JSON-instructies. Andere instructies geven 409 terug. Voltooide antwoorden worden 30 dagen bewaard; oude sleutels worden blijvend gemarkeerd als niet herbruikbaar. Wijzig een sleutel nooit alleen om een onzeker resultaat te omzeilen.
  • Sleutels hebben projectlijsten, optionele beperkingen voor factuurwinkels, een vervaldatum, IP-toelatingslijst en een quotum van 1–600/minuut (standaard 60). HTTP 429 bevat Retry-After. Sleutels die tot winkels zijn beperkt, kunnen geen verkopers, projectsaldi, grootboek, uitbetalingen of instellingen zien. Bewaar bestedingsreferenties uitsluitend op vertrouwde servers, nooit in browsers of uitgeleverde mobiele apps.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETBewaarde gebeurtenis lezen/v1/marketplace/events/{event_id}Alleen-lezen

Geeft de onwijzigbare oorspronkelijke gebeurtenispayload terug, geen reconstructie op basis van huidige saldi.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MARKETPLACE_API_TOKEN
ParameterType / locatieRegel
permissioncredential scopemarketplace.read

Queryparameters

project_idUUIDvereist

Een geautoriseerd project. Vereist bij elk verzoek, inclusief item-URL's.

pageoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

per_pageoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

qoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

statusoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

store_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

vendor_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

asset_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

fromoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

tooptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "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"
        }
      ]
    }
  }
}

Antwoordvelden

dataobject
event_idstring
event_typestring
payload_versioninteger
project_idstring
occurred_atstring
dataobject
payout_idstring
asset_idstring
amount_atomicstring
transactions[]object[]
transaction_idstring
explorer_urlstring
Gebruiksopmerkingen
  • Vereist marketplace.read. Antwoordvoorbeelden tonen geselecteerde velden; gebruik GET op de resource voor het volledige bewaarde bewijs.
  • Elke POST vereist een duurzaam opgeslagen Idempotency-Key van 16–128 tekens (letters, cijfers, -, _ of .). Hergebruik na een time-out dezelfde sleutel en JSON-instructies. Andere instructies geven 409 terug. Voltooide antwoorden worden 30 dagen bewaard; oude sleutels worden blijvend gemarkeerd als niet herbruikbaar. Wijzig een sleutel nooit alleen om een onzeker resultaat te omzeilen.
  • Sleutels hebben projectlijsten, optionele beperkingen voor factuurwinkels, een vervaldatum, IP-toelatingslijst en een quotum van 1–600/minuut (standaard 60). HTTP 429 bevat Retry-After. Sleutels die tot winkels zijn beperkt, kunnen geen verkopers, projectsaldi, grootboek, uitbetalingen of instellingen zien. Bewaar bestedingsreferenties uitsluitend op vertrouwde servers, nooit in browsers of uitgeleverde mobiele apps.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETMarketplace-bezorggeschiedenis/v1/marketplace/webhook-deliveriesAlleen-lezen

Gepagineerde bezorgingen, gebeurtenistype, pogingen en laatste resultaat. Filter status pending/sending/succeeded/failed/cancelled; q voor gebeurtenistype.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MARKETPLACE_API_TOKEN
ParameterType / locatieRegel
permissioncredential scopemarketplace.read

Queryparameters

project_idUUIDvereist

Een geautoriseerd project. Vereist bij elk verzoek, inclusief item-URL's.

pageoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

per_pageoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

qoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

statusoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

store_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

vendor_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

asset_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

fromoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

tooptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": [],
  "pagination": {
    "page": 1,
    "per_page": 25,
    "total": 0,
    "pages": 1
  }
}

Antwoordvelden

data[]array
paginationobject
pageinteger
per_pageinteger
totalinteger
pagesinteger
Gebruiksopmerkingen
  • Vereist marketplace.read. Antwoordvoorbeelden tonen geselecteerde velden; gebruik GET op de resource voor het volledige bewaarde bewijs.
  • Elke POST vereist een duurzaam opgeslagen Idempotency-Key van 16–128 tekens (letters, cijfers, -, _ of .). Hergebruik na een time-out dezelfde sleutel en JSON-instructies. Andere instructies geven 409 terug. Voltooide antwoorden worden 30 dagen bewaard; oude sleutels worden blijvend gemarkeerd als niet herbruikbaar. Wijzig een sleutel nooit alleen om een onzeker resultaat te omzeilen.
  • Sleutels hebben projectlijsten, optionele beperkingen voor factuurwinkels, een vervaldatum, IP-toelatingslijst en een quotum van 1–600/minuut (standaard 60). HTTP 429 bevat Retry-After. Sleutels die tot winkels zijn beperkt, kunnen geen verkopers, projectsaldi, grootboek, uitbetalingen of instellingen zien. Bewaar bestedingsreferenties uitsluitend op vertrouwde servers, nooit in browsers of uitgeleverde mobiele apps.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETBezorgdetails/v1/marketplace/webhook-deliveries/{delivery_id}Alleen-lezen

Oorspronkelijke URL, bewaarde payload, HTTP-resultaat en veilige foutmelding; geen ondertekeningsgeheim.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MARKETPLACE_API_TOKEN
ParameterType / locatieRegel
permissioncredential scopemarketplace.read

Queryparameters

project_idUUIDvereist

Een geautoriseerd project. Vereist bij elk verzoek, inclusief item-URL's.

pageoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

per_pageoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

qoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

statusoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

store_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

vendor_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

asset_idoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

fromoptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

tooptioneel

Gebruik alleen filters die voor deze resource zijn gedocumenteerd. Gepagineerde lijsten bevatten standaard 25 en maximaal 100 rijen.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": {}
}

Antwoordvelden

dataobject
Gebruiksopmerkingen
  • Vereist marketplace.read. Antwoordvoorbeelden tonen geselecteerde velden; gebruik GET op de resource voor het volledige bewaarde bewijs.
  • Elke POST vereist een duurzaam opgeslagen Idempotency-Key van 16–128 tekens (letters, cijfers, -, _ of .). Hergebruik na een time-out dezelfde sleutel en JSON-instructies. Andere instructies geven 409 terug. Voltooide antwoorden worden 30 dagen bewaard; oude sleutels worden blijvend gemarkeerd als niet herbruikbaar. Wijzig een sleutel nooit alleen om een onzeker resultaat te omzeilen.
  • Sleutels hebben projectlijsten, optionele beperkingen voor factuurwinkels, een vervaldatum, IP-toelatingslijst en een quotum van 1–600/minuut (standaard 60). HTTP 429 bevat Retry-After. Sleutels die tot winkels zijn beperkt, kunnen geen verkopers, projectsaldi, grootboek, uitbetalingen of instellingen zien. Bewaar bestedingsreferenties uitsluitend op vertrouwde servers, nooit in browsers of uitgeleverde mobiele apps.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTDezelfde gebeurtenis opnieuw bezorgen/v1/marketplace/webhook-deliveries/{delivery_id}/resendLezen + schrijven

Alleen voltooide bezorgingen en het ongewijzigde actieve eindpunt; maximaal 20 handmatige nieuwe pogingen. Hergebruikt event_id. Een mislukte melding geeft nooit toestemming voor een tweede betaling.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MARKETPLACE_API_TOKEN
Idempotency-Keyvereist16–128 letters, cijfers, -, _ of .; sla duurzaam op bij dit exacte verzoek
ParameterType / locatieRegel
permissioncredential scopewebhooks.write

Verzoek

: "${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
}'

Requestbody

project_idUUIDvereist

Een geautoriseerd project. Vereist bij elk verzoek, inclusief item-URL's.

confirm

true

Antwoord 200 application/json

Voorbeeldantwoord
{
  "data": {}
}

Antwoordvelden

dataobject
Gebruiksopmerkingen
  • Vereist webhooks.write. Antwoordvoorbeelden tonen geselecteerde velden; gebruik GET op de resource voor het volledige bewaarde bewijs.
  • Elke POST vereist een duurzaam opgeslagen Idempotency-Key van 16–128 tekens (letters, cijfers, -, _ of .). Hergebruik na een time-out dezelfde sleutel en JSON-instructies. Andere instructies geven 409 terug. Voltooide antwoorden worden 30 dagen bewaard; oude sleutels worden blijvend gemarkeerd als niet herbruikbaar. Wijzig een sleutel nooit alleen om een onzeker resultaat te omzeilen.
  • Sleutels hebben projectlijsten, optionele beperkingen voor factuurwinkels, een vervaldatum, IP-toelatingslijst en een quotum van 1–600/minuut (standaard 60). HTTP 429 bevat Retry-After. Sleutels die tot winkels zijn beperkt, kunnen geen verkopers, projectsaldi, grootboek, uitbetalingen of instellingen zien. Bewaar bestedingsreferenties uitsluitend op vertrouwde servers, nooit in browsers of uitgeleverde mobiele apps.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETBetalingsuitzonderingen opvragen/v1/projects/{project_id}/reconciliationAlleen-lezen

Eén gepagineerde beoordelingswachtrij voor onderbetaalde, overbetaalde, late, gereorganiseerde of onduidelijke betalingen, mislukte bezorgingen en uitgeschakelde/verlopen methoden. Door een operator afgehandelde gevallen worden bij nieuw bewijs heropend.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MERCHANT_API_TOKEN

Padparameters

project_idUUIDvereist

Project dat aan deze API-referentie is toegewezen.

Queryparameters

statusstring

open (standaard), resolved of all.

reasonstring

underpaid, overpaid, late, reorged, ambiguous, delivery_failed, disabled_method of expired_method.

store_idUUID

Optioneel winkelfilter.

pageinteger

1–40001. Vast 25 gevallen per pagina.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{"data":[],"pagination":{"page":1,"per_page":25,"total":0,"has_more":false},"counts":{"open":0,"resolved":0}}

Antwoordvelden

data[]object[]altijd

Meest recent bijgewerkte gevallen eerst. Gebruik invoice_id, niet de interne id, in handelaarsdetail-URL's.

idUUIDaltijd

Interne record-ID / factuur-UUID voor de klant. invoice_id komt overeen met callbackpayloads.

invoice_idUUIDaltijd

Interne record-ID / factuur-UUID voor de klant. invoice_id komt overeen met callbackpayloads.

store_idUUIDaltijd

Winkel waartoe dit behoort.

store_namestringaltijd

Winkel waartoe dit behoort.

order_idstring | nullaltijd

Private bestelreferentie van de handelaar en e-mailadres van de klant.

emailstring | nullaltijd

Private bestelreferentie van de handelaar en e-mailadres van de klant.

amountdecimal stringaltijd

Oorspronkelijk fiatfactuurbedrag en valuta.

currencystringaltijd

Oorspronkelijk fiatfactuurbedrag en valuta.

invoice_statusinvoice statusaltijd

Huidige status in de betalingslevenscyclus.

statusopen|resolvedaltijd

Gevalstatus en de uitzonderingstypen die in het redenfilter staan.

reasons[]string[]altijd

Gevalstatus en de uitzonderingstypen die in het redenfilter staan.

revisionintegeraltijd

Huidige beoordelingsrevisie en bijwerktijd.

updated_attimestampaltijd

Huidige beoordelingsrevisie en bijwerktijd.

paginationobjectaltijd

page (1–40001), per_page (25), total overeenkomende rijen, has_more.

pageinteger
per_pageinteger
totalinteger
has_moreboolean
countsobjectaltijd

Totalen open en resolved voor het hele project, onafhankelijk van de huidige filters.

openinteger
resolvedinteger
Gebruiksopmerkingen
  • Alleen-lezen, projectgebonden en vallend onder het quotum van de API-referentie. Financiële beslissingen en terugbetalingen blijven uitsluitend via de console beschikbaar.
  • Rijen bevatten id (interne UUID), invoice_id (publieke UUID, gelijk aan callbacks), winkelinformatie, oorspronkelijk fiatbedrag/valuta, invoice_status, gevalstatus, redenen, revision en updated_at. Gebruik invoice_id in het handelaarsdetaileindpunt.
  • Automatische detectie volgt het oorspronkelijke monitoringsvenster van de factuur; Opnieuw scannen verlengt de waarneming met één uur zonder afrekenen in te schakelen. Methoden na voldoening of annulering blijven binnen dat venster gevolgd worden.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETAfstemmingsbewijs lezen/v1/projects/{project_id}/reconciliation/{invoice_id}Alleen-lezen

Geeft factuur, geval, exacte methodetotalen en beschikbare terugbetalingsbedragen, waargenomen transacties, bezorggeschiedenis, handelaarsbeslissingen en gekoppelde terugbetalingsoverdrachten terug. Toont nooit ondertekeningssleutels of callbackgeheimen.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MERCHANT_API_TOKEN

Padparameters

project_idUUIDvereist

Toegewezen project.

invoice_idUUIDvereist

Publieke factuur-UUID, niet de interne id.

Queryparameters

pageinteger

Pagina met beslissingsgeschiedenis, beginnend bij 1; 25 beslissingen per pagina.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{"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":[]}

Antwoordvelden

invoiceobjectaltijd

Volledige handelaarsfactuur: samenvattingsvelden, private metadata en payment_intents. Niet verpakt in data.

idUUIDaltijd

Interne factuur-UUID. Gebruik die niet in handelaarsdetail- of afrekenpaden.

invoice_idUUIDaltijd

Publieke factuur-UUID die door handelaarsdetail- en afrekenpaden wordt gebruikt.

project_idUUIDaltijd

Project waartoe dit behoort.

store_idUUIDaltijd

Winkel waartoe dit behoort.

sourcemanual | apialtijd

Hoe de factuur is gemaakt.

order_idstring | nullaltijd

Bestelreferentie van de handelaar.

emailstring | nullaltijd

E-mailadres van de klant, alleen voor de handelaar. Wordt nooit door publiek afrekenen teruggegeven.

customer_namestring | nullaltijd

Afgeleide weergavenaam uit private metadata firstname, lastname en company.

customer_addressstring | nullaltijd

Afgeleid handelaarsadres op één regel uit private metadata company, street, street2, zip, city, country, countryiso2 en vatid.

descriptionstring | nullaltijd

Omschrijving voor de klant.

amountdecimal stringaltijd

Canoniek factuurbedrag.

currencystringaltijd

Genormaliseerde factuurvaluta-/activacode.

exchange_rate_spread_percentdecimal stringaltijd

Vastgezette prijsopslag: de afwijking bij aanmaak of de winkelstandaard bij weglaten. Toegepast vóór afronding naar boven; verandert nooit op deze factuur.

underpayment_tolerance_percentdecimal stringaltijd

Onwijzigbaar geaccepteerd tekortpercentage, vastgelegd bij het maken van de factuur.

statusinvoice statusaltijd

new, processing, settled, expired, invalid of cancelled.

amount_statusamount statusaltijd

none, partial, paid of overpaid. Een expliciet toegestane factuur met nulbedrag wordt voldaan met none en zonder betaalmethoden.

timing_statustiming statusaltijd

on_time of late.

resolutionresolutionaltijd

automatic, manually_settled of manually_invalidated.

sequenceintegeraltijd

Monotoon oplopende factuurstatus-sequence, beginnend bij 1.

winning_payment_intent_idUUID | nullaltijd

Betaalmethode die de factuur heeft afgehandeld, wanneer geselecteerd.

expires_atRFC 3339 timestampaltijd

Deadline van prijsopgave/betaling.

monitoring_expires_atRFC 3339 timestampaltijd

Laatste ingestelde grens voor controle op late betalingen over alle betaalmethoden.

settled_attimestamp | nullaltijd

Tijdstip van voldoening indien voldaan.

cancelled_attimestamp | nullaltijd

Annuleringstijd indien geannuleerd.

archived_attimestamp | nullaltijd

Archiveringstijd indien gearchiveerd.

created_atRFC 3339 timestampaltijd

Aanmaaktijd.

updated_atRFC 3339 timestampaltijd

Laatste bijwerktijd van de status.

ipn_urlstring | nullaltijd

Effectieve IPN-bestemming per factuur. Alleen handelaarsantwoord; weggelaten uit publiek afrekenen.

redirect_urlstring | nullaltijd

Effectieve succes-URL die na voldoening wordt gebruikt.

cancel_urlstring | nullaltijd

Effectieve terugkeer-URL die wordt gebruikt als afrekenen zonder succesvolle betaling eindigt.

redirect_automaticallybooleanaltijd

Of afrekenen na succes automatisch moet omleiden.

checkout_languagestringaltijd

Effectieve afrekentaaltag.

metadataobjectaltijd
Handelaarsmetadata. Wordt nooit door publiek afrekenen teruggegeven. Betaalhulpmiddelen in de console voegen payment_tool-herkomst toe (id, kind, title, pricing, requested_amount, request_id); dit bewijst geen betaling. Authenticeer callbacks en handel invoice.settled één keer per invoice_id af.Details

Handelaarsmetadata. Wordt nooit door publiek afrekenen teruggegeven. Betaalhulpmiddelen in de console voegen payment_tool-herkomst toe (id, kind, title, pricing, requested_amount, request_id); dit bewijst geen betaling. Authenticeer callbacks en handel invoice.settled één keer per invoice_id af.

payment_intents[]object[]altijd

Geoffreerde betaalmethoden en monitoringsstatus.

idUUIDaltijd

Identificatie van de betalingsintentie; ook gebruikt als intent_id voor de afreken-QR-code.

payment_railonchain | lightningaltijd
Factuurtransport. Bitcoin op de blockchain en Lightning kunnen asset_id delen; gebruik de intentie-id plus dit veld, niet alleen het symbool. Dit verschilt van de scanner-payment_rail in de activacatalogus.Details

Factuurtransport. Bitcoin op de blockchain en Lightning kunnen asset_id delen; gebruik de intentie-id plus dit veld, niet alleen het symbool. Dit verschilt van de scanner-payment_rail in de activacatalogus.

bolt11string | nullaltijd

Lightning-betaalverzoek, anders null. Betaal dit verzoek met een Lightning-wallet; stuur nooit blockchainmiddelen naar de betalingshash.

asset_idUUIDaltijd

Identificatie van het ingestelde betaalactief.

asset_keystringaltijd

Canonieke activasleutel in CAIP-stijl.

chain_slugstringaltijd

Wholly Crypto-blockchainidentificatie.

networkstringaltijd

Ingesteld netwerk, momenteel mainnet voor ondersteunde betaalactiva.

caip_network_idstringaltijd

Canonieke CAIP-2-netwerkidentificatie.

caip_asset_idstring | nullaltijd

Canonieke CAIP-19-identificatie, waar geregistreerd.

symbolstringaltijd

Activasymbool.

asset_decimalsintegeraltijd

Precisie in atomaire eenheden. Lightning BTC gebruikt 11 (millisatoshi's), niet de 8 van Bitcoin op de blockchain. Prijsopgaven zijn hele satoshi's; ontvangsten behouden millisatoshiprecisie.

statusintent statusaltijd

pending, partial, paid, overpaid, expired of invalid.

finality_modeconfirmations | finalizedaltijd

Finaliteitsbeleid.

required_confirmationsintegeraltijd

Vereiste bevestigingen indien van toepassing.

quote_ratedecimal stringaltijd

Eenheden van het actief per één eenheid factuurvaluta, inclusief de vastgezette opslag. Bijvoorbeeld 1.02 USDC per USD. Niet de omgekeerde koers.

quote_detailsobject | nullaltijd
Vastgezette herkomst van de prijsopgave: reference_rate vóór opslag, unrounded_payment_amount, rounding_adjustment, pricing_provider, asset_provider, pricing_fetched_at en asset_fetched_at. Null bij oudere facturen; er worden geen historische waarden verzonnen.Details

Vastgezette herkomst van de prijsopgave: reference_rate vóór opslag, unrounded_payment_amount, rounding_adjustment, pricing_provider, asset_provider, pricing_fetched_at en asset_fetched_at. Null bij oudere facturen; er worden geen historische waarden verzonnen.

expected_amountdecimal stringaltijd
Exact vastgezet te betalen activabedrag na opslag en afronding naar boven. Vanaf 4.1.1 worden herkende geverifieerde fiatstablecoins (zoals USDC, USDT, DAI, USDS, EURC) naar boven afgerond op maximaal twee decimalen; 1.321 wordt 1.33, nooit 1.32. Dit is het verwachte bedrag, ook bij nultolerantie. Andere activa behouden adaptieve precisie. Bestaande facturen worden nooit opnieuw geprijsd.Details

Exact vastgezet te betalen activabedrag na opslag en afronding naar boven. Vanaf 4.1.1 worden herkende geverifieerde fiatstablecoins (zoals USDC, USDT, DAI, USDS, EURC) naar boven afgerond op maximaal twee decimalen; 1.321 wordt 1.33, nooit 1.32. Dit is het verwachte bedrag, ook bij nultolerantie. Andere activa behouden adaptieve precisie. Bestaande facturen worden nooit opnieuw geprijsd.

expected_amount_atomicinteger stringaltijd

Exact bedrag in de kleinste eenheid van het actief.

minimum_payment_amountdecimal stringaltijd

Kleinste bedrag dat na toepassing van de factuurtolerantie als betaald wordt geaccepteerd.

minimum_payment_amount_atomicinteger stringaltijd

Exacte geaccepteerde drempel in de kleinste eenheid van het actief.

received_amountdecimal stringaltijd

Waargenomen bedrag.

received_amount_atomicinteger stringaltijd

Waargenomen atomair bedrag.

confirmed_amountdecimal stringaltijd

Bevestigd/definitief bedrag.

confirmed_amount_atomicinteger stringaltijd

Bevestigd/definitief atomair bedrag.

destination_addressstringaltijd

Ontvangstadres op de blockchain of de betalingshash van 64 tekens voor Lightning. Gebruik bolt11 om via Lightning te betalen; de hash is geen Bitcoin-adres.

destination_tagstring | nullaltijd

Vereiste publieke betalingsreferentie waar de betaalroute die gebruikt: XRP-bestemmingstag, Stellar-memo-ID of TON-factuurcommentaar. Null voor routes met unieke adressen.

derivation_indexintegeraltijd

Gereserveerde onderliggende walletindex; alleen handelaarsdetails.

quote_expires_atRFC 3339 timestampaltijd

Vervaltijd van de prijsopgave.

monitoring_expires_atRFC 3339 timestampaltijd

Eindgrens voor controle op late betalingen voor deze methode.

next_check_attimestamp | nullaltijd

Volgende geplande blockchaincontrole.

last_checked_attimestamp | nullaltijd

Laatste blockchaincontrole.

last_chain_heightinteger | nullaltijd

Laatste betrouwbare hoogte die door de monitor is waargenomen.

last_anchor_hashstring | nullaltijd

Laatste monitoranker/blokhash.

last_monitor_errorstring | nullaltijd

Veilige monitoringsdiagnostiek voor operators.

first_payment_attimestamp | nullaltijd

Tijdstip waarop een betaling voor het eerst is waargenomen.

fully_paid_attimestamp | nullaltijd

Tijdstip waarop het geaccepteerde minimumbedrag voor het eerst werd bereikt.

finalized_attimestamp | nullaltijd

Tijdstip waarop de betaling voldeed aan het finaliteitsbeleid.

caseobject | nullaltijd

Huidig geval met status, redenen, revision en tijdstempels; null als er geen uitzondering bestaat. Intern bewijs is uitgesloten.

statusstring
reasons[]array
revisioninteger
methods[]object[]altijd
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 en spending_supported. Atomaire bedragen zijn tekenreeksen.Details

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 en spending_supported. Atomaire bedragen zijn tekenreeksen.

history[]object[]altijd

Nieuwste 25 beslissingen voor deze pagina: id, action, note, actor, result, created_at.

history_paginationobjectaltijd

page, per_page (25), total. Alleen beslissingsgeschiedenis wordt per pagina gepagineerd.

pageinteger
per_pageinteger
totalinteger
refunds[]object[]altijd
Nieuwste 100 terugbetalingen: id, payment_intent_id, amount_atomic, destination, status, request, treasury_intent_id, transfer_status, created_at en transactions (id/status). Terugbetalingen indienen kan alleen via de console.Details

Nieuwste 100 terugbetalingen: id, payment_intent_id, amount_atomic, destination, status, request, treasury_intent_id, transfer_status, created_at en transactions (id/status). Terugbetalingen indienen kan alleen via de console.

observations[]object[]altijd
Nieuwste 100: payment_intent_id, transaction_id, event_index, amount, status, confirmations, observed_at, symbol, chain en disabled_at_detection. explorer_name/explorer_url worden opgenomen waar ondersteund.Details

Nieuwste 100: payment_intent_id, transaction_id, event_index, amount, status, confirmations, observed_at, symbol, chain en disabled_at_detection. explorer_name/explorer_url worden opgenomen waar ondersteund.

deliveries[]object[]altijd

Nieuwste 50: id, kind, status, attempts, response_status, error, next_attempt_at, event_type en created_at. Geen callbackgeheimen.

Gebruiksopmerkingen
  • case is null als de factuur geen uitzondering heeft veroorzaakt. De recentste 100 waarnemingen en 50 bezorgingen worden teruggegeven; beslissingsgeschiedenis is gepagineerd.
  • refundable_atomic vereist minstens één netwerkbevestiging, sluit bestaande terugbetalingsreserveringen uit en is geen belofte van besteedbare walletmiddelen. Een actuele prijsopgave valideert bovendien walletgereedheid, bronsaldi en kosten.
  • Een uitgezonden terugbetaling betekent dat deze is ingediend bij een blockchain-eindpunt, niet dat ontvangst door de klant onafhankelijk is bevestigd. Kosten komen erbij en fiatverwerkingskosten worden niet automatisch gecrediteerd door een terugbetaling uit te voeren.
  • Consoleprojectmenu → Aandacht nodig biedt annuleren, accepteren, afwijzen, heropenen, beoordelen, notities, Opnieuw scannen, opnieuw bezorgen en terugbetalingen op ondersteunde blockchains. Beslissingen gebruiken CSRF-beveiligde sessies, een unieke request_id, de huidige gevalrevisie, een verplichte notitie en expliciete bevestiging; bearertokens kunnen die wijzigingen niet uitvoeren.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETAPI-servicedetectie/Publiek

Antwoord van de beheerde API-hostproxy dat de rol van publieke v1-API bevestigt. Dit antwoord wordt door de beheerde proxy gemaakt, niet door de Axum-router van de handelaarssoftware.

Authenticatie & headers

Publiek

Verzoek

curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "service": "Wholly Crypto API",
  "status": "ready",
  "version": "v1"
}

Antwoordvelden

servicestring
statusstring
versionstring
Gebruiksopmerkingen
  • Er is geen bearertoken nodig.
  • Alleen de beheerde API-hostnaam garandeert dit exacte antwoord op het hoofdpad.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETServicestatus/healthzPubliek

Controleert de bereikbaarheid van de applicatie en een databaseping van twee seconden. Gebruik voor monitoring, niet als vervanging voor factuurstatus.

Authenticatie & headers

Publiek

Verzoek

curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://api.example.com/healthz"

Antwoord 200 healthy; 503 database unavailable

Voorbeeldantwoord
{
  "status": "ok",
  "database": "ok",
  "version": "0.1.0"
}

Antwoordvelden

statusstring
databasestring
versionstring
Gebruiksopmerkingen
  • Er is geen bearertoken nodig.
  • De version-waarde is de versie van het draaiende pakket, niet de versie in het API-pad.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETBetaalactiva van project opvragen/v1/projects/{project_id}/payment-assetsAlleen-lezen

Toont eigen munten en geverifieerde tokens met projectbeleid, blockchainwalletgereedheid en geïnstalleerde scanner-/saldomogelijkheden. scanner_ready controleert de gebouwde adapter, niet het actuele eindpuntquorum. Vanaf 6.0.6 behoudt aanmaak ingestelde methoden tijdens scanneruitval. Ontvangstverificatie vereist nog steeds de ingestelde drempel van gezonde providers met exact de juiste rol (standaard 2, optioneel 1).

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MERCHANT_API_TOKEN
Acceptaanbevolenapplication/json

Padparameters

project_idUUIDvereist

Ingeschakeld project dat aan de API-referentie is toegewezen.

Verzoek

: "${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'

Antwoord 200 application/json

Voorbeeldantwoord
{
  "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" }] }
    }
  ]
}

Antwoordvelden

data[]object[]
assetobjectaltijd

Blijvend geregistreerde eigen munt of geverifieerd tokenactief.

idUUIDaltijd

Blijvende identificatie van een betaalactief, gebruikt door project- en winkelbeleidsroutes.

asset_keystringaltijd

Canonieke identiteit van een eigen munt of contractactief in CAIP-stijl.

chain_slugstringaltijd

Wholly Crypto-blockchainidentificatie en ingesteld netwerk.

networkstringaltijd

Wholly Crypto-blockchainidentificatie en ingesteld netwerk.

caip_network_idstringaltijd

Canonieke netwerk- en activa-identiteiten.

caip_asset_idstring|nullaltijd

Canonieke netwerk- en activa-identiteiten.

asset_kindnative | tokenaltijd

Of voldoening de blockchainvaluta of een geverifieerd contract/mint gebruikt.

payment_railstringaltijd

Runtime-betaalroute: utxo, evm-native, solana-native, account-native, privacy-native of token-transfer.

symbolstringaltijd

Weergave-identiteit en exacte precisie in atomaire eenheden.

namestringaltijd

Weergave-identiteit en exacte precisie in atomaire eenheden.

decimalsintegeraltijd

Weergave-identiteit en exacte precisie in atomaire eenheden.

contract_addressstring | nullaltijd

Canoniek ERC-20-contract of SPL-mint voor tokens; null voor eigen munten.

coingecko_idstring | nullaltijd

Detectie-/prijsidentiteit. Null voor eigen contracten; leid nooit een marktprijs af van hun tickersymbool. Alleen CoinGecko-metadata maakt een token nooit selecteerbaar.

custom_tokenbooleanaltijd

Eigen contract dat op de blockchain is geverifieerd, met projectspecifieke vaste USD-prijs of prijsbepaling via een geselecteerde DEX-pool.

icon_pathpath | nullaltijd

Lokaal gecacht tokenpictogram indien beschikbaar.

token_standarderc20 | spl-token | nullaltijd

Geverifieerde runtime-tokenstandaard; null voor eigen munten.

metadata_verified_attimestamp | nullaltijd

Verificatietijd op de blockchain van metadata voor geregistreerde tokens.

payment_supportedbooleanaltijd
Registercontroles bij bouwen. scanner_ready betekent dat de betalingsscanner-runtime is geïnstalleerd; betalingsbevestiging vereist het ingestelde aantal gezonde providers met exact de juiste rol (standaard 2, optioneel 1); tijdelijke scannerbeschikbaarheid blokkeert factuuraanmaak vanaf 6.0.6 niet. balance_ready is alleen true voor geïmplementeerde saldo-adapters.Details

Registercontroles bij bouwen. scanner_ready betekent dat de betalingsscanner-runtime is geïnstalleerd; betalingsbevestiging vereist het ingestelde aantal gezonde providers met exact de juiste rol (standaard 2, optioneel 1); tijdelijke scannerbeschikbaarheid blokkeert factuuraanmaak vanaf 6.0.6 niet. balance_ready is alleen true voor geïmplementeerde saldo-adapters.

scanner_readybooleanaltijd
Registercontroles bij bouwen. scanner_ready betekent dat de betalingsscanner-runtime is geïnstalleerd; betalingsbevestiging vereist het ingestelde aantal gezonde providers met exact de juiste rol (standaard 2, optioneel 1); tijdelijke scannerbeschikbaarheid blokkeert factuuraanmaak vanaf 6.0.6 niet. balance_ready is alleen true voor geïmplementeerde saldo-adapters.Details

Registercontroles bij bouwen. scanner_ready betekent dat de betalingsscanner-runtime is geïnstalleerd; betalingsbevestiging vereist het ingestelde aantal gezonde providers met exact de juiste rol (standaard 2, optioneel 1); tijdelijke scannerbeschikbaarheid blokkeert factuuraanmaak vanaf 6.0.6 niet. balance_ready is alleen true voor geïmplementeerde saldo-adapters.

balance_readybooleanaltijd
Registercontroles bij bouwen. scanner_ready betekent dat de betalingsscanner-runtime is geïnstalleerd; betalingsbevestiging vereist het ingestelde aantal gezonde providers met exact de juiste rol (standaard 2, optioneel 1); tijdelijke scannerbeschikbaarheid blokkeert factuuraanmaak vanaf 6.0.6 niet. balance_ready is alleen true voor geïmplementeerde saldo-adapters.Details

Registercontroles bij bouwen. scanner_ready betekent dat de betalingsscanner-runtime is geïnstalleerd; betalingsbevestiging vereist het ingestelde aantal gezonde providers met exact de juiste rol (standaard 2, optioneel 1); tijdelijke scannerbeschikbaarheid blokkeert factuuraanmaak vanaf 6.0.6 niet. balance_ready is alleen true voor geïmplementeerde saldo-adapters.

default_finality_modeconfirmations | finalizedaltijd

Standaardfinaliteitsmodel dat nieuw projectbeleid overneemt.

default_required_confirmationsintegeraltijd

Standaardbeleid voor bevestiging en monitoring.

default_monitoring_minutesintegeraltijd

Standaardbeleid voor bevestiging en monitoring.

policyobject | nullaltijd
Activerings-/finaliteitsbeleid van het project, of null als niet ingesteld. Bevat custom_price_mode (fixed/dex), custom_price_usd (vaste decimale tekenreeks of null), custom_dex_pair (geselecteerde pool of null) en custom_dex (dex_id, quote_symbol, huidige price_usd of null, liquidity_usd, fetched_at, last_error). Eigen prijsbepaling wordt gedeeld door winkels in dit project.Details

Activerings-/finaliteitsbeleid van het project, of null als niet ingesteld. Bevat custom_price_mode (fixed/dex), custom_price_usd (vaste decimale tekenreeks of null), custom_dex_pair (geselecteerde pool of null) en custom_dex (dex_id, quote_symbol, huidige price_usd of null, liquidity_usd, fetched_at, last_error). Eigen prijsbepaling wordt gedeeld door winkels in dit project.

enabledbooleanvereist

Schakelt het actief voor het project in of uit. De eigen blockchain moet vóór elke token worden ingeschakeld.

finality_modeconfirmations | finalizedvereist

Finaliteitsbeleid dat door de betaalroute van het actief wordt ondersteund. finalized vereist required_confirmations=1.

required_confirmationsintegervereist
Bitcoin- en EVM-routes accepteren nul; andere bevestigingsroutes vereisen minstens één, routes met alleen finalized vereisen precies één, en EVM-routes zijn begrensd op 0–48 zodat elke overschrijving binnen het transactieherhaalvenster blijft.Details

Bitcoin- en EVM-routes accepteren nul; andere bevestigingsroutes vereisen minstens één, routes met alleen finalized vereisen precies één, en EVM-routes zijn begrensd op 0–48 zodat elke overschrijving binnen het transactieherhaalvenster blijft.

monitoring_minutesintegervereist

Opvraagvenster van 1–10,080 minuten terwijl een factuur actief is.

late_monitoring_daysintegervereist

0–3,650 dagen monitoring na het verlopen van de factuur.

walletobject | nullaltijd

Projectwallet van de blockchain met eigen sleutelbeheer. Tokens delen de wallet van de eigen munt van hun blockchain.

idUUIDaltijd

Identificaties van wallet, eigenaarproject en eigen blockchainactief.

project_idUUIDaltijd

Identificaties van wallet, eigenaarproject en eigen blockchainactief.

native_asset_idUUIDaltijd

Identificaties van wallet, eigenaarproject en eigen blockchainactief.

chain_slugstringaltijd

Blockchain en netwerk van de wallet.

networkstringaltijd

Blockchain en netwerk van de wallet.

asset_symbolstringaltijd

Weergave-identiteit van de eigen blockchainmunt.

asset_namestringaltijd

Weergave-identiteit van de eigen blockchainmunt.

statuspending | active | disabled | erroraltijd

Operationele walletstatus.

labelstringaltijd

Operatorlabel.

public_keystring | nullaltijd

Publieke walletidentiteit; er wordt geen herstelzin of private sleutel getoond.

primary_addressstring | nullaltijd

Publieke walletidentiteit; er wordt geen herstelzin of private sleutel getoond.

derivation_schemestring | nullaltijd

Adresbeleid en -formaat.

address_formatstring | nullaltijd

Adresbeleid en -formaat.

backup_confirmed_attimestamp | nullaltijd

Niet-null nadat de operator de herstelback-up heeft bevestigd.

activation_requiredbooleanaltijd
Gedeelde XRP- en Stellar-accounts blijven niet beschikbaar totdat de operator het getoonde adres financiert en de ingestelde scannerproviders dat exacte account verifiëren. Het blijvende bewijs verloopt niet; actuele scannergezondheid wordt afzonderlijk gecontroleerd voor betalingsverificatie, niet voor factuuraanmaak.Details

Gedeelde XRP- en Stellar-accounts blijven niet beschikbaar totdat de operator het getoonde adres financiert en de ingestelde scannerproviders dat exacte account verifiëren. Het blijvende bewijs verloopt niet; actuele scannergezondheid wordt afzonderlijk gecontroleerd voor betalingsverificatie, niet voor factuuraanmaak.

activation_verified_attimestamp|nullaltijd
Gedeelde XRP- en Stellar-accounts blijven niet beschikbaar totdat de operator het getoonde adres financiert en de ingestelde scannerproviders dat exacte account verifiëren. Het blijvende bewijs verloopt niet; actuele scannergezondheid wordt afzonderlijk gecontroleerd voor betalingsverificatie, niet voor factuuraanmaak.Details

Gedeelde XRP- en Stellar-accounts blijven niet beschikbaar totdat de operator het getoonde adres financiert en de ingestelde scannerproviders dat exacte account verifiëren. Het blijvende bewijs verloopt niet; actuele scannergezondheid wordt afzonderlijk gecontroleerd voor betalingsverificatie, niet voor factuuraanmaak.

receive_readinessobject | null5.5.0+
Opgenomen in walletlijsten: ontvangstconfiguratie van het project en vereisten voor de blockchainscanner. Staat los van saldi, tokengas en verzendgereedheid. Andere walletantwoorden kunnen dit null laten.Details

Opgenomen in walletlijsten: ontvangstconfiguratie van het project en vereisten voor de blockchainscanner. Staat los van saldi, tokengas en verzendgereedheid. Andere walletantwoorden kunnen dit null laten.

readybooleanaltijd

Ontvangstconfiguratiecontroles slagen. Beschrijft geen bestedingsgereedheid, gas, saldovernieuwing of gegarandeerde toekomstige prijsopgave.

invoice_creatableboolean6.0.6+
De configuratie staat een factuurmethode toe ondanks tijdelijke scannerwaarschuwingen. Valutaprijsbepaling wordt bij aanmaak gecontroleerd. Dit is geen betalingsverificatie: ready kan false zijn terwijl invoice_creatable true is. Ontbrekende wallets, uitgeschakeld beleid en niet-ondersteunde adapters blijven veilig weigeren.Details

De configuratie staat een factuurmethode toe ondanks tijdelijke scannerwaarschuwingen. Valutaprijsbepaling wordt bij aanmaak gecontroleerd. Dit is geen betalingsverificatie: ready kan false zijn terwijl invoice_creatable true is. Ontbrekende wallets, uitgeschakeld beleid en niet-ondersteunde adapters blijven veilig weigeren.

checked_attimestampaltijd

Beoordelingstijd. Een lijst opvragen maakt geen netwerkverzoek en wijst geen adres toe.

issues[]object[]altijd
Leeg indien gereed; anders een ontvangstwaarschuwing of configuratieblokkade. Controleer invoice_creatable om tijdelijke scannerwaarschuwingen van factuurconfiguratiefouten te onderscheiden.Details

Leeg indien gereed; anders een ontvangstwaarschuwing of configuratieblokkade. Controleer invoice_creatable om tijdelijke scannerwaarschuwingen van factuurconfiguratiefouten te onderscheiden.

chain_slugstringindien bekend

Identificeert de betrokken blockchain en het actief. Lightning kan asset_id weglaten.

asset_idUUIDindien bekend

Identificeert de betrokken blockchain en het actief. Lightning kan asset_id weglaten.

asset_tickerstringindien bekend

Identificeert de betrokken blockchain en het actief. Lightning kan asset_id weglaten.

reason_codestringaltijd
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 of asset_not_accepted.Details

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 of asset_not_accepted.

messagestringindien beschikbaar
Uitleg voor de handelaar en actie-identificatie: chain_connections, wallets, rates, payment_methods, project_settings of store_settings. Geen inloggegevens of private provider-URL's.Details

Uitleg voor de handelaar en actie-identificatie: chain_connections, wallets, rates, payment_methods, project_settings of store_settings. Geen inloggegevens of private provider-URL's.

actionstringindien beschikbaar
Uitleg voor de handelaar en actie-identificatie: chain_connections, wallets, rates, payment_methods, project_settings of store_settings. Geen inloggegevens of private provider-URL's.Details

Uitleg voor de handelaar en actie-identificatie: chain_connections, wallets, rates, payment_methods, project_settings of store_settings. Geen inloggegevens of private provider-URL's.

required_endpoint_rolestring | nullop de blockchain
Voorkeursrol van de scanner-API (verouderd veld). Gebruik accepted_endpoint_roles voor de volledige compatibiliteitslijst. Een gezonde node alleen bewijst geen ondersteuning voor betalingsgeschiedenis.Details

Voorkeursrol van de scanner-API (verouderd veld). Gebruik accepted_endpoint_roles voor de volledige compatibiliteitslijst. Een gezonde node alleen bewijst geen ondersteuning voor betalingsgeschiedenis.

accepted_endpoint_roles[]string[] | nullop de blockchain
Compatibele API-dialecten, geen bewijs van eindpuntgeschiedenis of capaciteit. Ruwe node-rpc ondersteunt BTC/BCH/LTC/DOGE/DASH en transparante ZEC (volledig gedecodeerde blokken, 1–48 bevestigingen), definitief bevestigde eigen TRX, eigen ALGO via algod, XTZ via Octez, definitief bevestigde Asset Hub DOT via SCALE-metadata en eigen XLM via Stellar RPC met factuurmemo-ID. Gesnoeide of onvolledige geschiedenis voldoet niet. Deze ruwe adapters voegen geen tokenroutes toe. Geïndexeerde API's blijven alternatieven; zie de tabel met betaalroutes hieronder. Gemengde ruwe/geïndexeerde bronnen verifiëren begrensde vensters onafhankelijk; de standaard blijft twee onafhankelijke providers, geen aliassen van één operator. Alleen nodehoogte, ORDnet-blockchaininformatie en een EVM-relay voor een niet-EVM-route zijn geen ontvangstbewijzen. Monero vereist nog steeds een aan het project gekoppelde wallet-RPC met alleen inzagerechten.Details

Compatibele API-dialecten, geen bewijs van eindpuntgeschiedenis of capaciteit. Ruwe node-rpc ondersteunt BTC/BCH/LTC/DOGE/DASH en transparante ZEC (volledig gedecodeerde blokken, 1–48 bevestigingen), definitief bevestigde eigen TRX, eigen ALGO via algod, XTZ via Octez, definitief bevestigde Asset Hub DOT via SCALE-metadata en eigen XLM via Stellar RPC met factuurmemo-ID. Gesnoeide of onvolledige geschiedenis voldoet niet. Deze ruwe adapters voegen geen tokenroutes toe. Geïndexeerde API's blijven alternatieven; zie de tabel met betaalroutes hieronder. Gemengde ruwe/geïndexeerde bronnen verifiëren begrensde vensters onafhankelijk; de standaard blijft twee onafhankelijke providers, geen aliassen van één operator. Alleen nodehoogte, ORDnet-blockchaininformatie en een EVM-relay voor een niet-EVM-route zijn geen ontvangstbewijzen. Monero vereist nog steeds een aan het project gekoppelde wallet-RPC met alleen inzagerechten.

healthy_endpointsintegerop de blockchain

Gezonde overeenkomende eindpunten, niet het aantal onafhankelijke providers.

usable_independent_providersintegerop de blockchain
Bruikbare verificatieplaatsen, begrensd op twee. required_independent_providers is de blockchaininstelling: standaard 2, of 1 na expliciete keuze door een beheerder. In de modus met twee providers zijn verschillende providersleutels EN hosts vereist. Uitgeschakelde, verouderde (ouder dan tien minuten) of afkoelende bronnen vullen geen plaats. Lightning gebruikt eigen verbindingsregels.Details

Bruikbare verificatieplaatsen, begrensd op twee. required_independent_providers is de blockchaininstelling: standaard 2, of 1 na expliciete keuze door een beheerder. In de modus met twee providers zijn verschillende providersleutels EN hosts vereist. Uitgeschakelde, verouderde (ouder dan tien minuten) of afkoelende bronnen vullen geen plaats. Lightning gebruikt eigen verbindingsregels.

required_independent_providersintegerop de blockchain
Bruikbare verificatieplaatsen, begrensd op twee. required_independent_providers is de blockchaininstelling: standaard 2, of 1 na expliciete keuze door een beheerder. In de modus met twee providers zijn verschillende providersleutels EN hosts vereist. Uitgeschakelde, verouderde (ouder dan tien minuten) of afkoelende bronnen vullen geen plaats. Lightning gebruikt eigen verbindingsregels.Details

Bruikbare verificatieplaatsen, begrensd op twee. required_independent_providers is de blockchaininstelling: standaard 2, of 1 na expliciete keuze door een beheerder. In de modus met twee providers zijn verschillende providersleutels EN hosts vereist. Uitgeschakelde, verouderde (ouder dan tien minuten) of afkoelende bronnen vullen geen plaats. Lightning gebruikt eigen verbindingsregels.

last_checked_attimestamp | nullop de blockchain

Laatste gezondheidscontrole van een overeenkomend eindpunt, los van de beoordelingstijd.

monero_wallet_rpcMoneroWalletRpcBinding | nullaltijd
Geschoonde externe wallet-RPC-koppelingsstatus met alleen inzagerechten voor Monero. Bevat eindpunt, authenticatiemodus, primair account-0-adres, technische bewijsvlaggen/-hoogtes en tijdstempels van operatorverklaringen; inloggegevens, walletsleutels en walletbestanden worden nooit geserialiseerd.Details

Geschoonde externe wallet-RPC-koppelingsstatus met alleen inzagerechten voor Monero. Bevat eindpunt, authenticatiemodus, primair account-0-adres, technische bewijsvlaggen/-hoogtes en tijdstempels van operatorverklaringen; inloggegevens, walletsleutels en walletbestanden worden nooit geserialiseerd.

last_secret_revealed_attimestamp|nullaltijd

Auditmetadata over het tonen van geheimen aan de consolekant.

secret_reveal_countintegeraltijd

Auditmetadata over het tonen van geheimen aan de consolekant.

next_receive_indexintegeraltijd

Volgende gereserveerde index van een onderliggend adres.

last_scanned_heightinteger|nullaltijd

Walletscannerstatus.

last_scanned_attimestamp|nullaltijd

Walletscannerstatus.

last_errorstring|nullaltijd

Walletscannerstatus.

balances[]object[]altijd
Gecachte saldi voor elk van de 30 eigen blockchainroutes, plus geverifieerde ERC-20- en SPL-activa. Voor Monero is een ingestelde externe wallet-RPC met alleen inzagerechten vereist.Details

Gecachte saldi voor elk van de 30 eigen blockchainroutes, plus geverifieerde ERC-20- en SPL-activa. Voor Monero is een ingestelde externe wallet-RPC met alleen inzagerechten vereist.

wallet_idUUIDaltijd

Walletidentiteit en blijvende activa-identiteiten.

asset_idUUIDaltijd

Walletidentiteit en blijvende activa-identiteiten.

project_enabledbooleanaltijd

Of dit actief momenteel is ingeschakeld volgens het activabeleid van het project.

active_store_countintegeraltijd

Aantal ingeschakelde winkels dat dit actief momenteel selecteert. Dit is een weergave van acceptatie; alleen-lezen saldoregistratie blijft onafhankelijk.

active_store_ids[]UUID[]altijd

Ingeschakelde winkels in dit project die het actief momenteel accepteren. Dit maakt exact lokaal filteren op winkel mogelijk zonder extra API-verzoek.

tracking_activebooleanaltijd
Of deze leesbare wallet en het geregistreerde actief op dezelfde blockchain in aanmerking komen voor saldovernieuwing op de achtergrond. Schakelaars voor project- en betaalmethodeacceptatie pauzeren alleen-lezen registratie niet.Details

Of deze leesbare wallet en het geregistreerde actief op dezelfde blockchain in aanmerking komen voor saldovernieuwing op de achtergrond. Schakelaars voor project- en betaalmethodeacceptatie pauzeren alleen-lezen registratie niet.

asset_kindnative | tokenaltijd

Eigen valuta of geverifieerd contract-/mintactief.

contract_addressstring | nullaltijd

Tokencontract of mint; null voor eigen valuta.

symbolstringaltijd

Weergave-identiteit en atomaire precisie.

namestringaltijd

Weergave-identiteit en atomaire precisie.

decimalsintegeraltijd

Weergave-identiteit en atomaire precisie.

coingecko_idstring | nullaltijd

Prijsidentiteit indien gekoppeld.

balancedecimal string|nullaltijd

Exact weergegeven en atomair saldo over het primaire walletadres en uitgegeven factuuradressen. Null zolang geen volledige waarde beschikbaar is.

balance_atomicinteger string|nullaltijd

Exact weergegeven en atomair saldo over het primaire walletadres en uitgegeven factuuradressen. Null zolang geen volledige waarde beschikbaar is.

price_usddecimal string | nullaltijd

Indicatieve gecachte USD-eenheidsprijs voor waardering.

value_usddecimal string | nullaltijd

Indicatieve fiatwaardering wanneer een actuele koers bestaat.

statuspending | refreshing | fresh | stale | erroraltijd
Gecachte scanstatus. refreshing kan een voltooid saldo behouden: gebruik checked_at voor de ouderdom. Pending betekent dat er geen voltooide momentopname is. Geen van deze statussen bewijst dat een overschrijving openstaat of een factuur is voldaan.Details

Gecachte scanstatus. refreshing kan een voltooid saldo behouden: gebruik checked_at voor de ouderdom. Pending betekent dat er geen voltooide momentopname is. Geen van deze statussen bewijst dat een overschrijving openstaat of een factuur is voldaan.

checked_attimestamp | nullaltijd

Tijdstip dat door een voltooide saldoscan wordt weergegeven.

last_errorstring | nullaltijd

Veilige operatordiagnostiek.

total_value_usddecimal string | nullaltijd

Indicatieve som van saldi met een actuele USD-prijs.

balance_statuspending | refreshing | fresh | stale | error | unknownaltijd

Samengevoegde cache-actualiteit; unknown is een defensieve terugval en geen van deze statussen bewijst factuurvoldoening.

balance_checked_attimestamp | nullaltijd

Oudste relevante succesvolle saldocontrole die in het totaal is vertegenwoordigd.

recent_payments[]object[]altijd

Maximaal drie nieuwste geldige waarnemingen met status detected, confirming of final die aan precies deze wallet zijn toegewezen.

invoice_public_idUUIDaltijd

Factuuridentiteit voor de klant die bij de waarneming hoort.

chain_slugstringaltijd

Blockchain en weergavesymbool van eigen munt of geverifieerde token.

symbolstringaltijd

Blockchain en weergavesymbool van eigen munt of geverifieerde token.

transaction_idstringaltijd

Canonieke transactie- en overschrijvingsgebeurtenisidentiteit.

event_indexintegeraltijd

Canonieke transactie- en overschrijvingsgebeurtenisidentiteit.

amountdecimal stringaltijd

Exact waargenomen activabedrag zonder omzetting naar drijvendekommagetallen.

statusdetected | confirming | finalaltijd

Huidige geldige waarnemingsstatus. Gereorganiseerde, vervangen en ongeldige waarnemingen worden uitgesloten.

confirmationsintegeraltijd

Laatst waargenomen aantal bevestigingen.

observed_atRFC 3339 timestampaltijd

Tijdstip waarop Wholly Crypto de betaling voor het eerst waarnam.

created_atRFC 3339 timestampaltijd

Aanmaaktijd en laatste bijwerktijd van de wallet.

updated_atRFC 3339 timestampaltijd

Aanmaaktijd en laatste bijwerktijd van de wallet.

wallet_readinessreadiness enumaltijd
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 of ready.Details

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 of ready.

receive_readinessobject | null5.5.0+
Gedeelde beoordeling van de ontvangstconfiguratie van het project. Omvat wallet- en onafhankelijke scannerprovidercontroles, los van saldoactualiteit en gas voor verzenden. Null als geen projectbeleid bestaat. Factuurvaluta/koersen worden bij factuuraanmaak gecontroleerd.Details

Gedeelde beoordeling van de ontvangstconfiguratie van het project. Omvat wallet- en onafhankelijke scannerprovidercontroles, los van saldoactualiteit en gas voor verzenden. Null als geen projectbeleid bestaat. Factuurvaluta/koersen worden bij factuuraanmaak gecontroleerd.

readybooleanaltijd

Ontvangstconfiguratiecontroles slagen. Beschrijft geen bestedingsgereedheid, gas, saldovernieuwing of gegarandeerde toekomstige prijsopgave.

invoice_creatableboolean6.0.6+
De configuratie staat een factuurmethode toe ondanks tijdelijke scannerwaarschuwingen. Valutaprijsbepaling wordt bij aanmaak gecontroleerd. Dit is geen betalingsverificatie: ready kan false zijn terwijl invoice_creatable true is. Ontbrekende wallets, uitgeschakeld beleid en niet-ondersteunde adapters blijven veilig weigeren.Details

De configuratie staat een factuurmethode toe ondanks tijdelijke scannerwaarschuwingen. Valutaprijsbepaling wordt bij aanmaak gecontroleerd. Dit is geen betalingsverificatie: ready kan false zijn terwijl invoice_creatable true is. Ontbrekende wallets, uitgeschakeld beleid en niet-ondersteunde adapters blijven veilig weigeren.

checked_attimestampaltijd

Beoordelingstijd. Een lijst opvragen maakt geen netwerkverzoek en wijst geen adres toe.

issues[]object[]altijd
Leeg indien gereed; anders een ontvangstwaarschuwing of configuratieblokkade. Controleer invoice_creatable om tijdelijke scannerwaarschuwingen van factuurconfiguratiefouten te onderscheiden.Details

Leeg indien gereed; anders een ontvangstwaarschuwing of configuratieblokkade. Controleer invoice_creatable om tijdelijke scannerwaarschuwingen van factuurconfiguratiefouten te onderscheiden.

chain_slugstringindien bekend

Identificeert de betrokken blockchain en het actief. Lightning kan asset_id weglaten.

asset_idUUIDindien bekend

Identificeert de betrokken blockchain en het actief. Lightning kan asset_id weglaten.

asset_tickerstringindien bekend

Identificeert de betrokken blockchain en het actief. Lightning kan asset_id weglaten.

reason_codestringaltijd
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 of asset_not_accepted.Details

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 of asset_not_accepted.

messagestringindien beschikbaar
Uitleg voor de handelaar en actie-identificatie: chain_connections, wallets, rates, payment_methods, project_settings of store_settings. Geen inloggegevens of private provider-URL's.Details

Uitleg voor de handelaar en actie-identificatie: chain_connections, wallets, rates, payment_methods, project_settings of store_settings. Geen inloggegevens of private provider-URL's.

actionstringindien beschikbaar
Uitleg voor de handelaar en actie-identificatie: chain_connections, wallets, rates, payment_methods, project_settings of store_settings. Geen inloggegevens of private provider-URL's.Details

Uitleg voor de handelaar en actie-identificatie: chain_connections, wallets, rates, payment_methods, project_settings of store_settings. Geen inloggegevens of private provider-URL's.

required_endpoint_rolestring | nullop de blockchain
Voorkeursrol van de scanner-API (verouderd veld). Gebruik accepted_endpoint_roles voor de volledige compatibiliteitslijst. Een gezonde node alleen bewijst geen ondersteuning voor betalingsgeschiedenis.Details

Voorkeursrol van de scanner-API (verouderd veld). Gebruik accepted_endpoint_roles voor de volledige compatibiliteitslijst. Een gezonde node alleen bewijst geen ondersteuning voor betalingsgeschiedenis.

accepted_endpoint_roles[]string[] | nullop de blockchain
Compatibele API-dialecten, geen bewijs van eindpuntgeschiedenis of capaciteit. Ruwe node-rpc ondersteunt BTC/BCH/LTC/DOGE/DASH en transparante ZEC (volledig gedecodeerde blokken, 1–48 bevestigingen), definitief bevestigde eigen TRX, eigen ALGO via algod, XTZ via Octez, definitief bevestigde Asset Hub DOT via SCALE-metadata en eigen XLM via Stellar RPC met factuurmemo-ID. Gesnoeide of onvolledige geschiedenis voldoet niet. Deze ruwe adapters voegen geen tokenroutes toe. Geïndexeerde API's blijven alternatieven; zie de tabel met betaalroutes hieronder. Gemengde ruwe/geïndexeerde bronnen verifiëren begrensde vensters onafhankelijk; de standaard blijft twee onafhankelijke providers, geen aliassen van één operator. Alleen nodehoogte, ORDnet-blockchaininformatie en een EVM-relay voor een niet-EVM-route zijn geen ontvangstbewijzen. Monero vereist nog steeds een aan het project gekoppelde wallet-RPC met alleen inzagerechten.Details

Compatibele API-dialecten, geen bewijs van eindpuntgeschiedenis of capaciteit. Ruwe node-rpc ondersteunt BTC/BCH/LTC/DOGE/DASH en transparante ZEC (volledig gedecodeerde blokken, 1–48 bevestigingen), definitief bevestigde eigen TRX, eigen ALGO via algod, XTZ via Octez, definitief bevestigde Asset Hub DOT via SCALE-metadata en eigen XLM via Stellar RPC met factuurmemo-ID. Gesnoeide of onvolledige geschiedenis voldoet niet. Deze ruwe adapters voegen geen tokenroutes toe. Geïndexeerde API's blijven alternatieven; zie de tabel met betaalroutes hieronder. Gemengde ruwe/geïndexeerde bronnen verifiëren begrensde vensters onafhankelijk; de standaard blijft twee onafhankelijke providers, geen aliassen van één operator. Alleen nodehoogte, ORDnet-blockchaininformatie en een EVM-relay voor een niet-EVM-route zijn geen ontvangstbewijzen. Monero vereist nog steeds een aan het project gekoppelde wallet-RPC met alleen inzagerechten.

healthy_endpointsintegerop de blockchain

Gezonde overeenkomende eindpunten, niet het aantal onafhankelijke providers.

usable_independent_providersintegerop de blockchain
Bruikbare verificatieplaatsen, begrensd op twee. required_independent_providers is de blockchaininstelling: standaard 2, of 1 na expliciete keuze door een beheerder. In de modus met twee providers zijn verschillende providersleutels EN hosts vereist. Uitgeschakelde, verouderde (ouder dan tien minuten) of afkoelende bronnen vullen geen plaats. Lightning gebruikt eigen verbindingsregels.Details

Bruikbare verificatieplaatsen, begrensd op twee. required_independent_providers is de blockchaininstelling: standaard 2, of 1 na expliciete keuze door een beheerder. In de modus met twee providers zijn verschillende providersleutels EN hosts vereist. Uitgeschakelde, verouderde (ouder dan tien minuten) of afkoelende bronnen vullen geen plaats. Lightning gebruikt eigen verbindingsregels.

required_independent_providersintegerop de blockchain
Bruikbare verificatieplaatsen, begrensd op twee. required_independent_providers is de blockchaininstelling: standaard 2, of 1 na expliciete keuze door een beheerder. In de modus met twee providers zijn verschillende providersleutels EN hosts vereist. Uitgeschakelde, verouderde (ouder dan tien minuten) of afkoelende bronnen vullen geen plaats. Lightning gebruikt eigen verbindingsregels.Details

Bruikbare verificatieplaatsen, begrensd op twee. required_independent_providers is de blockchaininstelling: standaard 2, of 1 na expliciete keuze door een beheerder. In de modus met twee providers zijn verschillende providersleutels EN hosts vereist. Uitgeschakelde, verouderde (ouder dan tien minuten) of afkoelende bronnen vullen geen plaats. Lightning gebruikt eigen verbindingsregels.

last_checked_attimestamp | nullop de blockchain

Laatste gezondheidscontrole van een overeenkomend eindpunt, los van de beoordelingstijd.

Gebruiksopmerkingen
  • Een token kan wereldwijd vermeld staan maar niet selecteerbaar blijven wanneer scanner_ready of payment_supported false is.
  • De operatormogelijkhedenmatrix vereist ook de exacte eindpuntrol van de scanner; een gezond eindpunt met een onverenigbare API telt niet mee.
  • Tokens delen de projectwallet van hun eigen blockchain; ze maken geen andere herstelzin.
  • Ingesloten walletsamenvattingen tonen alleen gereedheid en houden saldi leeg; gebruik GET /v1/projects/{project_id}/wallets voor verrijkte saldi.

Fouten

Foutcodes & regels voor nieuwe pogingen

PUTActivabeleid van project bijwerken/v1/projects/{project_id}/payment-assets/{asset_id}Lezen + schrijven

Maakt of vervangt het projectbeleid voor één blijvend actief en geeft de vernieuwde projectactivalijst terug. Een eigen blockchain uitschakelen maakt de eigen munt en tokens onbeschikbaar voor nieuwe facturen, maar behoudt tokenbeleid, wallets en winkelselecties zodat ze later kunnen worden hervat.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MERCHANT_API_TOKEN
Content-Typevereistapplication/json
Acceptaanbevolenapplication/json

Padparameters

project_idUUIDvereist

Ingeschakeld project dat aan de API-referentie is toegewezen.

asset_idUUIDvereist

Actief-id teruggegeven door de projectactivalijst of tokenregistratie.

Verzoek

: "${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
}'

Requestbody

enabledbooleanvereist

Schakelt het actief voor het project in of uit. De eigen blockchain moet vóór elke token worden ingeschakeld.

finality_modeconfirmations | finalizedvereist

Finaliteitsbeleid dat door de betaalroute van het actief wordt ondersteund. finalized vereist required_confirmations=1.

required_confirmationsintegervereist
Bitcoin- en EVM-routes accepteren nul; andere bevestigingsroutes vereisen minstens één, routes met alleen finalized vereisen precies één, en EVM-routes zijn begrensd op 0–48 zodat elke overschrijving binnen het transactieherhaalvenster blijft.Details

Bitcoin- en EVM-routes accepteren nul; andere bevestigingsroutes vereisen minstens één, routes met alleen finalized vereisen precies één, en EVM-routes zijn begrensd op 0–48 zodat elke overschrijving binnen het transactieherhaalvenster blijft.

monitoring_minutesintegervereist

Opvraagvenster van 1–10,080 minuten terwijl een factuur actief is.

late_monitoring_daysintegervereist

0–3,650 dagen monitoring na het verlopen van de factuur.

Antwoord 200 application/json

Voorbeeldantwoord
{
  "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" }
  ]
}

Antwoordvelden

data[]object[]
assetobjectaltijd

Blijvend geregistreerde eigen munt of geverifieerd tokenactief.

idUUIDaltijd

Blijvende identificatie van een betaalactief, gebruikt door project- en winkelbeleidsroutes.

asset_keystringaltijd

Canonieke identiteit van een eigen munt of contractactief in CAIP-stijl.

chain_slugstringaltijd

Wholly Crypto-blockchainidentificatie en ingesteld netwerk.

networkstringaltijd

Wholly Crypto-blockchainidentificatie en ingesteld netwerk.

caip_network_idstringaltijd

Canonieke netwerk- en activa-identiteiten.

caip_asset_idstring|nullaltijd

Canonieke netwerk- en activa-identiteiten.

asset_kindnative | tokenaltijd

Of voldoening de blockchainvaluta of een geverifieerd contract/mint gebruikt.

payment_railstringaltijd

Runtime-betaalroute: utxo, evm-native, solana-native, account-native, privacy-native of token-transfer.

symbolstringaltijd

Weergave-identiteit en exacte precisie in atomaire eenheden.

namestringaltijd

Weergave-identiteit en exacte precisie in atomaire eenheden.

decimalsintegeraltijd

Weergave-identiteit en exacte precisie in atomaire eenheden.

contract_addressstring | nullaltijd

Canoniek ERC-20-contract of SPL-mint voor tokens; null voor eigen munten.

coingecko_idstring | nullaltijd

Detectie-/prijsidentiteit. Null voor eigen contracten; leid nooit een marktprijs af van hun tickersymbool. Alleen CoinGecko-metadata maakt een token nooit selecteerbaar.

custom_tokenbooleanaltijd

Eigen contract dat op de blockchain is geverifieerd, met projectspecifieke vaste USD-prijs of prijsbepaling via een geselecteerde DEX-pool.

icon_pathpath | nullaltijd

Lokaal gecacht tokenpictogram indien beschikbaar.

token_standarderc20 | spl-token | nullaltijd

Geverifieerde runtime-tokenstandaard; null voor eigen munten.

metadata_verified_attimestamp | nullaltijd

Verificatietijd op de blockchain van metadata voor geregistreerde tokens.

payment_supportedbooleanaltijd
Registercontroles bij bouwen. scanner_ready betekent dat de betalingsscanner-runtime is geïnstalleerd; betalingsbevestiging vereist het ingestelde aantal gezonde providers met exact de juiste rol (standaard 2, optioneel 1); tijdelijke scannerbeschikbaarheid blokkeert factuuraanmaak vanaf 6.0.6 niet. balance_ready is alleen true voor geïmplementeerde saldo-adapters.Details

Registercontroles bij bouwen. scanner_ready betekent dat de betalingsscanner-runtime is geïnstalleerd; betalingsbevestiging vereist het ingestelde aantal gezonde providers met exact de juiste rol (standaard 2, optioneel 1); tijdelijke scannerbeschikbaarheid blokkeert factuuraanmaak vanaf 6.0.6 niet. balance_ready is alleen true voor geïmplementeerde saldo-adapters.

scanner_readybooleanaltijd
Registercontroles bij bouwen. scanner_ready betekent dat de betalingsscanner-runtime is geïnstalleerd; betalingsbevestiging vereist het ingestelde aantal gezonde providers met exact de juiste rol (standaard 2, optioneel 1); tijdelijke scannerbeschikbaarheid blokkeert factuuraanmaak vanaf 6.0.6 niet. balance_ready is alleen true voor geïmplementeerde saldo-adapters.Details

Registercontroles bij bouwen. scanner_ready betekent dat de betalingsscanner-runtime is geïnstalleerd; betalingsbevestiging vereist het ingestelde aantal gezonde providers met exact de juiste rol (standaard 2, optioneel 1); tijdelijke scannerbeschikbaarheid blokkeert factuuraanmaak vanaf 6.0.6 niet. balance_ready is alleen true voor geïmplementeerde saldo-adapters.

balance_readybooleanaltijd
Registercontroles bij bouwen. scanner_ready betekent dat de betalingsscanner-runtime is geïnstalleerd; betalingsbevestiging vereist het ingestelde aantal gezonde providers met exact de juiste rol (standaard 2, optioneel 1); tijdelijke scannerbeschikbaarheid blokkeert factuuraanmaak vanaf 6.0.6 niet. balance_ready is alleen true voor geïmplementeerde saldo-adapters.Details

Registercontroles bij bouwen. scanner_ready betekent dat de betalingsscanner-runtime is geïnstalleerd; betalingsbevestiging vereist het ingestelde aantal gezonde providers met exact de juiste rol (standaard 2, optioneel 1); tijdelijke scannerbeschikbaarheid blokkeert factuuraanmaak vanaf 6.0.6 niet. balance_ready is alleen true voor geïmplementeerde saldo-adapters.

default_finality_modeconfirmations | finalizedaltijd

Standaardfinaliteitsmodel dat nieuw projectbeleid overneemt.

default_required_confirmationsintegeraltijd

Standaardbeleid voor bevestiging en monitoring.

default_monitoring_minutesintegeraltijd

Standaardbeleid voor bevestiging en monitoring.

policyobject | nullaltijd
Activerings-/finaliteitsbeleid van het project, of null als niet ingesteld. Bevat custom_price_mode (fixed/dex), custom_price_usd (vaste decimale tekenreeks of null), custom_dex_pair (geselecteerde pool of null) en custom_dex (dex_id, quote_symbol, huidige price_usd of null, liquidity_usd, fetched_at, last_error). Eigen prijsbepaling wordt gedeeld door winkels in dit project.Details

Activerings-/finaliteitsbeleid van het project, of null als niet ingesteld. Bevat custom_price_mode (fixed/dex), custom_price_usd (vaste decimale tekenreeks of null), custom_dex_pair (geselecteerde pool of null) en custom_dex (dex_id, quote_symbol, huidige price_usd of null, liquidity_usd, fetched_at, last_error). Eigen prijsbepaling wordt gedeeld door winkels in dit project.

enabledbooleanvereist

Schakelt het actief voor het project in of uit. De eigen blockchain moet vóór elke token worden ingeschakeld.

finality_modeconfirmations | finalizedvereist

Finaliteitsbeleid dat door de betaalroute van het actief wordt ondersteund. finalized vereist required_confirmations=1.

required_confirmationsintegervereist
Bitcoin- en EVM-routes accepteren nul; andere bevestigingsroutes vereisen minstens één, routes met alleen finalized vereisen precies één, en EVM-routes zijn begrensd op 0–48 zodat elke overschrijving binnen het transactieherhaalvenster blijft.Details

Bitcoin- en EVM-routes accepteren nul; andere bevestigingsroutes vereisen minstens één, routes met alleen finalized vereisen precies één, en EVM-routes zijn begrensd op 0–48 zodat elke overschrijving binnen het transactieherhaalvenster blijft.

monitoring_minutesintegervereist

Opvraagvenster van 1–10,080 minuten terwijl een factuur actief is.

late_monitoring_daysintegervereist

0–3,650 dagen monitoring na het verlopen van de factuur.

walletobject | nullaltijd

Projectwallet van de blockchain met eigen sleutelbeheer. Tokens delen de wallet van de eigen munt van hun blockchain.

idUUIDaltijd

Identificaties van wallet, eigenaarproject en eigen blockchainactief.

project_idUUIDaltijd

Identificaties van wallet, eigenaarproject en eigen blockchainactief.

native_asset_idUUIDaltijd

Identificaties van wallet, eigenaarproject en eigen blockchainactief.

chain_slugstringaltijd

Blockchain en netwerk van de wallet.

networkstringaltijd

Blockchain en netwerk van de wallet.

asset_symbolstringaltijd

Weergave-identiteit van de eigen blockchainmunt.

asset_namestringaltijd

Weergave-identiteit van de eigen blockchainmunt.

statuspending | active | disabled | erroraltijd

Operationele walletstatus.

labelstringaltijd

Operatorlabel.

public_keystring | nullaltijd

Publieke walletidentiteit; er wordt geen herstelzin of private sleutel getoond.

primary_addressstring | nullaltijd

Publieke walletidentiteit; er wordt geen herstelzin of private sleutel getoond.

derivation_schemestring | nullaltijd

Adresbeleid en -formaat.

address_formatstring | nullaltijd

Adresbeleid en -formaat.

backup_confirmed_attimestamp | nullaltijd

Niet-null nadat de operator de herstelback-up heeft bevestigd.

activation_requiredbooleanaltijd
Gedeelde XRP- en Stellar-accounts blijven niet beschikbaar totdat de operator het getoonde adres financiert en de ingestelde scannerproviders dat exacte account verifiëren. Het blijvende bewijs verloopt niet; actuele scannergezondheid wordt afzonderlijk gecontroleerd voor betalingsverificatie, niet voor factuuraanmaak.Details

Gedeelde XRP- en Stellar-accounts blijven niet beschikbaar totdat de operator het getoonde adres financiert en de ingestelde scannerproviders dat exacte account verifiëren. Het blijvende bewijs verloopt niet; actuele scannergezondheid wordt afzonderlijk gecontroleerd voor betalingsverificatie, niet voor factuuraanmaak.

activation_verified_attimestamp|nullaltijd
Gedeelde XRP- en Stellar-accounts blijven niet beschikbaar totdat de operator het getoonde adres financiert en de ingestelde scannerproviders dat exacte account verifiëren. Het blijvende bewijs verloopt niet; actuele scannergezondheid wordt afzonderlijk gecontroleerd voor betalingsverificatie, niet voor factuuraanmaak.Details

Gedeelde XRP- en Stellar-accounts blijven niet beschikbaar totdat de operator het getoonde adres financiert en de ingestelde scannerproviders dat exacte account verifiëren. Het blijvende bewijs verloopt niet; actuele scannergezondheid wordt afzonderlijk gecontroleerd voor betalingsverificatie, niet voor factuuraanmaak.

receive_readinessobject | null5.5.0+
Opgenomen in walletlijsten: ontvangstconfiguratie van het project en vereisten voor de blockchainscanner. Staat los van saldi, tokengas en verzendgereedheid. Andere walletantwoorden kunnen dit null laten.Details

Opgenomen in walletlijsten: ontvangstconfiguratie van het project en vereisten voor de blockchainscanner. Staat los van saldi, tokengas en verzendgereedheid. Andere walletantwoorden kunnen dit null laten.

readybooleanaltijd

Ontvangstconfiguratiecontroles slagen. Beschrijft geen bestedingsgereedheid, gas, saldovernieuwing of gegarandeerde toekomstige prijsopgave.

invoice_creatableboolean6.0.6+
De configuratie staat een factuurmethode toe ondanks tijdelijke scannerwaarschuwingen. Valutaprijsbepaling wordt bij aanmaak gecontroleerd. Dit is geen betalingsverificatie: ready kan false zijn terwijl invoice_creatable true is. Ontbrekende wallets, uitgeschakeld beleid en niet-ondersteunde adapters blijven veilig weigeren.Details

De configuratie staat een factuurmethode toe ondanks tijdelijke scannerwaarschuwingen. Valutaprijsbepaling wordt bij aanmaak gecontroleerd. Dit is geen betalingsverificatie: ready kan false zijn terwijl invoice_creatable true is. Ontbrekende wallets, uitgeschakeld beleid en niet-ondersteunde adapters blijven veilig weigeren.

checked_attimestampaltijd

Beoordelingstijd. Een lijst opvragen maakt geen netwerkverzoek en wijst geen adres toe.

issues[]object[]altijd
Leeg indien gereed; anders een ontvangstwaarschuwing of configuratieblokkade. Controleer invoice_creatable om tijdelijke scannerwaarschuwingen van factuurconfiguratiefouten te onderscheiden.Details

Leeg indien gereed; anders een ontvangstwaarschuwing of configuratieblokkade. Controleer invoice_creatable om tijdelijke scannerwaarschuwingen van factuurconfiguratiefouten te onderscheiden.

chain_slugstringindien bekend

Identificeert de betrokken blockchain en het actief. Lightning kan asset_id weglaten.

asset_idUUIDindien bekend

Identificeert de betrokken blockchain en het actief. Lightning kan asset_id weglaten.

asset_tickerstringindien bekend

Identificeert de betrokken blockchain en het actief. Lightning kan asset_id weglaten.

reason_codestringaltijd
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 of asset_not_accepted.Details

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 of asset_not_accepted.

messagestringindien beschikbaar
Uitleg voor de handelaar en actie-identificatie: chain_connections, wallets, rates, payment_methods, project_settings of store_settings. Geen inloggegevens of private provider-URL's.Details

Uitleg voor de handelaar en actie-identificatie: chain_connections, wallets, rates, payment_methods, project_settings of store_settings. Geen inloggegevens of private provider-URL's.

actionstringindien beschikbaar
Uitleg voor de handelaar en actie-identificatie: chain_connections, wallets, rates, payment_methods, project_settings of store_settings. Geen inloggegevens of private provider-URL's.Details

Uitleg voor de handelaar en actie-identificatie: chain_connections, wallets, rates, payment_methods, project_settings of store_settings. Geen inloggegevens of private provider-URL's.

required_endpoint_rolestring | nullop de blockchain
Voorkeursrol van de scanner-API (verouderd veld). Gebruik accepted_endpoint_roles voor de volledige compatibiliteitslijst. Een gezonde node alleen bewijst geen ondersteuning voor betalingsgeschiedenis.Details

Voorkeursrol van de scanner-API (verouderd veld). Gebruik accepted_endpoint_roles voor de volledige compatibiliteitslijst. Een gezonde node alleen bewijst geen ondersteuning voor betalingsgeschiedenis.

accepted_endpoint_roles[]string[] | nullop de blockchain
Compatibele API-dialecten, geen bewijs van eindpuntgeschiedenis of capaciteit. Ruwe node-rpc ondersteunt BTC/BCH/LTC/DOGE/DASH en transparante ZEC (volledig gedecodeerde blokken, 1–48 bevestigingen), definitief bevestigde eigen TRX, eigen ALGO via algod, XTZ via Octez, definitief bevestigde Asset Hub DOT via SCALE-metadata en eigen XLM via Stellar RPC met factuurmemo-ID. Gesnoeide of onvolledige geschiedenis voldoet niet. Deze ruwe adapters voegen geen tokenroutes toe. Geïndexeerde API's blijven alternatieven; zie de tabel met betaalroutes hieronder. Gemengde ruwe/geïndexeerde bronnen verifiëren begrensde vensters onafhankelijk; de standaard blijft twee onafhankelijke providers, geen aliassen van één operator. Alleen nodehoogte, ORDnet-blockchaininformatie en een EVM-relay voor een niet-EVM-route zijn geen ontvangstbewijzen. Monero vereist nog steeds een aan het project gekoppelde wallet-RPC met alleen inzagerechten.Details

Compatibele API-dialecten, geen bewijs van eindpuntgeschiedenis of capaciteit. Ruwe node-rpc ondersteunt BTC/BCH/LTC/DOGE/DASH en transparante ZEC (volledig gedecodeerde blokken, 1–48 bevestigingen), definitief bevestigde eigen TRX, eigen ALGO via algod, XTZ via Octez, definitief bevestigde Asset Hub DOT via SCALE-metadata en eigen XLM via Stellar RPC met factuurmemo-ID. Gesnoeide of onvolledige geschiedenis voldoet niet. Deze ruwe adapters voegen geen tokenroutes toe. Geïndexeerde API's blijven alternatieven; zie de tabel met betaalroutes hieronder. Gemengde ruwe/geïndexeerde bronnen verifiëren begrensde vensters onafhankelijk; de standaard blijft twee onafhankelijke providers, geen aliassen van één operator. Alleen nodehoogte, ORDnet-blockchaininformatie en een EVM-relay voor een niet-EVM-route zijn geen ontvangstbewijzen. Monero vereist nog steeds een aan het project gekoppelde wallet-RPC met alleen inzagerechten.

healthy_endpointsintegerop de blockchain

Gezonde overeenkomende eindpunten, niet het aantal onafhankelijke providers.

usable_independent_providersintegerop de blockchain
Bruikbare verificatieplaatsen, begrensd op twee. required_independent_providers is de blockchaininstelling: standaard 2, of 1 na expliciete keuze door een beheerder. In de modus met twee providers zijn verschillende providersleutels EN hosts vereist. Uitgeschakelde, verouderde (ouder dan tien minuten) of afkoelende bronnen vullen geen plaats. Lightning gebruikt eigen verbindingsregels.Details

Bruikbare verificatieplaatsen, begrensd op twee. required_independent_providers is de blockchaininstelling: standaard 2, of 1 na expliciete keuze door een beheerder. In de modus met twee providers zijn verschillende providersleutels EN hosts vereist. Uitgeschakelde, verouderde (ouder dan tien minuten) of afkoelende bronnen vullen geen plaats. Lightning gebruikt eigen verbindingsregels.

required_independent_providersintegerop de blockchain
Bruikbare verificatieplaatsen, begrensd op twee. required_independent_providers is de blockchaininstelling: standaard 2, of 1 na expliciete keuze door een beheerder. In de modus met twee providers zijn verschillende providersleutels EN hosts vereist. Uitgeschakelde, verouderde (ouder dan tien minuten) of afkoelende bronnen vullen geen plaats. Lightning gebruikt eigen verbindingsregels.Details

Bruikbare verificatieplaatsen, begrensd op twee. required_independent_providers is de blockchaininstelling: standaard 2, of 1 na expliciete keuze door een beheerder. In de modus met twee providers zijn verschillende providersleutels EN hosts vereist. Uitgeschakelde, verouderde (ouder dan tien minuten) of afkoelende bronnen vullen geen plaats. Lightning gebruikt eigen verbindingsregels.

last_checked_attimestamp | nullop de blockchain

Laatste gezondheidscontrole van een overeenkomend eindpunt, los van de beoordelingstijd.

monero_wallet_rpcMoneroWalletRpcBinding | nullaltijd
Geschoonde externe wallet-RPC-koppelingsstatus met alleen inzagerechten voor Monero. Bevat eindpunt, authenticatiemodus, primair account-0-adres, technische bewijsvlaggen/-hoogtes en tijdstempels van operatorverklaringen; inloggegevens, walletsleutels en walletbestanden worden nooit geserialiseerd.Details

Geschoonde externe wallet-RPC-koppelingsstatus met alleen inzagerechten voor Monero. Bevat eindpunt, authenticatiemodus, primair account-0-adres, technische bewijsvlaggen/-hoogtes en tijdstempels van operatorverklaringen; inloggegevens, walletsleutels en walletbestanden worden nooit geserialiseerd.

last_secret_revealed_attimestamp|nullaltijd

Auditmetadata over het tonen van geheimen aan de consolekant.

secret_reveal_countintegeraltijd

Auditmetadata over het tonen van geheimen aan de consolekant.

next_receive_indexintegeraltijd

Volgende gereserveerde index van een onderliggend adres.

last_scanned_heightinteger|nullaltijd

Walletscannerstatus.

last_scanned_attimestamp|nullaltijd

Walletscannerstatus.

last_errorstring|nullaltijd

Walletscannerstatus.

balances[]object[]altijd
Gecachte saldi voor elk van de 30 eigen blockchainroutes, plus geverifieerde ERC-20- en SPL-activa. Voor Monero is een ingestelde externe wallet-RPC met alleen inzagerechten vereist.Details

Gecachte saldi voor elk van de 30 eigen blockchainroutes, plus geverifieerde ERC-20- en SPL-activa. Voor Monero is een ingestelde externe wallet-RPC met alleen inzagerechten vereist.

wallet_idUUIDaltijd

Walletidentiteit en blijvende activa-identiteiten.

asset_idUUIDaltijd

Walletidentiteit en blijvende activa-identiteiten.

project_enabledbooleanaltijd

Of dit actief momenteel is ingeschakeld volgens het activabeleid van het project.

active_store_countintegeraltijd

Aantal ingeschakelde winkels dat dit actief momenteel selecteert. Dit is een weergave van acceptatie; alleen-lezen saldoregistratie blijft onafhankelijk.

active_store_ids[]UUID[]altijd

Ingeschakelde winkels in dit project die het actief momenteel accepteren. Dit maakt exact lokaal filteren op winkel mogelijk zonder extra API-verzoek.

tracking_activebooleanaltijd
Of deze leesbare wallet en het geregistreerde actief op dezelfde blockchain in aanmerking komen voor saldovernieuwing op de achtergrond. Schakelaars voor project- en betaalmethodeacceptatie pauzeren alleen-lezen registratie niet.Details

Of deze leesbare wallet en het geregistreerde actief op dezelfde blockchain in aanmerking komen voor saldovernieuwing op de achtergrond. Schakelaars voor project- en betaalmethodeacceptatie pauzeren alleen-lezen registratie niet.

asset_kindnative | tokenaltijd

Eigen valuta of geverifieerd contract-/mintactief.

contract_addressstring | nullaltijd

Tokencontract of mint; null voor eigen valuta.

symbolstringaltijd

Weergave-identiteit en atomaire precisie.

namestringaltijd

Weergave-identiteit en atomaire precisie.

decimalsintegeraltijd

Weergave-identiteit en atomaire precisie.

coingecko_idstring | nullaltijd

Prijsidentiteit indien gekoppeld.

balancedecimal string|nullaltijd

Exact weergegeven en atomair saldo over het primaire walletadres en uitgegeven factuuradressen. Null zolang geen volledige waarde beschikbaar is.

balance_atomicinteger string|nullaltijd

Exact weergegeven en atomair saldo over het primaire walletadres en uitgegeven factuuradressen. Null zolang geen volledige waarde beschikbaar is.

price_usddecimal string | nullaltijd

Indicatieve gecachte USD-eenheidsprijs voor waardering.

value_usddecimal string | nullaltijd

Indicatieve fiatwaardering wanneer een actuele koers bestaat.

statuspending | refreshing | fresh | stale | erroraltijd
Gecachte scanstatus. refreshing kan een voltooid saldo behouden: gebruik checked_at voor de ouderdom. Pending betekent dat er geen voltooide momentopname is. Geen van deze statussen bewijst dat een overschrijving openstaat of een factuur is voldaan.Details

Gecachte scanstatus. refreshing kan een voltooid saldo behouden: gebruik checked_at voor de ouderdom. Pending betekent dat er geen voltooide momentopname is. Geen van deze statussen bewijst dat een overschrijving openstaat of een factuur is voldaan.

checked_attimestamp | nullaltijd

Tijdstip dat door een voltooide saldoscan wordt weergegeven.

last_errorstring | nullaltijd

Veilige operatordiagnostiek.

total_value_usddecimal string | nullaltijd

Indicatieve som van saldi met een actuele USD-prijs.

balance_statuspending | refreshing | fresh | stale | error | unknownaltijd

Samengevoegde cache-actualiteit; unknown is een defensieve terugval en geen van deze statussen bewijst factuurvoldoening.

balance_checked_attimestamp | nullaltijd

Oudste relevante succesvolle saldocontrole die in het totaal is vertegenwoordigd.

recent_payments[]object[]altijd

Maximaal drie nieuwste geldige waarnemingen met status detected, confirming of final die aan precies deze wallet zijn toegewezen.

invoice_public_idUUIDaltijd

Factuuridentiteit voor de klant die bij de waarneming hoort.

chain_slugstringaltijd

Blockchain en weergavesymbool van eigen munt of geverifieerde token.

symbolstringaltijd

Blockchain en weergavesymbool van eigen munt of geverifieerde token.

transaction_idstringaltijd

Canonieke transactie- en overschrijvingsgebeurtenisidentiteit.

event_indexintegeraltijd

Canonieke transactie- en overschrijvingsgebeurtenisidentiteit.

amountdecimal stringaltijd

Exact waargenomen activabedrag zonder omzetting naar drijvendekommagetallen.

statusdetected | confirming | finalaltijd

Huidige geldige waarnemingsstatus. Gereorganiseerde, vervangen en ongeldige waarnemingen worden uitgesloten.

confirmationsintegeraltijd

Laatst waargenomen aantal bevestigingen.

observed_atRFC 3339 timestampaltijd

Tijdstip waarop Wholly Crypto de betaling voor het eerst waarnam.

created_atRFC 3339 timestampaltijd

Aanmaaktijd en laatste bijwerktijd van de wallet.

updated_atRFC 3339 timestampaltijd

Aanmaaktijd en laatste bijwerktijd van de wallet.

wallet_readinessreadiness enumaltijd
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 of ready.Details

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 of ready.

receive_readinessobject | null5.5.0+
Gedeelde beoordeling van de ontvangstconfiguratie van het project. Omvat wallet- en onafhankelijke scannerprovidercontroles, los van saldoactualiteit en gas voor verzenden. Null als geen projectbeleid bestaat. Factuurvaluta/koersen worden bij factuuraanmaak gecontroleerd.Details

Gedeelde beoordeling van de ontvangstconfiguratie van het project. Omvat wallet- en onafhankelijke scannerprovidercontroles, los van saldoactualiteit en gas voor verzenden. Null als geen projectbeleid bestaat. Factuurvaluta/koersen worden bij factuuraanmaak gecontroleerd.

readybooleanaltijd

Ontvangstconfiguratiecontroles slagen. Beschrijft geen bestedingsgereedheid, gas, saldovernieuwing of gegarandeerde toekomstige prijsopgave.

invoice_creatableboolean6.0.6+
De configuratie staat een factuurmethode toe ondanks tijdelijke scannerwaarschuwingen. Valutaprijsbepaling wordt bij aanmaak gecontroleerd. Dit is geen betalingsverificatie: ready kan false zijn terwijl invoice_creatable true is. Ontbrekende wallets, uitgeschakeld beleid en niet-ondersteunde adapters blijven veilig weigeren.Details

De configuratie staat een factuurmethode toe ondanks tijdelijke scannerwaarschuwingen. Valutaprijsbepaling wordt bij aanmaak gecontroleerd. Dit is geen betalingsverificatie: ready kan false zijn terwijl invoice_creatable true is. Ontbrekende wallets, uitgeschakeld beleid en niet-ondersteunde adapters blijven veilig weigeren.

checked_attimestampaltijd

Beoordelingstijd. Een lijst opvragen maakt geen netwerkverzoek en wijst geen adres toe.

issues[]object[]altijd
Leeg indien gereed; anders een ontvangstwaarschuwing of configuratieblokkade. Controleer invoice_creatable om tijdelijke scannerwaarschuwingen van factuurconfiguratiefouten te onderscheiden.Details

Leeg indien gereed; anders een ontvangstwaarschuwing of configuratieblokkade. Controleer invoice_creatable om tijdelijke scannerwaarschuwingen van factuurconfiguratiefouten te onderscheiden.

chain_slugstringindien bekend

Identificeert de betrokken blockchain en het actief. Lightning kan asset_id weglaten.

asset_idUUIDindien bekend

Identificeert de betrokken blockchain en het actief. Lightning kan asset_id weglaten.

asset_tickerstringindien bekend

Identificeert de betrokken blockchain en het actief. Lightning kan asset_id weglaten.

reason_codestringaltijd
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 of asset_not_accepted.Details

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 of asset_not_accepted.

messagestringindien beschikbaar
Uitleg voor de handelaar en actie-identificatie: chain_connections, wallets, rates, payment_methods, project_settings of store_settings. Geen inloggegevens of private provider-URL's.Details

Uitleg voor de handelaar en actie-identificatie: chain_connections, wallets, rates, payment_methods, project_settings of store_settings. Geen inloggegevens of private provider-URL's.

actionstringindien beschikbaar
Uitleg voor de handelaar en actie-identificatie: chain_connections, wallets, rates, payment_methods, project_settings of store_settings. Geen inloggegevens of private provider-URL's.Details

Uitleg voor de handelaar en actie-identificatie: chain_connections, wallets, rates, payment_methods, project_settings of store_settings. Geen inloggegevens of private provider-URL's.

required_endpoint_rolestring | nullop de blockchain
Voorkeursrol van de scanner-API (verouderd veld). Gebruik accepted_endpoint_roles voor de volledige compatibiliteitslijst. Een gezonde node alleen bewijst geen ondersteuning voor betalingsgeschiedenis.Details

Voorkeursrol van de scanner-API (verouderd veld). Gebruik accepted_endpoint_roles voor de volledige compatibiliteitslijst. Een gezonde node alleen bewijst geen ondersteuning voor betalingsgeschiedenis.

accepted_endpoint_roles[]string[] | nullop de blockchain
Compatibele API-dialecten, geen bewijs van eindpuntgeschiedenis of capaciteit. Ruwe node-rpc ondersteunt BTC/BCH/LTC/DOGE/DASH en transparante ZEC (volledig gedecodeerde blokken, 1–48 bevestigingen), definitief bevestigde eigen TRX, eigen ALGO via algod, XTZ via Octez, definitief bevestigde Asset Hub DOT via SCALE-metadata en eigen XLM via Stellar RPC met factuurmemo-ID. Gesnoeide of onvolledige geschiedenis voldoet niet. Deze ruwe adapters voegen geen tokenroutes toe. Geïndexeerde API's blijven alternatieven; zie de tabel met betaalroutes hieronder. Gemengde ruwe/geïndexeerde bronnen verifiëren begrensde vensters onafhankelijk; de standaard blijft twee onafhankelijke providers, geen aliassen van één operator. Alleen nodehoogte, ORDnet-blockchaininformatie en een EVM-relay voor een niet-EVM-route zijn geen ontvangstbewijzen. Monero vereist nog steeds een aan het project gekoppelde wallet-RPC met alleen inzagerechten.Details

Compatibele API-dialecten, geen bewijs van eindpuntgeschiedenis of capaciteit. Ruwe node-rpc ondersteunt BTC/BCH/LTC/DOGE/DASH en transparante ZEC (volledig gedecodeerde blokken, 1–48 bevestigingen), definitief bevestigde eigen TRX, eigen ALGO via algod, XTZ via Octez, definitief bevestigde Asset Hub DOT via SCALE-metadata en eigen XLM via Stellar RPC met factuurmemo-ID. Gesnoeide of onvolledige geschiedenis voldoet niet. Deze ruwe adapters voegen geen tokenroutes toe. Geïndexeerde API's blijven alternatieven; zie de tabel met betaalroutes hieronder. Gemengde ruwe/geïndexeerde bronnen verifiëren begrensde vensters onafhankelijk; de standaard blijft twee onafhankelijke providers, geen aliassen van één operator. Alleen nodehoogte, ORDnet-blockchaininformatie en een EVM-relay voor een niet-EVM-route zijn geen ontvangstbewijzen. Monero vereist nog steeds een aan het project gekoppelde wallet-RPC met alleen inzagerechten.

healthy_endpointsintegerop de blockchain

Gezonde overeenkomende eindpunten, niet het aantal onafhankelijke providers.

usable_independent_providersintegerop de blockchain
Bruikbare verificatieplaatsen, begrensd op twee. required_independent_providers is de blockchaininstelling: standaard 2, of 1 na expliciete keuze door een beheerder. In de modus met twee providers zijn verschillende providersleutels EN hosts vereist. Uitgeschakelde, verouderde (ouder dan tien minuten) of afkoelende bronnen vullen geen plaats. Lightning gebruikt eigen verbindingsregels.Details

Bruikbare verificatieplaatsen, begrensd op twee. required_independent_providers is de blockchaininstelling: standaard 2, of 1 na expliciete keuze door een beheerder. In de modus met twee providers zijn verschillende providersleutels EN hosts vereist. Uitgeschakelde, verouderde (ouder dan tien minuten) of afkoelende bronnen vullen geen plaats. Lightning gebruikt eigen verbindingsregels.

required_independent_providersintegerop de blockchain
Bruikbare verificatieplaatsen, begrensd op twee. required_independent_providers is de blockchaininstelling: standaard 2, of 1 na expliciete keuze door een beheerder. In de modus met twee providers zijn verschillende providersleutels EN hosts vereist. Uitgeschakelde, verouderde (ouder dan tien minuten) of afkoelende bronnen vullen geen plaats. Lightning gebruikt eigen verbindingsregels.Details

Bruikbare verificatieplaatsen, begrensd op twee. required_independent_providers is de blockchaininstelling: standaard 2, of 1 na expliciete keuze door een beheerder. In de modus met twee providers zijn verschillende providersleutels EN hosts vereist. Uitgeschakelde, verouderde (ouder dan tien minuten) of afkoelende bronnen vullen geen plaats. Lightning gebruikt eigen verbindingsregels.

last_checked_attimestamp | nullop de blockchain

Laatste gezondheidscontrole van een overeenkomend eindpunt, los van de beoordelingstijd.

Gebruiksopmerkingen
  • De body vervangt het volledige beleid en wijst onbekende velden af.
  • Inschakelen op projectniveau selecteert het actief niet vanzelf voor een winkel.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETKandidaat-betaaltokens bekijken/v1/projects/{project_id}/payment-token-candidatesAlleen-lezen

Doorzoekt lokaal gecachte CoinGecko-contractkoppelingen alleen op blockchains waarvoor de tokenfactuurscanner en saldo-adapter zijn geïmplementeerd. Resultaten zijn detectiekandidaten, geen vertrouwde betaalactiva.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MERCHANT_API_TOKEN
Acceptaanbevolenapplication/json

Padparameters

project_idUUIDvereist

Ingeschakeld project dat aan de API-referentie is toegewezen.

Queryparameters

chain_slugstring

Vereiste ondersteunde EVM-blockchain-slug of solana.

qstring

Optioneel deel van naam, symbool, CoinGecko-id, contract of mint; maximaal 80 tekens.

limitinteger

Optioneel 1–100; standaard 50.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "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
    }
  ]
}

Antwoordvelden

data[]object[]
coingecko_idstringaltijd

CoinGecko-detectie-identiteit die door het registratieverzoek wordt gebruikt.

chain_slugstringaltijd

Gekoppelde Wholly Crypto-blockchain.

symbolstringaltijd

Weergave-identiteit in de catalogus.

namestringaltijd

Weergave-identiteit in de catalogus.

contract_addressstringaltijd

Gekoppeld contract of mint; wordt vóór registratie op de blockchain geverifieerd.

market_cap_rankinteger | nullaltijd

Detectierang, geen signaal voor vertrouwen of betaalgereedheid.

icon_pathpathaltijd

Pad naar lokaal gecacht CoinGecko-pictogram.

current_price_usddecimal string | nullaltijd

Indicatieve gecachte USD-prijs.

token_standarderc20 | spl-tokenaltijd

Tokenstandaard die door de geselecteerde blockchainadapter wordt ondersteund.

scanner_readybooleanaltijd

Alleen true voor kandidaten op een tokenroute die door deze build is geïmplementeerd.

registered_asset_idUUID | nullaltijd

Bestaand blijvend actief indien al geregistreerd.

project_enabledbooleanaltijd

Of het geregistreerde actief voor dit project is ingeschakeld.

Gebruiksopmerkingen
  • Ondersteunde tokenadapters: ERC-20 op Ethereum, Base, BNB Chain, HyperEVM, Avalanche, Polygon, Arbitrum en Optimism; SPL op Solana.
  • Niet-ondersteunde catalogusblockchains worden afgewezen en niet als selecteerbaar getoond.
  • CoinGecko-rang, pictogram en prijs zijn indicatieve detectiegegevens.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTToken verifiëren en registreren/v1/projects/{project_id}/payment-token-assetsLezen + schrijven

Neemt één huidige kandidaat pas in het blijvende betaalregister op nadat ingestelde nodes blockchainidentiteit, contract-/mintidentiteit, decimalen en een bruikbare saldo-opvraging hebben geverifieerd. Registratie vertrouwt nooit uitsluitend op CoinGecko-metadata en elk project is beperkt tot 20 geregistreerde tokenactiva.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MERCHANT_API_TOKEN
Content-Typevereistapplication/json
Acceptaanbevolenapplication/json

Padparameters

project_idUUIDvereist

Ingeschakeld project dat aan de API-referentie is toegewezen.

Verzoek

: "${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
}'

Requestbody

chain_slugstringvereist

ethereum, base, bnb-chain, hyperliquid, avalanche, polygon, arbitrum, optimism of solana.

coingecko_idstringvereist
Exacte kandidaatidentiteit teruggegeven door tokenzoeken. Behoud underscores of koppeltekens aan het begin, zoals _ of -6. Leid deze ID niet af van de tokennaam of het tickersymbool.Details

Exacte kandidaatidentiteit teruggegeven door tokenzoeken. Behoud underscores of koppeltekens aan het begin, zoals _ of -6. Leid deze ID niet af van de tokennaam of het tickersymbool.

enabledbooleanoptioneel

Projectbeleidsstatus na verificatie; standaard true.

Antwoord 201 application/json

Voorbeeldantwoord
{
  "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"
  }
}

Antwoordvelden

dataobject
asset_idUUIDaltijd

Blijvende identificatie van betaalactief.

chain_slugstringaltijd

Geverifieerde blockchain en bewaarde detectie-/prijsidentiteit.

coingecko_idstringaltijd

Geverifieerde blockchain en bewaarde detectie-/prijsidentiteit.

contract_addressstringaltijd

Canoniek geverifieerd contract of mint.

token_standarderc20 | spl-tokenaltijd

Geverifieerde runtime-tokenstandaard.

symbolstringaltijd

Geregistreerde weergave-identiteit en exacte precisie.

namestringaltijd

Geregistreerde weergave-identiteit en exacte precisie.

decimalsintegeraltijd

Geregistreerde weergave-identiteit en exacte precisie.

enabledbooleanaltijd

Initiële projectbeleidsstatus.

metadata_verified_atRFC 3339 timestampaltijd

Verificatietijd op de blockchain.

Gebruiksopmerkingen
  • Schakel het eigen projectactief van de blockchain in voordat je de tokens ervan registreert.
  • Een project kan maximaal 20 tokenactiva registreren; een nieuwe kandidaat boven die grens geeft token_chain_not_ready (409) terug. Hergebruik van een al geregistreerd actief verbruikt geen extra plek.
  • Nodeverificatie kan langer duren dan het lezen van de catalogus; gebruik een expliciete clienttime-out.
  • Selecteer na registratie het actief voor elke winkel die het moet aanbieden.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETDEX-pools voor eigen token zoeken/v1/projects/{project_id}/payment-token-dex-poolsAlleen-lezen

Vind via DEX Screener maximaal 12 geschikte pools op basis van exacte blockchain en basistokencontract, gesorteerd op liquiditeit. Dit registreert of activeert geen token.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MERCHANT_API_TOKEN

Padparameters

project_idUUIDvereist

Toegewezen project.

Queryparameters

chain_slugstring

Ondersteunde EVM-tokenblockchain of solana.

contract_addressstring

Exact ERC-20-contract of klassieke SPL-mint.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{"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"}]}

Antwoordvelden

data[]object[]
pair_addressstringaltijd

Exacte poolidentificatie, beurs-ID (bijv. uniswap/pancakeswap) en gekoppeld tickersymbool alleen voor weergave.

dex_idstringaltijd

Exacte poolidentificatie, beurs-ID (bijv. uniswap/pancakeswap) en gekoppeld tickersymbool alleen voor weergave.

quote_symbolstringaltijd

Exacte poolidentificatie, beurs-ID (bijv. uniswap/pancakeswap) en gekoppeld tickersymbool alleen voor weergave.

price_usddecimal stringaltijd

USD-prijs van de gevraagde basistoken en totale poolliquiditeit. Minstens $10,000 liquiditeit en een transactie in het afgelopen uur zijn vereist.

liquidity_usddecimal stringaltijd

USD-prijs van de gevraagde basistoken en totale poolliquiditeit. Minstens $10,000 liquiditeit en een transactie in het afgelopen uur zijn vereist.

fetched_atRFC 3339 timestampaltijd

Wanneer de server de providerwaarneming ophaalde, niet het tijdstip van een blockchaintransactie.

urlHTTPS URLaltijd

Gevalideerde DEX Screener-link naar deze pool.

Gebruiksopmerkingen
  • Een lege data-array betekent dat geen kwalificerende pool is gevonden. Alleen pools waarin het exact gevraagde contract de basistoken is worden teruggegeven; USD-prijzen aan de quote-kant worden nooit aangenomen.
  • Een DEX-vermelding is geen beveiligingsaudit. Minimale liquiditeit en recente activiteit verminderen onbruikbare prijsopgaven, maar voorkomen geen marktmanipulatie.
  • Uniswap, PancakeSwap en andere geïndexeerde DEX'en worden ondersteund waar de bestaande blockchainscanner tokens ondersteunt. API-toegang blijft projectgebonden en begrensd. Provideraanroepen worden ook achtereenvolgens uitgevoerd en begrensd.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTEigen token toevoegen of prijs wijzigen/v1/projects/{project_id}/payment-token-assets/customLezen + schrijven

Verifieert een eigen contract via ingestelde blockchainnodes en registreert het zonder CoinGecko-vermelding te vereisen. De vaste USD-prijs of geselecteerde automatische DEX-pool hoort bij dit project, niet bij het tickersymbool of andere projecten. Dezelfde identiteit herhalen werkt de projectprijs bij zonder bestaand ingeschakeld/uitgeschakeld beleid te veranderen.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MERCHANT_API_TOKEN
Content-Typevereistapplication/json

Padparameters

project_idUUIDvereist

Project toegewezen aan deze API-referentie met schrijfrechten.

Verzoek

: "${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"
}'

Requestbody

chain_slugstringvereist

ethereum, base, bnb-chain, hyperliquid, avalanche, polygon, arbitrum, optimism of solana. Vast voor dit contract.

contract_addressstringvereist
ERC-20-contract (0x plus 40 hexadecimale tekens) of een klassieke SPL-mint. Nodes verifiëren netwerkidentiteit en exacte decimalen; decimalen en RPC-URL's van de aanroeper worden afgewezen.Details

ERC-20-contract (0x plus 40 hexadecimale tekens) of een klassieke SPL-mint. Nodes verifiëren netwerkidentiteit en exacte decimalen; decimalen en RPC-URL's van de aanroeper worden afgewezen.

namestringvereist
Weergavenaam (1–80 tekens) en tickersymbool (1–16 letters/cijfers/punten/underscores/koppeltekens, eerste teken alfanumeriek). Bestaande identiteiten kunnen via dit eindpunt niet worden hernoemd.Details

Weergavenaam (1–80 tekens) en tickersymbool (1–16 letters/cijfers/punten/underscores/koppeltekens, eerste teken alfanumeriek). Bestaande identiteiten kunnen via dit eindpunt niet worden hernoemd.

symbolstringvereist
Weergavenaam (1–80 tekens) en tickersymbool (1–16 letters/cijfers/punten/underscores/koppeltekens, eerste teken alfanumeriek). Bestaande identiteiten kunnen via dit eindpunt niet worden hernoemd.Details

Weergavenaam (1–80 tekens) en tickersymbool (1–16 letters/cijfers/punten/underscores/koppeltekens, eerste teken alfanumeriek). Bestaande identiteiten kunnen via dit eindpunt niet worden hernoemd.

price_modefixed | dexoptioneel

Standaard fixed voor achterwaartse compatibiliteit. DEX gebruikt een specifieke pool die voor de exacte blockchain en het exacte contract is gevonden.

price_usddecimal stringfixed-modus

Vaste USD-waarde van ÉÉN token, positief, maximaal 30 decimalen, maximum 1000000000000000000000000. Geen exponent of floats. Weglaten in dex-modus.

dex_pair_addressstringdex-modus
Pooladres uit payment-token-dex-pools. Vereist in dex-modus; weglaten in fixed-modus. De server controleert poolidentiteit, prijs, liquiditeit en activiteit bij elke opslag opnieuw.Details

Pooladres uit payment-token-dex-pools. Vereist in dex-modus; weglaten in fixed-modus. De server controleert poolidentiteit, prijs, liquiditeit en activiteit bij elke opslag opnieuw.

Antwoord 200 application/json

Voorbeeldantwoord
{"data":{"asset_id":"44444444-4444-4444-8444-444444444444"}}

Antwoordvelden

dataobject
asset_idstring
Gebruiksopmerkingen
  • Selecteer na registratie asset_id in het payment-assets-eindpunt van de winkel; alleen registreren schakelt nooit een winkelmethode in.
  • Eigen en catalogustokens delen de projectlimiet van 20 tokens. Hetzelfde contract op verschillende blockchains is een ander betaalactief.
  • Bestaande cataloguscontracten geven 409 terug: gebruik catalogusregistratie om automatische marktkoersen te behouden. Een eigen tickersymbool leent nooit de prijs van een gelijknamige token.
  • Vaste prijzen zijn schattingen van de operator. Automatische DEX-prijzen zijn spotwaarnemingen uit de geselecteerde pool via DEX Screener, geen orakel dat tegen manipulatie bestand is. Winkelopslag en afronding naar boven blijven gelden, met actuele fiatkoersen. Reeds uitgegeven prijsopgaven blijven ongewijzigd.
  • Zoek voor DEX-modus eerst een pool en verstuur daarna price_mode: dex en dex_pair_address, zonder price_usd. Een gedeelde achtergrondtaak vernieuwt geselecteerde pools elke minuut. Mislukte controles of prijzen ouder dan vijf minuten verwijderen deze token uit nieuwe prijsopgaven; er is geen stille terugval naar een vaste prijs of tickersymbool.
  • Alleen standaard ERC-20- en klassieke SPL-tokens worden geaccepteerd. Token-2022/extensies en blockchains met alleen eigen munten worden afgewezen. Technische verificatie is geen beveiligingsaudit van uitgever/contract; tokens met overdrachtskosten, herbasering of zwarte lijsten kunnen onverenigbaar gedrag vertonen.
  • Gebruik een clienttime-out van minstens 60 seconden. Verificatie is begrensd en kan uitwijknodes proberen. Ongeldige invoer geeft 400 terug; mislukte blockchain-/contractcontroles 422; identiteitsconflicten of limieten 409.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETBetaalmethoden van winkel opvragen/v1/projects/{project_id}/stores/{store_id}/payment-assetsAlleen-lezen

Toont blockchainactiva in data en afzonderlijke Lightning-gereedheid in lightning. Blockchainmethoden vereisen gereedstaande blockchainwallets. Lightning gebruikt de geverifieerde externe ontvangstverbinding die in de winkel is geselecteerd, onafhankelijk van de Bitcoin-wallet op de blockchain.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MERCHANT_API_TOKEN
Acceptaanbevolenapplication/json

Padparameters

project_idUUIDvereist

Project toegewezen aan de API-referentie; mag gepauzeerd zijn.

store_idUUIDvereist

Winkel die bij project_id hoort; mag gepauzeerd zijn.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "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 }
}

Antwoordvelden

data[]object[]
assetobjectaltijd

Voor het project zichtbare eigen munt of geverifieerd tokenactief.

idUUIDaltijd

Blijvende identificatie van een betaalactief, gebruikt door project- en winkelbeleidsroutes.

asset_keystringaltijd

Canonieke identiteit van een eigen munt of contractactief in CAIP-stijl.

chain_slugstringaltijd

Wholly Crypto-blockchainidentificatie en ingesteld netwerk.

networkstringaltijd

Wholly Crypto-blockchainidentificatie en ingesteld netwerk.

caip_network_idstringaltijd

Canonieke netwerk- en activa-identiteiten.

caip_asset_idstring|nullaltijd

Canonieke netwerk- en activa-identiteiten.

asset_kindnative | tokenaltijd

Of voldoening de blockchainvaluta of een geverifieerd contract/mint gebruikt.

payment_railstringaltijd

Runtime-betaalroute: utxo, evm-native, solana-native, account-native, privacy-native of token-transfer.

symbolstringaltijd

Weergave-identiteit en exacte precisie in atomaire eenheden.

namestringaltijd

Weergave-identiteit en exacte precisie in atomaire eenheden.

decimalsintegeraltijd

Weergave-identiteit en exacte precisie in atomaire eenheden.

contract_addressstring | nullaltijd

Canoniek ERC-20-contract of SPL-mint voor tokens; null voor eigen munten.

coingecko_idstring | nullaltijd

Detectie-/prijsidentiteit. Null voor eigen contracten; leid nooit een marktprijs af van hun tickersymbool. Alleen CoinGecko-metadata maakt een token nooit selecteerbaar.

custom_tokenbooleanaltijd

Eigen contract dat op de blockchain is geverifieerd, met projectspecifieke vaste USD-prijs of prijsbepaling via een geselecteerde DEX-pool.

icon_pathpath | nullaltijd

Lokaal gecacht tokenpictogram indien beschikbaar.

token_standarderc20 | spl-token | nullaltijd

Geverifieerde runtime-tokenstandaard; null voor eigen munten.

metadata_verified_attimestamp | nullaltijd

Verificatietijd op de blockchain van metadata voor geregistreerde tokens.

payment_supportedbooleanaltijd
Registercontroles bij bouwen. scanner_ready betekent dat de betalingsscanner-runtime is geïnstalleerd; betalingsbevestiging vereist het ingestelde aantal gezonde providers met exact de juiste rol (standaard 2, optioneel 1); tijdelijke scannerbeschikbaarheid blokkeert factuuraanmaak vanaf 6.0.6 niet. balance_ready is alleen true voor geïmplementeerde saldo-adapters.Details

Registercontroles bij bouwen. scanner_ready betekent dat de betalingsscanner-runtime is geïnstalleerd; betalingsbevestiging vereist het ingestelde aantal gezonde providers met exact de juiste rol (standaard 2, optioneel 1); tijdelijke scannerbeschikbaarheid blokkeert factuuraanmaak vanaf 6.0.6 niet. balance_ready is alleen true voor geïmplementeerde saldo-adapters.

scanner_readybooleanaltijd
Registercontroles bij bouwen. scanner_ready betekent dat de betalingsscanner-runtime is geïnstalleerd; betalingsbevestiging vereist het ingestelde aantal gezonde providers met exact de juiste rol (standaard 2, optioneel 1); tijdelijke scannerbeschikbaarheid blokkeert factuuraanmaak vanaf 6.0.6 niet. balance_ready is alleen true voor geïmplementeerde saldo-adapters.Details

Registercontroles bij bouwen. scanner_ready betekent dat de betalingsscanner-runtime is geïnstalleerd; betalingsbevestiging vereist het ingestelde aantal gezonde providers met exact de juiste rol (standaard 2, optioneel 1); tijdelijke scannerbeschikbaarheid blokkeert factuuraanmaak vanaf 6.0.6 niet. balance_ready is alleen true voor geïmplementeerde saldo-adapters.

balance_readybooleanaltijd
Registercontroles bij bouwen. scanner_ready betekent dat de betalingsscanner-runtime is geïnstalleerd; betalingsbevestiging vereist het ingestelde aantal gezonde providers met exact de juiste rol (standaard 2, optioneel 1); tijdelijke scannerbeschikbaarheid blokkeert factuuraanmaak vanaf 6.0.6 niet. balance_ready is alleen true voor geïmplementeerde saldo-adapters.Details

Registercontroles bij bouwen. scanner_ready betekent dat de betalingsscanner-runtime is geïnstalleerd; betalingsbevestiging vereist het ingestelde aantal gezonde providers met exact de juiste rol (standaard 2, optioneel 1); tijdelijke scannerbeschikbaarheid blokkeert factuuraanmaak vanaf 6.0.6 niet. balance_ready is alleen true voor geïmplementeerde saldo-adapters.

default_finality_modeconfirmations | finalizedaltijd

Standaardfinaliteitsmodel dat nieuw projectbeleid overneemt.

default_required_confirmationsintegeraltijd

Standaardbeleid voor bevestiging en monitoring.

default_monitoring_minutesintegeraltijd

Standaardbeleid voor bevestiging en monitoring.

project_policyobject | nullaltijd

Bovenliggend projectbeleid.

enabledbooleanvereist

Schakelt het actief voor het project in of uit. De eigen blockchain moet vóór elke token worden ingeschakeld.

finality_modeconfirmations | finalizedvereist

Finaliteitsbeleid dat door de betaalroute van het actief wordt ondersteund. finalized vereist required_confirmations=1.

required_confirmationsintegervereist
Bitcoin- en EVM-routes accepteren nul; andere bevestigingsroutes vereisen minstens één, routes met alleen finalized vereisen precies één, en EVM-routes zijn begrensd op 0–48 zodat elke overschrijving binnen het transactieherhaalvenster blijft.Details

Bitcoin- en EVM-routes accepteren nul; andere bevestigingsroutes vereisen minstens één, routes met alleen finalized vereisen precies één, en EVM-routes zijn begrensd op 0–48 zodat elke overschrijving binnen het transactieherhaalvenster blijft.

monitoring_minutesintegervereist

Opvraagvenster van 1–10,080 minuten terwijl een factuur actief is.

late_monitoring_daysintegervereist

0–3,650 dagen monitoring na het verlopen van de factuur.

selectedbooleanaltijd
Of deze methode deel uitmaakt van de opgeslagen gewenste winkelconfiguratie. Ze wordt aangeboden wanneer projectbeleid, wallet, geïnstalleerde adapter en prijsbepaling geldig zijn. Tijdelijke scannerstoringen verwijderen haar niet uit nieuwe facturen.Details

Of deze methode deel uitmaakt van de opgeslagen gewenste winkelconfiguratie. Ze wordt aangeboden wanneer projectbeleid, wallet, geïnstalleerde adapter en prijsbepaling geldig zijn. Tijdelijke scannerstoringen verwijderen haar niet uit nieuwe facturen.

display_orderinteger | nullaltijd

Volgorde bij afrekenen in de winkel wanneer geselecteerd.

confirmation_policyobject | nullaltijd

Effectief winkelbeleid voor een in het project ingesteld actief. Null als geen projectbeleid bestaat.

finality_modeconfirmations | finalizedaltijd

Of voldoening een instelbaar aantal blokken of netwerkfinaliteit gebruikt.

project_required_confirmationsintegeraltijd

Huidige projectstandaard voor toekomstige facturen wanneer geen winkelafwijking is ingesteld.

override_required_confirmationsinteger | nullaltijd

Winkelspecifiek aantal of null om de projectstandaard over te nemen.

effective_required_confirmationsintegeraltijd

Aantal dat nieuwe facturen voor deze winkel en dit actief vastleggen.

editablebooleanaltijd

False voor netwerken met finalized waarvan het finaliteitsbeleid niet kan worden overschreven.

minimum_required_confirmationsintegeraltijd

Inclusieve blockchainspecifieke ondergrens; 0 wordt alleen aangeboden op routes die acceptatie bij detectie ondersteunen.

maximum_required_confirmationsintegeraltijd

Inclusieve blockchainspecifieke bovengrens.

walletobject | nullaltijd

Blockchainwallet gedeeld door eigen munten en tokenactiva.

idUUIDaltijd

Identificaties van wallet, eigenaarproject en eigen blockchainactief.

project_idUUIDaltijd

Identificaties van wallet, eigenaarproject en eigen blockchainactief.

native_asset_idUUIDaltijd

Identificaties van wallet, eigenaarproject en eigen blockchainactief.

chain_slugstringaltijd

Blockchain en netwerk van de wallet.

networkstringaltijd

Blockchain en netwerk van de wallet.

asset_symbolstringaltijd

Weergave-identiteit van de eigen blockchainmunt.

asset_namestringaltijd

Weergave-identiteit van de eigen blockchainmunt.

statuspending | active | disabled | erroraltijd

Operationele walletstatus.

labelstringaltijd

Operatorlabel.

public_keystring | nullaltijd

Publieke walletidentiteit; er wordt geen herstelzin of private sleutel getoond.

primary_addressstring | nullaltijd

Publieke walletidentiteit; er wordt geen herstelzin of private sleutel getoond.

derivation_schemestring | nullaltijd

Adresbeleid en -formaat.

address_formatstring | nullaltijd

Adresbeleid en -formaat.

backup_confirmed_attimestamp | nullaltijd

Niet-null nadat de operator de herstelback-up heeft bevestigd.

activation_requiredbooleanaltijd
Gedeelde XRP- en Stellar-accounts blijven niet beschikbaar totdat de operator het getoonde adres financiert en de ingestelde scannerproviders dat exacte account verifiëren. Het blijvende bewijs verloopt niet; actuele scannergezondheid wordt afzonderlijk gecontroleerd voor betalingsverificatie, niet voor factuuraanmaak.Details

Gedeelde XRP- en Stellar-accounts blijven niet beschikbaar totdat de operator het getoonde adres financiert en de ingestelde scannerproviders dat exacte account verifiëren. Het blijvende bewijs verloopt niet; actuele scannergezondheid wordt afzonderlijk gecontroleerd voor betalingsverificatie, niet voor factuuraanmaak.

activation_verified_attimestamp|nullaltijd
Gedeelde XRP- en Stellar-accounts blijven niet beschikbaar totdat de operator het getoonde adres financiert en de ingestelde scannerproviders dat exacte account verifiëren. Het blijvende bewijs verloopt niet; actuele scannergezondheid wordt afzonderlijk gecontroleerd voor betalingsverificatie, niet voor factuuraanmaak.Details

Gedeelde XRP- en Stellar-accounts blijven niet beschikbaar totdat de operator het getoonde adres financiert en de ingestelde scannerproviders dat exacte account verifiëren. Het blijvende bewijs verloopt niet; actuele scannergezondheid wordt afzonderlijk gecontroleerd voor betalingsverificatie, niet voor factuuraanmaak.

receive_readinessobject | null5.5.0+
Opgenomen in walletlijsten: ontvangstconfiguratie van het project en vereisten voor de blockchainscanner. Staat los van saldi, tokengas en verzendgereedheid. Andere walletantwoorden kunnen dit null laten.Details

Opgenomen in walletlijsten: ontvangstconfiguratie van het project en vereisten voor de blockchainscanner. Staat los van saldi, tokengas en verzendgereedheid. Andere walletantwoorden kunnen dit null laten.

readybooleanaltijd

Ontvangstconfiguratiecontroles slagen. Beschrijft geen bestedingsgereedheid, gas, saldovernieuwing of gegarandeerde toekomstige prijsopgave.

invoice_creatableboolean6.0.6+
De configuratie staat een factuurmethode toe ondanks tijdelijke scannerwaarschuwingen. Valutaprijsbepaling wordt bij aanmaak gecontroleerd. Dit is geen betalingsverificatie: ready kan false zijn terwijl invoice_creatable true is. Ontbrekende wallets, uitgeschakeld beleid en niet-ondersteunde adapters blijven veilig weigeren.Details

De configuratie staat een factuurmethode toe ondanks tijdelijke scannerwaarschuwingen. Valutaprijsbepaling wordt bij aanmaak gecontroleerd. Dit is geen betalingsverificatie: ready kan false zijn terwijl invoice_creatable true is. Ontbrekende wallets, uitgeschakeld beleid en niet-ondersteunde adapters blijven veilig weigeren.

checked_attimestampaltijd

Beoordelingstijd. Een lijst opvragen maakt geen netwerkverzoek en wijst geen adres toe.

issues[]object[]altijd
Leeg indien gereed; anders een ontvangstwaarschuwing of configuratieblokkade. Controleer invoice_creatable om tijdelijke scannerwaarschuwingen van factuurconfiguratiefouten te onderscheiden.Details

Leeg indien gereed; anders een ontvangstwaarschuwing of configuratieblokkade. Controleer invoice_creatable om tijdelijke scannerwaarschuwingen van factuurconfiguratiefouten te onderscheiden.

chain_slugstringindien bekend

Identificeert de betrokken blockchain en het actief. Lightning kan asset_id weglaten.

asset_idUUIDindien bekend

Identificeert de betrokken blockchain en het actief. Lightning kan asset_id weglaten.

asset_tickerstringindien bekend

Identificeert de betrokken blockchain en het actief. Lightning kan asset_id weglaten.

reason_codestringaltijd
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 of asset_not_accepted.Details

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 of asset_not_accepted.

messagestringindien beschikbaar
Uitleg voor de handelaar en actie-identificatie: chain_connections, wallets, rates, payment_methods, project_settings of store_settings. Geen inloggegevens of private provider-URL's.Details

Uitleg voor de handelaar en actie-identificatie: chain_connections, wallets, rates, payment_methods, project_settings of store_settings. Geen inloggegevens of private provider-URL's.

actionstringindien beschikbaar
Uitleg voor de handelaar en actie-identificatie: chain_connections, wallets, rates, payment_methods, project_settings of store_settings. Geen inloggegevens of private provider-URL's.Details

Uitleg voor de handelaar en actie-identificatie: chain_connections, wallets, rates, payment_methods, project_settings of store_settings. Geen inloggegevens of private provider-URL's.

required_endpoint_rolestring | nullop de blockchain
Voorkeursrol van de scanner-API (verouderd veld). Gebruik accepted_endpoint_roles voor de volledige compatibiliteitslijst. Een gezonde node alleen bewijst geen ondersteuning voor betalingsgeschiedenis.Details

Voorkeursrol van de scanner-API (verouderd veld). Gebruik accepted_endpoint_roles voor de volledige compatibiliteitslijst. Een gezonde node alleen bewijst geen ondersteuning voor betalingsgeschiedenis.

accepted_endpoint_roles[]string[] | nullop de blockchain
Compatibele API-dialecten, geen bewijs van eindpuntgeschiedenis of capaciteit. Ruwe node-rpc ondersteunt BTC/BCH/LTC/DOGE/DASH en transparante ZEC (volledig gedecodeerde blokken, 1–48 bevestigingen), definitief bevestigde eigen TRX, eigen ALGO via algod, XTZ via Octez, definitief bevestigde Asset Hub DOT via SCALE-metadata en eigen XLM via Stellar RPC met factuurmemo-ID. Gesnoeide of onvolledige geschiedenis voldoet niet. Deze ruwe adapters voegen geen tokenroutes toe. Geïndexeerde API's blijven alternatieven; zie de tabel met betaalroutes hieronder. Gemengde ruwe/geïndexeerde bronnen verifiëren begrensde vensters onafhankelijk; de standaard blijft twee onafhankelijke providers, geen aliassen van één operator. Alleen nodehoogte, ORDnet-blockchaininformatie en een EVM-relay voor een niet-EVM-route zijn geen ontvangstbewijzen. Monero vereist nog steeds een aan het project gekoppelde wallet-RPC met alleen inzagerechten.Details

Compatibele API-dialecten, geen bewijs van eindpuntgeschiedenis of capaciteit. Ruwe node-rpc ondersteunt BTC/BCH/LTC/DOGE/DASH en transparante ZEC (volledig gedecodeerde blokken, 1–48 bevestigingen), definitief bevestigde eigen TRX, eigen ALGO via algod, XTZ via Octez, definitief bevestigde Asset Hub DOT via SCALE-metadata en eigen XLM via Stellar RPC met factuurmemo-ID. Gesnoeide of onvolledige geschiedenis voldoet niet. Deze ruwe adapters voegen geen tokenroutes toe. Geïndexeerde API's blijven alternatieven; zie de tabel met betaalroutes hieronder. Gemengde ruwe/geïndexeerde bronnen verifiëren begrensde vensters onafhankelijk; de standaard blijft twee onafhankelijke providers, geen aliassen van één operator. Alleen nodehoogte, ORDnet-blockchaininformatie en een EVM-relay voor een niet-EVM-route zijn geen ontvangstbewijzen. Monero vereist nog steeds een aan het project gekoppelde wallet-RPC met alleen inzagerechten.

healthy_endpointsintegerop de blockchain

Gezonde overeenkomende eindpunten, niet het aantal onafhankelijke providers.

usable_independent_providersintegerop de blockchain
Bruikbare verificatieplaatsen, begrensd op twee. required_independent_providers is de blockchaininstelling: standaard 2, of 1 na expliciete keuze door een beheerder. In de modus met twee providers zijn verschillende providersleutels EN hosts vereist. Uitgeschakelde, verouderde (ouder dan tien minuten) of afkoelende bronnen vullen geen plaats. Lightning gebruikt eigen verbindingsregels.Details

Bruikbare verificatieplaatsen, begrensd op twee. required_independent_providers is de blockchaininstelling: standaard 2, of 1 na expliciete keuze door een beheerder. In de modus met twee providers zijn verschillende providersleutels EN hosts vereist. Uitgeschakelde, verouderde (ouder dan tien minuten) of afkoelende bronnen vullen geen plaats. Lightning gebruikt eigen verbindingsregels.

required_independent_providersintegerop de blockchain
Bruikbare verificatieplaatsen, begrensd op twee. required_independent_providers is de blockchaininstelling: standaard 2, of 1 na expliciete keuze door een beheerder. In de modus met twee providers zijn verschillende providersleutels EN hosts vereist. Uitgeschakelde, verouderde (ouder dan tien minuten) of afkoelende bronnen vullen geen plaats. Lightning gebruikt eigen verbindingsregels.Details

Bruikbare verificatieplaatsen, begrensd op twee. required_independent_providers is de blockchaininstelling: standaard 2, of 1 na expliciete keuze door een beheerder. In de modus met twee providers zijn verschillende providersleutels EN hosts vereist. Uitgeschakelde, verouderde (ouder dan tien minuten) of afkoelende bronnen vullen geen plaats. Lightning gebruikt eigen verbindingsregels.

last_checked_attimestamp | nullop de blockchain

Laatste gezondheidscontrole van een overeenkomend eindpunt, los van de beoordelingstijd.

monero_wallet_rpcMoneroWalletRpcBinding | nullaltijd
Geschoonde externe wallet-RPC-koppelingsstatus met alleen inzagerechten voor Monero. Bevat eindpunt, authenticatiemodus, primair account-0-adres, technische bewijsvlaggen/-hoogtes en tijdstempels van operatorverklaringen; inloggegevens, walletsleutels en walletbestanden worden nooit geserialiseerd.Details

Geschoonde externe wallet-RPC-koppelingsstatus met alleen inzagerechten voor Monero. Bevat eindpunt, authenticatiemodus, primair account-0-adres, technische bewijsvlaggen/-hoogtes en tijdstempels van operatorverklaringen; inloggegevens, walletsleutels en walletbestanden worden nooit geserialiseerd.

last_secret_revealed_attimestamp|nullaltijd

Auditmetadata over het tonen van geheimen aan de consolekant.

secret_reveal_countintegeraltijd

Auditmetadata over het tonen van geheimen aan de consolekant.

next_receive_indexintegeraltijd

Volgende gereserveerde index van een onderliggend adres.

last_scanned_heightinteger|nullaltijd

Walletscannerstatus.

last_scanned_attimestamp|nullaltijd

Walletscannerstatus.

last_errorstring|nullaltijd

Walletscannerstatus.

balances[]object[]altijd
Gecachte saldi voor elk van de 30 eigen blockchainroutes, plus geverifieerde ERC-20- en SPL-activa. Voor Monero is een ingestelde externe wallet-RPC met alleen inzagerechten vereist.Details

Gecachte saldi voor elk van de 30 eigen blockchainroutes, plus geverifieerde ERC-20- en SPL-activa. Voor Monero is een ingestelde externe wallet-RPC met alleen inzagerechten vereist.

wallet_idUUIDaltijd

Walletidentiteit en blijvende activa-identiteiten.

asset_idUUIDaltijd

Walletidentiteit en blijvende activa-identiteiten.

project_enabledbooleanaltijd

Of dit actief momenteel is ingeschakeld volgens het activabeleid van het project.

active_store_countintegeraltijd

Aantal ingeschakelde winkels dat dit actief momenteel selecteert. Dit is een weergave van acceptatie; alleen-lezen saldoregistratie blijft onafhankelijk.

active_store_ids[]UUID[]altijd

Ingeschakelde winkels in dit project die het actief momenteel accepteren. Dit maakt exact lokaal filteren op winkel mogelijk zonder extra API-verzoek.

tracking_activebooleanaltijd
Of deze leesbare wallet en het geregistreerde actief op dezelfde blockchain in aanmerking komen voor saldovernieuwing op de achtergrond. Schakelaars voor project- en betaalmethodeacceptatie pauzeren alleen-lezen registratie niet.Details

Of deze leesbare wallet en het geregistreerde actief op dezelfde blockchain in aanmerking komen voor saldovernieuwing op de achtergrond. Schakelaars voor project- en betaalmethodeacceptatie pauzeren alleen-lezen registratie niet.

asset_kindnative | tokenaltijd

Eigen valuta of geverifieerd contract-/mintactief.

contract_addressstring | nullaltijd

Tokencontract of mint; null voor eigen valuta.

symbolstringaltijd

Weergave-identiteit en atomaire precisie.

namestringaltijd

Weergave-identiteit en atomaire precisie.

decimalsintegeraltijd

Weergave-identiteit en atomaire precisie.

coingecko_idstring | nullaltijd

Prijsidentiteit indien gekoppeld.

balancedecimal string|nullaltijd

Exact weergegeven en atomair saldo over het primaire walletadres en uitgegeven factuuradressen. Null zolang geen volledige waarde beschikbaar is.

balance_atomicinteger string|nullaltijd

Exact weergegeven en atomair saldo over het primaire walletadres en uitgegeven factuuradressen. Null zolang geen volledige waarde beschikbaar is.

price_usddecimal string | nullaltijd

Indicatieve gecachte USD-eenheidsprijs voor waardering.

value_usddecimal string | nullaltijd

Indicatieve fiatwaardering wanneer een actuele koers bestaat.

statuspending | refreshing | fresh | stale | erroraltijd
Gecachte scanstatus. refreshing kan een voltooid saldo behouden: gebruik checked_at voor de ouderdom. Pending betekent dat er geen voltooide momentopname is. Geen van deze statussen bewijst dat een overschrijving openstaat of een factuur is voldaan.Details

Gecachte scanstatus. refreshing kan een voltooid saldo behouden: gebruik checked_at voor de ouderdom. Pending betekent dat er geen voltooide momentopname is. Geen van deze statussen bewijst dat een overschrijving openstaat of een factuur is voldaan.

checked_attimestamp | nullaltijd

Tijdstip dat door een voltooide saldoscan wordt weergegeven.

last_errorstring | nullaltijd

Veilige operatordiagnostiek.

total_value_usddecimal string | nullaltijd

Indicatieve som van saldi met een actuele USD-prijs.

balance_statuspending | refreshing | fresh | stale | error | unknownaltijd

Samengevoegde cache-actualiteit; unknown is een defensieve terugval en geen van deze statussen bewijst factuurvoldoening.

balance_checked_attimestamp | nullaltijd

Oudste relevante succesvolle saldocontrole die in het totaal is vertegenwoordigd.

recent_payments[]object[]altijd

Maximaal drie nieuwste geldige waarnemingen met status detected, confirming of final die aan precies deze wallet zijn toegewezen.

invoice_public_idUUIDaltijd

Factuuridentiteit voor de klant die bij de waarneming hoort.

chain_slugstringaltijd

Blockchain en weergavesymbool van eigen munt of geverifieerde token.

symbolstringaltijd

Blockchain en weergavesymbool van eigen munt of geverifieerde token.

transaction_idstringaltijd

Canonieke transactie- en overschrijvingsgebeurtenisidentiteit.

event_indexintegeraltijd

Canonieke transactie- en overschrijvingsgebeurtenisidentiteit.

amountdecimal stringaltijd

Exact waargenomen activabedrag zonder omzetting naar drijvendekommagetallen.

statusdetected | confirming | finalaltijd

Huidige geldige waarnemingsstatus. Gereorganiseerde, vervangen en ongeldige waarnemingen worden uitgesloten.

confirmationsintegeraltijd

Laatst waargenomen aantal bevestigingen.

observed_atRFC 3339 timestampaltijd

Tijdstip waarop Wholly Crypto de betaling voor het eerst waarnam.

created_atRFC 3339 timestampaltijd

Aanmaaktijd en laatste bijwerktijd van de wallet.

updated_atRFC 3339 timestampaltijd

Aanmaaktijd en laatste bijwerktijd van de wallet.

wallet_readinessreadiness enumaltijd

Alleen wallet-/beleidsstatus; gebruik receive_readiness voor scannervereisten.

receive_readinessobject | null5.5.0+
Gedeelde ontvangstconfiguratie plus winkelacceptatie. Gebruikt gecachte waarnemingen; geen reservering of garantie. Aanmaak controleert vereisten en de werkelijke factuurwisselkoers opnieuw.Details

Gedeelde ontvangstconfiguratie plus winkelacceptatie. Gebruikt gecachte waarnemingen; geen reservering of garantie. Aanmaak controleert vereisten en de werkelijke factuurwisselkoers opnieuw.

readybooleanaltijd

Ontvangstconfiguratiecontroles slagen. Beschrijft geen bestedingsgereedheid, gas, saldovernieuwing of gegarandeerde toekomstige prijsopgave.

invoice_creatableboolean6.0.6+
De configuratie staat een factuurmethode toe ondanks tijdelijke scannerwaarschuwingen. Valutaprijsbepaling wordt bij aanmaak gecontroleerd. Dit is geen betalingsverificatie: ready kan false zijn terwijl invoice_creatable true is. Ontbrekende wallets, uitgeschakeld beleid en niet-ondersteunde adapters blijven veilig weigeren.Details

De configuratie staat een factuurmethode toe ondanks tijdelijke scannerwaarschuwingen. Valutaprijsbepaling wordt bij aanmaak gecontroleerd. Dit is geen betalingsverificatie: ready kan false zijn terwijl invoice_creatable true is. Ontbrekende wallets, uitgeschakeld beleid en niet-ondersteunde adapters blijven veilig weigeren.

checked_attimestampaltijd

Beoordelingstijd. Een lijst opvragen maakt geen netwerkverzoek en wijst geen adres toe.

issues[]object[]altijd
Leeg indien gereed; anders een ontvangstwaarschuwing of configuratieblokkade. Controleer invoice_creatable om tijdelijke scannerwaarschuwingen van factuurconfiguratiefouten te onderscheiden.Details

Leeg indien gereed; anders een ontvangstwaarschuwing of configuratieblokkade. Controleer invoice_creatable om tijdelijke scannerwaarschuwingen van factuurconfiguratiefouten te onderscheiden.

chain_slugstringindien bekend

Identificeert de betrokken blockchain en het actief. Lightning kan asset_id weglaten.

asset_idUUIDindien bekend

Identificeert de betrokken blockchain en het actief. Lightning kan asset_id weglaten.

asset_tickerstringindien bekend

Identificeert de betrokken blockchain en het actief. Lightning kan asset_id weglaten.

reason_codestringaltijd
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 of asset_not_accepted.Details

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 of asset_not_accepted.

messagestringindien beschikbaar
Uitleg voor de handelaar en actie-identificatie: chain_connections, wallets, rates, payment_methods, project_settings of store_settings. Geen inloggegevens of private provider-URL's.Details

Uitleg voor de handelaar en actie-identificatie: chain_connections, wallets, rates, payment_methods, project_settings of store_settings. Geen inloggegevens of private provider-URL's.

actionstringindien beschikbaar
Uitleg voor de handelaar en actie-identificatie: chain_connections, wallets, rates, payment_methods, project_settings of store_settings. Geen inloggegevens of private provider-URL's.Details

Uitleg voor de handelaar en actie-identificatie: chain_connections, wallets, rates, payment_methods, project_settings of store_settings. Geen inloggegevens of private provider-URL's.

required_endpoint_rolestring | nullop de blockchain
Voorkeursrol van de scanner-API (verouderd veld). Gebruik accepted_endpoint_roles voor de volledige compatibiliteitslijst. Een gezonde node alleen bewijst geen ondersteuning voor betalingsgeschiedenis.Details

Voorkeursrol van de scanner-API (verouderd veld). Gebruik accepted_endpoint_roles voor de volledige compatibiliteitslijst. Een gezonde node alleen bewijst geen ondersteuning voor betalingsgeschiedenis.

accepted_endpoint_roles[]string[] | nullop de blockchain
Compatibele API-dialecten, geen bewijs van eindpuntgeschiedenis of capaciteit. Ruwe node-rpc ondersteunt BTC/BCH/LTC/DOGE/DASH en transparante ZEC (volledig gedecodeerde blokken, 1–48 bevestigingen), definitief bevestigde eigen TRX, eigen ALGO via algod, XTZ via Octez, definitief bevestigde Asset Hub DOT via SCALE-metadata en eigen XLM via Stellar RPC met factuurmemo-ID. Gesnoeide of onvolledige geschiedenis voldoet niet. Deze ruwe adapters voegen geen tokenroutes toe. Geïndexeerde API's blijven alternatieven; zie de tabel met betaalroutes hieronder. Gemengde ruwe/geïndexeerde bronnen verifiëren begrensde vensters onafhankelijk; de standaard blijft twee onafhankelijke providers, geen aliassen van één operator. Alleen nodehoogte, ORDnet-blockchaininformatie en een EVM-relay voor een niet-EVM-route zijn geen ontvangstbewijzen. Monero vereist nog steeds een aan het project gekoppelde wallet-RPC met alleen inzagerechten.Details

Compatibele API-dialecten, geen bewijs van eindpuntgeschiedenis of capaciteit. Ruwe node-rpc ondersteunt BTC/BCH/LTC/DOGE/DASH en transparante ZEC (volledig gedecodeerde blokken, 1–48 bevestigingen), definitief bevestigde eigen TRX, eigen ALGO via algod, XTZ via Octez, definitief bevestigde Asset Hub DOT via SCALE-metadata en eigen XLM via Stellar RPC met factuurmemo-ID. Gesnoeide of onvolledige geschiedenis voldoet niet. Deze ruwe adapters voegen geen tokenroutes toe. Geïndexeerde API's blijven alternatieven; zie de tabel met betaalroutes hieronder. Gemengde ruwe/geïndexeerde bronnen verifiëren begrensde vensters onafhankelijk; de standaard blijft twee onafhankelijke providers, geen aliassen van één operator. Alleen nodehoogte, ORDnet-blockchaininformatie en een EVM-relay voor een niet-EVM-route zijn geen ontvangstbewijzen. Monero vereist nog steeds een aan het project gekoppelde wallet-RPC met alleen inzagerechten.

healthy_endpointsintegerop de blockchain

Gezonde overeenkomende eindpunten, niet het aantal onafhankelijke providers.

usable_independent_providersintegerop de blockchain
Bruikbare verificatieplaatsen, begrensd op twee. required_independent_providers is de blockchaininstelling: standaard 2, of 1 na expliciete keuze door een beheerder. In de modus met twee providers zijn verschillende providersleutels EN hosts vereist. Uitgeschakelde, verouderde (ouder dan tien minuten) of afkoelende bronnen vullen geen plaats. Lightning gebruikt eigen verbindingsregels.Details

Bruikbare verificatieplaatsen, begrensd op twee. required_independent_providers is de blockchaininstelling: standaard 2, of 1 na expliciete keuze door een beheerder. In de modus met twee providers zijn verschillende providersleutels EN hosts vereist. Uitgeschakelde, verouderde (ouder dan tien minuten) of afkoelende bronnen vullen geen plaats. Lightning gebruikt eigen verbindingsregels.

required_independent_providersintegerop de blockchain
Bruikbare verificatieplaatsen, begrensd op twee. required_independent_providers is de blockchaininstelling: standaard 2, of 1 na expliciete keuze door een beheerder. In de modus met twee providers zijn verschillende providersleutels EN hosts vereist. Uitgeschakelde, verouderde (ouder dan tien minuten) of afkoelende bronnen vullen geen plaats. Lightning gebruikt eigen verbindingsregels.Details

Bruikbare verificatieplaatsen, begrensd op twee. required_independent_providers is de blockchaininstelling: standaard 2, of 1 na expliciete keuze door een beheerder. In de modus met twee providers zijn verschillende providersleutels EN hosts vereist. Uitgeschakelde, verouderde (ouder dan tien minuten) of afkoelende bronnen vullen geen plaats. Lightning gebruikt eigen verbindingsregels.

last_checked_attimestamp | nullop de blockchain

Laatste gezondheidscontrole van een overeenkomend eindpunt, los van de beoordelingstijd.

lightningobject
payment_railstring
symbolstring
asset_decimalsinteger
enabledboolean
readyboolean
Gebruiksopmerkingen
  • selected is blockchainconfiguratie; wallet_readiness bepaalt de actuele geschiktheid.
  • Het antwoordveld lightning bevat payment_rail: lightning, symbol: BTC, asset_decimals: 11, enabled en ready. Het bevat nooit node-inloggegevens. Configureer deze methode in de winkelconsole; de assets-array bijwerken verandert Lightning niet.
  • confirmation_policy geldt alleen voor blockchainmethoden. Lightning wordt zonder blokbevestigingen voldaan en vereist het volledige BOLT11-bedrag, zonder tolerantie voor deelbetalingen.
  • Methoden voor eigen munten en tokens op één blockchain gebruiken dezelfde factuurbestemming voor die blockchainwallet.
  • Ingesloten walletsamenvattingen tonen alleen gereedheid en houden saldi leeg; gebruik de afzonderlijke route voor projectwallets voor actuele waarden.

Fouten

Foutcodes & regels voor nieuwe pogingen

PUTBetaalmethoden van winkel vervangen/v1/projects/{project_id}/stores/{store_id}/payment-assetsLezen + schrijven

Vervangt atomair de volledige geordende selectie van activa van de winkel en geeft de vernieuwde lijst terug. Weggelaten activa worden gedeselecteerd.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MERCHANT_API_TOKEN
Content-Typevereistapplication/json
Acceptaanbevolenapplication/json

Padparameters

project_idUUIDvereist

Project toegewezen aan de API-referentie; mag gepauzeerd zijn.

store_idUUIDvereist

Winkel die bij project_id hoort; mag gepauzeerd zijn.

Verzoek

: "${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
    }
  ]
}'

Requestbody

assets[]object[]vereist

Volledige vervangingslijst, maximaal 64 vermeldingen. Elke vermelding bevat een unieke asset_id en unieke display_order van 0 tot en met 10,000.

asset_idUUIDvereist
display_orderintegeroptioneel

Antwoord 200 application/json

Voorbeeldantwoord
{
  "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" }
  ]
}

Antwoordvelden

data[]object[]
assetobjectaltijd

Voor het project zichtbare eigen munt of geverifieerd tokenactief.

idUUIDaltijd

Blijvende identificatie van een betaalactief, gebruikt door project- en winkelbeleidsroutes.

asset_keystringaltijd

Canonieke identiteit van een eigen munt of contractactief in CAIP-stijl.

chain_slugstringaltijd

Wholly Crypto-blockchainidentificatie en ingesteld netwerk.

networkstringaltijd

Wholly Crypto-blockchainidentificatie en ingesteld netwerk.

caip_network_idstringaltijd

Canonieke netwerk- en activa-identiteiten.

caip_asset_idstring|nullaltijd

Canonieke netwerk- en activa-identiteiten.

asset_kindnative | tokenaltijd

Of voldoening de blockchainvaluta of een geverifieerd contract/mint gebruikt.

payment_railstringaltijd

Runtime-betaalroute: utxo, evm-native, solana-native, account-native, privacy-native of token-transfer.

symbolstringaltijd

Weergave-identiteit en exacte precisie in atomaire eenheden.

namestringaltijd

Weergave-identiteit en exacte precisie in atomaire eenheden.

decimalsintegeraltijd

Weergave-identiteit en exacte precisie in atomaire eenheden.

contract_addressstring | nullaltijd

Canoniek ERC-20-contract of SPL-mint voor tokens; null voor eigen munten.

coingecko_idstring | nullaltijd

Detectie-/prijsidentiteit. Null voor eigen contracten; leid nooit een marktprijs af van hun tickersymbool. Alleen CoinGecko-metadata maakt een token nooit selecteerbaar.

custom_tokenbooleanaltijd

Eigen contract dat op de blockchain is geverifieerd, met projectspecifieke vaste USD-prijs of prijsbepaling via een geselecteerde DEX-pool.

icon_pathpath | nullaltijd

Lokaal gecacht tokenpictogram indien beschikbaar.

token_standarderc20 | spl-token | nullaltijd

Geverifieerde runtime-tokenstandaard; null voor eigen munten.

metadata_verified_attimestamp | nullaltijd

Verificatietijd op de blockchain van metadata voor geregistreerde tokens.

payment_supportedbooleanaltijd
Registercontroles bij bouwen. scanner_ready betekent dat de betalingsscanner-runtime is geïnstalleerd; betalingsbevestiging vereist het ingestelde aantal gezonde providers met exact de juiste rol (standaard 2, optioneel 1); tijdelijke scannerbeschikbaarheid blokkeert factuuraanmaak vanaf 6.0.6 niet. balance_ready is alleen true voor geïmplementeerde saldo-adapters.Details

Registercontroles bij bouwen. scanner_ready betekent dat de betalingsscanner-runtime is geïnstalleerd; betalingsbevestiging vereist het ingestelde aantal gezonde providers met exact de juiste rol (standaard 2, optioneel 1); tijdelijke scannerbeschikbaarheid blokkeert factuuraanmaak vanaf 6.0.6 niet. balance_ready is alleen true voor geïmplementeerde saldo-adapters.

scanner_readybooleanaltijd
Registercontroles bij bouwen. scanner_ready betekent dat de betalingsscanner-runtime is geïnstalleerd; betalingsbevestiging vereist het ingestelde aantal gezonde providers met exact de juiste rol (standaard 2, optioneel 1); tijdelijke scannerbeschikbaarheid blokkeert factuuraanmaak vanaf 6.0.6 niet. balance_ready is alleen true voor geïmplementeerde saldo-adapters.Details

Registercontroles bij bouwen. scanner_ready betekent dat de betalingsscanner-runtime is geïnstalleerd; betalingsbevestiging vereist het ingestelde aantal gezonde providers met exact de juiste rol (standaard 2, optioneel 1); tijdelijke scannerbeschikbaarheid blokkeert factuuraanmaak vanaf 6.0.6 niet. balance_ready is alleen true voor geïmplementeerde saldo-adapters.

balance_readybooleanaltijd
Registercontroles bij bouwen. scanner_ready betekent dat de betalingsscanner-runtime is geïnstalleerd; betalingsbevestiging vereist het ingestelde aantal gezonde providers met exact de juiste rol (standaard 2, optioneel 1); tijdelijke scannerbeschikbaarheid blokkeert factuuraanmaak vanaf 6.0.6 niet. balance_ready is alleen true voor geïmplementeerde saldo-adapters.Details

Registercontroles bij bouwen. scanner_ready betekent dat de betalingsscanner-runtime is geïnstalleerd; betalingsbevestiging vereist het ingestelde aantal gezonde providers met exact de juiste rol (standaard 2, optioneel 1); tijdelijke scannerbeschikbaarheid blokkeert factuuraanmaak vanaf 6.0.6 niet. balance_ready is alleen true voor geïmplementeerde saldo-adapters.

default_finality_modeconfirmations | finalizedaltijd

Standaardfinaliteitsmodel dat nieuw projectbeleid overneemt.

default_required_confirmationsintegeraltijd

Standaardbeleid voor bevestiging en monitoring.

default_monitoring_minutesintegeraltijd

Standaardbeleid voor bevestiging en monitoring.

project_policyobject | nullaltijd

Bovenliggend projectbeleid.

enabledbooleanvereist

Schakelt het actief voor het project in of uit. De eigen blockchain moet vóór elke token worden ingeschakeld.

finality_modeconfirmations | finalizedvereist

Finaliteitsbeleid dat door de betaalroute van het actief wordt ondersteund. finalized vereist required_confirmations=1.

required_confirmationsintegervereist
Bitcoin- en EVM-routes accepteren nul; andere bevestigingsroutes vereisen minstens één, routes met alleen finalized vereisen precies één, en EVM-routes zijn begrensd op 0–48 zodat elke overschrijving binnen het transactieherhaalvenster blijft.Details

Bitcoin- en EVM-routes accepteren nul; andere bevestigingsroutes vereisen minstens één, routes met alleen finalized vereisen precies één, en EVM-routes zijn begrensd op 0–48 zodat elke overschrijving binnen het transactieherhaalvenster blijft.

monitoring_minutesintegervereist

Opvraagvenster van 1–10,080 minuten terwijl een factuur actief is.

late_monitoring_daysintegervereist

0–3,650 dagen monitoring na het verlopen van de factuur.

selectedbooleanaltijd
Of deze methode deel uitmaakt van de opgeslagen gewenste winkelconfiguratie. Ze wordt aangeboden wanneer projectbeleid, wallet, geïnstalleerde adapter en prijsbepaling geldig zijn. Tijdelijke scannerstoringen verwijderen haar niet uit nieuwe facturen.Details

Of deze methode deel uitmaakt van de opgeslagen gewenste winkelconfiguratie. Ze wordt aangeboden wanneer projectbeleid, wallet, geïnstalleerde adapter en prijsbepaling geldig zijn. Tijdelijke scannerstoringen verwijderen haar niet uit nieuwe facturen.

display_orderinteger | nullaltijd

Volgorde bij afrekenen in de winkel wanneer geselecteerd.

confirmation_policyobject | nullaltijd

Effectief winkelbeleid voor een in het project ingesteld actief. Null als geen projectbeleid bestaat.

finality_modeconfirmations | finalizedaltijd

Of voldoening een instelbaar aantal blokken of netwerkfinaliteit gebruikt.

project_required_confirmationsintegeraltijd

Huidige projectstandaard voor toekomstige facturen wanneer geen winkelafwijking is ingesteld.

override_required_confirmationsinteger | nullaltijd

Winkelspecifiek aantal of null om de projectstandaard over te nemen.

effective_required_confirmationsintegeraltijd

Aantal dat nieuwe facturen voor deze winkel en dit actief vastleggen.

editablebooleanaltijd

False voor netwerken met finalized waarvan het finaliteitsbeleid niet kan worden overschreven.

minimum_required_confirmationsintegeraltijd

Inclusieve blockchainspecifieke ondergrens; 0 wordt alleen aangeboden op routes die acceptatie bij detectie ondersteunen.

maximum_required_confirmationsintegeraltijd

Inclusieve blockchainspecifieke bovengrens.

walletobject | nullaltijd

Blockchainwallet gedeeld door eigen munten en tokenactiva.

idUUIDaltijd

Identificaties van wallet, eigenaarproject en eigen blockchainactief.

project_idUUIDaltijd

Identificaties van wallet, eigenaarproject en eigen blockchainactief.

native_asset_idUUIDaltijd

Identificaties van wallet, eigenaarproject en eigen blockchainactief.

chain_slugstringaltijd

Blockchain en netwerk van de wallet.

networkstringaltijd

Blockchain en netwerk van de wallet.

asset_symbolstringaltijd

Weergave-identiteit van de eigen blockchainmunt.

asset_namestringaltijd

Weergave-identiteit van de eigen blockchainmunt.

statuspending | active | disabled | erroraltijd

Operationele walletstatus.

labelstringaltijd

Operatorlabel.

public_keystring | nullaltijd

Publieke walletidentiteit; er wordt geen herstelzin of private sleutel getoond.

primary_addressstring | nullaltijd

Publieke walletidentiteit; er wordt geen herstelzin of private sleutel getoond.

derivation_schemestring | nullaltijd

Adresbeleid en -formaat.

address_formatstring | nullaltijd

Adresbeleid en -formaat.

backup_confirmed_attimestamp | nullaltijd

Niet-null nadat de operator de herstelback-up heeft bevestigd.

activation_requiredbooleanaltijd
Gedeelde XRP- en Stellar-accounts blijven niet beschikbaar totdat de operator het getoonde adres financiert en de ingestelde scannerproviders dat exacte account verifiëren. Het blijvende bewijs verloopt niet; actuele scannergezondheid wordt afzonderlijk gecontroleerd voor betalingsverificatie, niet voor factuuraanmaak.Details

Gedeelde XRP- en Stellar-accounts blijven niet beschikbaar totdat de operator het getoonde adres financiert en de ingestelde scannerproviders dat exacte account verifiëren. Het blijvende bewijs verloopt niet; actuele scannergezondheid wordt afzonderlijk gecontroleerd voor betalingsverificatie, niet voor factuuraanmaak.

activation_verified_attimestamp|nullaltijd
Gedeelde XRP- en Stellar-accounts blijven niet beschikbaar totdat de operator het getoonde adres financiert en de ingestelde scannerproviders dat exacte account verifiëren. Het blijvende bewijs verloopt niet; actuele scannergezondheid wordt afzonderlijk gecontroleerd voor betalingsverificatie, niet voor factuuraanmaak.Details

Gedeelde XRP- en Stellar-accounts blijven niet beschikbaar totdat de operator het getoonde adres financiert en de ingestelde scannerproviders dat exacte account verifiëren. Het blijvende bewijs verloopt niet; actuele scannergezondheid wordt afzonderlijk gecontroleerd voor betalingsverificatie, niet voor factuuraanmaak.

receive_readinessobject | null5.5.0+
Opgenomen in walletlijsten: ontvangstconfiguratie van het project en vereisten voor de blockchainscanner. Staat los van saldi, tokengas en verzendgereedheid. Andere walletantwoorden kunnen dit null laten.Details

Opgenomen in walletlijsten: ontvangstconfiguratie van het project en vereisten voor de blockchainscanner. Staat los van saldi, tokengas en verzendgereedheid. Andere walletantwoorden kunnen dit null laten.

readybooleanaltijd

Ontvangstconfiguratiecontroles slagen. Beschrijft geen bestedingsgereedheid, gas, saldovernieuwing of gegarandeerde toekomstige prijsopgave.

invoice_creatableboolean6.0.6+
De configuratie staat een factuurmethode toe ondanks tijdelijke scannerwaarschuwingen. Valutaprijsbepaling wordt bij aanmaak gecontroleerd. Dit is geen betalingsverificatie: ready kan false zijn terwijl invoice_creatable true is. Ontbrekende wallets, uitgeschakeld beleid en niet-ondersteunde adapters blijven veilig weigeren.Details

De configuratie staat een factuurmethode toe ondanks tijdelijke scannerwaarschuwingen. Valutaprijsbepaling wordt bij aanmaak gecontroleerd. Dit is geen betalingsverificatie: ready kan false zijn terwijl invoice_creatable true is. Ontbrekende wallets, uitgeschakeld beleid en niet-ondersteunde adapters blijven veilig weigeren.

checked_attimestampaltijd

Beoordelingstijd. Een lijst opvragen maakt geen netwerkverzoek en wijst geen adres toe.

issues[]object[]altijd
Leeg indien gereed; anders een ontvangstwaarschuwing of configuratieblokkade. Controleer invoice_creatable om tijdelijke scannerwaarschuwingen van factuurconfiguratiefouten te onderscheiden.Details

Leeg indien gereed; anders een ontvangstwaarschuwing of configuratieblokkade. Controleer invoice_creatable om tijdelijke scannerwaarschuwingen van factuurconfiguratiefouten te onderscheiden.

chain_slugstringindien bekend

Identificeert de betrokken blockchain en het actief. Lightning kan asset_id weglaten.

asset_idUUIDindien bekend

Identificeert de betrokken blockchain en het actief. Lightning kan asset_id weglaten.

asset_tickerstringindien bekend

Identificeert de betrokken blockchain en het actief. Lightning kan asset_id weglaten.

reason_codestringaltijd
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 of asset_not_accepted.Details

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 of asset_not_accepted.

messagestringindien beschikbaar
Uitleg voor de handelaar en actie-identificatie: chain_connections, wallets, rates, payment_methods, project_settings of store_settings. Geen inloggegevens of private provider-URL's.Details

Uitleg voor de handelaar en actie-identificatie: chain_connections, wallets, rates, payment_methods, project_settings of store_settings. Geen inloggegevens of private provider-URL's.

actionstringindien beschikbaar
Uitleg voor de handelaar en actie-identificatie: chain_connections, wallets, rates, payment_methods, project_settings of store_settings. Geen inloggegevens of private provider-URL's.Details

Uitleg voor de handelaar en actie-identificatie: chain_connections, wallets, rates, payment_methods, project_settings of store_settings. Geen inloggegevens of private provider-URL's.

required_endpoint_rolestring | nullop de blockchain
Voorkeursrol van de scanner-API (verouderd veld). Gebruik accepted_endpoint_roles voor de volledige compatibiliteitslijst. Een gezonde node alleen bewijst geen ondersteuning voor betalingsgeschiedenis.Details

Voorkeursrol van de scanner-API (verouderd veld). Gebruik accepted_endpoint_roles voor de volledige compatibiliteitslijst. Een gezonde node alleen bewijst geen ondersteuning voor betalingsgeschiedenis.

accepted_endpoint_roles[]string[] | nullop de blockchain
Compatibele API-dialecten, geen bewijs van eindpuntgeschiedenis of capaciteit. Ruwe node-rpc ondersteunt BTC/BCH/LTC/DOGE/DASH en transparante ZEC (volledig gedecodeerde blokken, 1–48 bevestigingen), definitief bevestigde eigen TRX, eigen ALGO via algod, XTZ via Octez, definitief bevestigde Asset Hub DOT via SCALE-metadata en eigen XLM via Stellar RPC met factuurmemo-ID. Gesnoeide of onvolledige geschiedenis voldoet niet. Deze ruwe adapters voegen geen tokenroutes toe. Geïndexeerde API's blijven alternatieven; zie de tabel met betaalroutes hieronder. Gemengde ruwe/geïndexeerde bronnen verifiëren begrensde vensters onafhankelijk; de standaard blijft twee onafhankelijke providers, geen aliassen van één operator. Alleen nodehoogte, ORDnet-blockchaininformatie en een EVM-relay voor een niet-EVM-route zijn geen ontvangstbewijzen. Monero vereist nog steeds een aan het project gekoppelde wallet-RPC met alleen inzagerechten.Details

Compatibele API-dialecten, geen bewijs van eindpuntgeschiedenis of capaciteit. Ruwe node-rpc ondersteunt BTC/BCH/LTC/DOGE/DASH en transparante ZEC (volledig gedecodeerde blokken, 1–48 bevestigingen), definitief bevestigde eigen TRX, eigen ALGO via algod, XTZ via Octez, definitief bevestigde Asset Hub DOT via SCALE-metadata en eigen XLM via Stellar RPC met factuurmemo-ID. Gesnoeide of onvolledige geschiedenis voldoet niet. Deze ruwe adapters voegen geen tokenroutes toe. Geïndexeerde API's blijven alternatieven; zie de tabel met betaalroutes hieronder. Gemengde ruwe/geïndexeerde bronnen verifiëren begrensde vensters onafhankelijk; de standaard blijft twee onafhankelijke providers, geen aliassen van één operator. Alleen nodehoogte, ORDnet-blockchaininformatie en een EVM-relay voor een niet-EVM-route zijn geen ontvangstbewijzen. Monero vereist nog steeds een aan het project gekoppelde wallet-RPC met alleen inzagerechten.

healthy_endpointsintegerop de blockchain

Gezonde overeenkomende eindpunten, niet het aantal onafhankelijke providers.

usable_independent_providersintegerop de blockchain
Bruikbare verificatieplaatsen, begrensd op twee. required_independent_providers is de blockchaininstelling: standaard 2, of 1 na expliciete keuze door een beheerder. In de modus met twee providers zijn verschillende providersleutels EN hosts vereist. Uitgeschakelde, verouderde (ouder dan tien minuten) of afkoelende bronnen vullen geen plaats. Lightning gebruikt eigen verbindingsregels.Details

Bruikbare verificatieplaatsen, begrensd op twee. required_independent_providers is de blockchaininstelling: standaard 2, of 1 na expliciete keuze door een beheerder. In de modus met twee providers zijn verschillende providersleutels EN hosts vereist. Uitgeschakelde, verouderde (ouder dan tien minuten) of afkoelende bronnen vullen geen plaats. Lightning gebruikt eigen verbindingsregels.

required_independent_providersintegerop de blockchain
Bruikbare verificatieplaatsen, begrensd op twee. required_independent_providers is de blockchaininstelling: standaard 2, of 1 na expliciete keuze door een beheerder. In de modus met twee providers zijn verschillende providersleutels EN hosts vereist. Uitgeschakelde, verouderde (ouder dan tien minuten) of afkoelende bronnen vullen geen plaats. Lightning gebruikt eigen verbindingsregels.Details

Bruikbare verificatieplaatsen, begrensd op twee. required_independent_providers is de blockchaininstelling: standaard 2, of 1 na expliciete keuze door een beheerder. In de modus met twee providers zijn verschillende providersleutels EN hosts vereist. Uitgeschakelde, verouderde (ouder dan tien minuten) of afkoelende bronnen vullen geen plaats. Lightning gebruikt eigen verbindingsregels.

last_checked_attimestamp | nullop de blockchain

Laatste gezondheidscontrole van een overeenkomend eindpunt, los van de beoordelingstijd.

monero_wallet_rpcMoneroWalletRpcBinding | nullaltijd
Geschoonde externe wallet-RPC-koppelingsstatus met alleen inzagerechten voor Monero. Bevat eindpunt, authenticatiemodus, primair account-0-adres, technische bewijsvlaggen/-hoogtes en tijdstempels van operatorverklaringen; inloggegevens, walletsleutels en walletbestanden worden nooit geserialiseerd.Details

Geschoonde externe wallet-RPC-koppelingsstatus met alleen inzagerechten voor Monero. Bevat eindpunt, authenticatiemodus, primair account-0-adres, technische bewijsvlaggen/-hoogtes en tijdstempels van operatorverklaringen; inloggegevens, walletsleutels en walletbestanden worden nooit geserialiseerd.

last_secret_revealed_attimestamp|nullaltijd

Auditmetadata over het tonen van geheimen aan de consolekant.

secret_reveal_countintegeraltijd

Auditmetadata over het tonen van geheimen aan de consolekant.

next_receive_indexintegeraltijd

Volgende gereserveerde index van een onderliggend adres.

last_scanned_heightinteger|nullaltijd

Walletscannerstatus.

last_scanned_attimestamp|nullaltijd

Walletscannerstatus.

last_errorstring|nullaltijd

Walletscannerstatus.

balances[]object[]altijd
Gecachte saldi voor elk van de 30 eigen blockchainroutes, plus geverifieerde ERC-20- en SPL-activa. Voor Monero is een ingestelde externe wallet-RPC met alleen inzagerechten vereist.Details

Gecachte saldi voor elk van de 30 eigen blockchainroutes, plus geverifieerde ERC-20- en SPL-activa. Voor Monero is een ingestelde externe wallet-RPC met alleen inzagerechten vereist.

wallet_idUUIDaltijd

Walletidentiteit en blijvende activa-identiteiten.

asset_idUUIDaltijd

Walletidentiteit en blijvende activa-identiteiten.

project_enabledbooleanaltijd

Of dit actief momenteel is ingeschakeld volgens het activabeleid van het project.

active_store_countintegeraltijd

Aantal ingeschakelde winkels dat dit actief momenteel selecteert. Dit is een weergave van acceptatie; alleen-lezen saldoregistratie blijft onafhankelijk.

active_store_ids[]UUID[]altijd

Ingeschakelde winkels in dit project die het actief momenteel accepteren. Dit maakt exact lokaal filteren op winkel mogelijk zonder extra API-verzoek.

tracking_activebooleanaltijd
Of deze leesbare wallet en het geregistreerde actief op dezelfde blockchain in aanmerking komen voor saldovernieuwing op de achtergrond. Schakelaars voor project- en betaalmethodeacceptatie pauzeren alleen-lezen registratie niet.Details

Of deze leesbare wallet en het geregistreerde actief op dezelfde blockchain in aanmerking komen voor saldovernieuwing op de achtergrond. Schakelaars voor project- en betaalmethodeacceptatie pauzeren alleen-lezen registratie niet.

asset_kindnative | tokenaltijd

Eigen valuta of geverifieerd contract-/mintactief.

contract_addressstring | nullaltijd

Tokencontract of mint; null voor eigen valuta.

symbolstringaltijd

Weergave-identiteit en atomaire precisie.

namestringaltijd

Weergave-identiteit en atomaire precisie.

decimalsintegeraltijd

Weergave-identiteit en atomaire precisie.

coingecko_idstring | nullaltijd

Prijsidentiteit indien gekoppeld.

balancedecimal string|nullaltijd

Exact weergegeven en atomair saldo over het primaire walletadres en uitgegeven factuuradressen. Null zolang geen volledige waarde beschikbaar is.

balance_atomicinteger string|nullaltijd

Exact weergegeven en atomair saldo over het primaire walletadres en uitgegeven factuuradressen. Null zolang geen volledige waarde beschikbaar is.

price_usddecimal string | nullaltijd

Indicatieve gecachte USD-eenheidsprijs voor waardering.

value_usddecimal string | nullaltijd

Indicatieve fiatwaardering wanneer een actuele koers bestaat.

statuspending | refreshing | fresh | stale | erroraltijd
Gecachte scanstatus. refreshing kan een voltooid saldo behouden: gebruik checked_at voor de ouderdom. Pending betekent dat er geen voltooide momentopname is. Geen van deze statussen bewijst dat een overschrijving openstaat of een factuur is voldaan.Details

Gecachte scanstatus. refreshing kan een voltooid saldo behouden: gebruik checked_at voor de ouderdom. Pending betekent dat er geen voltooide momentopname is. Geen van deze statussen bewijst dat een overschrijving openstaat of een factuur is voldaan.

checked_attimestamp | nullaltijd

Tijdstip dat door een voltooide saldoscan wordt weergegeven.

last_errorstring | nullaltijd

Veilige operatordiagnostiek.

total_value_usddecimal string | nullaltijd

Indicatieve som van saldi met een actuele USD-prijs.

balance_statuspending | refreshing | fresh | stale | error | unknownaltijd

Samengevoegde cache-actualiteit; unknown is een defensieve terugval en geen van deze statussen bewijst factuurvoldoening.

balance_checked_attimestamp | nullaltijd

Oudste relevante succesvolle saldocontrole die in het totaal is vertegenwoordigd.

recent_payments[]object[]altijd

Maximaal drie nieuwste geldige waarnemingen met status detected, confirming of final die aan precies deze wallet zijn toegewezen.

invoice_public_idUUIDaltijd

Factuuridentiteit voor de klant die bij de waarneming hoort.

chain_slugstringaltijd

Blockchain en weergavesymbool van eigen munt of geverifieerde token.

symbolstringaltijd

Blockchain en weergavesymbool van eigen munt of geverifieerde token.

transaction_idstringaltijd

Canonieke transactie- en overschrijvingsgebeurtenisidentiteit.

event_indexintegeraltijd

Canonieke transactie- en overschrijvingsgebeurtenisidentiteit.

amountdecimal stringaltijd

Exact waargenomen activabedrag zonder omzetting naar drijvendekommagetallen.

statusdetected | confirming | finalaltijd

Huidige geldige waarnemingsstatus. Gereorganiseerde, vervangen en ongeldige waarnemingen worden uitgesloten.

confirmationsintegeraltijd

Laatst waargenomen aantal bevestigingen.

observed_atRFC 3339 timestampaltijd

Tijdstip waarop Wholly Crypto de betaling voor het eerst waarnam.

created_atRFC 3339 timestampaltijd

Aanmaaktijd en laatste bijwerktijd van de wallet.

updated_atRFC 3339 timestampaltijd

Aanmaaktijd en laatste bijwerktijd van de wallet.

wallet_readinessreadiness enumaltijd

Alleen wallet-/beleidsstatus; gebruik receive_readiness voor scannervereisten.

receive_readinessobject | null5.5.0+
Gedeelde ontvangstconfiguratie plus winkelacceptatie. Gebruikt gecachte waarnemingen; geen reservering of garantie. Aanmaak controleert vereisten en de werkelijke factuurwisselkoers opnieuw.Details

Gedeelde ontvangstconfiguratie plus winkelacceptatie. Gebruikt gecachte waarnemingen; geen reservering of garantie. Aanmaak controleert vereisten en de werkelijke factuurwisselkoers opnieuw.

readybooleanaltijd

Ontvangstconfiguratiecontroles slagen. Beschrijft geen bestedingsgereedheid, gas, saldovernieuwing of gegarandeerde toekomstige prijsopgave.

invoice_creatableboolean6.0.6+
De configuratie staat een factuurmethode toe ondanks tijdelijke scannerwaarschuwingen. Valutaprijsbepaling wordt bij aanmaak gecontroleerd. Dit is geen betalingsverificatie: ready kan false zijn terwijl invoice_creatable true is. Ontbrekende wallets, uitgeschakeld beleid en niet-ondersteunde adapters blijven veilig weigeren.Details

De configuratie staat een factuurmethode toe ondanks tijdelijke scannerwaarschuwingen. Valutaprijsbepaling wordt bij aanmaak gecontroleerd. Dit is geen betalingsverificatie: ready kan false zijn terwijl invoice_creatable true is. Ontbrekende wallets, uitgeschakeld beleid en niet-ondersteunde adapters blijven veilig weigeren.

checked_attimestampaltijd

Beoordelingstijd. Een lijst opvragen maakt geen netwerkverzoek en wijst geen adres toe.

issues[]object[]altijd
Leeg indien gereed; anders een ontvangstwaarschuwing of configuratieblokkade. Controleer invoice_creatable om tijdelijke scannerwaarschuwingen van factuurconfiguratiefouten te onderscheiden.Details

Leeg indien gereed; anders een ontvangstwaarschuwing of configuratieblokkade. Controleer invoice_creatable om tijdelijke scannerwaarschuwingen van factuurconfiguratiefouten te onderscheiden.

chain_slugstringindien bekend

Identificeert de betrokken blockchain en het actief. Lightning kan asset_id weglaten.

asset_idUUIDindien bekend

Identificeert de betrokken blockchain en het actief. Lightning kan asset_id weglaten.

asset_tickerstringindien bekend

Identificeert de betrokken blockchain en het actief. Lightning kan asset_id weglaten.

reason_codestringaltijd
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 of asset_not_accepted.Details

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 of asset_not_accepted.

messagestringindien beschikbaar
Uitleg voor de handelaar en actie-identificatie: chain_connections, wallets, rates, payment_methods, project_settings of store_settings. Geen inloggegevens of private provider-URL's.Details

Uitleg voor de handelaar en actie-identificatie: chain_connections, wallets, rates, payment_methods, project_settings of store_settings. Geen inloggegevens of private provider-URL's.

actionstringindien beschikbaar
Uitleg voor de handelaar en actie-identificatie: chain_connections, wallets, rates, payment_methods, project_settings of store_settings. Geen inloggegevens of private provider-URL's.Details

Uitleg voor de handelaar en actie-identificatie: chain_connections, wallets, rates, payment_methods, project_settings of store_settings. Geen inloggegevens of private provider-URL's.

required_endpoint_rolestring | nullop de blockchain
Voorkeursrol van de scanner-API (verouderd veld). Gebruik accepted_endpoint_roles voor de volledige compatibiliteitslijst. Een gezonde node alleen bewijst geen ondersteuning voor betalingsgeschiedenis.Details

Voorkeursrol van de scanner-API (verouderd veld). Gebruik accepted_endpoint_roles voor de volledige compatibiliteitslijst. Een gezonde node alleen bewijst geen ondersteuning voor betalingsgeschiedenis.

accepted_endpoint_roles[]string[] | nullop de blockchain
Compatibele API-dialecten, geen bewijs van eindpuntgeschiedenis of capaciteit. Ruwe node-rpc ondersteunt BTC/BCH/LTC/DOGE/DASH en transparante ZEC (volledig gedecodeerde blokken, 1–48 bevestigingen), definitief bevestigde eigen TRX, eigen ALGO via algod, XTZ via Octez, definitief bevestigde Asset Hub DOT via SCALE-metadata en eigen XLM via Stellar RPC met factuurmemo-ID. Gesnoeide of onvolledige geschiedenis voldoet niet. Deze ruwe adapters voegen geen tokenroutes toe. Geïndexeerde API's blijven alternatieven; zie de tabel met betaalroutes hieronder. Gemengde ruwe/geïndexeerde bronnen verifiëren begrensde vensters onafhankelijk; de standaard blijft twee onafhankelijke providers, geen aliassen van één operator. Alleen nodehoogte, ORDnet-blockchaininformatie en een EVM-relay voor een niet-EVM-route zijn geen ontvangstbewijzen. Monero vereist nog steeds een aan het project gekoppelde wallet-RPC met alleen inzagerechten.Details

Compatibele API-dialecten, geen bewijs van eindpuntgeschiedenis of capaciteit. Ruwe node-rpc ondersteunt BTC/BCH/LTC/DOGE/DASH en transparante ZEC (volledig gedecodeerde blokken, 1–48 bevestigingen), definitief bevestigde eigen TRX, eigen ALGO via algod, XTZ via Octez, definitief bevestigde Asset Hub DOT via SCALE-metadata en eigen XLM via Stellar RPC met factuurmemo-ID. Gesnoeide of onvolledige geschiedenis voldoet niet. Deze ruwe adapters voegen geen tokenroutes toe. Geïndexeerde API's blijven alternatieven; zie de tabel met betaalroutes hieronder. Gemengde ruwe/geïndexeerde bronnen verifiëren begrensde vensters onafhankelijk; de standaard blijft twee onafhankelijke providers, geen aliassen van één operator. Alleen nodehoogte, ORDnet-blockchaininformatie en een EVM-relay voor een niet-EVM-route zijn geen ontvangstbewijzen. Monero vereist nog steeds een aan het project gekoppelde wallet-RPC met alleen inzagerechten.

healthy_endpointsintegerop de blockchain

Gezonde overeenkomende eindpunten, niet het aantal onafhankelijke providers.

usable_independent_providersintegerop de blockchain
Bruikbare verificatieplaatsen, begrensd op twee. required_independent_providers is de blockchaininstelling: standaard 2, of 1 na expliciete keuze door een beheerder. In de modus met twee providers zijn verschillende providersleutels EN hosts vereist. Uitgeschakelde, verouderde (ouder dan tien minuten) of afkoelende bronnen vullen geen plaats. Lightning gebruikt eigen verbindingsregels.Details

Bruikbare verificatieplaatsen, begrensd op twee. required_independent_providers is de blockchaininstelling: standaard 2, of 1 na expliciete keuze door een beheerder. In de modus met twee providers zijn verschillende providersleutels EN hosts vereist. Uitgeschakelde, verouderde (ouder dan tien minuten) of afkoelende bronnen vullen geen plaats. Lightning gebruikt eigen verbindingsregels.

required_independent_providersintegerop de blockchain
Bruikbare verificatieplaatsen, begrensd op twee. required_independent_providers is de blockchaininstelling: standaard 2, of 1 na expliciete keuze door een beheerder. In de modus met twee providers zijn verschillende providersleutels EN hosts vereist. Uitgeschakelde, verouderde (ouder dan tien minuten) of afkoelende bronnen vullen geen plaats. Lightning gebruikt eigen verbindingsregels.Details

Bruikbare verificatieplaatsen, begrensd op twee. required_independent_providers is de blockchaininstelling: standaard 2, of 1 na expliciete keuze door een beheerder. In de modus met twee providers zijn verschillende providersleutels EN hosts vereist. Uitgeschakelde, verouderde (ouder dan tien minuten) of afkoelende bronnen vullen geen plaats. Lightning gebruikt eigen verbindingsregels.

last_checked_attimestamp | nullop de blockchain

Laatste gezondheidscontrole van een overeenkomend eindpunt, los van de beoordelingstijd.

Gebruiksopmerkingen
  • De array accepteert maximaal 64 unieke activa en weergavevolgordes.
  • Selecties zijn opgeslagen gewenste configuratie en kunnen worden voorbereid voordat een walletback-up is gemaakt of terwijl een blockchain is gepauzeerd. Factuuraanmaak biedt nog steeds alleen methoden waarvan projectbeleid, beleid voor de eigen bovenliggende munt, wallet en runtimecontroles gereed zijn.
  • Verstuur een lege assets-array om geen betaalmethoden in te stellen.

Fouten

Foutcodes & regels voor nieuwe pogingen

PUTBevestigingsbeleid van winkel instellen/v1/projects/{project_id}/stores/{store_id}/payment-assets/{asset_id}/confirmation-policyLezen + schrijven

Stelt één winkelspecifieke afwijking voor bevestigingen in of wist die en geeft de vernieuwde betaalmethodenlijst van de winkel terug. Het actief moet al voor de winkel zijn geselecteerd. Configuratie blijft beschikbaar terwijl project, winkel, blockchain of wallet gepauzeerd is.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MERCHANT_API_TOKEN
Content-Typevereistapplication/json
Acceptaanbevolenapplication/json

Padparameters

project_idUUIDvereist

Project toegewezen aan de API-referentie; mag gepauzeerd zijn.

store_idUUIDvereist

Winkel die bij project_id hoort; mag gepauzeerd zijn.

asset_idUUIDvereist

Momenteel geselecteerd winkelbetaalactief om bij te werken.

Verzoek

: "${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
}'

Requestbody

strategyinherit | customvereist

Getagde strategie. inherit verwijdert de winkelafwijking; custom vereist required_confirmations.

required_confirmationsintegeralleen custom

Geheel getal binnen het minimum/maximum dat voor dit actief is teruggegeven. Onbekende of extra velden worden afgewezen.

Antwoord 200 application/json

Voorbeeldantwoord
{
  "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"
    }
  ]
}

Antwoordvelden

data[]object[]
assetobjectaltijd

Voor het project zichtbare eigen munt of geverifieerd tokenactief.

idUUIDaltijd

Blijvende identificatie van een betaalactief, gebruikt door project- en winkelbeleidsroutes.

asset_keystringaltijd

Canonieke identiteit van een eigen munt of contractactief in CAIP-stijl.

chain_slugstringaltijd

Wholly Crypto-blockchainidentificatie en ingesteld netwerk.

networkstringaltijd

Wholly Crypto-blockchainidentificatie en ingesteld netwerk.

caip_network_idstringaltijd

Canonieke netwerk- en activa-identiteiten.

caip_asset_idstring|nullaltijd

Canonieke netwerk- en activa-identiteiten.

asset_kindnative | tokenaltijd

Of voldoening de blockchainvaluta of een geverifieerd contract/mint gebruikt.

payment_railstringaltijd

Runtime-betaalroute: utxo, evm-native, solana-native, account-native, privacy-native of token-transfer.

symbolstringaltijd

Weergave-identiteit en exacte precisie in atomaire eenheden.

namestringaltijd

Weergave-identiteit en exacte precisie in atomaire eenheden.

decimalsintegeraltijd

Weergave-identiteit en exacte precisie in atomaire eenheden.

contract_addressstring | nullaltijd

Canoniek ERC-20-contract of SPL-mint voor tokens; null voor eigen munten.

coingecko_idstring | nullaltijd

Detectie-/prijsidentiteit. Null voor eigen contracten; leid nooit een marktprijs af van hun tickersymbool. Alleen CoinGecko-metadata maakt een token nooit selecteerbaar.

custom_tokenbooleanaltijd

Eigen contract dat op de blockchain is geverifieerd, met projectspecifieke vaste USD-prijs of prijsbepaling via een geselecteerde DEX-pool.

icon_pathpath | nullaltijd

Lokaal gecacht tokenpictogram indien beschikbaar.

token_standarderc20 | spl-token | nullaltijd

Geverifieerde runtime-tokenstandaard; null voor eigen munten.

metadata_verified_attimestamp | nullaltijd

Verificatietijd op de blockchain van metadata voor geregistreerde tokens.

payment_supportedbooleanaltijd
Registercontroles bij bouwen. scanner_ready betekent dat de betalingsscanner-runtime is geïnstalleerd; betalingsbevestiging vereist het ingestelde aantal gezonde providers met exact de juiste rol (standaard 2, optioneel 1); tijdelijke scannerbeschikbaarheid blokkeert factuuraanmaak vanaf 6.0.6 niet. balance_ready is alleen true voor geïmplementeerde saldo-adapters.Details

Registercontroles bij bouwen. scanner_ready betekent dat de betalingsscanner-runtime is geïnstalleerd; betalingsbevestiging vereist het ingestelde aantal gezonde providers met exact de juiste rol (standaard 2, optioneel 1); tijdelijke scannerbeschikbaarheid blokkeert factuuraanmaak vanaf 6.0.6 niet. balance_ready is alleen true voor geïmplementeerde saldo-adapters.

scanner_readybooleanaltijd
Registercontroles bij bouwen. scanner_ready betekent dat de betalingsscanner-runtime is geïnstalleerd; betalingsbevestiging vereist het ingestelde aantal gezonde providers met exact de juiste rol (standaard 2, optioneel 1); tijdelijke scannerbeschikbaarheid blokkeert factuuraanmaak vanaf 6.0.6 niet. balance_ready is alleen true voor geïmplementeerde saldo-adapters.Details

Registercontroles bij bouwen. scanner_ready betekent dat de betalingsscanner-runtime is geïnstalleerd; betalingsbevestiging vereist het ingestelde aantal gezonde providers met exact de juiste rol (standaard 2, optioneel 1); tijdelijke scannerbeschikbaarheid blokkeert factuuraanmaak vanaf 6.0.6 niet. balance_ready is alleen true voor geïmplementeerde saldo-adapters.

balance_readybooleanaltijd
Registercontroles bij bouwen. scanner_ready betekent dat de betalingsscanner-runtime is geïnstalleerd; betalingsbevestiging vereist het ingestelde aantal gezonde providers met exact de juiste rol (standaard 2, optioneel 1); tijdelijke scannerbeschikbaarheid blokkeert factuuraanmaak vanaf 6.0.6 niet. balance_ready is alleen true voor geïmplementeerde saldo-adapters.Details

Registercontroles bij bouwen. scanner_ready betekent dat de betalingsscanner-runtime is geïnstalleerd; betalingsbevestiging vereist het ingestelde aantal gezonde providers met exact de juiste rol (standaard 2, optioneel 1); tijdelijke scannerbeschikbaarheid blokkeert factuuraanmaak vanaf 6.0.6 niet. balance_ready is alleen true voor geïmplementeerde saldo-adapters.

default_finality_modeconfirmations | finalizedaltijd

Standaardfinaliteitsmodel dat nieuw projectbeleid overneemt.

default_required_confirmationsintegeraltijd

Standaardbeleid voor bevestiging en monitoring.

default_monitoring_minutesintegeraltijd

Standaardbeleid voor bevestiging en monitoring.

project_policyobject | nullaltijd

Bovenliggend projectbeleid.

enabledbooleanvereist

Schakelt het actief voor het project in of uit. De eigen blockchain moet vóór elke token worden ingeschakeld.

finality_modeconfirmations | finalizedvereist

Finaliteitsbeleid dat door de betaalroute van het actief wordt ondersteund. finalized vereist required_confirmations=1.

required_confirmationsintegervereist
Bitcoin- en EVM-routes accepteren nul; andere bevestigingsroutes vereisen minstens één, routes met alleen finalized vereisen precies één, en EVM-routes zijn begrensd op 0–48 zodat elke overschrijving binnen het transactieherhaalvenster blijft.Details

Bitcoin- en EVM-routes accepteren nul; andere bevestigingsroutes vereisen minstens één, routes met alleen finalized vereisen precies één, en EVM-routes zijn begrensd op 0–48 zodat elke overschrijving binnen het transactieherhaalvenster blijft.

monitoring_minutesintegervereist

Opvraagvenster van 1–10,080 minuten terwijl een factuur actief is.

late_monitoring_daysintegervereist

0–3,650 dagen monitoring na het verlopen van de factuur.

selectedbooleanaltijd
Of deze methode deel uitmaakt van de opgeslagen gewenste winkelconfiguratie. Ze wordt aangeboden wanneer projectbeleid, wallet, geïnstalleerde adapter en prijsbepaling geldig zijn. Tijdelijke scannerstoringen verwijderen haar niet uit nieuwe facturen.Details

Of deze methode deel uitmaakt van de opgeslagen gewenste winkelconfiguratie. Ze wordt aangeboden wanneer projectbeleid, wallet, geïnstalleerde adapter en prijsbepaling geldig zijn. Tijdelijke scannerstoringen verwijderen haar niet uit nieuwe facturen.

display_orderinteger | nullaltijd

Volgorde bij afrekenen in de winkel wanneer geselecteerd.

confirmation_policyobject | nullaltijd

Effectief winkelbeleid voor een in het project ingesteld actief. Null als geen projectbeleid bestaat.

finality_modeconfirmations | finalizedaltijd

Of voldoening een instelbaar aantal blokken of netwerkfinaliteit gebruikt.

project_required_confirmationsintegeraltijd

Huidige projectstandaard voor toekomstige facturen wanneer geen winkelafwijking is ingesteld.

override_required_confirmationsinteger | nullaltijd

Winkelspecifiek aantal of null om de projectstandaard over te nemen.

effective_required_confirmationsintegeraltijd

Aantal dat nieuwe facturen voor deze winkel en dit actief vastleggen.

editablebooleanaltijd

False voor netwerken met finalized waarvan het finaliteitsbeleid niet kan worden overschreven.

minimum_required_confirmationsintegeraltijd

Inclusieve blockchainspecifieke ondergrens; 0 wordt alleen aangeboden op routes die acceptatie bij detectie ondersteunen.

maximum_required_confirmationsintegeraltijd

Inclusieve blockchainspecifieke bovengrens.

walletobject | nullaltijd

Blockchainwallet gedeeld door eigen munten en tokenactiva.

idUUIDaltijd

Identificaties van wallet, eigenaarproject en eigen blockchainactief.

project_idUUIDaltijd

Identificaties van wallet, eigenaarproject en eigen blockchainactief.

native_asset_idUUIDaltijd

Identificaties van wallet, eigenaarproject en eigen blockchainactief.

chain_slugstringaltijd

Blockchain en netwerk van de wallet.

networkstringaltijd

Blockchain en netwerk van de wallet.

asset_symbolstringaltijd

Weergave-identiteit van de eigen blockchainmunt.

asset_namestringaltijd

Weergave-identiteit van de eigen blockchainmunt.

statuspending | active | disabled | erroraltijd

Operationele walletstatus.

labelstringaltijd

Operatorlabel.

public_keystring | nullaltijd

Publieke walletidentiteit; er wordt geen herstelzin of private sleutel getoond.

primary_addressstring | nullaltijd

Publieke walletidentiteit; er wordt geen herstelzin of private sleutel getoond.

derivation_schemestring | nullaltijd

Adresbeleid en -formaat.

address_formatstring | nullaltijd

Adresbeleid en -formaat.

backup_confirmed_attimestamp | nullaltijd

Niet-null nadat de operator de herstelback-up heeft bevestigd.

activation_requiredbooleanaltijd
Gedeelde XRP- en Stellar-accounts blijven niet beschikbaar totdat de operator het getoonde adres financiert en de ingestelde scannerproviders dat exacte account verifiëren. Het blijvende bewijs verloopt niet; actuele scannergezondheid wordt afzonderlijk gecontroleerd voor betalingsverificatie, niet voor factuuraanmaak.Details

Gedeelde XRP- en Stellar-accounts blijven niet beschikbaar totdat de operator het getoonde adres financiert en de ingestelde scannerproviders dat exacte account verifiëren. Het blijvende bewijs verloopt niet; actuele scannergezondheid wordt afzonderlijk gecontroleerd voor betalingsverificatie, niet voor factuuraanmaak.

activation_verified_attimestamp|nullaltijd
Gedeelde XRP- en Stellar-accounts blijven niet beschikbaar totdat de operator het getoonde adres financiert en de ingestelde scannerproviders dat exacte account verifiëren. Het blijvende bewijs verloopt niet; actuele scannergezondheid wordt afzonderlijk gecontroleerd voor betalingsverificatie, niet voor factuuraanmaak.Details

Gedeelde XRP- en Stellar-accounts blijven niet beschikbaar totdat de operator het getoonde adres financiert en de ingestelde scannerproviders dat exacte account verifiëren. Het blijvende bewijs verloopt niet; actuele scannergezondheid wordt afzonderlijk gecontroleerd voor betalingsverificatie, niet voor factuuraanmaak.

receive_readinessobject | null5.5.0+
Opgenomen in walletlijsten: ontvangstconfiguratie van het project en vereisten voor de blockchainscanner. Staat los van saldi, tokengas en verzendgereedheid. Andere walletantwoorden kunnen dit null laten.Details

Opgenomen in walletlijsten: ontvangstconfiguratie van het project en vereisten voor de blockchainscanner. Staat los van saldi, tokengas en verzendgereedheid. Andere walletantwoorden kunnen dit null laten.

readybooleanaltijd

Ontvangstconfiguratiecontroles slagen. Beschrijft geen bestedingsgereedheid, gas, saldovernieuwing of gegarandeerde toekomstige prijsopgave.

invoice_creatableboolean6.0.6+
De configuratie staat een factuurmethode toe ondanks tijdelijke scannerwaarschuwingen. Valutaprijsbepaling wordt bij aanmaak gecontroleerd. Dit is geen betalingsverificatie: ready kan false zijn terwijl invoice_creatable true is. Ontbrekende wallets, uitgeschakeld beleid en niet-ondersteunde adapters blijven veilig weigeren.Details

De configuratie staat een factuurmethode toe ondanks tijdelijke scannerwaarschuwingen. Valutaprijsbepaling wordt bij aanmaak gecontroleerd. Dit is geen betalingsverificatie: ready kan false zijn terwijl invoice_creatable true is. Ontbrekende wallets, uitgeschakeld beleid en niet-ondersteunde adapters blijven veilig weigeren.

checked_attimestampaltijd

Beoordelingstijd. Een lijst opvragen maakt geen netwerkverzoek en wijst geen adres toe.

issues[]object[]altijd
Leeg indien gereed; anders een ontvangstwaarschuwing of configuratieblokkade. Controleer invoice_creatable om tijdelijke scannerwaarschuwingen van factuurconfiguratiefouten te onderscheiden.Details

Leeg indien gereed; anders een ontvangstwaarschuwing of configuratieblokkade. Controleer invoice_creatable om tijdelijke scannerwaarschuwingen van factuurconfiguratiefouten te onderscheiden.

chain_slugstringindien bekend

Identificeert de betrokken blockchain en het actief. Lightning kan asset_id weglaten.

asset_idUUIDindien bekend

Identificeert de betrokken blockchain en het actief. Lightning kan asset_id weglaten.

asset_tickerstringindien bekend

Identificeert de betrokken blockchain en het actief. Lightning kan asset_id weglaten.

reason_codestringaltijd
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 of asset_not_accepted.Details

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 of asset_not_accepted.

messagestringindien beschikbaar
Uitleg voor de handelaar en actie-identificatie: chain_connections, wallets, rates, payment_methods, project_settings of store_settings. Geen inloggegevens of private provider-URL's.Details

Uitleg voor de handelaar en actie-identificatie: chain_connections, wallets, rates, payment_methods, project_settings of store_settings. Geen inloggegevens of private provider-URL's.

actionstringindien beschikbaar
Uitleg voor de handelaar en actie-identificatie: chain_connections, wallets, rates, payment_methods, project_settings of store_settings. Geen inloggegevens of private provider-URL's.Details

Uitleg voor de handelaar en actie-identificatie: chain_connections, wallets, rates, payment_methods, project_settings of store_settings. Geen inloggegevens of private provider-URL's.

required_endpoint_rolestring | nullop de blockchain
Voorkeursrol van de scanner-API (verouderd veld). Gebruik accepted_endpoint_roles voor de volledige compatibiliteitslijst. Een gezonde node alleen bewijst geen ondersteuning voor betalingsgeschiedenis.Details

Voorkeursrol van de scanner-API (verouderd veld). Gebruik accepted_endpoint_roles voor de volledige compatibiliteitslijst. Een gezonde node alleen bewijst geen ondersteuning voor betalingsgeschiedenis.

accepted_endpoint_roles[]string[] | nullop de blockchain
Compatibele API-dialecten, geen bewijs van eindpuntgeschiedenis of capaciteit. Ruwe node-rpc ondersteunt BTC/BCH/LTC/DOGE/DASH en transparante ZEC (volledig gedecodeerde blokken, 1–48 bevestigingen), definitief bevestigde eigen TRX, eigen ALGO via algod, XTZ via Octez, definitief bevestigde Asset Hub DOT via SCALE-metadata en eigen XLM via Stellar RPC met factuurmemo-ID. Gesnoeide of onvolledige geschiedenis voldoet niet. Deze ruwe adapters voegen geen tokenroutes toe. Geïndexeerde API's blijven alternatieven; zie de tabel met betaalroutes hieronder. Gemengde ruwe/geïndexeerde bronnen verifiëren begrensde vensters onafhankelijk; de standaard blijft twee onafhankelijke providers, geen aliassen van één operator. Alleen nodehoogte, ORDnet-blockchaininformatie en een EVM-relay voor een niet-EVM-route zijn geen ontvangstbewijzen. Monero vereist nog steeds een aan het project gekoppelde wallet-RPC met alleen inzagerechten.Details

Compatibele API-dialecten, geen bewijs van eindpuntgeschiedenis of capaciteit. Ruwe node-rpc ondersteunt BTC/BCH/LTC/DOGE/DASH en transparante ZEC (volledig gedecodeerde blokken, 1–48 bevestigingen), definitief bevestigde eigen TRX, eigen ALGO via algod, XTZ via Octez, definitief bevestigde Asset Hub DOT via SCALE-metadata en eigen XLM via Stellar RPC met factuurmemo-ID. Gesnoeide of onvolledige geschiedenis voldoet niet. Deze ruwe adapters voegen geen tokenroutes toe. Geïndexeerde API's blijven alternatieven; zie de tabel met betaalroutes hieronder. Gemengde ruwe/geïndexeerde bronnen verifiëren begrensde vensters onafhankelijk; de standaard blijft twee onafhankelijke providers, geen aliassen van één operator. Alleen nodehoogte, ORDnet-blockchaininformatie en een EVM-relay voor een niet-EVM-route zijn geen ontvangstbewijzen. Monero vereist nog steeds een aan het project gekoppelde wallet-RPC met alleen inzagerechten.

healthy_endpointsintegerop de blockchain

Gezonde overeenkomende eindpunten, niet het aantal onafhankelijke providers.

usable_independent_providersintegerop de blockchain
Bruikbare verificatieplaatsen, begrensd op twee. required_independent_providers is de blockchaininstelling: standaard 2, of 1 na expliciete keuze door een beheerder. In de modus met twee providers zijn verschillende providersleutels EN hosts vereist. Uitgeschakelde, verouderde (ouder dan tien minuten) of afkoelende bronnen vullen geen plaats. Lightning gebruikt eigen verbindingsregels.Details

Bruikbare verificatieplaatsen, begrensd op twee. required_independent_providers is de blockchaininstelling: standaard 2, of 1 na expliciete keuze door een beheerder. In de modus met twee providers zijn verschillende providersleutels EN hosts vereist. Uitgeschakelde, verouderde (ouder dan tien minuten) of afkoelende bronnen vullen geen plaats. Lightning gebruikt eigen verbindingsregels.

required_independent_providersintegerop de blockchain
Bruikbare verificatieplaatsen, begrensd op twee. required_independent_providers is de blockchaininstelling: standaard 2, of 1 na expliciete keuze door een beheerder. In de modus met twee providers zijn verschillende providersleutels EN hosts vereist. Uitgeschakelde, verouderde (ouder dan tien minuten) of afkoelende bronnen vullen geen plaats. Lightning gebruikt eigen verbindingsregels.Details

Bruikbare verificatieplaatsen, begrensd op twee. required_independent_providers is de blockchaininstelling: standaard 2, of 1 na expliciete keuze door een beheerder. In de modus met twee providers zijn verschillende providersleutels EN hosts vereist. Uitgeschakelde, verouderde (ouder dan tien minuten) of afkoelende bronnen vullen geen plaats. Lightning gebruikt eigen verbindingsregels.

last_checked_attimestamp | nullop de blockchain

Laatste gezondheidscontrole van een overeenkomend eindpunt, los van de beoordelingstijd.

monero_wallet_rpcMoneroWalletRpcBinding | nullaltijd
Geschoonde externe wallet-RPC-koppelingsstatus met alleen inzagerechten voor Monero. Bevat eindpunt, authenticatiemodus, primair account-0-adres, technische bewijsvlaggen/-hoogtes en tijdstempels van operatorverklaringen; inloggegevens, walletsleutels en walletbestanden worden nooit geserialiseerd.Details

Geschoonde externe wallet-RPC-koppelingsstatus met alleen inzagerechten voor Monero. Bevat eindpunt, authenticatiemodus, primair account-0-adres, technische bewijsvlaggen/-hoogtes en tijdstempels van operatorverklaringen; inloggegevens, walletsleutels en walletbestanden worden nooit geserialiseerd.

last_secret_revealed_attimestamp|nullaltijd

Auditmetadata over het tonen van geheimen aan de consolekant.

secret_reveal_countintegeraltijd

Auditmetadata over het tonen van geheimen aan de consolekant.

next_receive_indexintegeraltijd

Volgende gereserveerde index van een onderliggend adres.

last_scanned_heightinteger|nullaltijd

Walletscannerstatus.

last_scanned_attimestamp|nullaltijd

Walletscannerstatus.

last_errorstring|nullaltijd

Walletscannerstatus.

balances[]object[]altijd
Gecachte saldi voor elk van de 30 eigen blockchainroutes, plus geverifieerde ERC-20- en SPL-activa. Voor Monero is een ingestelde externe wallet-RPC met alleen inzagerechten vereist.Details

Gecachte saldi voor elk van de 30 eigen blockchainroutes, plus geverifieerde ERC-20- en SPL-activa. Voor Monero is een ingestelde externe wallet-RPC met alleen inzagerechten vereist.

wallet_idUUIDaltijd

Walletidentiteit en blijvende activa-identiteiten.

asset_idUUIDaltijd

Walletidentiteit en blijvende activa-identiteiten.

project_enabledbooleanaltijd

Of dit actief momenteel is ingeschakeld volgens het activabeleid van het project.

active_store_countintegeraltijd

Aantal ingeschakelde winkels dat dit actief momenteel selecteert. Dit is een weergave van acceptatie; alleen-lezen saldoregistratie blijft onafhankelijk.

active_store_ids[]UUID[]altijd

Ingeschakelde winkels in dit project die het actief momenteel accepteren. Dit maakt exact lokaal filteren op winkel mogelijk zonder extra API-verzoek.

tracking_activebooleanaltijd
Of deze leesbare wallet en het geregistreerde actief op dezelfde blockchain in aanmerking komen voor saldovernieuwing op de achtergrond. Schakelaars voor project- en betaalmethodeacceptatie pauzeren alleen-lezen registratie niet.Details

Of deze leesbare wallet en het geregistreerde actief op dezelfde blockchain in aanmerking komen voor saldovernieuwing op de achtergrond. Schakelaars voor project- en betaalmethodeacceptatie pauzeren alleen-lezen registratie niet.

asset_kindnative | tokenaltijd

Eigen valuta of geverifieerd contract-/mintactief.

contract_addressstring | nullaltijd

Tokencontract of mint; null voor eigen valuta.

symbolstringaltijd

Weergave-identiteit en atomaire precisie.

namestringaltijd

Weergave-identiteit en atomaire precisie.

decimalsintegeraltijd

Weergave-identiteit en atomaire precisie.

coingecko_idstring | nullaltijd

Prijsidentiteit indien gekoppeld.

balancedecimal string|nullaltijd

Exact weergegeven en atomair saldo over het primaire walletadres en uitgegeven factuuradressen. Null zolang geen volledige waarde beschikbaar is.

balance_atomicinteger string|nullaltijd

Exact weergegeven en atomair saldo over het primaire walletadres en uitgegeven factuuradressen. Null zolang geen volledige waarde beschikbaar is.

price_usddecimal string | nullaltijd

Indicatieve gecachte USD-eenheidsprijs voor waardering.

value_usddecimal string | nullaltijd

Indicatieve fiatwaardering wanneer een actuele koers bestaat.

statuspending | refreshing | fresh | stale | erroraltijd
Gecachte scanstatus. refreshing kan een voltooid saldo behouden: gebruik checked_at voor de ouderdom. Pending betekent dat er geen voltooide momentopname is. Geen van deze statussen bewijst dat een overschrijving openstaat of een factuur is voldaan.Details

Gecachte scanstatus. refreshing kan een voltooid saldo behouden: gebruik checked_at voor de ouderdom. Pending betekent dat er geen voltooide momentopname is. Geen van deze statussen bewijst dat een overschrijving openstaat of een factuur is voldaan.

checked_attimestamp | nullaltijd

Tijdstip dat door een voltooide saldoscan wordt weergegeven.

last_errorstring | nullaltijd

Veilige operatordiagnostiek.

total_value_usddecimal string | nullaltijd

Indicatieve som van saldi met een actuele USD-prijs.

balance_statuspending | refreshing | fresh | stale | error | unknownaltijd

Samengevoegde cache-actualiteit; unknown is een defensieve terugval en geen van deze statussen bewijst factuurvoldoening.

balance_checked_attimestamp | nullaltijd

Oudste relevante succesvolle saldocontrole die in het totaal is vertegenwoordigd.

recent_payments[]object[]altijd

Maximaal drie nieuwste geldige waarnemingen met status detected, confirming of final die aan precies deze wallet zijn toegewezen.

invoice_public_idUUIDaltijd

Factuuridentiteit voor de klant die bij de waarneming hoort.

chain_slugstringaltijd

Blockchain en weergavesymbool van eigen munt of geverifieerde token.

symbolstringaltijd

Blockchain en weergavesymbool van eigen munt of geverifieerde token.

transaction_idstringaltijd

Canonieke transactie- en overschrijvingsgebeurtenisidentiteit.

event_indexintegeraltijd

Canonieke transactie- en overschrijvingsgebeurtenisidentiteit.

amountdecimal stringaltijd

Exact waargenomen activabedrag zonder omzetting naar drijvendekommagetallen.

statusdetected | confirming | finalaltijd

Huidige geldige waarnemingsstatus. Gereorganiseerde, vervangen en ongeldige waarnemingen worden uitgesloten.

confirmationsintegeraltijd

Laatst waargenomen aantal bevestigingen.

observed_atRFC 3339 timestampaltijd

Tijdstip waarop Wholly Crypto de betaling voor het eerst waarnam.

created_atRFC 3339 timestampaltijd

Aanmaaktijd en laatste bijwerktijd van de wallet.

updated_atRFC 3339 timestampaltijd

Aanmaaktijd en laatste bijwerktijd van de wallet.

wallet_readinessreadiness enumaltijd

Alleen wallet-/beleidsstatus; gebruik receive_readiness voor scannervereisten.

receive_readinessobject | null5.5.0+
Gedeelde ontvangstconfiguratie plus winkelacceptatie. Gebruikt gecachte waarnemingen; geen reservering of garantie. Aanmaak controleert vereisten en de werkelijke factuurwisselkoers opnieuw.Details

Gedeelde ontvangstconfiguratie plus winkelacceptatie. Gebruikt gecachte waarnemingen; geen reservering of garantie. Aanmaak controleert vereisten en de werkelijke factuurwisselkoers opnieuw.

readybooleanaltijd

Ontvangstconfiguratiecontroles slagen. Beschrijft geen bestedingsgereedheid, gas, saldovernieuwing of gegarandeerde toekomstige prijsopgave.

invoice_creatableboolean6.0.6+
De configuratie staat een factuurmethode toe ondanks tijdelijke scannerwaarschuwingen. Valutaprijsbepaling wordt bij aanmaak gecontroleerd. Dit is geen betalingsverificatie: ready kan false zijn terwijl invoice_creatable true is. Ontbrekende wallets, uitgeschakeld beleid en niet-ondersteunde adapters blijven veilig weigeren.Details

De configuratie staat een factuurmethode toe ondanks tijdelijke scannerwaarschuwingen. Valutaprijsbepaling wordt bij aanmaak gecontroleerd. Dit is geen betalingsverificatie: ready kan false zijn terwijl invoice_creatable true is. Ontbrekende wallets, uitgeschakeld beleid en niet-ondersteunde adapters blijven veilig weigeren.

checked_attimestampaltijd

Beoordelingstijd. Een lijst opvragen maakt geen netwerkverzoek en wijst geen adres toe.

issues[]object[]altijd
Leeg indien gereed; anders een ontvangstwaarschuwing of configuratieblokkade. Controleer invoice_creatable om tijdelijke scannerwaarschuwingen van factuurconfiguratiefouten te onderscheiden.Details

Leeg indien gereed; anders een ontvangstwaarschuwing of configuratieblokkade. Controleer invoice_creatable om tijdelijke scannerwaarschuwingen van factuurconfiguratiefouten te onderscheiden.

chain_slugstringindien bekend

Identificeert de betrokken blockchain en het actief. Lightning kan asset_id weglaten.

asset_idUUIDindien bekend

Identificeert de betrokken blockchain en het actief. Lightning kan asset_id weglaten.

asset_tickerstringindien bekend

Identificeert de betrokken blockchain en het actief. Lightning kan asset_id weglaten.

reason_codestringaltijd
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 of asset_not_accepted.Details

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 of asset_not_accepted.

messagestringindien beschikbaar
Uitleg voor de handelaar en actie-identificatie: chain_connections, wallets, rates, payment_methods, project_settings of store_settings. Geen inloggegevens of private provider-URL's.Details

Uitleg voor de handelaar en actie-identificatie: chain_connections, wallets, rates, payment_methods, project_settings of store_settings. Geen inloggegevens of private provider-URL's.

actionstringindien beschikbaar
Uitleg voor de handelaar en actie-identificatie: chain_connections, wallets, rates, payment_methods, project_settings of store_settings. Geen inloggegevens of private provider-URL's.Details

Uitleg voor de handelaar en actie-identificatie: chain_connections, wallets, rates, payment_methods, project_settings of store_settings. Geen inloggegevens of private provider-URL's.

required_endpoint_rolestring | nullop de blockchain
Voorkeursrol van de scanner-API (verouderd veld). Gebruik accepted_endpoint_roles voor de volledige compatibiliteitslijst. Een gezonde node alleen bewijst geen ondersteuning voor betalingsgeschiedenis.Details

Voorkeursrol van de scanner-API (verouderd veld). Gebruik accepted_endpoint_roles voor de volledige compatibiliteitslijst. Een gezonde node alleen bewijst geen ondersteuning voor betalingsgeschiedenis.

accepted_endpoint_roles[]string[] | nullop de blockchain
Compatibele API-dialecten, geen bewijs van eindpuntgeschiedenis of capaciteit. Ruwe node-rpc ondersteunt BTC/BCH/LTC/DOGE/DASH en transparante ZEC (volledig gedecodeerde blokken, 1–48 bevestigingen), definitief bevestigde eigen TRX, eigen ALGO via algod, XTZ via Octez, definitief bevestigde Asset Hub DOT via SCALE-metadata en eigen XLM via Stellar RPC met factuurmemo-ID. Gesnoeide of onvolledige geschiedenis voldoet niet. Deze ruwe adapters voegen geen tokenroutes toe. Geïndexeerde API's blijven alternatieven; zie de tabel met betaalroutes hieronder. Gemengde ruwe/geïndexeerde bronnen verifiëren begrensde vensters onafhankelijk; de standaard blijft twee onafhankelijke providers, geen aliassen van één operator. Alleen nodehoogte, ORDnet-blockchaininformatie en een EVM-relay voor een niet-EVM-route zijn geen ontvangstbewijzen. Monero vereist nog steeds een aan het project gekoppelde wallet-RPC met alleen inzagerechten.Details

Compatibele API-dialecten, geen bewijs van eindpuntgeschiedenis of capaciteit. Ruwe node-rpc ondersteunt BTC/BCH/LTC/DOGE/DASH en transparante ZEC (volledig gedecodeerde blokken, 1–48 bevestigingen), definitief bevestigde eigen TRX, eigen ALGO via algod, XTZ via Octez, definitief bevestigde Asset Hub DOT via SCALE-metadata en eigen XLM via Stellar RPC met factuurmemo-ID. Gesnoeide of onvolledige geschiedenis voldoet niet. Deze ruwe adapters voegen geen tokenroutes toe. Geïndexeerde API's blijven alternatieven; zie de tabel met betaalroutes hieronder. Gemengde ruwe/geïndexeerde bronnen verifiëren begrensde vensters onafhankelijk; de standaard blijft twee onafhankelijke providers, geen aliassen van één operator. Alleen nodehoogte, ORDnet-blockchaininformatie en een EVM-relay voor een niet-EVM-route zijn geen ontvangstbewijzen. Monero vereist nog steeds een aan het project gekoppelde wallet-RPC met alleen inzagerechten.

healthy_endpointsintegerop de blockchain

Gezonde overeenkomende eindpunten, niet het aantal onafhankelijke providers.

usable_independent_providersintegerop de blockchain
Bruikbare verificatieplaatsen, begrensd op twee. required_independent_providers is de blockchaininstelling: standaard 2, of 1 na expliciete keuze door een beheerder. In de modus met twee providers zijn verschillende providersleutels EN hosts vereist. Uitgeschakelde, verouderde (ouder dan tien minuten) of afkoelende bronnen vullen geen plaats. Lightning gebruikt eigen verbindingsregels.Details

Bruikbare verificatieplaatsen, begrensd op twee. required_independent_providers is de blockchaininstelling: standaard 2, of 1 na expliciete keuze door een beheerder. In de modus met twee providers zijn verschillende providersleutels EN hosts vereist. Uitgeschakelde, verouderde (ouder dan tien minuten) of afkoelende bronnen vullen geen plaats. Lightning gebruikt eigen verbindingsregels.

required_independent_providersintegerop de blockchain
Bruikbare verificatieplaatsen, begrensd op twee. required_independent_providers is de blockchaininstelling: standaard 2, of 1 na expliciete keuze door een beheerder. In de modus met twee providers zijn verschillende providersleutels EN hosts vereist. Uitgeschakelde, verouderde (ouder dan tien minuten) of afkoelende bronnen vullen geen plaats. Lightning gebruikt eigen verbindingsregels.Details

Bruikbare verificatieplaatsen, begrensd op twee. required_independent_providers is de blockchaininstelling: standaard 2, of 1 na expliciete keuze door een beheerder. In de modus met twee providers zijn verschillende providersleutels EN hosts vereist. Uitgeschakelde, verouderde (ouder dan tien minuten) of afkoelende bronnen vullen geen plaats. Lightning gebruikt eigen verbindingsregels.

last_checked_attimestamp | nullop de blockchain

Laatste gezondheidscontrole van een overeenkomend eindpunt, los van de beoordelingstijd.

Gebruiksopmerkingen
  • Gebruik {"strategy":"inherit"} om de winkelafwijking te verwijderen en voor toekomstige facturen de huidige projectstandaard te volgen.
  • Netwerken met finalized geven editable false terug en gebruiken Netwerkfinaliteit; ze accepteren geen afwijkend aantal blokken.
  • Een waarde van 0 betekent accepteren bij detectie zonder netwerkbevestiging en zonder bescherming tegen reorganisaties. Dit wordt alleen geaccepteerd waar minimum_required_confirmations 0 is.
  • Beleidswijzigingen gelden alleen voor nieuwe facturen. Bestaande facturen behouden de momentopname van het project-/winkelbevestigingsbeleid die bij aanmaak is vastgelegd.
  • Updates gebeuren voor één actief tegelijk; voer gelijktijdige wijzigingen voor hetzelfde winkelactief achtereenvolgens uit en gebruik het vernieuwde antwoord als huidige status.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETProjectwallets en saldi opvragen/v1/projects/{project_id}/walletsAlleen-lezen

Geeft publieke walletmetadata terug plus elk geregistreerd actief met saldo-ondersteuning op exact de blockchain en het netwerk van de wallet. Alle 30 eigen blockchainroutes worden ondersteund; geverifieerde ERC-20- en SPL-activa worden ook gevolgd. Activa verschijnen onmiddellijk, ook vóór de eerste scan of wanneer ze niet voor betalingen worden geaccepteerd. project_enabled meldt betaalacceptatie; tracking_active meldt onafhankelijk de geschiktheid voor alleen-lezen vernieuwing. Monero vereist de aan het project gekoppelde externe wallet-RPC met alleen inzagerechten. Saldi scannen in de console geeft voorrang aan begrensde leesacties met voortgang/fouten per actief; alleen volledige cycli werken actuele totalen bij. Factuurvoldoening blijft bepaald door monitoring op transactieniveau en bevestigingsbeleid, niet door deze gecachte saldi.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MERCHANT_API_TOKEN
Acceptaanbevolenapplication/json

Padparameters

project_idUUIDvereist

Ingeschakeld project dat aan de API-referentie is toegewezen.

Verzoek

: "${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"

Antwoord 200 application/json

Voorbeeldantwoord
{
  "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"
    }
  ]
}

Antwoordvelden

data[]object[]
idUUIDaltijd

Identificaties van wallet, eigenaarproject en eigen blockchainactief.

project_idUUIDaltijd

Identificaties van wallet, eigenaarproject en eigen blockchainactief.

native_asset_idUUIDaltijd

Identificaties van wallet, eigenaarproject en eigen blockchainactief.

chain_slugstringaltijd

Blockchain en netwerk van de wallet.

networkstringaltijd

Blockchain en netwerk van de wallet.

asset_symbolstringaltijd

Weergave-identiteit van de eigen blockchainmunt.

asset_namestringaltijd

Weergave-identiteit van de eigen blockchainmunt.

statuspending | active | disabled | erroraltijd

Operationele walletstatus.

labelstringaltijd

Operatorlabel.

public_keystring | nullaltijd

Publieke walletidentiteit; er wordt geen herstelzin of private sleutel getoond.

primary_addressstring | nullaltijd

Publieke walletidentiteit; er wordt geen herstelzin of private sleutel getoond.

derivation_schemestring | nullaltijd

Adresbeleid en -formaat.

address_formatstring | nullaltijd

Adresbeleid en -formaat.

backup_confirmed_attimestamp | nullaltijd

Niet-null nadat de operator de herstelback-up heeft bevestigd.

activation_requiredbooleanaltijd
Gedeelde XRP- en Stellar-accounts blijven niet beschikbaar totdat de operator het getoonde adres financiert en de ingestelde scannerproviders dat exacte account verifiëren. Het blijvende bewijs verloopt niet; actuele scannergezondheid wordt afzonderlijk gecontroleerd voor betalingsverificatie, niet voor factuuraanmaak.Details

Gedeelde XRP- en Stellar-accounts blijven niet beschikbaar totdat de operator het getoonde adres financiert en de ingestelde scannerproviders dat exacte account verifiëren. Het blijvende bewijs verloopt niet; actuele scannergezondheid wordt afzonderlijk gecontroleerd voor betalingsverificatie, niet voor factuuraanmaak.

activation_verified_attimestamp|nullaltijd
Gedeelde XRP- en Stellar-accounts blijven niet beschikbaar totdat de operator het getoonde adres financiert en de ingestelde scannerproviders dat exacte account verifiëren. Het blijvende bewijs verloopt niet; actuele scannergezondheid wordt afzonderlijk gecontroleerd voor betalingsverificatie, niet voor factuuraanmaak.Details

Gedeelde XRP- en Stellar-accounts blijven niet beschikbaar totdat de operator het getoonde adres financiert en de ingestelde scannerproviders dat exacte account verifiëren. Het blijvende bewijs verloopt niet; actuele scannergezondheid wordt afzonderlijk gecontroleerd voor betalingsverificatie, niet voor factuuraanmaak.

receive_readinessobject | null5.5.0+
Opgenomen in walletlijsten: ontvangstconfiguratie van het project en vereisten voor de blockchainscanner. Staat los van saldi, tokengas en verzendgereedheid. Andere walletantwoorden kunnen dit null laten.Details

Opgenomen in walletlijsten: ontvangstconfiguratie van het project en vereisten voor de blockchainscanner. Staat los van saldi, tokengas en verzendgereedheid. Andere walletantwoorden kunnen dit null laten.

readybooleanaltijd

Ontvangstconfiguratiecontroles slagen. Beschrijft geen bestedingsgereedheid, gas, saldovernieuwing of gegarandeerde toekomstige prijsopgave.

invoice_creatableboolean6.0.6+
De configuratie staat een factuurmethode toe ondanks tijdelijke scannerwaarschuwingen. Valutaprijsbepaling wordt bij aanmaak gecontroleerd. Dit is geen betalingsverificatie: ready kan false zijn terwijl invoice_creatable true is. Ontbrekende wallets, uitgeschakeld beleid en niet-ondersteunde adapters blijven veilig weigeren.Details

De configuratie staat een factuurmethode toe ondanks tijdelijke scannerwaarschuwingen. Valutaprijsbepaling wordt bij aanmaak gecontroleerd. Dit is geen betalingsverificatie: ready kan false zijn terwijl invoice_creatable true is. Ontbrekende wallets, uitgeschakeld beleid en niet-ondersteunde adapters blijven veilig weigeren.

checked_attimestampaltijd

Beoordelingstijd. Een lijst opvragen maakt geen netwerkverzoek en wijst geen adres toe.

issues[]object[]altijd
Leeg indien gereed; anders een ontvangstwaarschuwing of configuratieblokkade. Controleer invoice_creatable om tijdelijke scannerwaarschuwingen van factuurconfiguratiefouten te onderscheiden.Details

Leeg indien gereed; anders een ontvangstwaarschuwing of configuratieblokkade. Controleer invoice_creatable om tijdelijke scannerwaarschuwingen van factuurconfiguratiefouten te onderscheiden.

chain_slugstringindien bekend

Identificeert de betrokken blockchain en het actief. Lightning kan asset_id weglaten.

asset_idUUIDindien bekend

Identificeert de betrokken blockchain en het actief. Lightning kan asset_id weglaten.

asset_tickerstringindien bekend

Identificeert de betrokken blockchain en het actief. Lightning kan asset_id weglaten.

reason_codestringaltijd
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 of asset_not_accepted.Details

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 of asset_not_accepted.

messagestringindien beschikbaar
Uitleg voor de handelaar en actie-identificatie: chain_connections, wallets, rates, payment_methods, project_settings of store_settings. Geen inloggegevens of private provider-URL's.Details

Uitleg voor de handelaar en actie-identificatie: chain_connections, wallets, rates, payment_methods, project_settings of store_settings. Geen inloggegevens of private provider-URL's.

actionstringindien beschikbaar
Uitleg voor de handelaar en actie-identificatie: chain_connections, wallets, rates, payment_methods, project_settings of store_settings. Geen inloggegevens of private provider-URL's.Details

Uitleg voor de handelaar en actie-identificatie: chain_connections, wallets, rates, payment_methods, project_settings of store_settings. Geen inloggegevens of private provider-URL's.

required_endpoint_rolestring | nullop de blockchain
Voorkeursrol van de scanner-API (verouderd veld). Gebruik accepted_endpoint_roles voor de volledige compatibiliteitslijst. Een gezonde node alleen bewijst geen ondersteuning voor betalingsgeschiedenis.Details

Voorkeursrol van de scanner-API (verouderd veld). Gebruik accepted_endpoint_roles voor de volledige compatibiliteitslijst. Een gezonde node alleen bewijst geen ondersteuning voor betalingsgeschiedenis.

accepted_endpoint_roles[]string[] | nullop de blockchain
Compatibele API-dialecten, geen bewijs van eindpuntgeschiedenis of capaciteit. Ruwe node-rpc ondersteunt BTC/BCH/LTC/DOGE/DASH en transparante ZEC (volledig gedecodeerde blokken, 1–48 bevestigingen), definitief bevestigde eigen TRX, eigen ALGO via algod, XTZ via Octez, definitief bevestigde Asset Hub DOT via SCALE-metadata en eigen XLM via Stellar RPC met factuurmemo-ID. Gesnoeide of onvolledige geschiedenis voldoet niet. Deze ruwe adapters voegen geen tokenroutes toe. Geïndexeerde API's blijven alternatieven; zie de tabel met betaalroutes hieronder. Gemengde ruwe/geïndexeerde bronnen verifiëren begrensde vensters onafhankelijk; de standaard blijft twee onafhankelijke providers, geen aliassen van één operator. Alleen nodehoogte, ORDnet-blockchaininformatie en een EVM-relay voor een niet-EVM-route zijn geen ontvangstbewijzen. Monero vereist nog steeds een aan het project gekoppelde wallet-RPC met alleen inzagerechten.Details

Compatibele API-dialecten, geen bewijs van eindpuntgeschiedenis of capaciteit. Ruwe node-rpc ondersteunt BTC/BCH/LTC/DOGE/DASH en transparante ZEC (volledig gedecodeerde blokken, 1–48 bevestigingen), definitief bevestigde eigen TRX, eigen ALGO via algod, XTZ via Octez, definitief bevestigde Asset Hub DOT via SCALE-metadata en eigen XLM via Stellar RPC met factuurmemo-ID. Gesnoeide of onvolledige geschiedenis voldoet niet. Deze ruwe adapters voegen geen tokenroutes toe. Geïndexeerde API's blijven alternatieven; zie de tabel met betaalroutes hieronder. Gemengde ruwe/geïndexeerde bronnen verifiëren begrensde vensters onafhankelijk; de standaard blijft twee onafhankelijke providers, geen aliassen van één operator. Alleen nodehoogte, ORDnet-blockchaininformatie en een EVM-relay voor een niet-EVM-route zijn geen ontvangstbewijzen. Monero vereist nog steeds een aan het project gekoppelde wallet-RPC met alleen inzagerechten.

healthy_endpointsintegerop de blockchain

Gezonde overeenkomende eindpunten, niet het aantal onafhankelijke providers.

usable_independent_providersintegerop de blockchain
Bruikbare verificatieplaatsen, begrensd op twee. required_independent_providers is de blockchaininstelling: standaard 2, of 1 na expliciete keuze door een beheerder. In de modus met twee providers zijn verschillende providersleutels EN hosts vereist. Uitgeschakelde, verouderde (ouder dan tien minuten) of afkoelende bronnen vullen geen plaats. Lightning gebruikt eigen verbindingsregels.Details

Bruikbare verificatieplaatsen, begrensd op twee. required_independent_providers is de blockchaininstelling: standaard 2, of 1 na expliciete keuze door een beheerder. In de modus met twee providers zijn verschillende providersleutels EN hosts vereist. Uitgeschakelde, verouderde (ouder dan tien minuten) of afkoelende bronnen vullen geen plaats. Lightning gebruikt eigen verbindingsregels.

required_independent_providersintegerop de blockchain
Bruikbare verificatieplaatsen, begrensd op twee. required_independent_providers is de blockchaininstelling: standaard 2, of 1 na expliciete keuze door een beheerder. In de modus met twee providers zijn verschillende providersleutels EN hosts vereist. Uitgeschakelde, verouderde (ouder dan tien minuten) of afkoelende bronnen vullen geen plaats. Lightning gebruikt eigen verbindingsregels.Details

Bruikbare verificatieplaatsen, begrensd op twee. required_independent_providers is de blockchaininstelling: standaard 2, of 1 na expliciete keuze door een beheerder. In de modus met twee providers zijn verschillende providersleutels EN hosts vereist. Uitgeschakelde, verouderde (ouder dan tien minuten) of afkoelende bronnen vullen geen plaats. Lightning gebruikt eigen verbindingsregels.

last_checked_attimestamp | nullop de blockchain

Laatste gezondheidscontrole van een overeenkomend eindpunt, los van de beoordelingstijd.

monero_wallet_rpcMoneroWalletRpcBinding | nullaltijd
Geschoonde externe wallet-RPC-koppelingsstatus met alleen inzagerechten voor Monero. Bevat eindpunt, authenticatiemodus, primair account-0-adres, technische bewijsvlaggen/-hoogtes en tijdstempels van operatorverklaringen; inloggegevens, walletsleutels en walletbestanden worden nooit geserialiseerd.Details

Geschoonde externe wallet-RPC-koppelingsstatus met alleen inzagerechten voor Monero. Bevat eindpunt, authenticatiemodus, primair account-0-adres, technische bewijsvlaggen/-hoogtes en tijdstempels van operatorverklaringen; inloggegevens, walletsleutels en walletbestanden worden nooit geserialiseerd.

last_secret_revealed_attimestamp|nullaltijd

Auditmetadata over het tonen van geheimen aan de consolekant.

secret_reveal_countintegeraltijd

Auditmetadata over het tonen van geheimen aan de consolekant.

next_receive_indexintegeraltijd

Volgende gereserveerde index van een onderliggend adres.

last_scanned_heightinteger|nullaltijd

Walletscannerstatus.

last_scanned_attimestamp|nullaltijd

Walletscannerstatus.

last_errorstring|nullaltijd

Walletscannerstatus.

balances[]object[]altijd
Gecachte saldi voor elk van de 30 eigen blockchainroutes, plus geverifieerde ERC-20- en SPL-activa. Voor Monero is een ingestelde externe wallet-RPC met alleen inzagerechten vereist.Details

Gecachte saldi voor elk van de 30 eigen blockchainroutes, plus geverifieerde ERC-20- en SPL-activa. Voor Monero is een ingestelde externe wallet-RPC met alleen inzagerechten vereist.

wallet_idUUIDaltijd

Walletidentiteit en blijvende activa-identiteiten.

asset_idUUIDaltijd

Walletidentiteit en blijvende activa-identiteiten.

project_enabledbooleanaltijd

Of dit actief momenteel is ingeschakeld volgens het activabeleid van het project.

active_store_countintegeraltijd

Aantal ingeschakelde winkels dat dit actief momenteel selecteert. Dit is een weergave van acceptatie; alleen-lezen saldoregistratie blijft onafhankelijk.

active_store_ids[]UUID[]altijd

Ingeschakelde winkels in dit project die het actief momenteel accepteren. Dit maakt exact lokaal filteren op winkel mogelijk zonder extra API-verzoek.

tracking_activebooleanaltijd
Of deze leesbare wallet en het geregistreerde actief op dezelfde blockchain in aanmerking komen voor saldovernieuwing op de achtergrond. Schakelaars voor project- en betaalmethodeacceptatie pauzeren alleen-lezen registratie niet.Details

Of deze leesbare wallet en het geregistreerde actief op dezelfde blockchain in aanmerking komen voor saldovernieuwing op de achtergrond. Schakelaars voor project- en betaalmethodeacceptatie pauzeren alleen-lezen registratie niet.

asset_kindnative | tokenaltijd

Eigen valuta of geverifieerd contract-/mintactief.

contract_addressstring | nullaltijd

Tokencontract of mint; null voor eigen valuta.

symbolstringaltijd

Weergave-identiteit en atomaire precisie.

namestringaltijd

Weergave-identiteit en atomaire precisie.

decimalsintegeraltijd

Weergave-identiteit en atomaire precisie.

coingecko_idstring | nullaltijd

Prijsidentiteit indien gekoppeld.

balancedecimal string|nullaltijd

Exact weergegeven en atomair saldo over het primaire walletadres en uitgegeven factuuradressen. Null zolang geen volledige waarde beschikbaar is.

balance_atomicinteger string|nullaltijd

Exact weergegeven en atomair saldo over het primaire walletadres en uitgegeven factuuradressen. Null zolang geen volledige waarde beschikbaar is.

price_usddecimal string | nullaltijd

Indicatieve gecachte USD-eenheidsprijs voor waardering.

value_usddecimal string | nullaltijd

Indicatieve fiatwaardering wanneer een actuele koers bestaat.

statuspending | refreshing | fresh | stale | erroraltijd
Gecachte scanstatus. refreshing kan een voltooid saldo behouden: gebruik checked_at voor de ouderdom. Pending betekent dat er geen voltooide momentopname is. Geen van deze statussen bewijst dat een overschrijving openstaat of een factuur is voldaan.Details

Gecachte scanstatus. refreshing kan een voltooid saldo behouden: gebruik checked_at voor de ouderdom. Pending betekent dat er geen voltooide momentopname is. Geen van deze statussen bewijst dat een overschrijving openstaat of een factuur is voldaan.

checked_attimestamp | nullaltijd

Tijdstip dat door een voltooide saldoscan wordt weergegeven.

last_errorstring | nullaltijd

Veilige operatordiagnostiek.

total_value_usddecimal string | nullaltijd

Indicatieve som van saldi met een actuele USD-prijs.

balance_statuspending | refreshing | fresh | stale | error | unknownaltijd

Samengevoegde cache-actualiteit; unknown is een defensieve terugval en geen van deze statussen bewijst factuurvoldoening.

balance_checked_attimestamp | nullaltijd

Oudste relevante succesvolle saldocontrole die in het totaal is vertegenwoordigd.

recent_payments[]object[]altijd

Maximaal drie nieuwste geldige waarnemingen met status detected, confirming of final die aan precies deze wallet zijn toegewezen.

invoice_public_idUUIDaltijd

Factuuridentiteit voor de klant die bij de waarneming hoort.

chain_slugstringaltijd

Blockchain en weergavesymbool van eigen munt of geverifieerde token.

symbolstringaltijd

Blockchain en weergavesymbool van eigen munt of geverifieerde token.

transaction_idstringaltijd

Canonieke transactie- en overschrijvingsgebeurtenisidentiteit.

event_indexintegeraltijd

Canonieke transactie- en overschrijvingsgebeurtenisidentiteit.

amountdecimal stringaltijd

Exact waargenomen activabedrag zonder omzetting naar drijvendekommagetallen.

statusdetected | confirming | finalaltijd

Huidige geldige waarnemingsstatus. Gereorganiseerde, vervangen en ongeldige waarnemingen worden uitgesloten.

confirmationsintegeraltijd

Laatst waargenomen aantal bevestigingen.

observed_atRFC 3339 timestampaltijd

Tijdstip waarop Wholly Crypto de betaling voor het eerst waarnam.

created_atRFC 3339 timestampaltijd

Aanmaaktijd en laatste bijwerktijd van de wallet.

updated_atRFC 3339 timestampaltijd

Aanmaaktijd en laatste bijwerktijd van de wallet.

Gebruiksopmerkingen
  • Deze bearerroute geeft nooit een herstelzin, private sleutel, versleuteld geheim of bestedingsmethode terug.
  • Een nieuw geregistreerd actief op dezelfde blockchain wordt vóór de eerste voltooide scan teruggegeven met null-saldi en status pending; nooit met een verzonnen nul.
  • Een project, wallet voor betaalacceptatie, eigen betaalroute of afzonderlijk actief uitschakelen stopt alleen-lezen saldoregistratie niet: actieve en uitgeschakelde wallets met een primair adres blijven elk geregistreerd ondersteund actief op dezelfde blockchain vernieuwen. Wallets met status pending of error worden niet gescand.
  • project_enabled meldt alleen het acceptatiebeleid voor activa van het project en kan false zijn terwijl tracking_active true blijft.
  • balance en balance_atomic zijn exacte tekenreeksen; price_usd, value_usd en total_value_usd zijn indicatief en kunnen null zijn. Een actuele saldostatus garandeert geen actuele marktprijs.
  • Waardering gebruikt bij voorkeur CoinGecko-prijzen tot twee uur oud. Eigen munten en geverifieerde canonieke USDC/USDT kunnen terugvallen op ingeschakelde Kraken-/Binance-USD-koersen tot vijf minuten oud, met de primaire provider eerst. Geen aangenomen dollarkoppeling of prijsbepaling van eigen tokens alleen op tickersymbool; vaste/DEX-projectprijzen blijven afzonderlijk. Factuurprijsopgaven blijven ongewijzigd.
  • Pending heeft geen volledige momentopname. Refreshing behoudt het laatste voltooide bedrag en checked_at; het betekent niet dat een blockchainoverschrijving openstaat. Stale/error-bedragen kunnen ook oudere waarden behouden. Behandel een onbeschikbare cache nooit als nul of als een ontbrekende betaling. Routinematige EVM-/Solana-vernieuwingen hergebruiken recent gecontroleerde lege adressen tot 30 minuten tussen audits, terwijl gefinancierde, nieuwe en gewijzigde adressen opnieuw worden gecontroleerd. Expliciet Saldi scannen in de console vraagt een volledige scan aan.
  • recent_payments is begrensd op drie waarnemingen per wallet en sluit ongeldig verklaarde geschiedenis uit.

Fouten

Foutcodes & regels voor nieuwe pogingen

POSTFactuur maken/v1/projects/{project_id}/stores/{store_id}/invoicesLezen + schrijven

Maakt atomair een factuur met walletbestemmingen, actuele exacte prijsopgaven, auditgeschiedenis en meldingsuitboxrecords. Identieke onbewerkte bodybytes herhalen met dezelfde API-referentie en Idempotency-Key geeft de oorspronkelijke factuur terug.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MERCHANT_API_TOKEN
Idempotency-KeyvereistUnieke 1–128 zichtbare ASCII-tekens zonder witruimte.
Content-Typeaanbevolenapplication/json. De huidige handler voor de onbewerkte body verwerkt JSON zonder het mediatype af te dwingen.
Acceptaanbevolenapplication/json

Padparameters

project_idUUIDvereist

Kopieer de Project-API-ID uit Project → Instellingen → API-ID's. Moet aan de API-referentie zijn toegewezen; een leesbare projectidentificatie wordt niet geaccepteerd.

store_idUUIDvereist

Kopieer de Store-API-ID uit Project → Winkels → selecteer een winkel → Basis → API-ID's. Vereist ook voor de standaardwinkel; moet ingeschakeld zijn en bij project_id horen.

Verzoek

: "${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"
}'

Requestbody

amountstringvereist
Gewone decimale tekenreeks zonder teken; geen teken of exponent, maximaal 48 cijfers vóór en 30 na de komma. Moet standaard positief zijn. Een winkel kan facturen met nulbedrag toestaan onder Winkels → Factuur; nultotalen worden voldaan zonder geld te ontvangen, adressen toe te wijzen of verwerkingskosten.Details

Gewone decimale tekenreeks zonder teken; geen teken of exponent, maximaal 48 cijfers vóór en 30 na de komma. Moet standaard positief zijn. Een winkel kan facturen met nulbedrag toestaan onder Winkels → Factuur; nultotalen worden voldaan zonder geld te ontvangen, adressen toe te wijzen of verwerkingskosten.

currencystring | nulloptioneel
Ondersteunde fiatvaluta met drie letters, genormaliseerd naar hoofdletters. Weggelaten of null neemt de factuurvaluta van de winkel over. Aanmaak vereist ook een onafhankelijk beschikbare omrekenkoers voor facturering.Details

Ondersteunde fiatvaluta met drie letters, genormaliseerd naar hoofdletters. Weggelaten of null neemt de factuurvaluta van de winkel over. Aanmaak vereist ook een onafhankelijk beschikbare omrekenkoers voor facturering.

payment_methods[]object[] | nulloptioneel
Selecteer voor deze factuur methoden die in de winkel zijn ingeschakeld. Merchant 5.4.0+: negeer onbekende/inactieve/niet-geaccepteerde keuzes; als niets overeenkomt, gebruik de winkelstandaarden. Weggelaten/null gebruikt ook de winkelstandaarden; [] is ongeldig. Schakelt nooit een methode in en wijzigt geen winkelinstellingen. Zie het selectieschema hieronder.Details

Selecteer voor deze factuur methoden die in de winkel zijn ingeschakeld. Merchant 5.4.0+: negeer onbekende/inactieve/niet-geaccepteerde keuzes; als niets overeenkomt, gebruik de winkelstandaarden. Weggelaten/null gebruikt ook de winkelstandaarden; [] is ongeldig. Schakelt nooit een methode in en wijzigt geen winkelinstellingen. Zie het selectieschema hieronder.

chain_slugstringvereist
Kopieer chain_slug in Project → Winkels → Betaalmethoden of lees deze uit GET /v1/projects/{project_id}/stores/{store_id}/payment-assets, zoals ethereum, base of bitcoin. Een blockchain-/betaalroutepaar mag maar één keer voorkomen.Details

Kopieer chain_slug in Project → Winkels → Betaalmethoden of lees deze uit GET /v1/projects/{project_id}/stores/{store_id}/payment-assets, zoals ethereum, base of bitcoin. Een blockchain-/betaalroutepaar mag maar één keer voorkomen.

asset_ids[]UUID[] | nulloptioneel
asset.id-UUID's van blockchainactiva, geen contractadressen of factuur-betaalmethode-ID's. Gebruik dit OF asset_tickers. Laat beide selectoren weg voor alle actieve geaccepteerde activa op deze blockchain. [] en dubbele/nul-ID's zijn ongeldig. Negeer op 5.4.0+ ID's die op deze blockchain in deze winkel niet actief/geaccepteerd zijn; een volledig niet-overeenkomende selectie gebruikt winkelstandaarden.Details

asset.id-UUID's van blockchainactiva, geen contractadressen of factuur-betaalmethode-ID's. Gebruik dit OF asset_tickers. Laat beide selectoren weg voor alle actieve geaccepteerde activa op deze blockchain. [] en dubbele/nul-ID's zijn ongeldig. Negeer op 5.4.0+ ID's die op deze blockchain in deze winkel niet actief/geaccepteerd zijn; een volledig niet-overeenkomende selectie gebruikt winkelstandaarden.

asset_tickers[]string[] | nulloptioneel
Merchant 5.3.0+. Symbolen zoals BTC, USDC of PEPE, beperkt tot chain_slug en deze winkel. 1–64 unieke tickersymbolen; witruimte aan uiteinden verwijderd/hoofdletterongevoelig, 1–40 ASCII-letters/cijfers/punt/underscore/koppelteken. Gebruik dit OF asset_ids. Negeer op 5.4.0+ onbekende/inactieve/niet-geaccepteerde tickersymbolen. Dubbelzinnige geaccepteerde symbolen blijven een fout geven: gebruik asset_ids. Actieve geselecteerde methoden hebben geldige wallets en prijsbepaling nodig; tijdelijke storingen van blockchainscanners blokkeren aanmaak vanaf 6.0.6 niet. Lightning accepteert optioneel alleen BTC.Details

Merchant 5.3.0+. Symbolen zoals BTC, USDC of PEPE, beperkt tot chain_slug en deze winkel. 1–64 unieke tickersymbolen; witruimte aan uiteinden verwijderd/hoofdletterongevoelig, 1–40 ASCII-letters/cijfers/punt/underscore/koppelteken. Gebruik dit OF asset_ids. Negeer op 5.4.0+ onbekende/inactieve/niet-geaccepteerde tickersymbolen. Dubbelzinnige geaccepteerde symbolen blijven een fout geven: gebruik asset_ids. Actieve geselecteerde methoden hebben geldige wallets en prijsbepaling nodig; tijdelijke storingen van blockchainscanners blokkeren aanmaak vanaf 6.0.6 niet. Lightning accepteert optioneel alleen BTC.

payment_railonchain | lightningoptioneel
Standaard onchain. Gebruik om Bitcoin Lightning te kiezen {chain_slug: bitcoin, payment_rail: lightning} zonder asset_ids; asset_tickers mag optioneel [BTC] zijn. Bitcoin op de blockchain omvat Lightning niet. De Lightning-verbinding van de winkel moet al ingeschakeld en gereed zijn.Details

Standaard onchain. Gebruik om Bitcoin Lightning te kiezen {chain_slug: bitcoin, payment_rail: lightning} zonder asset_ids; asset_tickers mag optioneel [BTC] zijn. Bitcoin op de blockchain omvat Lightning niet. De Lightning-verbinding van de winkel moet al ingeschakeld en gereed zijn.

order_idstring | nulloptioneel

Bestelreferentie van de handelaar, 1–128 tekens na verwijderen van witruimte aan de uiteinden; stuurtekens worden afgewezen.

emailstring | nulloptioneel

E-mailadres van de klant, alleen voor de handelaar, genormaliseerd naar een praktisch ASCII-adres van maximaal 254 tekens. Weggelaten of null slaat geen e-mailadres op.

descriptionstring | nulloptioneel

Omschrijving voor de klant, 1–500 tekens; regeleinden en tabs zijn toegestaan.

expires_in_secondsinteger | nulloptioneel

Geldigheidsduur van de factuurprijsopgave van 300 tot en met 86,400 seconden; weggelaten of null neemt het winkelbeleid over.

exchange_rate_spread_percentdecimal string | nulloptioneel
Prijsopslag van 0 tot en met 100, met maximaal twee decimalen. Weggelaten of null neemt de winkelstandaard over; "0" schakelt deze uit voor deze factuur. Wordt vóór afronding naar boven toegepast en daarna vastgezet. Verandert het fiatbedrag van de factuur of de basis voor de verwerkingsvergoeding niet.Details

Prijsopslag van 0 tot en met 100, met maximaal twee decimalen. Weggelaten of null neemt de winkelstandaard over; "0" schakelt deze uit voor deze factuur. Wordt vóór afronding naar boven toegepast en daarna vastgezet. Verandert het fiatbedrag van de factuur of de basis voor de verwerkingsvergoeding niet.

underpayment_tolerance_percentdecimal string | nulloptioneel

Geaccepteerd tekort van 0 tot en met 99.99 met maximaal twee decimalen. Weggelaten of null neemt de winkelstandaard over.

ipn_urlstring | nulloptioneel

Publieke HTTPS-callback, maximaal 2,048 bytes en zonder inloggegevens of fragment. Overschrijft de winkelstandaard; null/weggelaten neemt die over.

redirect_urlstring | nulloptioneel

HTTPS-succes-URL die na voldoening wordt gebruikt, maximaal 2,048 bytes en zonder ingebedde inloggegevens. Weggelaten of null neemt de winkelstandaard over en kan die niet wissen.

cancel_urlstring | nulloptioneel

HTTPS-terugkeer-URL die wordt gebruikt als afrekenen zonder succesvolle betaling eindigt. Weggelaten of null neemt de winkelstandaard over en kan die niet wissen.

redirect_automaticallyboolean | nulloptioneel

Weggelaten of null neemt het winkelbeleid over. true vereist een effectieve redirect_url.

languagestring | nulloptioneel
Klanttaal: en, de, es, pt-BR, it, ru, zh-CN, fr, ko of ja. pt betekent Braziliaans Portugees en zh betekent vereenvoudigd Chinees. Ondersteunde regionale tags zoals de-DE worden genormaliseerd naar de vermelde taal. Weggelaten of null neemt de winkeltaal over. De consoletaal staat hier los van.Details

Klanttaal: en, de, es, pt-BR, it, ru, zh-CN, fr, ko of ja. pt betekent Braziliaans Portugees en zh betekent vereenvoudigd Chinees. Ondersteunde regionale tags zoals de-DE worden genormaliseerd naar de vermelde taal. Weggelaten of null neemt de winkeltaal over. De consoletaal staat hier los van.

checkout_appearanceobject | nulloptioneel
Gedeeltelijke presentatie-instellingen voor deze factuur. Weggelaten/null volgt het huidige winkelontwerp. Een object, inclusief {}, zet het berekende ontwerp en de afbeeldingen bij aanmaak vast. Zie het afwijkingsschema hieronder; geen financiële instellingen, HTML, CSS, JavaScript of externe afbeeldings-URL's.Details

Gedeeltelijke presentatie-instellingen voor deze factuur. Weggelaten/null volgt het huidige winkelontwerp. Een object, inclusief {}, zet het berekende ontwerp en de afbeeldingen bij aanmaak vast. Zie het afwijkingsschema hieronder; geen financiële instellingen, HTML, CSS, JavaScript of externe afbeeldings-URL's.

inherit_default_storebooleanoptioneel
true kiest het ontwerp van de standaardwinkel van het project als basis; gebruik anders het effectieve ontwerp van de doelwinkel. Afwijkingen worden daarna toegepast en onafhankelijk opgeslagen; de uiteindelijke factuurvlag is false.Details

true kiest het ontwerp van de standaardwinkel van het project als basis; gebruik anders het effectieve ontwerp van de doelwinkel. Afwijkingen worden daarna toegepast en onafhankelijk opgeslagen; de uiteindelijke factuurvlag is false.

titlestringoptioneel

Afrekenkop, maximaal 120 tekens. Leeg gebruikt de standaardkop.

introstringoptioneel
Platte tekst, elk maximaal 2,000 tekens. Intro verschijnt bovenaan, Outro onderaan in elke status. Regeleinden blijven behouden; veilige tekst-URL's worden links. Een lege tekenreeks wist. Het oudere customer_message wordt als alias voor intro geaccepteerd; verstuur niet beide.Details

Platte tekst, elk maximaal 2,000 tekens. Intro verschijnt bovenaan, Outro onderaan in elke status. Regeleinden blijven behouden; veilige tekst-URL's worden links. Een lege tekenreeks wist. Het oudere customer_message wordt als alias voor intro geaccepteerd; verstuur niet beide.

outrostringoptioneel
Platte tekst, elk maximaal 2,000 tekens. Intro verschijnt bovenaan, Outro onderaan in elke status. Regeleinden blijven behouden; veilige tekst-URL's worden links. Een lege tekenreeks wist. Het oudere customer_message wordt als alias voor intro geaccepteerd; verstuur niet beide.Details

Platte tekst, elk maximaal 2,000 tekens. Intro verschijnt bovenaan, Outro onderaan in elke status. Regeleinden blijven behouden; veilige tekst-URL's worden links. Een lege tekenreeks wist. Het oudere customer_message wordt als alias voor intro geaccepteerd; verstuur niet beide.

intro_font_sizeintegeroptioneel

Pixels: 12, 14, 16, 18, 20 of 24. Standaard 16 tenzij anders overgenomen.

outro_font_sizeintegeroptioneel

Pixels: 12, 14, 16, 18, 20 of 24. Standaard 16 tenzij anders overgenomen.

themesystem | light | dim | darkoptioneel

Volg het apparaat van de klant of gebruik een vast thema.

accent_colorstringoptioneel

#RRGGBB. Achtergrond, kaart en knop mogen leeg zijn voor automatische kleuren. Tekstcontrast is automatisch.

background_colorstringoptioneel

#RRGGBB. Achtergrond, kaart en knop mogen leeg zijn voor automatische kleuren. Tekstcontrast is automatisch.

card_colorstringoptioneel

#RRGGBB. Achtergrond, kaart en knop mogen leeg zijn voor automatische kleuren. Tekstcontrast is automatisch.

button_colorstringoptioneel

#RRGGBB. Achtergrond, kaart en knop mogen leeg zijn voor automatische kleuren. Tekstcontrast is automatisch.

logo_sizestringoptioneel

small, medium of large; left of center.

logo_alignmentstringoptioneel

small, medium of large; left of center.

imagesobjectoptioneel
Sleutels logo_light, logo_dark, favicon. Een weggelaten sleutel behoudt de basisafbeelding; null verwijdert die. Een object {store_id: UUID, kind?: logo_light|logo_dark|favicon} hergebruikt de effectieve geüploade afbeelding van die winkel in HETZELFDE project. kind is standaard de doelsleutel. Upload eerst onder Winkel → Afrekenen; kopieer de Store-API-ID uit Basis → API-ID's. Ontbrekende afbeeldingen of ID's uit andere projecten geven 400 terug. Geen externe URL's of afbeeldingsgegevens toegestaan.Details

Sleutels logo_light, logo_dark, favicon. Een weggelaten sleutel behoudt de basisafbeelding; null verwijdert die. Een object {store_id: UUID, kind?: logo_light|logo_dark|favicon} hergebruikt de effectieve geüploade afbeelding van die winkel in HETZELFDE project. kind is standaard de doelsleutel. Upload eerst onder Winkel → Afrekenen; kopieer de Store-API-ID uit Basis → API-ID's. Ontbrekende afbeeldingen of ID's uit andere projecten geven 400 terug. Geen externe URL's of afbeeldingsgegevens toegestaan.

logo_lightobject | nulloptioneel
store_idUUIDvereist
kindlogo_light | logo_dark | faviconoptioneel
logo_darkobject | nulloptioneel
store_idUUIDvereist
kindlogo_light | logo_dark | faviconoptioneel
faviconobject | nulloptioneel
store_idUUIDvereist
kindlogo_light | logo_dark | faviconoptioneel
show_order_idbooleanoptioneel

Toon bestel-ID-details en een platte-tekstomschrijving onder de titel. details_expanded opent bestel-ID-details standaard. Alleen weergave, geen afscherming van gegevens.

show_descriptionbooleanoptioneel

Toon bestel-ID-details en een platte-tekstomschrijving onder de titel. details_expanded opent bestel-ID-details standaard. Alleen weergave, geen afscherming van gegevens.

details_expandedbooleanoptioneel

Toon bestel-ID-details en een platte-tekstomschrijving onder de titel. details_expanded opent bestel-ID-details standaard. Alleen weergave, geen afscherming van gegevens.

show_project_namebooleanoptioneel
Merchant 5.6.0+: toon of verberg elke naam in de kop van de klantafrekenpagina. Beide zijn standaard true. Ook beschikbaar onder Winkel → Afrekenen; overgenomen en vastgelegd per factuur zoals andere uiterlijkinstellingen. Alleen weergave, geen afscherming van gegevens.Details

Merchant 5.6.0+: toon of verberg elke naam in de kop van de klantafrekenpagina. Beide zijn standaard true. Ook beschikbaar onder Winkel → Afrekenen; overgenomen en vastgelegd per factuur zoals andere uiterlijkinstellingen. Alleen weergave, geen afscherming van gegevens.

show_store_namebooleanoptioneel
Merchant 5.6.0+: toon of verberg elke naam in de kop van de klantafrekenpagina. Beide zijn standaard true. Ook beschikbaar onder Winkel → Afrekenen; overgenomen en vastgelegd per factuur zoals andere uiterlijkinstellingen. Alleen weergave, geen afscherming van gegevens.Details

Merchant 5.6.0+: toon of verberg elke naam in de kop van de klantafrekenpagina. Beide zijn standaard true. Ook beschikbaar onder Winkel → Afrekenen; overgenomen en vastgelegd per factuur zoals andere uiterlijkinstellingen. Alleen weergave, geen afscherming van gegevens.

featured_chains[]string[]optioneel
Geordende blockchain-slugs, maximaal 60 unieke waarden (kleine letters, cijfers, koppeltekens; maximaal 64 tekens). [] wist. Alleen beschikbare factuurmethoden worden opnieuw geordend.Details

Geordende blockchain-slugs, maximaal 60 unieke waarden (kleine letters, cijfers, koppeltekens; maximaal 64 tekens). [] wist. Alleen beschikbare factuurmethoden worden opnieuw geordend.

featured_asset_ids[]UUID[]optioneel
Maximaal 100 unieke geordende activa-ID's; [] wist. Het standaardactief mag null zijn. ID's komen uit payment-assets, niet uit betalingsintenties. Deze schakelen nooit methoden in; ontvangen betalingen en geldige klantvoorkeuren hebben voorrang.Details

Maximaal 100 unieke geordende activa-ID's; [] wist. Het standaardactief mag null zijn. ID's komen uit payment-assets, niet uit betalingsintenties. Deze schakelen nooit methoden in; ontvangen betalingen en geldige klantvoorkeuren hebben voorrang.

default_asset_idUUID|nulloptioneel
Maximaal 100 unieke geordende activa-ID's; [] wist. Het standaardactief mag null zijn. ID's komen uit payment-assets, niet uit betalingsintenties. Deze schakelen nooit methoden in; ontvangen betalingen en geldige klantvoorkeuren hebben voorrang.Details

Maximaal 100 unieke geordende activa-ID's; [] wist. Het standaardactief mag null zijn. ID's komen uit payment-assets, niet uit betalingsintenties. Deze schakelen nooit methoden in; ontvangen betalingen en geldige klantvoorkeuren hebben voorrang.

messagesobjectoptioneel
Taalobjecten met sleutels en, de, es, pt-BR, it, ru, zh-CN, fr, ko of ja, met gewone tekenreeksen waiting, confirming, paid, underpaid, expired (elk 500 tekens). Alleen aangeleverde talen/statussen veranderen; {} wist alle berichten, {en:{}} wist Engels en een lege statustekenreeks wist die status. Engels is de terugvaltaal. Vervangt de werkelijke status niet.Details

Taalobjecten met sleutels en, de, es, pt-BR, it, ru, zh-CN, fr, ko of ja, met gewone tekenreeksen waiting, confirming, paid, underpaid, expired (elk 500 tekens). Alleen aangeleverde talen/statussen veranderen; {} wist alle berichten, {en:{}} wist Engels en een lege statustekenreeks wist die status. Engels is de terugvaltaal. Vervangt de werkelijke status niet.

enobjectoptioneel
waitingstringoptioneel
confirmingstringoptioneel
paidstringoptioneel
underpaidstringoptioneel
expiredstringoptioneel
deobjectoptioneel
waitingstringoptioneel
confirmingstringoptioneel
paidstringoptioneel
underpaidstringoptioneel
expiredstringoptioneel
esobjectoptioneel
waitingstringoptioneel
confirmingstringoptioneel
paidstringoptioneel
underpaidstringoptioneel
expiredstringoptioneel
pt-BRobjectoptioneel
waitingstringoptioneel
confirmingstringoptioneel
paidstringoptioneel
underpaidstringoptioneel
expiredstringoptioneel
itobjectoptioneel
waitingstringoptioneel
confirmingstringoptioneel
paidstringoptioneel
underpaidstringoptioneel
expiredstringoptioneel
ruobjectoptioneel
waitingstringoptioneel
confirmingstringoptioneel
paidstringoptioneel
underpaidstringoptioneel
expiredstringoptioneel
zh-CNobjectoptioneel
waitingstringoptioneel
confirmingstringoptioneel
paidstringoptioneel
underpaidstringoptioneel
expiredstringoptioneel
frobjectoptioneel
waitingstringoptioneel
confirmingstringoptioneel
paidstringoptioneel
underpaidstringoptioneel
expiredstringoptioneel
koobjectoptioneel
waitingstringoptioneel
confirmingstringoptioneel
paidstringoptioneel
underpaidstringoptioneel
expiredstringoptioneel
jaobjectoptioneel
waitingstringoptioneel
confirmingstringoptioneel
paidstringoptioneel
underpaidstringoptioneel
expiredstringoptioneel
support_emailstringoptioneel

ASCII-e-mailadres, maximaal 254 tekens. Leeg wist.

support_urlstringoptioneel

HTTPS-URL's tot 2,048 tekens, zonder inloggegevens. Leeg wist. Links openen in een nieuw venster.

terms_urlstringoptioneel

HTTPS-URL's tot 2,048 tekens, zonder inloggegevens. Leeg wist. Links openen in een nieuw venster.

privacy_urlstringoptioneel

HTTPS-URL's tot 2,048 tekens, zonder inloggegevens. Leeg wist. Links openen in een nieuw venster.

return_button_textstringoptioneel

Label tot 60 tekens. Gebruik redirect_url/cancel_url/redirect_automatically/language op het hoogste niveau voor factuurgedrag.

show_return_buttonbooleanoptioneel
Toon de handmatige knop Terug naar handelaar/annuleren op de afrekenpagina, inclusief eindstatussen. Laat weg om het winkeluiterlijk over te nemen (standaard true); false verbergt de knop. Annuleert geen factuur, verbergt geen URL's in JSON en schakelt automatische succesomleidingen niet uit. Stel zo nodig redirect_automatically op het hoogste niveau afzonderlijk in op false. Vereist merchant 8.1.4 of nieuwer.Details

Toon de handmatige knop Terug naar handelaar/annuleren op de afrekenpagina, inclusief eindstatussen. Laat weg om het winkeluiterlijk over te nemen (standaard true); false verbergt de knop. Annuleert geen factuur, verbergt geen URL's in JSON en schakelt automatische succesomleidingen niet uit. Stel zo nodig redirect_automatically op het hoogste niveau afzonderlijk in op false. Vereist merchant 8.1.4 of nieuwer.

metadataobject | nulloptioneel
JSON-object alleen voor de handelaar; weggelaten of null wordt {}, maximaal 4,096 gecodeerde bytes en vijf nestingsniveaus. firstname, lastname, street, street2, zip, city, country, countryiso2, company en vatid worden gevalideerd, genormaliseerd en overgenomen in samenvattingsvelden van de klant.Details

JSON-object alleen voor de handelaar; weggelaten of null wordt {}, maximaal 4,096 gecodeerde bytes en vijf nestingsniveaus. firstname, lastname, street, street2, zip, city, country, countryiso2, company en vatid worden gevalideerd, genormaliseerd en overgenomen in samenvattingsvelden van de klant.

firstnamestringoptioneel
lastnamestringoptioneel
streetstringoptioneel
street2stringoptioneel
zipstringoptioneel
citystringoptioneel
countrystringoptioneel
countryiso2stringoptioneel
companystringoptioneel
vatidstringoptioneel
cart_idstring

Antwoord 201 new invoice; 200 exact idempotent replay

Voorbeeldantwoord
{
  "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"
  }
}

Antwoordvelden

dataobject
idUUIDaltijd

Interne factuur-UUID. Gebruik die niet in handelaarsdetail- of afrekenpaden.

invoice_idUUIDaltijd

Publieke factuur-UUID die door handelaarsdetail- en afrekenpaden wordt gebruikt.

project_idUUIDaltijd

Project waartoe dit behoort.

store_idUUIDaltijd

Winkel waartoe dit behoort.

sourcemanual | apialtijd

Hoe de factuur is gemaakt.

order_idstring | nullaltijd

Bestelreferentie van de handelaar.

emailstring | nullaltijd

E-mailadres van de klant, alleen voor de handelaar. Wordt nooit door publiek afrekenen teruggegeven.

customer_namestring | nullaltijd

Afgeleide weergavenaam uit private metadata firstname, lastname en company.

customer_addressstring | nullaltijd

Afgeleid handelaarsadres op één regel uit private metadata company, street, street2, zip, city, country, countryiso2 en vatid.

descriptionstring | nullaltijd

Omschrijving voor de klant.

amountdecimal stringaltijd

Canoniek factuurbedrag.

currencystringaltijd

Genormaliseerde factuurvaluta-/activacode.

exchange_rate_spread_percentdecimal stringaltijd

Vastgezette prijsopslag: de afwijking bij aanmaak of de winkelstandaard bij weglaten. Toegepast vóór afronding naar boven; verandert nooit op deze factuur.

underpayment_tolerance_percentdecimal stringaltijd

Onwijzigbaar geaccepteerd tekortpercentage, vastgelegd bij het maken van de factuur.

statusinvoice statusaltijd

new, processing, settled, expired, invalid of cancelled.

amount_statusamount statusaltijd

none, partial, paid of overpaid. Een expliciet toegestane factuur met nulbedrag wordt voldaan met none en zonder betaalmethoden.

timing_statustiming statusaltijd

on_time of late.

resolutionresolutionaltijd

automatic, manually_settled of manually_invalidated.

sequenceintegeraltijd

Monotoon oplopende factuurstatus-sequence, beginnend bij 1.

winning_payment_intent_idUUID | nullaltijd

Betaalmethode die de factuur heeft afgehandeld, wanneer geselecteerd.

expires_atRFC 3339 timestampaltijd

Deadline van prijsopgave/betaling.

monitoring_expires_atRFC 3339 timestampaltijd

Laatste ingestelde grens voor controle op late betalingen over alle betaalmethoden.

settled_attimestamp | nullaltijd

Tijdstip van voldoening indien voldaan.

cancelled_attimestamp | nullaltijd

Annuleringstijd indien geannuleerd.

archived_attimestamp | nullaltijd

Archiveringstijd indien gearchiveerd.

created_atRFC 3339 timestampaltijd

Aanmaaktijd.

updated_atRFC 3339 timestampaltijd

Laatste bijwerktijd van de status.

ipn_urlstring | nullaltijd

Effectieve IPN-bestemming per factuur. Alleen handelaarsantwoord; weggelaten uit publiek afrekenen.

redirect_urlstring | nullaltijd

Effectieve succes-URL die na voldoening wordt gebruikt.

cancel_urlstring | nullaltijd

Effectieve terugkeer-URL die wordt gebruikt als afrekenen zonder succesvolle betaling eindigt.

redirect_automaticallybooleanaltijd

Of afrekenen na succes automatisch moet omleiden.

checkout_languagestringaltijd

Effectieve afrekentaaltag.

metadataobjectaltijd
Handelaarsmetadata. Wordt nooit door publiek afrekenen teruggegeven. Betaalhulpmiddelen in de console voegen payment_tool-herkomst toe (id, kind, title, pricing, requested_amount, request_id); dit bewijst geen betaling. Authenticeer callbacks en handel invoice.settled één keer per invoice_id af.Details

Handelaarsmetadata. Wordt nooit door publiek afrekenen teruggegeven. Betaalhulpmiddelen in de console voegen payment_tool-herkomst toe (id, kind, title, pricing, requested_amount, request_id); dit bewijst geen betaling. Authenticeer callbacks en handel invoice.settled één keer per invoice_id af.

cart_idstring
firstnamestring
lastnamestring
streetstring
street2string
zipstring
citystring
countrystring
countryiso2string
companystring
vatidstring
payment_intents[]object[]altijd

Geoffreerde betaalmethoden en monitoringsstatus.

idUUIDaltijd

Identificatie van de betalingsintentie; ook gebruikt als intent_id voor de afreken-QR-code.

payment_railonchain | lightningaltijd
Factuurtransport. Bitcoin op de blockchain en Lightning kunnen asset_id delen; gebruik de intentie-id plus dit veld, niet alleen het symbool. Dit verschilt van de scanner-payment_rail in de activacatalogus.Details

Factuurtransport. Bitcoin op de blockchain en Lightning kunnen asset_id delen; gebruik de intentie-id plus dit veld, niet alleen het symbool. Dit verschilt van de scanner-payment_rail in de activacatalogus.

bolt11string | nullaltijd

Lightning-betaalverzoek, anders null. Betaal dit verzoek met een Lightning-wallet; stuur nooit blockchainmiddelen naar de betalingshash.

asset_idUUIDaltijd

Identificatie van het ingestelde betaalactief.

asset_keystringaltijd

Canonieke activasleutel in CAIP-stijl.

chain_slugstringaltijd

Wholly Crypto-blockchainidentificatie.

networkstringaltijd

Ingesteld netwerk, momenteel mainnet voor ondersteunde betaalactiva.

caip_network_idstringaltijd

Canonieke CAIP-2-netwerkidentificatie.

caip_asset_idstring | nullaltijd

Canonieke CAIP-19-identificatie, waar geregistreerd.

symbolstringaltijd

Activasymbool.

asset_decimalsintegeraltijd

Precisie in atomaire eenheden. Lightning BTC gebruikt 11 (millisatoshi's), niet de 8 van Bitcoin op de blockchain. Prijsopgaven zijn hele satoshi's; ontvangsten behouden millisatoshiprecisie.

statusintent statusaltijd

pending, partial, paid, overpaid, expired of invalid.

finality_modeconfirmations | finalizedaltijd

Finaliteitsbeleid.

required_confirmationsintegeraltijd

Vereiste bevestigingen indien van toepassing.

quote_ratedecimal stringaltijd

Eenheden van het actief per één eenheid factuurvaluta, inclusief de vastgezette opslag. Bijvoorbeeld 1.02 USDC per USD. Niet de omgekeerde koers.

quote_detailsobject | nullaltijd
Vastgezette herkomst van de prijsopgave: reference_rate vóór opslag, unrounded_payment_amount, rounding_adjustment, pricing_provider, asset_provider, pricing_fetched_at en asset_fetched_at. Null bij oudere facturen; er worden geen historische waarden verzonnen.Details

Vastgezette herkomst van de prijsopgave: reference_rate vóór opslag, unrounded_payment_amount, rounding_adjustment, pricing_provider, asset_provider, pricing_fetched_at en asset_fetched_at. Null bij oudere facturen; er worden geen historische waarden verzonnen.

expected_amountdecimal stringaltijd
Exact vastgezet te betalen activabedrag na opslag en afronding naar boven. Vanaf 4.1.1 worden herkende geverifieerde fiatstablecoins (zoals USDC, USDT, DAI, USDS, EURC) naar boven afgerond op maximaal twee decimalen; 1.321 wordt 1.33, nooit 1.32. Dit is het verwachte bedrag, ook bij nultolerantie. Andere activa behouden adaptieve precisie. Bestaande facturen worden nooit opnieuw geprijsd.Details

Exact vastgezet te betalen activabedrag na opslag en afronding naar boven. Vanaf 4.1.1 worden herkende geverifieerde fiatstablecoins (zoals USDC, USDT, DAI, USDS, EURC) naar boven afgerond op maximaal twee decimalen; 1.321 wordt 1.33, nooit 1.32. Dit is het verwachte bedrag, ook bij nultolerantie. Andere activa behouden adaptieve precisie. Bestaande facturen worden nooit opnieuw geprijsd.

expected_amount_atomicinteger stringaltijd

Exact bedrag in de kleinste eenheid van het actief.

minimum_payment_amountdecimal stringaltijd

Kleinste bedrag dat na toepassing van de factuurtolerantie als betaald wordt geaccepteerd.

minimum_payment_amount_atomicinteger stringaltijd

Exacte geaccepteerde drempel in de kleinste eenheid van het actief.

received_amountdecimal stringaltijd

Waargenomen bedrag.

received_amount_atomicinteger stringaltijd

Waargenomen atomair bedrag.

confirmed_amountdecimal stringaltijd

Bevestigd/definitief bedrag.

confirmed_amount_atomicinteger stringaltijd

Bevestigd/definitief atomair bedrag.

destination_addressstringaltijd

Ontvangstadres op de blockchain of de betalingshash van 64 tekens voor Lightning. Gebruik bolt11 om via Lightning te betalen; de hash is geen Bitcoin-adres.

destination_tagstring | nullaltijd

Vereiste publieke betalingsreferentie waar de betaalroute die gebruikt: XRP-bestemmingstag, Stellar-memo-ID of TON-factuurcommentaar. Null voor routes met unieke adressen.

derivation_indexintegeraltijd

Gereserveerde onderliggende walletindex; alleen handelaarsdetails.

quote_expires_atRFC 3339 timestampaltijd

Vervaltijd van de prijsopgave.

monitoring_expires_atRFC 3339 timestampaltijd

Eindgrens voor controle op late betalingen voor deze methode.

next_check_attimestamp | nullaltijd

Volgende geplande blockchaincontrole.

last_checked_attimestamp | nullaltijd

Laatste blockchaincontrole.

last_chain_heightinteger | nullaltijd

Laatste betrouwbare hoogte die door de monitor is waargenomen.

last_anchor_hashstring | nullaltijd

Laatste monitoranker/blokhash.

last_monitor_errorstring | nullaltijd

Veilige monitoringsdiagnostiek voor operators.

first_payment_attimestamp | nullaltijd

Tijdstip waarop een betaling voor het eerst is waargenomen.

fully_paid_attimestamp | nullaltijd

Tijdstip waarop het geaccepteerde minimumbedrag voor het eerst werd bereikt.

finalized_attimestamp | nullaltijd

Tijdstip waarop de betaling voldeed aan het finaliteitsbeleid.

Gebruiksopmerkingen
  • payment_methods filtert ingeschakelde winkelmethoden alleen voor deze factuur. Weggelaten/null behoudt alle winkelmethoden; [] is ongeldig. Je vindt de kleine chain_slug-aanduiding en getoonde tickersymbolen onder Project → Winkels → Betaalmethoden. De API-lijst payment-assets levert chain_slug, asset.symbol en asset.id. Gebruik {chain_slug: ethereum, asset_tickers: [USDC, USDT]} voor geaccepteerde Ethereum-tokens; BTC en PEPE werken hetzelfde op hun geselecteerde blockchains. Tickersymbolen zijn hoofdletterongevoelig, beperkt tot de blockchain en worden alleen binnen de winkel opgezocht. Twee geaccepteerde contracten met hetzelfde tickersymbool geven 400 terug in plaats van er één te kiezen, ook als één niet gereed is; gebruik in dat geval asset_ids. Eigen munten, catalogustokens en eigen tokens volgen dezelfde regels. Elke blockchain/betaalroute mag één keer voorkomen; maximaal 64 uiteindelijke methoden. Merchant 5.4.0+: onbekende, uitgeschakelde, verkeerde-blockchain- of niet-geaccepteerde keuzes worden genegeerd. Als de volledige selectie geen actieve geaccepteerde overeenkomsten heeft, gelden de winkelstandaarden; anders worden alleen overeenkomende keuzes gebruikt. Een vermelding met alleen de blockchain omvat elk actief geaccepteerd blockchainactief. Actieve geselecteerde methoden hebben geldige wallets, geïnstalleerde scanneradapters en betrouwbare koersen nodig. Vanaf 6.0.6 blokkeren onbeschikbare scanners, wachttijden en nog niet uitgevoerde/verouderde gezondheidscontroles de factuuraanmaak niet en verwijderen ze geen ingestelde blockchainmethoden. Detectie probeert automatisch opnieuw; voldoening vereist nog steeds providerquorum en bevestigingen. Bewaak receive_readiness en houd providers beschikbaar: een factuur kan ongeverifieerd blijven totdat scanners herstellen. Toewijzing van Monero-subadressen en aanmaak van Lightning-BOLT11 vereisen nog steeds hun externe wallet-/nodeservice. Fouten geven error.message plus error.details.payment_methods terug met chain_slug, asset_ticker, reason_code en, voor scannerdiagnostiek, required_endpoint_role, healthy_endpoints en required_independent_providers. TRON accepteert geïndexeerde geschiedenis of ondersteunde ruwe API's voor definitief bevestigde blokken van de eigen munt; basisgezondheid alleen bewijst geen scannercompatibiliteit. Prijsfouten identificeren het actief/de valuta. Niets schakelt een niet-geaccepteerd actief in of wijzigt winkelbeleid. Op merchantversies vóór 5.4.0 mislukken onbekende/inactieve expliciete keuzes in plaats daarvan. Bestaande factuurmethoden worden nooit uitgebreid wanneer winkelinstellingen veranderen. Lightning moet afzonderlijk worden geselecteerd. Herhalingen behouden de oorspronkelijke methoden en selecties wijzigen met dezelfde Idempotency-Key geeft 409 terug.
  • checkout_appearance ondersteunt elke hierboven vermelde presentatie-instelling. Weggelaten velden nemen waarden over, arrays vervangen en geneste berichtvelden worden samengevoegd; een leeg berichtobject wist dat bereik. Het berekende ontwerp en de afbeeldingen worden voor deze factuur opgeslagen zonder de winkel te bewerken. Lees appearance uit de publieke afreken-JSON om het resultaat te bekijken. Het volledige verzoek is beperkt tot 32 KiB en de uiteindelijke instellingen tot 20 KiB.
  • checkout_appearance wijzigen met dezelfde Idempotency-Key geeft 409 terug; probeer opnieuw met identieke onbewerkte bytes. Uiterlijk verandert geen bedragen, koersen, geaccepteerde activa, bevestigingseisen, werkelijke status of inbedrechten. Geen HTML, CSS, scripts of ophalen van externe afbeeldingen.
  • exchange_rate_spread_percent overschrijft de winkelstandaard voor deze factuur: laat weg of verstuur null om over te nemen, of verstuur "0" om uit te schakelen. Bestaande factuurprijsopgaven veranderen nooit.
  • Opslag wordt vóór afronding naar boven toegepast. Kosten blijven gebaseerd op het oorspronkelijke fiatbedrag van de factuur, exclusief de opslag.
  • Verstuur altijd het teruggegeven expected_amount of expected_amount_atomic. Afronding gebeurt naar boven, begrensd door activaprecisie, 0.1% van het bedrag en één kleine fiatvaluta-eenheid.
  • Nieuwe pogingen moeten dezelfde API-referentie, Idempotency-Key en exacte bodybytes behouden. Opslag wijzigen met dezelfde sleutel geeft 409 idempotency_conflict terug.
  • Een exacte herhaling wordt gecontroleerd vóór een nieuwe prijsopgave, callback-DNS of adresvoorbereiding. Bereik van de API-referentie en project-/winkelautorisatie worden nog steeds bij elk verzoek gecontroleerd.
  • Een effectieve ipn_url vereist het IPN-ondertekeningsgeheim van de winkel. Onbekende bodyvelden worden afgewezen.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETFacturen opvragen/v1/projects/{project_id}/invoicesAlleen-lezen

Geeft een compacte pagina met factuursamenvattingen binnen het bereik terug, nieuwste eerst, inclusief e-mail alleen voor de handelaar en klantvelden afgeleid van herkende metadata. Zoek-, status- en winkelfilters worden op de server toegepast; het antwoord bevat total en has_more voor voorspelbare paginering.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MERCHANT_API_TOKEN
Acceptaanbevolenapplication/json

Padparameters

project_idUUIDvereist

Ingeschakeld project dat aan de API-referentie is toegewezen.

Queryparameters

store_idUUID

Optioneel exact winkelfilter.

statusenum

Optioneel new, processing, settled, expired, invalid of cancelled.

limitinteger

Optioneel 1–100; standaard 50.

offsetinteger

Optioneel 0–1,000,000; standaard 0.

Verzoek

: "${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'

Antwoord 200 application/json

Voorbeeldantwoord
{
  "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
  }
}

Antwoordvelden

data[]object[]
idUUIDaltijd

Interne factuur-UUID. Gebruik die niet in handelaarsdetail- of afrekenpaden.

invoice_idUUIDaltijd

Publieke factuur-UUID die door handelaarsdetail- en afrekenpaden wordt gebruikt.

project_idUUIDaltijd

Project waartoe dit behoort.

store_idUUIDaltijd

Winkel waartoe dit behoort.

sourcemanual | apialtijd

Hoe de factuur is gemaakt.

order_idstring | nullaltijd

Bestelreferentie van de handelaar.

emailstring | nullaltijd

E-mailadres van de klant, alleen voor de handelaar. Wordt nooit door publiek afrekenen teruggegeven.

customer_namestring | nullaltijd

Afgeleide weergavenaam uit private metadata firstname, lastname en company.

customer_addressstring | nullaltijd

Afgeleid handelaarsadres op één regel uit private metadata company, street, street2, zip, city, country, countryiso2 en vatid.

descriptionstring | nullaltijd

Omschrijving voor de klant.

amountdecimal stringaltijd

Canoniek factuurbedrag.

currencystringaltijd

Genormaliseerde factuurvaluta-/activacode.

exchange_rate_spread_percentdecimal stringaltijd

Vastgezette prijsopslag: de afwijking bij aanmaak of de winkelstandaard bij weglaten. Toegepast vóór afronding naar boven; verandert nooit op deze factuur.

underpayment_tolerance_percentdecimal stringaltijd

Onwijzigbaar geaccepteerd tekortpercentage, vastgelegd bij het maken van de factuur.

statusinvoice statusaltijd

new, processing, settled, expired, invalid of cancelled.

amount_statusamount statusaltijd

none, partial, paid of overpaid. Een expliciet toegestane factuur met nulbedrag wordt voldaan met none en zonder betaalmethoden.

timing_statustiming statusaltijd

on_time of late.

resolutionresolutionaltijd

automatic, manually_settled of manually_invalidated.

sequenceintegeraltijd

Monotoon oplopende factuurstatus-sequence, beginnend bij 1.

winning_payment_intent_idUUID | nullaltijd

Betaalmethode die de factuur heeft afgehandeld, wanneer geselecteerd.

expires_atRFC 3339 timestampaltijd

Deadline van prijsopgave/betaling.

monitoring_expires_atRFC 3339 timestampaltijd

Laatste ingestelde grens voor controle op late betalingen over alle betaalmethoden.

settled_attimestamp | nullaltijd

Tijdstip van voldoening indien voldaan.

cancelled_attimestamp | nullaltijd

Annuleringstijd indien geannuleerd.

archived_attimestamp | nullaltijd

Archiveringstijd indien gearchiveerd.

created_atRFC 3339 timestampaltijd

Aanmaaktijd.

updated_atRFC 3339 timestampaltijd

Laatste bijwerktijd van de status.

paginationobject
limitintegeraltijd

Effectieve paginagrootte, 1–100.

offsetintegeraltijd

Effectieve rij-offset vanaf nul, 0–1,000,000.

totalintegeraltijd

Totaal aantal rijen dat overeenkomt met project-, winkel-, status- en zoekfilters in de paginamomentopname.

has_morebooleanaltijd

True wanneer offset plus het aantal teruggegeven rijen kleiner is dan total.

Gebruiksopmerkingen
  • Gesorteerd op created_at aflopend, daarna interne id aflopend.
  • Lijstitems zijn InvoiceSummary-objecten; email, customer_name en customer_address zijn alleen voor de handelaar. Vraag details op voor ruwe metadata en betalingsintenties.
  • Stel voor de volgende pagina offset in op pagination.offset + pagination.limit, alleen als has_more true is.
  • Aantal en pagina worden uit één repeatable-read-databasemomentopname gelezen; gelijktijdige schrijfacties verschijnen bij een later verzoek.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETFactuur ophalen/v1/projects/{project_id}/invoices/{invoice_id}Alleen-lezen

Geeft volledige handelaarsfactuurdetails en de huidige actieve afreken-URL terug. Gebruik deze route voor periodiek opvragen en afstemming.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MERCHANT_API_TOKEN
Acceptaanbevolenapplication/json

Padparameters

project_idUUIDvereist

Ingeschakeld project dat aan de API-referentie is toegewezen.

invoice_idUUIDvereist

De invoice_id die bij aanmaak/opvragen wordt teruggegeven, niet de interne id.

Verzoek

: "${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'

Antwoord 200 application/json

Voorbeeldantwoord
{
  "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"
  }
}

Antwoordvelden

dataobject
idUUIDaltijd

Interne factuur-UUID. Gebruik die niet in handelaarsdetail- of afrekenpaden.

invoice_idUUIDaltijd

Publieke factuur-UUID die door handelaarsdetail- en afrekenpaden wordt gebruikt.

project_idUUIDaltijd

Project waartoe dit behoort.

store_idUUIDaltijd

Winkel waartoe dit behoort.

sourcemanual | apialtijd

Hoe de factuur is gemaakt.

order_idstring | nullaltijd

Bestelreferentie van de handelaar.

emailstring | nullaltijd

E-mailadres van de klant, alleen voor de handelaar. Wordt nooit door publiek afrekenen teruggegeven.

customer_namestring | nullaltijd

Afgeleide weergavenaam uit private metadata firstname, lastname en company.

customer_addressstring | nullaltijd

Afgeleid handelaarsadres op één regel uit private metadata company, street, street2, zip, city, country, countryiso2 en vatid.

descriptionstring | nullaltijd

Omschrijving voor de klant.

amountdecimal stringaltijd

Canoniek factuurbedrag.

currencystringaltijd

Genormaliseerde factuurvaluta-/activacode.

exchange_rate_spread_percentdecimal stringaltijd

Vastgezette prijsopslag: de afwijking bij aanmaak of de winkelstandaard bij weglaten. Toegepast vóór afronding naar boven; verandert nooit op deze factuur.

underpayment_tolerance_percentdecimal stringaltijd

Onwijzigbaar geaccepteerd tekortpercentage, vastgelegd bij het maken van de factuur.

statusinvoice statusaltijd

new, processing, settled, expired, invalid of cancelled.

amount_statusamount statusaltijd

none, partial, paid of overpaid. Een expliciet toegestane factuur met nulbedrag wordt voldaan met none en zonder betaalmethoden.

timing_statustiming statusaltijd

on_time of late.

resolutionresolutionaltijd

automatic, manually_settled of manually_invalidated.

sequenceintegeraltijd

Monotoon oplopende factuurstatus-sequence, beginnend bij 1.

winning_payment_intent_idUUID | nullaltijd

Betaalmethode die de factuur heeft afgehandeld, wanneer geselecteerd.

expires_atRFC 3339 timestampaltijd

Deadline van prijsopgave/betaling.

monitoring_expires_atRFC 3339 timestampaltijd

Laatste ingestelde grens voor controle op late betalingen over alle betaalmethoden.

settled_attimestamp | nullaltijd

Tijdstip van voldoening indien voldaan.

cancelled_attimestamp | nullaltijd

Annuleringstijd indien geannuleerd.

archived_attimestamp | nullaltijd

Archiveringstijd indien gearchiveerd.

created_atRFC 3339 timestampaltijd

Aanmaaktijd.

updated_atRFC 3339 timestampaltijd

Laatste bijwerktijd van de status.

ipn_urlstring | nullaltijd

Effectieve IPN-bestemming per factuur. Alleen handelaarsantwoord; weggelaten uit publiek afrekenen.

redirect_urlstring | nullaltijd

Effectieve succes-URL die na voldoening wordt gebruikt.

cancel_urlstring | nullaltijd

Effectieve terugkeer-URL die wordt gebruikt als afrekenen zonder succesvolle betaling eindigt.

redirect_automaticallybooleanaltijd

Of afrekenen na succes automatisch moet omleiden.

checkout_languagestringaltijd

Effectieve afrekentaaltag.

metadataobjectaltijd
Handelaarsmetadata. Wordt nooit door publiek afrekenen teruggegeven. Betaalhulpmiddelen in de console voegen payment_tool-herkomst toe (id, kind, title, pricing, requested_amount, request_id); dit bewijst geen betaling. Authenticeer callbacks en handel invoice.settled één keer per invoice_id af.Details

Handelaarsmetadata. Wordt nooit door publiek afrekenen teruggegeven. Betaalhulpmiddelen in de console voegen payment_tool-herkomst toe (id, kind, title, pricing, requested_amount, request_id); dit bewijst geen betaling. Authenticeer callbacks en handel invoice.settled één keer per invoice_id af.

cart_idstring
firstnamestring
lastnamestring
streetstring
street2string
zipstring
citystring
countrystring
countryiso2string
companystring
vatidstring
payment_intents[]object[]altijd

Geoffreerde betaalmethoden en monitoringsstatus.

idUUIDaltijd

Identificatie van de betalingsintentie; ook gebruikt als intent_id voor de afreken-QR-code.

payment_railonchain | lightningaltijd
Factuurtransport. Bitcoin op de blockchain en Lightning kunnen asset_id delen; gebruik de intentie-id plus dit veld, niet alleen het symbool. Dit verschilt van de scanner-payment_rail in de activacatalogus.Details

Factuurtransport. Bitcoin op de blockchain en Lightning kunnen asset_id delen; gebruik de intentie-id plus dit veld, niet alleen het symbool. Dit verschilt van de scanner-payment_rail in de activacatalogus.

bolt11string | nullaltijd

Lightning-betaalverzoek, anders null. Betaal dit verzoek met een Lightning-wallet; stuur nooit blockchainmiddelen naar de betalingshash.

asset_idUUIDaltijd

Identificatie van het ingestelde betaalactief.

asset_keystringaltijd

Canonieke activasleutel in CAIP-stijl.

chain_slugstringaltijd

Wholly Crypto-blockchainidentificatie.

networkstringaltijd

Ingesteld netwerk, momenteel mainnet voor ondersteunde betaalactiva.

caip_network_idstringaltijd

Canonieke CAIP-2-netwerkidentificatie.

caip_asset_idstring | nullaltijd

Canonieke CAIP-19-identificatie, waar geregistreerd.

symbolstringaltijd

Activasymbool.

asset_decimalsintegeraltijd

Precisie in atomaire eenheden. Lightning BTC gebruikt 11 (millisatoshi's), niet de 8 van Bitcoin op de blockchain. Prijsopgaven zijn hele satoshi's; ontvangsten behouden millisatoshiprecisie.

statusintent statusaltijd

pending, partial, paid, overpaid, expired of invalid.

finality_modeconfirmations | finalizedaltijd

Finaliteitsbeleid.

required_confirmationsintegeraltijd

Vereiste bevestigingen indien van toepassing.

quote_ratedecimal stringaltijd

Eenheden van het actief per één eenheid factuurvaluta, inclusief de vastgezette opslag. Bijvoorbeeld 1.02 USDC per USD. Niet de omgekeerde koers.

quote_detailsobject | nullaltijd
Vastgezette herkomst van de prijsopgave: reference_rate vóór opslag, unrounded_payment_amount, rounding_adjustment, pricing_provider, asset_provider, pricing_fetched_at en asset_fetched_at. Null bij oudere facturen; er worden geen historische waarden verzonnen.Details

Vastgezette herkomst van de prijsopgave: reference_rate vóór opslag, unrounded_payment_amount, rounding_adjustment, pricing_provider, asset_provider, pricing_fetched_at en asset_fetched_at. Null bij oudere facturen; er worden geen historische waarden verzonnen.

expected_amountdecimal stringaltijd
Exact vastgezet te betalen activabedrag na opslag en afronding naar boven. Vanaf 4.1.1 worden herkende geverifieerde fiatstablecoins (zoals USDC, USDT, DAI, USDS, EURC) naar boven afgerond op maximaal twee decimalen; 1.321 wordt 1.33, nooit 1.32. Dit is het verwachte bedrag, ook bij nultolerantie. Andere activa behouden adaptieve precisie. Bestaande facturen worden nooit opnieuw geprijsd.Details

Exact vastgezet te betalen activabedrag na opslag en afronding naar boven. Vanaf 4.1.1 worden herkende geverifieerde fiatstablecoins (zoals USDC, USDT, DAI, USDS, EURC) naar boven afgerond op maximaal twee decimalen; 1.321 wordt 1.33, nooit 1.32. Dit is het verwachte bedrag, ook bij nultolerantie. Andere activa behouden adaptieve precisie. Bestaande facturen worden nooit opnieuw geprijsd.

expected_amount_atomicinteger stringaltijd

Exact bedrag in de kleinste eenheid van het actief.

minimum_payment_amountdecimal stringaltijd

Kleinste bedrag dat na toepassing van de factuurtolerantie als betaald wordt geaccepteerd.

minimum_payment_amount_atomicinteger stringaltijd

Exacte geaccepteerde drempel in de kleinste eenheid van het actief.

received_amountdecimal stringaltijd

Waargenomen bedrag.

received_amount_atomicinteger stringaltijd

Waargenomen atomair bedrag.

confirmed_amountdecimal stringaltijd

Bevestigd/definitief bedrag.

confirmed_amount_atomicinteger stringaltijd

Bevestigd/definitief atomair bedrag.

destination_addressstringaltijd

Ontvangstadres op de blockchain of de betalingshash van 64 tekens voor Lightning. Gebruik bolt11 om via Lightning te betalen; de hash is geen Bitcoin-adres.

destination_tagstring | nullaltijd

Vereiste publieke betalingsreferentie waar de betaalroute die gebruikt: XRP-bestemmingstag, Stellar-memo-ID of TON-factuurcommentaar. Null voor routes met unieke adressen.

derivation_indexintegeraltijd

Gereserveerde onderliggende walletindex; alleen handelaarsdetails.

quote_expires_atRFC 3339 timestampaltijd

Vervaltijd van de prijsopgave.

monitoring_expires_atRFC 3339 timestampaltijd

Eindgrens voor controle op late betalingen voor deze methode.

next_check_attimestamp | nullaltijd

Volgende geplande blockchaincontrole.

last_checked_attimestamp | nullaltijd

Laatste blockchaincontrole.

last_chain_heightinteger | nullaltijd

Laatste betrouwbare hoogte die door de monitor is waargenomen.

last_anchor_hashstring | nullaltijd

Laatste monitoranker/blokhash.

last_monitor_errorstring | nullaltijd

Veilige monitoringsdiagnostiek voor operators.

first_payment_attimestamp | nullaltijd

Tijdstip waarop een betaling voor het eerst is waargenomen.

fully_paid_attimestamp | nullaltijd

Tijdstip waarop het geaccepteerde minimumbedrag voor het eerst werd bereikt.

finalized_attimestamp | nullaltijd

Tijdstip waarop de betaling voldeed aan het finaliteitsbeleid.

Gebruiksopmerkingen
  • Een zoekactie binnen een beperkt bereik geeft bewust invoice_not_found terug wanneer de publieke ID niet in het geautoriseerde project staat.
  • links.checkout gebruikt Winkel → Basis → Winkeldomeinen: de actieve betaalhostnaam van deze winkel, daarna de keuze van de standaardwinkel en dan de primaire systeemhost. Vervallen/concept-hosts of hosts voor de verkeerde service worden genegeerd. Dit geldt ook voor aanmaak- en MCP-antwoorden; links worden bij het antwoorden bepaald, ook bij idempotente herhalingen. Ondertekende callbacklinks worden bij het maken van de gebeurtenis vastgezet en niet bij nieuwe pogingen herschreven. Deze voorkeuren genereren alleen links; ze leiden geen verkeer om en veranderen geen IP-beperkingen.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETFactuurbetalingen opvragen/v1/projects/{project_id}/invoices/{invoice_id}/paymentsAlleen-lezen

Volledige actuele overschrijvingsgeschiedenis, inclusief ongeldig verklaarde waarnemingen. Gebruik dit wanneer een callback payments_truncated aangeeft. Dit is de huidige toestand, geen reconstructie van een oudere gebeurtenis.

Authenticatie & headers
HeaderAanwezigheidRegel
AuthorizationvereistBearer YOUR_MERCHANT_API_TOKEN
Acceptaanbevolenapplication/json

Padparameters

project_idUUIDvereist

Project dat aan deze API-referentie is toegewezen.

invoice_idUUIDvereist

Publieke invoice_id die bij aanmaak wordt teruggegeven.

Queryparameters

payment_method_idUUIDoptioneel

Beperk tot één factuur-betaalmethode.

limitinteger

1–100; standaard 25.

offsetinteger

0–1,000,000; standaard 0.

Verzoek

: "${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'

Antwoord 200 application/json

Voorbeeldantwoord
{
  "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}
}

Antwoordvelden

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
Gebruiksopmerkingen
  • Een waarneming is een tokenlog, UTXO-output of andere overschrijving op een betaalroute, niet noodzakelijk een unieke transactiehash. Ontdubbel op payment_id; transaction_id plus event_index identificeert de blockchainoverschrijving.
  • status is detected, confirming, final, reorged, replaced of invalid. Alleen waarnemingen met counts_towards_received dragen bij aan ontvangen bedragen. Tel bedragen van verschillende activa nooit bij elkaar op.
  • Lightning-records gebruiken payment_hash met null voor transaction_id, confirmations en explorerlinks; BTC-precisie is 11 (millisatoshi's). Er worden geen preimages, BOLT11 of walletgeheimen getoond.
  • Gesorteerd op observed_at aflopend, daarna payment_id aflopend. Aantal en pagina gebruiken één repeatable-read-momentopname; latere pagina's kunnen wijzigen wanneer betalingen binnenkomen. Ontdubbel op payment_id wanneer je een actieve factuur pagineert.
  • Bestaande alleen-lezen projecttoegang, IP-beperkingen en aanvraaglimieten per API-referentie gelden. Volg nooit een callbacklink met je token tenzij de oorsprong overeenkomt met je ingestelde API-host.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETAfrekenbasis/Publiek

Hoofdpad van de beheerde afrekenhost dat de afrekenapplicatie levert zonder een factuur te selecteren. Klantintegraties horen normaal links.checkout te gebruiken.

Authenticatie & headers

Publiek

Verzoek

curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://pay.example.com/" \
  --output 'checkout.html'

Antwoord 200 text/html

Voorbeeldantwoord
<!doctype html>
<!-- Hosted Wholly Crypto checkout shell -->
Gebruiksopmerkingen
  • Er is geen bearertoken nodig.
  • De beheerde afrekenproxy staat GET/HEAD toe en wijst andere methoden af.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETGehoste afrekenpagina/invoice/{invoice_id}Publiek

HTML-afrekenpagina voor klanten. De pagina haalt veilige afreken-JSON op bij dezelfde afrekenhost. Inbedden wordt geweigerd tenzij de winkel dit inschakelt en expliciet de HTTPS-oorsprong van de bovenliggende pagina toestaat.

Authenticatie & headers

Publiek

Padparameters

invoice_idUUIDvereist

Publieke factuur-UUID teruggegeven door de handelaars-API.

Verzoek

curl --fail-with-body --max-time 30 \
  --request GET \
  --url "https://pay.example.com/invoice/YOUR_PUBLIC_INVOICE_ID" \
  --output 'checkout.html'

Antwoord 200 text/html

Voorbeeldantwoord
<!doctype html>
<!-- Hosted Wholly Crypto checkout application -->
Gebruiksopmerkingen
  • Er wordt geen bearertoken geaccepteerd of vereist.
  • De HTML-basis geeft zelf 200 terug, ook als een factuur ontbreekt; het afreken-JSON-verzoek ontvangt dan invoice_not_found.
  • Het antwoord is no-store, noindex en heeft een factuurspecifieke frame-ancestors-CSP.
  • Een uitgeschakeld project/winkel of een onbekende factuur toont geen afrekengegevens.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETFactuur met gegevens die veilig op de afrekenpagina kunnen worden getoond/checkout-api/invoices/{invoice_id}Publiek

Geeft alleen velden terug die nodig zijn om afrekenen weer te geven. Laat bewust interne ID's, klant-e-mail en afgeleide adresvelden, IPN-URL, handelaarsmetadata, wallet-ID's, afleidingspaden en monitordiagnostiek weg.

Authenticatie & headers

Publiek

Padparameters

invoice_idUUIDvereist

Publieke factuur-UUID.

Verzoek

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'

Antwoord 200 application/json

Voorbeeldantwoord
{
  "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": []
      }
    ]
  }
}

Antwoordvelden

dataobject
invoice_idUUIDaltijd

Publieke factuur-UUID.

order_idstring | nullaltijd

Bestelreferentie van de handelaar.

descriptionstring | nullaltijd

Omschrijving voor de klant.

amountdecimal stringaltijd

Factuurbedrag.

currencystringaltijd

Factuurvaluta.

exchange_rate_spread_percentdecimal stringaltijd

Effectieve prijsopslag vastgezet bij aanmaak, inclusief een afwijking per factuur.

underpayment_tolerance_percentdecimal stringaltijd

Geaccepteerd tekortpercentage voor deze factuur.

statusinvoice statusaltijd

Huidige factuurstatus.

amount_statusamount statusaltijd

none, partial, paid of overpaid. Een expliciet toegestane factuur met nulbedrag wordt voldaan met none en zonder betaalmethoden.

timing_statustiming statusaltijd

on_time of late.

sequenceintegeraltijd

Huidige status-sequence.

active_payment_method_idUUID | nullaltijd

De vermelde betaalmethode die geld heeft ontvangen. Afrekenen blijft op deze methode zodat een onderbetaling niet met een onverenigbaar actief wordt voortgezet.

payment_method_lockedbooleanaltijd

True nadat een geldige betaling active_payment_method_id selecteert.

server_timeRFC 3339 timestampaltijd

Serverklok vastgelegd voor dit antwoord; gebruik die met expires_at om klokafwijkingen van het klantapparaat te vermijden.

expires_atRFC 3339 timestampaltijd

Factuurdeadline.

expires_in_secondsintegeraltijd

Hele resterende seconden bij server_time, naar boven afgerond en begrensd op nul.

payment_openbooleanaltijd

Alleen true zolang een factuur met status new of processing vóór de deadline is en minstens één betaalbare methode met een resterend bedrag heeft.

redirect_urlstring | nullaltijd

Terugkeerbestemming voor de klant na succesvolle voldoening.

cancel_urlstring | nullaltijd

Terugkeerbestemming voor de klant bij verlaten zonder succesvolle voldoening.

redirect_automaticallybooleanaltijd

Beleid voor automatische omleiding.

checkout_languagestringaltijd

Afrekentaal.

projectobjectaltijd

name, checkout_title, checkout_description, theme, accent_color en logo_url.

namestring
checkout_titlestring
checkout_descriptionstring
themestring
accent_colorstring
logo_urlstring
storeobjectaltijd

Publieke winkelnaam.

namestring
appearanceobjectaltijd

Effectieve presentatie: vastgezette factuurafwijking indien aangeleverd, anders het huidige winkelontwerp. Wijzigt nooit financiële velden of veiligheidswaarschuwingen.

inherit_default_storebooleanaltijd

True wanneer de standaardwinkel van het project dit uiterlijk levert. False voor onafhankelijke winkels en vastgezette factuurafwijkingen.

invoice_overridebooleanaltijd

True wanneer checkout_appearance bij factuuraanmaak is aangeleverd. Weggelaten/null houdt dit false.

titlestringaltijd

Gewone handelaarskop, bovenbericht en onderbericht. intro vervangt customer_message; oude opgeslagen tekst blijft behouden. Interpreteer dit nooit als opmaakcode.

introstringaltijd

Gewone handelaarskop, bovenbericht en onderbericht. intro vervangt customer_message; oude opgeslagen tekst blijft behouden. Interpreteer dit nooit als opmaakcode.

outrostringaltijd

Gewone handelaarskop, bovenbericht en onderbericht. intro vervangt customer_message; oude opgeslagen tekst blijft behouden. Interpreteer dit nooit als opmaakcode.

intro_font_sizeintegeraltijd

Lettergroottes in pixels: 12, 14, 16, 18, 20 of 24.

outro_font_sizeintegeraltijd

Lettergroottes in pixels: 12, 14, 16, 18, 20 of 24.

customer_messagestringaltijd

Verouderde compatibiliteitsalias van intro. Gebruik intro voor nieuwe integraties.

themesystem | light | dim | darkaltijd

Voorkeur van het klantapparaat of een vast thema.

accent_colorstringaltijd

Strikte #RRGGBB-kleuren. Optionele kleuren zijn leeg voor automatische waarden; voorgrondcontrast wordt berekend.

background_colorstringaltijd

Strikte #RRGGBB-kleuren. Optionele kleuren zijn leeg voor automatische waarden; voorgrondcontrast wordt berekend.

card_colorstringaltijd

Strikte #RRGGBB-kleuren. Optionele kleuren zijn leeg voor automatische waarden; voorgrondcontrast wordt berekend.

button_colorstringaltijd

Strikte #RRGGBB-kleuren. Optionele kleuren zijn leeg voor automatische waarden; voorgrondcontrast wordt berekend.

logo_sizestringaltijd

small, medium of large; left of center. Afbeeldingen worden passend weergegeven, niet bijgesneden.

logo_alignmentstringaltijd

small, medium of large; left of center. Afbeeldingen worden passend weergegeven, niet bijgesneden.

imagesobjectaltijd

Optionele URL's voor logo_light, logo_dark en favicon: afgebakende genormaliseerde PNG-afbeeldingen van dezelfde oorsprong.

show_order_idbooleanaltijd

Zichtbaarheid van bestel-ID, omschrijving onder de titel en aanvankelijke uitklapstatus van bestel-ID. Het bedrag blijft zichtbaar; dit regelt weergave, geen afscherming van gegevens.

show_descriptionbooleanaltijd

Zichtbaarheid van bestel-ID, omschrijving onder de titel en aanvankelijke uitklapstatus van bestel-ID. Het bedrag blijft zichtbaar; dit regelt weergave, geen afscherming van gegevens.

details_expandedbooleanaltijd

Zichtbaarheid van bestel-ID, omschrijving onder de titel en aanvankelijke uitklapstatus van bestel-ID. Het bedrag blijft zichtbaar; dit regelt weergave, geen afscherming van gegevens.

show_project_namebooleanaltijd

Merchant 5.6.0+: zichtbaarheid van namen in de kop. Beide zijn standaard true. Project-/winkelidentiteit blijft beschikbaar in JSON.

show_store_namebooleanaltijd

Merchant 5.6.0+: zichtbaarheid van namen in de kop. Beide zijn standaard true. Project-/winkelidentiteit blijft beschikbaar in JSON.

featured_chains[]arrayaltijd

Geordende voorkeuren, alleen toegepast op methoden die al in de factuur aanwezig zijn. Ontbrekende of uitgeschakelde methoden worden genegeerd.

featured_asset_ids[]arrayaltijd

Geordende voorkeuren, alleen toegepast op methoden die al in de factuur aanwezig zijn. Ontbrekende of uitgeschakelde methoden worden genegeerd.

default_asset_idUUID | nullaltijd

Voorgestelde eerste methode. Een geldige onthouden klantvoorkeur of een methode die al geld ontvangt heeft voorrang.

messagesobjectaltijd
Platte tekst voor en, de, es, pt-BR, it, ru, zh-CN, fr, ko en ja, met sleutels waiting, confirming, paid, underpaid en expired. Engelse terugval voor ontbrekende handelaarsberichten. Aanvullend; vervangt nooit de werkelijke status. Door de handelaar geschreven inhoud wordt niet automatisch vertaald.Details

Platte tekst voor en, de, es, pt-BR, it, ru, zh-CN, fr, ko en ja, met sleutels waiting, confirming, paid, underpaid en expired. Engelse terugval voor ontbrekende handelaarsberichten. Aanvullend; vervangt nooit de werkelijke status. Door de handelaar geschreven inhoud wordt niet automatisch vertaald.

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_emailstringaltijd

Optionele contact- en HTTPS-links, zonder URL-inloggegevens. Externe links openen in een nieuw venster.

support_urlstringaltijd

Optionele contact- en HTTPS-links, zonder URL-inloggegevens. Externe links openen in een nieuw venster.

terms_urlstringaltijd

Optionele contact- en HTTPS-links, zonder URL-inloggegevens. Externe links openen in een nieuw venster.

privacy_urlstringaltijd

Optionele contact- en HTTPS-links, zonder URL-inloggegevens. Externe links openen in een nieuw venster.

return_button_textstringaltijd

Alleen een optioneel label. Succes-/annuleringsbestemmingen en omleidingsbeleid horen nog steeds bij de factuur.

show_return_buttonbooleanaltijd

Zichtbaarheid van de handmatige terugkeer-/annuleerknop; standaard true. Geldt voor actieve en eindstatussen, niet voor automatische succesomleidingen. Beschikbaar vanaf merchant 8.1.4.

payment_methods[]object[]altijd

Betaalmethoden die veilig op de afrekenpagina kunnen worden getoond.

payment_railonchain | lightningaltijd

Lightning blijft een Bitcoin-methode, afzonderlijk van BTC op de blockchain. Identificeer de keuze met intentie-id en betaalroute, niet alleen asset_id.

bolt11string | nullaltijd

Ondertekend Lightning-verzoek; null voor blockchainmethoden. Betaal nooit nadat payable false wordt.

payment_hashstring | nullaltijd

Lightning-betalingshash voor afstemming, geen ontvangstadres. Null voor blockchainmethoden.

idUUIDaltijd

Identificatie van de betalingsintentie.

asset_idUUIDaltijd

Activa-UUID gebruikt door uiterlijkvoorkeuren; verschilt van de betalingsintentie-id van deze factuur.

asset_keystringaltijd

Canonieke activasleutel.

chain_slugstringaltijd

Machineleesbare en getoonde blockchainnamen.

chain_namestringaltijd

Machineleesbare en getoonde blockchainnamen.

networkstringaltijd

Betaalnetwerk.

caip_network_idstringaltijd

Canonieke netwerkidentiteit om de geselecteerde blockchain ondubbelzinnig te bepalen.

caip_asset_idstring | nullaltijd

Canonieke exacte activa-identiteit, inclusief een geverifieerd tokencontract of mint indien van toepassing.

asset_namestringaltijd

Weergavewaarden van het betaalactief.

symbolstringaltijd

Weergavewaarden van het betaalactief.

asset_icon_urlstring | nullaltijd

Lokaal gecacht activapictogram van dezelfde oorsprong, of null als geen geverifieerde CoinGecko-koppeling bestaat.

asset_kindnative | tokenaltijd

Onderscheidt eigen valuta van contract-/mintbetalingen.

contract_addressstring | nullaltijd

Canoniek ERC-20-contract of SPL-mint voor tokens; null voor eigen valuta.

token_standarderc20 | spl-token | nullaltijd

Geverifieerde tokenruntime of null voor eigen valuta.

asset_decimalsintegeraltijd

Precisie in atomaire eenheden: 11 voor Lightning BTC-millisatoshi's, 8 voor BTC-satoshi's op de blockchain.

statusintent statusaltijd

Huidige betaalmethodestatus.

payablebooleanaltijd

Alleen true wanneer precies deze methode momenteel betaling kan accepteren; false voor inactieve methoden nadat een ander actief geld ontvangt.

finality_modestringaltijd

Finaliteitsbeleid.

required_confirmationsintegeraltijd

Finaliteitsbeleid.

expected_amountdecimalaltijd
Volledige vastgezette prijsopgave in weergave-eenheden en werkelijke blockchaineenheden. Herkende fiatstablecoins gebruiken maximaal twee decimalen voor prijsopgaven, altijd naar boven afgerond na opslag; andere activa gebruiken adaptieve precisie. Werkelijke tokendecimalen, ontvangen geld en restbedragen van deelbetalingen blijven exact. Gebruik teruggegeven bedragen ongewijzigd.Details

Volledige vastgezette prijsopgave in weergave-eenheden en werkelijke blockchaineenheden. Herkende fiatstablecoins gebruiken maximaal twee decimalen voor prijsopgaven, altijd naar boven afgerond na opslag; andere activa gebruiken adaptieve precisie. Werkelijke tokendecimalen, ontvangen geld en restbedragen van deelbetalingen blijven exact. Gebruik teruggegeven bedragen ongewijzigd.

expected_amount_atomicinteger stringaltijd
Volledige vastgezette prijsopgave in weergave-eenheden en werkelijke blockchaineenheden. Herkende fiatstablecoins gebruiken maximaal twee decimalen voor prijsopgaven, altijd naar boven afgerond na opslag; andere activa gebruiken adaptieve precisie. Werkelijke tokendecimalen, ontvangen geld en restbedragen van deelbetalingen blijven exact. Gebruik teruggegeven bedragen ongewijzigd.Details

Volledige vastgezette prijsopgave in weergave-eenheden en werkelijke blockchaineenheden. Herkende fiatstablecoins gebruiken maximaal twee decimalen voor prijsopgaven, altijd naar boven afgerond na opslag; andere activa gebruiken adaptieve precisie. Werkelijke tokendecimalen, ontvangen geld en restbedragen van deelbetalingen blijven exact. Gebruik teruggegeven bedragen ongewijzigd.

minimum_payment_amountdecimalaltijd

Geaccepteerde voldaan-drempel na toepassing van onderbetalingstolerantie.

minimum_payment_amount_atomicinteger stringaltijd

Geaccepteerde voldaan-drempel na toepassing van onderbetalingstolerantie.

received_amountdecimalaltijd

Waargenomen bedrag.

received_amount_atomicinteger stringaltijd

Waargenomen bedrag.

remaining_amountdecimal stringaltijd

Exact weergegeven bedrag dat nog nodig is om de geaccepteerde drempel te bereiken, begrensd op nul.

remaining_amount_atomicinteger stringaltijd

Tekort tot de geaccepteerde drempel in atomaire eenheden. Dit is niet het gevraagde betaalbedrag: tolerantie beïnvloedt alleen acceptatie.

confirmed_amountdecimalaltijd

Bevestigd/definitief bedrag.

confirmed_amount_atomicinteger stringaltijd

Bevestigd/definitief bedrag.

destination_addressstringaltijd

Blockchainbestemming en optionele referentie. Voor Lightning is dit de betalingshash zonder tag; betaal in plaats daarvan bolt11/payment_uri.

destination_tagstring|nullaltijd

Blockchainbestemming en optionele referentie. Voor Lightning is dit de betalingshash zonder tag; betaal in plaats daarvan bolt11/payment_uri.

quote_expires_atRFC 3339 timestampaltijd

Vervaltijd van de prijsopgave.

payment_uristring | nullaltijd
Blockchainspecifiek verzoek: ERC-681, Solana Pay, native URI of lightning:<bolt11>. Verzoeken met bedrag gebruiken het volledige verwachte bedrag minus ontvangen geld, nooit de tolerantiedrempel. Null wanneer payable false is, ook nadat een toegestaan tekort is geaccepteerd. De Lightning-QR-code codeert het volledige Lightning-verzoek, niet de betalingshash.Details

Blockchainspecifiek verzoek: ERC-681, Solana Pay, native URI of lightning:<bolt11>. Verzoeken met bedrag gebruiken het volledige verwachte bedrag minus ontvangen geld, nooit de tolerantiedrempel. Null wanneer payable false is, ook nadat een toegestaan tekort is geaccepteerd. De Lightning-QR-code codeert het volledige Lightning-verzoek, niet de betalingshash.

qr_urlpath | nullaltijd

SVG-QR-pad van dezelfde oorsprong met revisie op basis van sequence en exact restbedrag, of null wanneer payable false is. De SVG is no-store.

address_explorer_namestring|nullaltijd

Gevalideerde mainnet-explorer als uitwijkmogelijkheid waar ondersteund.

address_explorer_urlstring|nullaltijd

Gevalideerde mainnet-explorer als uitwijkmogelijkheid waar ondersteund.

transaction_countintegeraltijd

Totaal aantal afzonderlijke publieke geldige transacties waargenomen voor deze methode.

transactions_truncatedbooleanaltijd

True wanneer transaction_count groter is dan de teruggegeven lijst met recente transacties.

transactions[]object[]altijd

Maximaal de 10 recentste publieke geldige transacties. Exacte ontvangen totalen blijven onafhankelijk van deze weergavelimiet.

transaction_idstringaltijd

Identificatie van de waargenomen transactie.

statusdetected | confirming | finalaltijd

Publieke waarnemingsstatus.

confirmationsintegeraltijd

Waargenomen aantal bevestigingen.

block_heightinteger | nullaltijd

Waargenomen blok-/grootboekhoogte.

explorer_namestringindien teruggegeven

Gevalideerde vaste explorernaam.

explorer_urlstringindien teruggegeven

Gevalideerde vaste mainnet-explorer-URL.

Gebruiksopmerkingen
  • Er is geen bearertoken nodig.
  • Cache-Control is no-store en zoekindexering is uitgeschakeld.
  • Behandel invoice_id als toegangsgegevens voor de klant; publiceer die niet onnodig.
  • asset_icon_url is een lokaal bestand van dezelfde oorsprong; de klantafrekenpagina hoeft nooit CoinGecko te benaderen om het weer te geven.
  • Als destination_tag niet null is, toon en kopieer die naast het adres: het is een vereiste XRP-bestemmingstag, Stellar-memo-ID of TON-factuurcommentaar en moet exact worden meegestuurd.
  • Voor geverifieerde tokens is asset_kind token, identificeert contract_address het exacte ERC-20-contract of de SPL-mint, identificeert token_standard de betaalroute en bevat payment_uri die tokenidentiteit.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETVoorbeeld van winkelafrekenpagina/invoice/preview/{project_id}Publiek

Toont het opgeslagen winkeluiterlijk met een voorbeeldbedrag en echte metadata van geaccepteerde activa. Wissel tussen voorbeelden waiting, confirming, paid, underpaid en expired zonder betalingen te maken.

Authenticatie & headers

Publiek

Padparameters

project_idUUIDvereist

Project-UUID die door de geauthenticeerde console in de voorbeeldlink is gekopieerd.

Queryparameters

store_idUUID,optioneel

Winkel die bij dit project hoort. Laat weg om de eerste/standaardwinkel te gebruiken.

statestring,optioneel

waiting, confirming, paid, underpaid of expired. Alleen een illustratie in de browser.

Verzoek

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'

Antwoord 200 text/html

Voorbeeldantwoord
<!doctype html>
<!-- Hosted branding preview; no invoice is created -->
Gebruiksopmerkingen
  • Het voorbeeld is alleen voor huisstijl en mag nooit als betaalverzoek naar een klant worden gestuurd.
  • Geen ontvangstadres, betaalbare QR-code, walletactie, omleiding of betalingsopvraging. Voorbeelden veranderen de werkelijke factuurstatus niet.
  • Het antwoord is no-store, noindex en kan niet worden ingebed.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETGegevens voor afrekenvoorbeeld/checkout-api/previews/{project_id}Publiek

Geeft effectief winkeluiterlijk en veilige metadata van geaccepteerde activa terug. payment_methods blijft leeg; preview_methods bevat geen betaaladressen, prijsopgaven of private walletgegevens.

Authenticatie & headers

Publiek

Padparameters

project_idUUIDvereist

Project-UUID uit de consolevoorbeeldlink.

Queryparameters

store_idUUID,optioneel

Moet bij dit project horen; niet-overeenkomende ID's geven 404 terug. Onbekende queryvelden worden afgewezen.

Verzoek

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'

Antwoord 200 application/json

Voorbeeldantwoord
{
  "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": []
  }
}

Antwoordvelden

dataobject
previewboolean
invoice_idstring
amountstring
currencystring
projectobject
namestring
checkout_titlestring
checkout_descriptionstring
themestring
accent_colorstring
logo_urlstring
appearanceobject
inherit_default_storebooleanaltijd

True wanneer de standaardwinkel van het project dit uiterlijk levert. False voor onafhankelijke winkels en vastgezette factuurafwijkingen.

invoice_overridebooleanaltijd

True wanneer checkout_appearance bij factuuraanmaak is aangeleverd. Weggelaten/null houdt dit false.

titlestringaltijd

Gewone handelaarskop, bovenbericht en onderbericht. intro vervangt customer_message; oude opgeslagen tekst blijft behouden. Interpreteer dit nooit als opmaakcode.

introstringaltijd

Gewone handelaarskop, bovenbericht en onderbericht. intro vervangt customer_message; oude opgeslagen tekst blijft behouden. Interpreteer dit nooit als opmaakcode.

outrostringaltijd

Gewone handelaarskop, bovenbericht en onderbericht. intro vervangt customer_message; oude opgeslagen tekst blijft behouden. Interpreteer dit nooit als opmaakcode.

intro_font_sizeintegeraltijd

Lettergroottes in pixels: 12, 14, 16, 18, 20 of 24.

outro_font_sizeintegeraltijd

Lettergroottes in pixels: 12, 14, 16, 18, 20 of 24.

customer_messagestringaltijd

Verouderde compatibiliteitsalias van intro. Gebruik intro voor nieuwe integraties.

themesystem | light | dim | darkaltijd

Voorkeur van het klantapparaat of een vast thema.

accent_colorstringaltijd

Strikte #RRGGBB-kleuren. Optionele kleuren zijn leeg voor automatische waarden; voorgrondcontrast wordt berekend.

background_colorstringaltijd

Strikte #RRGGBB-kleuren. Optionele kleuren zijn leeg voor automatische waarden; voorgrondcontrast wordt berekend.

card_colorstringaltijd

Strikte #RRGGBB-kleuren. Optionele kleuren zijn leeg voor automatische waarden; voorgrondcontrast wordt berekend.

button_colorstringaltijd

Strikte #RRGGBB-kleuren. Optionele kleuren zijn leeg voor automatische waarden; voorgrondcontrast wordt berekend.

logo_sizestringaltijd

small, medium of large; left of center. Afbeeldingen worden passend weergegeven, niet bijgesneden.

logo_alignmentstringaltijd

small, medium of large; left of center. Afbeeldingen worden passend weergegeven, niet bijgesneden.

imagesobjectaltijd

Optionele URL's voor logo_light, logo_dark en favicon: afgebakende genormaliseerde PNG-afbeeldingen van dezelfde oorsprong.

show_order_idbooleanaltijd

Zichtbaarheid van bestel-ID, omschrijving onder de titel en aanvankelijke uitklapstatus van bestel-ID. Het bedrag blijft zichtbaar; dit regelt weergave, geen afscherming van gegevens.

show_descriptionbooleanaltijd

Zichtbaarheid van bestel-ID, omschrijving onder de titel en aanvankelijke uitklapstatus van bestel-ID. Het bedrag blijft zichtbaar; dit regelt weergave, geen afscherming van gegevens.

details_expandedbooleanaltijd

Zichtbaarheid van bestel-ID, omschrijving onder de titel en aanvankelijke uitklapstatus van bestel-ID. Het bedrag blijft zichtbaar; dit regelt weergave, geen afscherming van gegevens.

show_project_namebooleanaltijd

Merchant 5.6.0+: zichtbaarheid van namen in de kop. Beide zijn standaard true. Project-/winkelidentiteit blijft beschikbaar in JSON.

show_store_namebooleanaltijd

Merchant 5.6.0+: zichtbaarheid van namen in de kop. Beide zijn standaard true. Project-/winkelidentiteit blijft beschikbaar in JSON.

featured_chains[]arrayaltijd

Geordende voorkeuren, alleen toegepast op methoden die al in de factuur aanwezig zijn. Ontbrekende of uitgeschakelde methoden worden genegeerd.

featured_asset_ids[]arrayaltijd

Geordende voorkeuren, alleen toegepast op methoden die al in de factuur aanwezig zijn. Ontbrekende of uitgeschakelde methoden worden genegeerd.

default_asset_idUUID | nullaltijd

Voorgestelde eerste methode. Een geldige onthouden klantvoorkeur of een methode die al geld ontvangt heeft voorrang.

messagesobjectaltijd
Platte tekst voor en, de, es, pt-BR, it, ru, zh-CN, fr, ko en ja, met sleutels waiting, confirming, paid, underpaid en expired. Engelse terugval voor ontbrekende handelaarsberichten. Aanvullend; vervangt nooit de werkelijke status. Door de handelaar geschreven inhoud wordt niet automatisch vertaald.Details

Platte tekst voor en, de, es, pt-BR, it, ru, zh-CN, fr, ko en ja, met sleutels waiting, confirming, paid, underpaid en expired. Engelse terugval voor ontbrekende handelaarsberichten. Aanvullend; vervangt nooit de werkelijke status. Door de handelaar geschreven inhoud wordt niet automatisch vertaald.

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_emailstringaltijd

Optionele contact- en HTTPS-links, zonder URL-inloggegevens. Externe links openen in een nieuw venster.

support_urlstringaltijd

Optionele contact- en HTTPS-links, zonder URL-inloggegevens. Externe links openen in een nieuw venster.

terms_urlstringaltijd

Optionele contact- en HTTPS-links, zonder URL-inloggegevens. Externe links openen in een nieuw venster.

privacy_urlstringaltijd

Optionele contact- en HTTPS-links, zonder URL-inloggegevens. Externe links openen in een nieuw venster.

return_button_textstringaltijd

Alleen een optioneel label. Succes-/annuleringsbestemmingen en omleidingsbeleid horen nog steeds bij de factuur.

show_return_buttonbooleanaltijd

Zichtbaarheid van de handmatige terugkeer-/annuleerknop; standaard true. Geldt voor actieve en eindstatussen, niet voor automatische succesomleidingen. Beschikbaar vanaf merchant 8.1.4.

preview_methods[]array
payment_methods[]array
Gebruiksopmerkingen
  • Er wordt geen bearertoken geaccepteerd of vereist.
  • Er worden geen factuur, bestemming, wallet, transactie, IPN, webhook of handelaarsmetadata teruggegeven.
  • Gebruik de geauthenticeerde console om de juiste voorbeeldlink op het betaaldomein te krijgen.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETAfbeelding voor winkelafrekenpagina/checkout-api/invoices/{invoice_id}/appearance-images/{kind}/{revision}/image.pngPubliek

Geeft een genormaliseerd winkellogo of favicon terug dat bij deze factuur hoort. Gebruik appearance.images-URL's uit de afrekengegevens.

Authenticatie & headers

Publiek

Padparameters

invoice_idUUIDvereist

Publieke factuur-UUID.

kindenumvereist

logo_light, logo_dark of favicon.

revisionUUIDvereist

Huidige afbeeldingsrevisie.

Verzoek

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'

Antwoord 200 image/png

Voorbeeldantwoord
(binary PNG response)
Gebruiksopmerkingen
  • Gebruik appearance.images uit afreken-JSON. Vastgezette factuurafbeeldingen blijven werken nadat de bronwinkel een upload vervangt of verwijdert. Expliciet verwijderde revisies, revisies voor de verkeerde factuur of soort en onbekende revisies geven 404 terug; een momentopname valt nooit terug op een huidige winkelafbeelding.
  • Zonder factuurafwijking wordt de huidige effectieve winkelafbeelding gebruikt en geven vervangen/verwijderde revisies 404 terug. Alleen PNG, nosniff en private caching.
  • Winkelafbeeldingsuploads accepteren begrensde PNG, JPEG of WebP in de geauthenticeerde console; nooit SVG, HTML of externe afbeeldings-URL's.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETAfbeelding voor winkelvoorbeeld/checkout-api/previews/{project_id}/stores/{store_id}/appearance-images/{kind}/{revision}/image.pngPubliek

Geeft alleen een genormaliseerde voorbeeldafbeelding terug voor het overeenkomende project, de winkel, soort en huidige revisie.

Authenticatie & headers

Publiek

Padparameters

project_idUUIDvereist

Project-UUID.

store_idUUIDvereist

Winkel die bij het project hoort.

kindenumvereist

logo_light, logo_dark of favicon.

revisionUUIDvereist

Huidige afbeeldingsrevisie.

Verzoek

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'

Antwoord 200 image/png

Voorbeeldantwoord
(binary PNG response)
Gebruiksopmerkingen
  • Gebruik appearance.images uit voorbeeldgegevens. Onbekende of niet-overeenkomende ID's geven 404 terug. Er wordt geen wallet- of betalingsinformatie getoond.

Fouten

Foutcodes & regels voor nieuwe pogingen

GETAfbeelding van betalings-QR-code/checkout-api/invoices/{invoice_id}/payment-methods/{intent_id}/qr.svgPubliek

Genereert een SVG-QR-code van 512×512 voor de exacte blockchainspecifieke betaalpayload van een factuur-betaalmethode.

Authenticatie & headers

Publiek

Padparameters

invoice_idUUIDvereist

Publieke factuur-UUID.

intent_idUUIDvereist

Betaalmethode-id uit afreken-JSON.

Verzoek

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'

Antwoord 200 image/svg+xml

Voorbeeldantwoord
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512">…</svg>
Gebruiksopmerkingen
  • Er is geen bearertoken nodig.
  • Gebruik de qr_url met revisie op basis van sequence en restbedrag die afreken-JSON teruggeeft; de SVG is private en no-store.
  • Na een deelbetaling vraagt deze het exacte resterende bedrag en blijft vastgezet op dat actief.
  • Geeft 409 terug na verloop, voltooiing of wanneer een andere methode actief is; geeft payment_qr_unavailable (422) terug als het verzoek te groot is om te coderen.

Fouten

Foutcodes & regels voor nieuwe pogingen

Referentie voor Wholly Crypto 8.3.2. Open voor je geïnstalleerde versie Instellingen → API-toegang → Documentatie in je console. Releases bekijken.