Eksempel
Opret en konto for underkontoen:emailer underkontoens e-mailadresse. Whop bruger den til at identificere underkontoen og sende vigtige notifikationer.- Account-API-nøglen afgør, hvilken platformkonto der ejer underkontoen.
titleer underkontoens påkrævede visningsnavn.external_ider din platforms eget ID for denne underkonto, f.eks. dit butiks-ID. Hvert ID svarer til én underkonto, og du kan slå kontoen op via det senere.metadataindeholder brugerdefinerede nøgle-værdi-par, f.eks.seller_tier, en klassificering eller et niveau for underkontoen (f.eks. “bronze”, “silver” eller “gold”).- Svaret indeholder et
account.id, som du kan bruge til at referere til denne underkonto i fremtidige API-kald
Find en underkonto via dit ID
Vis dine underkonti medexternal_id for at få kontoen til en af dine poster. Afslut værdien med % for at få alle konti, hvis ID starter med et navnerum, du har valgt, f.eks. shopline:%. Matchning skelner mellem store og små bogstaver, _ matcher bogstaveligt, og % virker kun til sidst, så ID’er, du opretter, kan ikke indeholde det.
TypeScript
external_id på en eksisterende underkonto. Kun din platform kan ændre det. Underkontoen kan læse det, men ikke redigere det.
Genbrug af en e-mailadresse
Flere underkonti kan dele én e-mailadresse, så længe hver af dem har et særskiltexternal_id. Oprettelse af en konto er idempotent på parret af e-mail og external_id:
- Nyt
external_id: Whop opretter en ny underkonto, selv når e-mailen allerede er i brug. - Samme e-mail og
external_id: Whop returnerer den eksisterende underkonto i stedet for at oprette en dublet, så genforsøg er sikre. external_idallerede brugt med en anden e-mail: Whop returnerer409i stedet for at oprette en ekstra konto med det ID. Se Erstat kontoen bag et ID for at flytte ID’et til den nye konto i samme request.- Intet
external_id: Whop returnerer den eksisterende underkonto for den e-mail, der ikke har nogetexternal_id, hvis der findes en.
Tidligere versioner af denne guide placerede
external_id i metadata. Whop accepterer det stadig dér i alle API-
versioner, sætter external_id ud fra det og returnerer det i metadata. Det følger samme regler som feltet på øverste niveau,
herunder 409, når en anden underkonto allerede har det, så send reassign_external_id: true for at genbruge et.
Ændring af metadata.external_id senere ændrer ikke external_id. Brug Update Account for at ændre det. Nye
integrationer bør sende feltet på øverste niveau.Erstat kontoen bag et ID
Når du genudsteder en konto hos dig, f.eks. en butik, der skifter ejer, skal du oprette den nye underkonto med sammeexternal_id og reassign_external_id: true. Whop flytter ID’et til den nye underkonto i samme request i stedet for at returnere 409.
TypeScript
- Den underkonto, der havde ID’et, slettes ikke og ændres ikke på nogen anden måde. Den forbliver aktiv med
external_idsat tilnull, beholder sinmetadataog saldo og sender enaccount.updated-webhook. Slet den selv, hvis du ikke længere har brug for den. - Hvis oprettelsen mislykkes, bliver ID’et, hvor det var.
- Requesten kræver tilladelsen
company:updatepå din platformkonto samtcompany:create_child, fordi den ændrer en eksisterende underkonto. - En request med samme e-mail og
external_idsom en eksisterende underkonto returnerer den underkonto, selv når den sætter flaget. - ID’et flyttes kun mellem dine egne underkonti.
external_id på den gamle, og sæt det derefter på den anden. Update Account har ingen reassign_external_id, og hvis du sætter ID’et, før du rydder det, returneres 409.
Afslut onboarding
Hvis modtageren ikke allerede har en Whop-konto, skal du sende vedkommende et onboardinglink til kontoen, efter du har oprettet den. Modtageren gennemfører Know Your Customer-verifikation (KYC) via linket, og derefter kan kontoen modtage overførsler og andre udbetalingsflows.- oprette checkout-flows for vedkommende med application fees.
- overføre midler til vedkommendes kontosaldo.
- lade vedkommende hæve midler med udbetalingsportalen.
Kom godt i gang
Før du kan tilmelde underkonti, skal du konfigurere din platformkonto:- Tilmeld dig en platformkonto: Opret en konto på whop.com/dashboard
- Generer en Account-API-nøgle: Gå til siden med dine udviklerindstillinger, og generer en Account-API-nøgle
- Brug API-nøglen til godkendelse: Det er med denne API-nøgle, du godkender dig mod det aktuelle API og styrer dine underkonti
Brugerdefinerede metadata
Du kan knytte brugerdefinerede metadata til konti, når du opretter dem. Metadata giver dig mulighed for at gemme yderligere oplysninger om hver underkonto som nøgle-værdi-par. Det er nyttigt til:- At spore underkontoniveauer eller klassificeringer
- At linke til poster i din platforms database
external_id.
API-reference
Create Account API
Se den fulde API-reference for oprettelse af konti og alle tilgængelige parametre
Næste trin
Efter du har oprettet en Account for en underkonto:Opkræv og fordel betalinger
Vælg mellem direkte opkrævninger og overførsler
Vis udbetalingsportalen
Lad underkonti hæve deres midler

