Volání pro práci s Fidoo kartami: výpis karet, dobití a odbití včetně hromadných variant a kontrola stavu procesu. Prostředí, klíč v hlavičce X-Api-Key, stránkování a čtení tabulek popisuje Public API – základy. Dokumentace odpovídá stavu API k 6. 8. 2026.
POST /v2/card/get-cards
Lze zjistit např. stav karty a jejich typ, embosované prvky karty, datum expirace, zůstatky a blokace karty aj.
Je vrácen výpis osobních a týmových Fidoo karet v držení konkrétního hledaného uživatele.
Volané parametry
| Parametr | Popis | Vzor dat |
|---|---|---|
limit | Maximální počet vrácených řádků (karet). Výchozí hodnota je 100. | 100 |
userId | Unikátní identifikátor uživatele v systému Fidoo. | 0cf6e5c1-3c77-4383-9a86-6fef12d9f62b |
offsetToken | Klíč pro vícenásobné volání. Uveden jako hodnota parametru nextOffsetToken vraceného do nabytí stavu "complete": true. | T3 |
Vrácené parametry
| Parametr | Popis | Vzor dat |
|---|---|---|
complete | Stav dokončení kompletního výpisu. Hodnoty: true = výpis je kompletní (dokončen); false = výpis není kompletní. | false |
nextOffsetToken | Klíč pro vícenásobné volání. | T3 |
cardList | Výpis karet. | – |
· cardId | Unikátní identifikátor karty v systému Fidoo. | b16d2df4-5c28-4b90-9a8a-a88c3258fa53 |
· cardState | Stav karty. Hodnoty: first-ordered = karta K aktivaci; active = karta Aktivní; hard-blocked = karta Blokovaná; soft-blocked = karta Uzamčená; expired = karta Expirovaná. | active |
· cardType | Typ karty. Hodnoty: personal = karta je osobní; shared = karta je týmová. | shared |
· maskedNumber | Maskovaný PAN karty. Zobrazuje se pouze prvních 6 čísel a poslední 4 čísla. Jedná se o číslo vyražené na přední straně karty. | 549546******3575 |
· embossName | Vyražené pojmenování karty. Když cardType=personal, pak je vráceno: jméno držitele karty. Když cardType=shared, pak je vrácen: název karty. | TYM OMEGA |
· alias | Volitelný název karty pro snadné hledání v systému. | Omega z Kladna |
· expiration | Datum expirace karty. | 2026-01-31 |
· availableBalance | Disponibilní zůstatek karty. | 0 |
· accountingBalance | Účetní zůstatek karty. | 0 |
· blockedBalance | Součet všech nezaúčtovaných (blokovaných) transakcí. | 0 |
· deliveryEstimate | Předpokládané datum doručení karty. | 2024-01-31 |
· userId | Unikátní identifikátor uživatele v systému Fidoo. | 0cf6e5c1-3c77-4383-9a86-6fef12d9f62b |
· connectedUserIds | Unikátní identifikátory uživatelů v systému Fidoo spojených s kartou. Když cardType=personal, pak je vrácen: userId. Když cardType=shared, pak je zpravidla vrácen: seznam identifikátorů uživatelů oddělených čárkou. | 0cf6e5c1-3c77-4383-9a86-6fef12d9f62b, 3fa85f64-5717-4562-b3fc-2c963f66afa6 |
· employeeNumber | Zaměstnanecké číslo uživatele. | AX12545 |
POST /v2/card/load-card
Umožňuje dobít jednu Fidoo kartu z Fidoo (MVC) účtu.
Je vráceno potvrzení o zaevidování požadavku a přidělený unikátní identifikátor na dobití prostředků na Fidoo kartu z Fidoo (MVC) účtu.
Volané parametry
| Parametr | Popis | Vzor dat |
|---|---|---|
cardId (povinné) | Unikátní identifikátor karty v systému Fidoo. | b16d2df4-5c28-4b90-9a8a-a88c3258fa53 |
amount (povinné) | Dobíjená částka. Uvedená v měně CZK (Korunách českých). | 1000 |
message | Zpráva pro příjemce. Maximální délka: 50 znaků. | Peníze na nákup materiálu |
customerProcessId | Vlastní ID procesu pro nabití karty. Maximální délka: 255 znaků. Musí být jedinečný v rámci společnosti. Lze použít ve službě load-status, zda je proces nabití karty již dokončen. | nabiti 02233 |
Vrácené parametry
| Parametr | Popis | Vzor dat |
|---|---|---|
asyncToken | Asynchronní klíč v systému Fidoo. odpovídá hodnotě processId. | bdadbc33-6b9b-4c63-a3c1-29ba8fbbbf47 |
processId | Unikátní identifikátor procesu v systému Fidoo. odpovídá hodnotě asyncToken. | bdadbc33-6b9b-4c63-a3c1-29ba8fbbbf47 |
customerProcessId | Vlastní ID procesu pro nabití karty. Lze použít ve službě load-status, zda je proces nabití karty již dokončen. | nabiti 02233 |
callBackTime | Časové razítko volání. Uveden ve formátu ISO 8601. | 2024-01-24T12:30:11.053729Z |
cardId | Unikátní identifikátor karty v systému Fidoo. | b16d2df4-5c28-4b90-9a8a-a88c3258fa53 |
POST /v2/card/load-cards
Umožňuje dobít více Fidoo karet z Fidoo (MVC) účtu.
Jsou vrácena potvrzení o zaevidování jednotlivých požadavků, přidělených unikátních identifikátorů na dobití prostředků na Fidoo karty z Fidoo (MVC) účtu, popř. informování o chybovém stavu nabití jednotlivých karet.
Volané parametry
| Parametr | Popis | Vzor dat |
|---|---|---|
cards (povinné) | Seznam jednotlivých požadavků na nabití karet. | – |
· cardId (povinné) | Unikátní identifikátor karty v systému Fidoo. | b16d2df4-5c28-4b90-9a8a-a88c3258fa53 |
· amount (povinné) | Dobíjená částka. Uvedená v měně CZK (Korunách českých). | 1000 |
· message | Zpráva pro příjemce. Maximální délka: 50 znaků. | Peníze na nákup materiálu |
· customerProcessId | Vlastní ID procesu pro nabití karty. Maximální délka: 255 znaků. Musí být jedinečný v rámci společnosti. Lze použít ve službě load-status, zda je proces nabití karty již dokončen. | nabiti 03344 |
Vrácené parametry
| Parametr | Popis | Vzor dat |
|---|---|---|
cards | Výpis zaevidovaných požadavků o dobití karet. | – |
· asyncToken | Asynchronní klíč v systému Fidoo. odpovídá hodnotě processId. | bdadbc33-6b9b-4c63-a3c1-29ba8fbbbf47 |
· processId | Unikátní identifikátor procesu v systému Fidoo. odpovídá hodnotě asyncToken. | bdadbc33-6b9b-4c63-a3c1-29ba8fbbbf47 |
· customerProcessId | Vlastní ID procesu pro nabití karty. Lze použít ve službě load-status, zda je proces nabití karty již dokončen. | nabiti 03344 |
· callBackTime | Časové razítko volání. Uveden ve formátu ISO 8601. | 2024-01-24T12:30:11.053729Z |
· cardId | Unikátní identifikátor karty v systému Fidoo. | b16d2df4-5c28-4b90-9a8a-a88c3258fa53 |
· code | Kód chyby. Když bez chyby, pak je vráceno null. | DUPLICATED_CUSTOMER_PROCESS_ID |
· errorId | Unikátní identifikátor chybového stavu v systému Fidoo. Když bez chyby, pak je vráceno null. | prod-f1b46317-cc6c-45fc-ae70-5b9f553c92bb |
· message | Popis chybového stavu. Když bez chyby, pak je vráceno null. | CustomerProcessId already used by other process |
POST /v2/card/load-status
Umožňuje kontrolu stavu nabití více Fidoo karet z Fidoo (MVC) účtu.
Jsou vráceny stavy nabití prostředků Fidoo karet z Fidoo (MVC) účtu, popř. informování o chybovém stavu nabití jednotlivých karet.
Volané parametry
| Parametr | Popis | Vzor dat |
|---|---|---|
statusList (povinné) | Seznam stavů dílčích požadavků na dobití karet. | – |
· processId | Unikátní identifikátor procesu v systému Fidoo. | bdadbc33-6b9b-4c63-a3c1-29ba8fbbbf47 |
· customerProcessId | Vlastní ID procesu pro nabití karty. Již vytvořeno ve službě load-card či load-cards. | nabiti 02233 |
Vrácené parametry
| Parametr | Popis | Vzor dat |
|---|---|---|
statusList | Seznam stavů dílčích požadavků na dobití karet. | – |
· processId | Unikátní identifikátor procesu v systému Fidoo. | bdadbc33-6b9b-4c63-a3c1-29ba8fbbbf47 |
· customerProcessId | Vlastní ID procesu pro nabití karty. Již vytvořeno ve službě load-card či load-cards. | nabiti 02233 |
· cardId | Unikátní identifikátor karty v systému Fidoo. | b16d2df4-5c28-4b90-9a8a-a88c3258fa53 |
· status | Stav nabití karty. Hodnoty: success = nabití úspěšně dokončeno; proceeding = nabití v procesu; error = nabití dokončeno s chybou; not_found = nabití nenalezeno v systému Fidoo. | success |
· callBackTime | Časové razítko volání. Uveden ve formátu ISO 8601. | 2024-01-24T12:30:11.053729Z |
· code | Kód chyby. Když bez chyby, pak je vráceno null. | DUPLICATED_CUSTOMER_PROCESS_ID |
· errorId | Unikátní identifikátor chybového stavu v systému Fidoo. Když bez chyby, pak je vráceno null. | prod-f1b46317-cc6c-45fc-ae70-5b9f553c92bb |
· message | Popis chybového stavu. Když bez chyby, pak je vráceno null. | CustomerProcessId already used by other process |
POST /v2/card/unload-card
Umožňuje odbít jednu Fidoo kartu na Fidoo (MVC) účet.
Je vráceno potvrzení o zaevidování požadavku a přidělený unikátní identifikátor pro odbití prostředků z Fidoo karty na Fidoo (MVC) účet.
Volané parametry
| Parametr | Popis | Vzor dat |
|---|---|---|
cardId (povinné) | Unikátní identifikátor karty v systému Fidoo. | b16d2df4-5c28-4b90-9a8a-a88c3258fa53 |
amount (povinné) | Vybíjená částka. Uvedená v měně CZK (Korunách českých). | 1000 |
message | Zpráva pro příjemce. Maximální délka: 50 znaků. | Zbylé peníze z nákupu materiálu |
customerProcessId | Vlastní ID procesu pro odbití karty. Maximální délka: 255 znaků. Musí být jedinečný v rámci společnosti. Lze použít ve službě unload-status, zda je proces odbití karty již dokončen. | odbiti 02233 |
fullUnload | Odbití celé karty do nuly. Předchází nutnosti provádět výpočet částky. Hodnoty: true = odbití celé karty; false = odbití výše stanové částky amount. | false |
Vrácené parametry
| Parametr | Popis | Vzor dat |
|---|---|---|
asyncToken | Asynchronní klíč v systému Fidoo. odpovídá hodnotě processId. | bdadbc33-6b9b-4c63-a3c1-29ba8fbbbf47 |
processId | Unikátní identifikátor procesu v systému Fidoo. odpovídá hodnotě asyncToken. | bdadbc33-6b9b-4c63-a3c1-29ba8fbbbf47 |
customerProcessId | Vlastní ID procesu pro odbití karty. Lze použít ve službě unload-status, zda je proces odbití karty již dokončen. | odbiti 02233 |
callBackTime | Časové razítko volání. Uveden ve formátu ISO 8601. | 2024-01-24T12:30:11.053729Z |
cardId | Unikátní identifikátor karty v systému Fidoo. | b16d2df4-5c28-4b90-9a8a-a88c3258fa53 |
POST /v2/card/unload-cards
Umožňuje vybít více Fidoo karet na Fidoo (MVC) účet.
Jsou vrácena potvrzení o zaevidování jednotlivých požadavků, přidělených unikátních identifikátorů na odbití prostředků z Fidoo karet na Fidoo (MVC) účet, popř. informování o chybovém stavu odbití jednotlivých karet.
Volané parametry
| Parametr | Popis | Vzor dat |
|---|---|---|
cards (povinné) | Seznam jednotlivých požadavků na odbití karet. | – |
· cardId (povinné) | Unikátní identifikátor karty v systému Fidoo. | b16d2df4-5c28-4b90-9a8a-a88c3258fa53 |
· amount (povinné) | Vybíjená částka. Uvedená v měně CZK (Korunách českých). | 1000 |
· message | Zpráva pro příjemce. Maximální délka: 50 znaků. | Zbylé peníze z nákupu materiálu |
· customerProcessId | Vlastní ID procesu pro odbití karty. Maximální délka: 255 znaků. Musí být jedinečný v rámci společnosti. Lze použít ve službě unload-status, zda je proces odbití karty již dokončen. | odbiti 03344 |
· fullUnload | Odbití celé karty do nuly. Předchází nutnosti provádět výpočet částky. Hodnoty: true = odbití celé karty; false = odbití výše stanové částky amount. | false |
Vrácené parametry
| Parametr | Popis | Vzor dat |
|---|---|---|
cards | Výpis zaevidovaných požadavků o odbití karet. | – |
· asyncToken | Asynchronní klíč v systému Fidoo. odpovídá hodnotě processId. | bdadbc33-6b9b-4c63-a3c1-29ba8fbbbf47 |
· processId | Unikátní identifikátor procesu v systému Fidoo. odpovídá hodnotě asyncToken. | bdadbc33-6b9b-4c63-a3c1-29ba8fbbbf47 |
· customerProcessId | Vlastní ID procesu pro odbití karty. Lze použít ve službě unload-status, zda je proces odbití karty již dokončen. | nabiti 03344 |
· callBackTime | Časové razítko volání. Uveden ve formátu ISO 8601. | 2024-01-24T12:30:11.053729Z |
· cardId | Unikátní identifikátor karty v systému Fidoo. | b16d2df4-5c28-4b90-9a8a-a88c3258fa53 |
· code | Kód chyby. Když bez chyby, pak je vráceno null. | DUPLICATED_CUSTOMER_PROCESS_ID |
· errorId | Unikátní identifikátor chybového stavu v systému Fidoo. Když bez chyby, pak je vráceno null. | prod-f1b46317-cc6c-45fc-ae70-5b9f553c92bb |
· message | Popis chybového stavu. Když bez chyby, pak je vráceno null. | CustomerProcessId already used by other process |
POST /v2/card/unload-status
Umožňuje kontrolu stavu odbití více Fidoo karet na Fidoo (MVC) účtu.
Jsou vráceny stavy odbití prostředků Fidoo karet na Fidoo (MVC) účet, popř. informování o chybovém stavu odbití jednotlivých karet.
Volané parametry
| Parametr | Popis | Vzor dat |
|---|---|---|
statusList (povinné) | Seznam stavů dílčích požadavků na odbití karet. | – |
· processId | Unikátní identifikátor procesu v systému Fidoo. | bdadbc33-6b9b-4c63-a3c1-29ba8fbbbf47 |
· customerProcessId | Vlastní ID procesu pro nabití karty. Již vytvořeno ve službě unload-card či unload-cards. | odbiti 02233 |
Vrácené parametry
| Parametr | Popis | Vzor dat |
|---|---|---|
statusList | Výpis stavů dílčích požadavků na odbití karet. | – |
· processId | Unikátní identifikátor procesu v systému Fidoo. | bdadbc33-6b9b-4c63-a3c1-29ba8fbbbf47 |
· customerProcessId | Vlastní ID procesu pro odbití karty. Již vytvořeno ve službě unload-card či unload-cards. | odbiti 02233 |
· cardId | Unikátní identifikátor karty v systému Fidoo. | b16d2df4-5c28-4b90-9a8a-a88c3258fa53 |
· status | Stav odbití karty. Hodnoty: success = odbití úspěšně dokončeno; proceeding = odbití v procesu; error = odbití dokončeno s chybou; not_found = odbití nenalezeno v systému Fidoo. | success |
· callBackTime | Časové razítko volání. Uvedeno ve formátu ISO 8601. | 2024-01-24T12:30:11.053729Z |
· code | Kód chyby. Když bez chyby, pak je vráceno null. | DUPLICATED_CUSTOMER_PROCESS_ID |
· errorId | Unikátní identifikátor chybového stavu v systému Fidoo. Když bez chyby, pak je vráceno null. | prod-f1b46317-cc6c-45fc-ae70-5b9f553c92bb |
· message | Popis chybového stavu. Když bez chyby, pak je vráceno null. | CustomerProcessId already used by other process |
Byl tento článek užitečný?