Interface description for portals
An overview of all the interface calls your portal uses to connect, and of the notifications it receives from the service. Download the full description as an OpenAPI file.
The interface description is currently in Czech only; the rest of the page is in English.
The file describes all calls, response schemas and notification signing. It is written in Czech.
Wallets, top-ups, withdrawals and identity verification currently run in trial mode only, with play money.
Konfigurace
| Method | Path | Description |
|---|---|---|
| GET | /v1/config | Podporované měny, jejich meze a země, ze kterých služba přijme hráče |
Pořadatelé
| Method | Path | Description |
|---|---|---|
| PUT | /v1/organizers/{externalId} | Založení nebo úprava pořadatele a jeho účtů pro příjem plateb |
| GET | /v1/organizers/{externalId} | Profil pořadatele |
Akce
| Method | Path | Description |
|---|---|---|
| PUT | /v1/events/{externalId} | Založení nebo úprava akce (turnaje) |
| GET | /v1/events/{externalId} | Detail akce |
| POST | /v1/events/{externalId}/cancel | Zrušení akce |
Platby startovného
| Method | Path | Description |
|---|---|---|
| POST | /v1/events/{externalId}/entries | Nová platba startovného pro hráče |
| GET | /v1/events/{externalId}/entries | Přehled plateb akce a součty podle stavů |
| GET | /v1/entries/{id} | Stav platby |
| POST | /v1/entries/{id}/confirm | Ruční potvrzení platby pořadatelem |
| POST | /v1/entries/{id}/refund-due | Portál hlásí, že hráče nešlo zaregistrovat (například plno) |
| POST | /v1/entries/{id}/refunded | Pořadatel vrátil peníze hráči |
| GET | /v1/entries/{id}/refund-qr | QR pro vrácení startovného hráči |
Výsledky a výplaty
| Method | Path | Description |
|---|---|---|
| POST | /v1/events/{externalId}/results | Odeslání výsledků turnaje a vznik výplat |
| POST | /v1/events/{externalId}/results/confirm | Potvrzení výsledků akce vypořádané přes peněženky (připsání výher) |
| GET | /v1/events/{externalId}/payouts | Výplaty akce a jejich součet |
| GET | /v1/payouts/{id}/qr | QR pro zaplacení výplaty z účtu pořadatele |
| POST | /v1/payouts/{id}/sent | Pořadatel výplatu odeslal |
| POST | /v1/payouts/{id}/confirm | Hráč potvrdil přijetí výplaty |
| POST | /v1/events/{externalId}/settle | Zopakování vypořádání akce vypořádané přes peněženky |
Hráči
| Method | Path | Description |
|---|---|---|
| PUT | /v1/players/{externalId} | Založení nebo úprava hráče |
| GET | /v1/players/{externalId} | Údaje hráče |
| PUT | /v1/players/{externalId}/payout-account | Uložení účtu hráče pro výplaty |
| GET | /v1/players/{externalId}/payout-account | Účet hráče pro výplaty |
| GET | /v1/players/{externalId}/payments | Podklad pro „Moje platby“ hráče |
Peněženky
| Method | Path | Description |
|---|---|---|
| GET | /v1/players/{externalId}/wallet | Peněženka hráče (zůstatky a poslední pohyby) |
| GET | /v1/organizers/{externalId}/wallet | Peněženka pořadatele (zůstatky a poslední pohyby) |
Odkaz na peněženku
| Method | Path | Description |
|---|---|---|
| POST | /v1/players/{externalId}/wallet-link | Jednorázový odkaz na peněženku hráče (stránka EsportPay bez programování obrazovek) |
| POST | /v1/organizers/{externalId}/wallet-link | Jednorázový odkaz na peněženku pořadatele |
Dobití
| Method | Path | Description |
|---|---|---|
| POST | /v1/players/{externalId}/wallet/topups | Žádost o dobití peněženky hráče |
| POST | /v1/organizers/{externalId}/wallet/topups | Žádost o dobití peněženky pořadatele |
| GET | /v1/wallet/topups/{id} | Stav dobití |
Výběry
| Method | Path | Description |
|---|---|---|
| POST | /v1/players/{externalId}/wallet/withdrawals | Žádost o výběr zůstatku hráče na jeho bankovní účet |
| POST | /v1/organizers/{externalId}/wallet/withdrawals | Žádost o výběr zůstatku pořadatele na jeho bankovní účet |
| GET | /v1/wallet/withdrawals/{id} | Stav výběru |
Ověření totožnosti
| Method | Path | Description |
|---|---|---|
| PUT | /v1/players/{externalId}/kyc | Odeslání údajů k ověření totožnosti hráče |
| GET | /v1/players/{externalId}/kyc | Stav ověření totožnosti hráče |
| PUT | /v1/organizers/{externalId}/kyc | Odeslání údajů k ověření totožnosti pořadatele |
| GET | /v1/organizers/{externalId}/kyc | Stav ověření totožnosti pořadatele |
Výpisy
| Method | Path | Description |
|---|---|---|
| GET | /v1/players/{externalId}/statements/{year} | Roční výpis hráče (podklad pro účetnictví a přiznání) |
| GET | /v1/organizers/{externalId}/statements/{year} | Roční výpis pořadatele (podklad pro účetnictví a přiznání) |
Zkušební cesty
| Method | Path | Description |
|---|---|---|
| POST | /v1/test/wallet/topups/{id}/simulate | Zkušební připsání dobití (jen testovací režim) |
| POST | /v1/test/wallet/withdrawals/{id}/simulate-settle | Zkušební vypořádání výběru (jen testovací režim) |
Portal notifications
The service sends them to your portal's address and signs each one.
| Type | Description |
|---|---|
entry.paid | Platba startovného je zaplacena |
entry.expired | Platba vypršela nebo byla uzavřena |
entry.refund_due | Startovné je třeba vrátit |
payout.ready | Výplata je připravena k odeslání |
payout.sent | Pořadatel výplatu odeslal |
payout.confirmed | Hráč potvrdil přijetí výplaty |
entry.refunded | Startovné bylo vráceno na zůstatek hráče (akce vypořádaná přes peněženky) |
event.awaiting_funds | Vypořádání akce čeká na prostředky pořadatele |
wallet.topup_credited | Dobití bylo připsáno na zůstatek |
wallet.withdrawal_settled | Výběr byl vypořádán (peníze odešly) |
wallet.withdrawal_failed | Výběr se nepovedl a částka se vrátila na zůstatek |