Skip to main content
Maak een Account-object aan onder je platformaccount om een subaccount op je platform in te schrijven. Dat account kan daarna directe afschrijvingen accepteren, overboekingen ontvangen en de uitbetalingsflows van Whop gebruiken.

Voorbeeld

Maak een account aan voor het subaccount:
In dit voorbeeld:
  • email is het e-mailadres van het subaccount. Whop gebruikt het om het subaccount te identificeren en belangrijke meldingen te versturen.
  • De Account API-sleutel bepaalt welk platformaccount eigenaar is van het subaccount.
  • title is de verplichte weergavenaam van het subaccount.
  • external_id is het eigen ID van je platform voor dit subaccount, bijvoorbeeld je winkel-ID. Elk ID hoort bij één subaccount, en je kunt het account er later mee opzoeken.
  • metadata bevat aangepaste key-valueparen, zoals seller_tier, een classificatie of niveau voor het subaccount (bijv. “bronze”, “silver” of “gold”).
  • Het antwoord bevat een account.id waarmee je in toekomstige API-aanroepen naar dit subaccount kunt verwijzen
Het e-mailadres moet toebehoren aan het subaccount (bedrijf of particulier) dat het account gaat beheren. Deze persoon ontvangt meldingen over het instellen van het account en over betalingen.

Een subaccount vinden aan de hand van je ID

Geef je subaccounts weer met external_id om het account bij een van je records op te halen. Eindig de waarde met % om elk account op te halen waarvan het ID begint met een namespace die je hebt gekozen, zoals shopline:%. De vergelijking is hoofdlettergevoelig, _ wordt letterlijk vergeleken en % werkt alleen aan het einde, dus ID’s die je aanmaakt, mogen dit teken niet bevatten.
TypeScript
Update Account stelt external_id in op een bestaand subaccount of wist het. Alleen je platform kan het wijzigen. Het subaccount kan het lezen, maar niet bewerken.

Een e-mailadres hergebruiken

Meerdere subaccounts kunnen één e-mailadres delen, zolang elk een eigen external_id heeft. Het aanmaken van een account is idempotent op het paar van e-mailadres en external_id:
  • Nieuwe external_id: Whop maakt een nieuw subaccount aan, ook wanneer het e-mailadres al in gebruik is.
  • Hetzelfde e-mailadres en dezelfde external_id: Whop geeft het bestaande subaccount terug in plaats van een duplicaat aan te maken, dus herhaalpogingen zijn veilig.
  • external_id al gebruikt met een ander e-mailadres: Whop geeft een 409 terug in plaats van een tweede account met dat ID aan te maken. Zie Het account achter een ID vervangen om het ID in hetzelfde verzoek naar het nieuwe account te verplaatsen.
  • Geen external_id: Whop geeft het bestaande subaccount voor dat e-mailadres zonder external_id terug, als dat er is.
Accounts die een e-mailadres delen, worden beheerd door dezelfde Whop-gebruiker: de persoon die die inbox ontvangt.
Eerdere versies van deze gids plaatsten external_id in metadata. Whop accepteert het daar nog steeds in elke API- versie, stelt external_id ermee in en geeft het terug in metadata. Het volgt dezelfde regels als het veld op het hoogste niveau, inclusief de 409 wanneer een ander subaccount het al heeft, dus stuur reassign_external_id: true om er een te hergebruiken. Als je metadata.external_id later wijzigt, verandert external_id niet. Gebruik Update Account om het te wijzigen. Nieuwe integraties moeten het veld op het hoogste niveau versturen.

Het account achter een ID vervangen

Wanneer je aan jouw kant een account opnieuw uitgeeft, bijvoorbeeld een winkel die naar een nieuwe eigenaar gaat, maak dan het nieuwe subaccount aan met dezelfde external_id en reassign_external_id: true. Whop verplaatst het ID in hetzelfde verzoek naar het nieuwe subaccount in plaats van een 409 terug te geven.
TypeScript
  • Het subaccount dat het ID had, wordt niet verwijderd of op een andere manier gewijzigd. Het blijft actief met external_id ingesteld op null, behoudt zijn metadata en saldo, en verstuurt een account.updated-webhook. Verwijder het zelf als je het niet meer nodig hebt.
  • Als het aanmaken mislukt, blijft het ID waar het was.
  • Het verzoek heeft zowel de permissie company:update op je platformaccount als company:create_child nodig, omdat het een bestaand subaccount wijzigt.
  • Een verzoek met hetzelfde e-mailadres en dezelfde external_id als een bestaand subaccount geeft dat subaccount terug, ook wanneer de flag is ingesteld.
  • Het ID wordt alleen tussen je eigen subaccounts verplaatst.
Roep Update Account twee keer aan om een ID tussen twee bestaande subaccounts te verplaatsen: wis external_id op het oude account en stel het daarna in op het andere. Update Account heeft geen reassign_external_id, en als je het ID instelt voordat je het wist, krijg je een 409.

Onboarding afronden

Als de ontvanger nog geen Whop-account heeft, stuur dan een onboardinglink voor het account nadat je het account hebt aangemaakt. Via die link voltooit de ontvanger de Know Your Customer-verificatie (KYC), waarna het account overboekingen en andere uitbetalingsflows kan ontvangen.
Nadat de ontvanger de onboarding heeft voltooid, kun je:
  • checkoutflows voor hen aanmaken met applicatievergoedingen.
  • geld overmaken naar hun accountsaldo.
  • hen geld laten opnemen met het uitbetalingsportaal.

Aan de slag

Voordat je subaccounts kunt inschrijven, moet je je platformaccount instellen:
  1. Registreer een platformaccount: maak een account aan op whop.com/dashboard
  2. Genereer een Account API-sleutel: ga naar de pagina met je ontwikkelaarsinstellingen en genereer een Account API-sleutel
  3. Gebruik de API-sleutel voor authenticatie: met deze API-sleutel authenticeer je bij de huidige API en beheer je je subaccounts
De Account API-sleutel geeft de benodigde permissies om subaccounts onder je platformaccount aan te maken en te beheren.

Aangepaste metadata

Je kunt aangepaste metadata aan accounts koppelen wanneer je ze aanmaakt. Met metadata sla je aanvullende informatie over elk subaccount op als key-valueparen. Dit is handig voor:
  • Het bijhouden van niveaus of classificaties van subaccounts
  • Het koppelen aan databaserecords van je platform
Whop slaat metadata op bij het Account-object en geeft deze bij elke leesactie terug, maar je kunt accounts er niet op filteren. Zet de identifier waarmee je accounts opzoekt in plaats daarvan in external_id.

API-referentie

API voor het aanmaken van accounts

Bekijk de volledige API-referentie voor het aanmaken van accounts en alle beschikbare parameters

Volgende stappen

Na het aanmaken van een Account voor een subaccount:

Betalingen innen en verdelen

Kies tussen directe afschrijvingen en overboekingen

Uitbetalingsportaal weergeven

Laat subaccounts hun geld opnemen