Zkušební provoz

Popis rozhraní pro portály

Přehled všech volání rozhraní, kterými se váš portál napojí, a oznámení, která od služby dostane. Úplný popis si stáhnete jako soubor OpenAPI.

Soubor popisuje všechna volání, schémata odpovědí a podpis oznámení. Je psaný česky.

Peněženky, dobití, výběry a ověření totožnosti dnes běží jen ve zkušebním režimu s hracími penězi.

Konfigurace

MetodaCestaPopis
GET/v1/configPodporované měny, jejich meze a země, ze kterých služba přijme hráče

Pořadatelé

MetodaCestaPopis
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

MetodaCestaPopis
PUT/v1/events/{externalId}Založení nebo úprava akce (turnaje)
GET/v1/events/{externalId}Detail akce
POST/v1/events/{externalId}/cancelZrušení akce

Platby startovného

MetodaCestaPopis
POST/v1/events/{externalId}/entriesNová platba startovného pro hráče
GET/v1/events/{externalId}/entriesPřehled plateb akce a součty podle stavů
GET/v1/entries/{id}Stav platby
POST/v1/entries/{id}/confirmRuční potvrzení platby pořadatelem
POST/v1/entries/{id}/refund-duePortál hlásí, že hráče nešlo zaregistrovat (například plno)
POST/v1/entries/{id}/refundedPořadatel vrátil peníze hráči
GET/v1/entries/{id}/refund-qrQR pro vrácení startovného hráči

Výsledky a výplaty

MetodaCestaPopis
POST/v1/events/{externalId}/resultsOdeslání výsledků turnaje a vznik výplat
POST/v1/events/{externalId}/results/confirmPotvrzení výsledků akce vypořádané přes peněženky (připsání výher)
GET/v1/events/{externalId}/payoutsVýplaty akce a jejich součet
GET/v1/payouts/{id}/qrQR pro zaplacení výplaty z účtu pořadatele
POST/v1/payouts/{id}/sentPořadatel výplatu odeslal
POST/v1/payouts/{id}/confirmHráč potvrdil přijetí výplaty
POST/v1/events/{externalId}/settleZopakování vypořádání akce vypořádané přes peněženky

Hráči

MetodaCestaPopis
PUT/v1/players/{externalId}Založení nebo úprava hráče
GET/v1/players/{externalId}Údaje hráče
PUT/v1/players/{externalId}/payout-accountUložení účtu hráče pro výplaty
GET/v1/players/{externalId}/payout-accountÚčet hráče pro výplaty
GET/v1/players/{externalId}/paymentsPodklad pro „Moje platby“ hráče

Peněženky

MetodaCestaPopis
GET/v1/players/{externalId}/walletPeněženka hráče (zůstatky a poslední pohyby)
GET/v1/organizers/{externalId}/walletPeněženka pořadatele (zůstatky a poslední pohyby)

Odkaz na peněženku

MetodaCestaPopis
POST/v1/players/{externalId}/wallet-linkJednorázový odkaz na peněženku hráče (stránka EsportPay bez programování obrazovek)
POST/v1/organizers/{externalId}/wallet-linkJednorázový odkaz na peněženku pořadatele

Dobití

MetodaCestaPopis
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

MetodaCestaPopis
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

MetodaCestaPopis
PUT/v1/players/{externalId}/kycOdeslání údajů k ověření totožnosti hráče
GET/v1/players/{externalId}/kycStav ověření totožnosti hráče
PUT/v1/organizers/{externalId}/kycOdeslání údajů k ověření totožnosti pořadatele
GET/v1/organizers/{externalId}/kycStav ověření totožnosti pořadatele

Výpisy

MetodaCestaPopis
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

MetodaCestaPopis
POST/v1/test/wallet/topups/{id}/simulateZkušební připsání dobití (jen testovací režim)
POST/v1/test/wallet/withdrawals/{id}/simulate-settleZkušební vypořádání výběru (jen testovací režim)

Oznámení portálu

Služba je posílá na adresu vašeho portálu a každé podepisuje.

TypPopis
entry.paidPlatba startovného je zaplacena
entry.expiredPlatba vypršela nebo byla uzavřena
entry.refund_dueStartovné je třeba vrátit
payout.readyVýplata je připravena k odeslání
payout.sentPořadatel výplatu odeslal
payout.confirmedHráč potvrdil přijetí výplaty
entry.refundedStartovné bylo vráceno na zůstatek hráče (akce vypořádaná přes peněženky)
event.awaiting_fundsVypořádání akce čeká na prostředky pořadatele
wallet.topup_creditedDobití bylo připsáno na zůstatek
wallet.withdrawal_settledVýběr byl vypořádán (peníze odešly)
wallet.withdrawal_failedVýběr se nepovedl a částka se vrátila na zůstatek