API pro stahování souborů

Seznam převodů v rámci dne

Metoda transferList slouží k získání informace, jaké převody byly uskutečněny v rámci daného dne.
URL metody: https://payments.comgate.cz/v1.0/transferList

Parametry volání
parametr typ povinný popis
merchant string A identifikátor e-shopu v systému ComGate
secret string A heslo pro komunikaci na pozadí
date string A metoda vrací převody za jeden den
Příklad založení seznamu převodů v rámci dne – HTTP request

POST /v1.0/transferList HTTP/1.1A
Host: payments.comgate.cz
Content-Type: application/x-www-form-urlencoded; charset=utf-8

merchant=135258&secret=wi9VplRz0UNqoxFqSM4udyxyA1ia5z32&date=2019-07-25
Příklad založení seznamu převodů v rámci dne – HTTP response

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8

[{"transferId":5211530,"transferDate":"2019-07-25","accountCounterparty":"0\/0000","accountOutgoing":"281481882\/0300","variableSymbol":"86616655"}]

Detaily ke konkrétnímu bankovnímu převodu

Metoda singleTransfer zobrazuje detailní informace ke konkrétnímu převodu.
Povinný parametr transferId získá obchodník pomocí metody transferList.
URL metody: https://payments.comgate.cz/v1.0/singleTransfer

Parametry volání
parametr typ povinný popis
merchant string A identifikátor e-shopu v systému ComGate
secret string A heslo pro komunikaci na pozadí
transefld string A

detaily ke konkrétnímu bankovnímu převodu

Příklad založení detailu ke konkrétnímu bank. převodu – HTTP request

POST /v1.0/singleTransfer HTTP/1.1

Host: payments.comgate.cz

Content-Type: application/x-www-form-urlencoded; charset=utf-8

merchant=135258&secret=wi9VplRz0UNqoxFqSM4udyxyA1ia5z32&transferId=5211530

Příklad založení detailu ke konkrétnímu bank. převodu – HTTP response

1 = platba
2 = refundace
3 = měsíční poplatek
4 = ostatní poplatky, chargebacky a ruční pohyby
5 = sumární řádek

HTTP/1.1 200 OK

Content-Type: application/json; charset=UTF-8
[

   {
       "typ": 1,AAAAA
       "Merchant": "135261",

       "Datum založení": "2019-07-23 11:40:20",

       "Datum zaplacení": "2019-07-23 11:42:02",

       "Datum převodu": "2019-07-25",

       "Měsíc fakturace": null,

       "ID ComGate": "QWDZ-AGRU-1F6L",

       "Metoda": "Platba kartou",

       "Produkt": null,

       "Popis": "ComGate s.r.o.",

       "E-mail plátce": "info@comgate.cz",

       "Variabilní symbol platby": "86230990",

       "Variabilní symbol převodu": "86616655",

       "ID od klienta": "5331940",

       "Měna": "HUF",

       "Potvrzená částka": "12480,00",

       "Převedená částka": "12356,45",

       "Poplatek celkem": "123,55",

       "Poplatek mezibankovní": "24,96",

       "Poplatek asociace": "33,70",

       "Poplatek zpracovatel": "64,89"

   },

   {

       "typ": 5,

       "Merchant": "-",

       "Datum založení": null,

       "Datum zaplacení": null,

       "Datum převodu": "2019-07-25",

       "Měsíc fakturace": null,

       "ID ComGate": null,

       "Metoda": null,

       "Produkt": "suma",

       "Popis": "-",

       "E-mail plátce": "-",

       "Variabilní symbol platby": "-",

       "Variabilní symbol převodu": "86616655",

       "ID od klienta": "-",

       "Měna": "HUF",

       "Potvrzená částka": "54910,00",

       "Převedená částka": "54366,40",

       "Poplatek celkem": "543,60",

       "Poplatek mezibankovní": "109,82",

       "Poplatek asociace": "148,27",

       "Poplatek zpracovatel": "285,51"

   }

]

CSV rozpis ke konkrétnímu bankovnímu převodu

Díky metodě csvSingleTransfer si lze stáhnout denní výpis ve formátu CSV.

URL metody: https://payments.comgate.cz/v1.0/csvSingleTransfer

Parametry volání
parametr typ povinný popis
merchant string A identifikátor e-shopu v systému ComGate
secret string A heslo pro komunikaci na pozadí
transferId string A detaily ke konkrétnímu bankovnímu převodu
download string N

Pokud není vyplněno nebo je false, tak vrací data: název souboru a jeho obsah; pokud je true, tak vrací rovnou CSV soubor.

Příklad stahování výpisu ve formátu csv ke konkrétnímu bankovnímu převodu – HTTP request

POST /v1.0/csvSingleTransfer HTTP/1.1

Host: payments.comgate.cz

Content-Type: application/x-www-form-urlencoded; charset=utf-8

 

merchant=135258&secret=wi9VplRz0UNqoxFqSM4udyxyA1ia5z32&transferId=5211530&download=false

Příklad stahování výpisu ve formátu csv ke konkrétnímu bankovnímu převodu – HTTP response

HTTP/1.1 200 OK

Content-Type: application/json; charset=UTF-8

{
"nazev": "vypis-2019-07-25.csv",
"csv": base64 encoded csv
}

ABO rozpis ke konkrétnímu bankovnímu převodu

Díky metodě aboSingleTransfer si lze stáhnout denní výpis ve formátu ABO.
URL metody: https://payments.comgate.cz/v1.0/aboSingleTransfer

Parametry volání
parametr typ povinný popis
merchant string A identifikátor e-shopu v systému ComGate
secret string A heslo pro komunikaci na pozadí
transferId string A detaily ke konkrétnímu bankovnímu převodu
download string N

Pokud není vyplněno nebo je false, tak vrací data : název souboru a jeho obsah; pokud je true, tak vrací rovnou ABO soubor.
type string N parametr "type" může nabývat hodnot "v1" a "v2". Pod "v1" získáíte ABO verzi s poplatky uvedenými zvlášť ke každé platbě, pod "v2" pak ABO s poplatek souhrným v jednom řádku. Pokud nebude parametr vyplněn, automaticky obdržíte typ "v1". Rozdíl mezi jednolivými typy najdete na https://www.comgate.cz/cz/soubory-s-vypisy-transakci.

Příklad stahování rozpisu ABO ke konkrétnímu bankovnímu převodu – HTTP request

POST /v1.0/aboSingleTransfer HTTP/1.1

Host: payments.comgate.cz

Content-Type: application/x-www-form-urlencoded; charset=utf-8

merchant=135258&secret=wi9VplRz0UNqoxFqSM4udyxyA1ia5z32&transferId=5211530&download=true&type=v2

Příklad stahování rozpisu ABO ke konkrétnímu bankovnímu převodu – HTTP response

HTTP/1.1 200 OK

Content-Type: application/json; charset=UTF-8

{
"nazev": "vypis-2019-07-25.gpc",
"abo": base64 encoded abo/gpc file
}

Stažení CSV pro převody v rámci dne

Přímé stažení CSV souborů pro konkrétní den metodou csvDowload. Lze stáhnout buď 1 CSV, nebo více CSV v ZIP souboru, pokud je více převodů v rámci dne. Lze využít např. pro volání pomocí wget.
URL metody: https://payments.comgate.cz/v1.0/csvDownload

Parametry volání
parametr typ povinný popis
merchant string A identifikátor e-shopu v systému ComGate
secret string A heslo pro komunikaci na pozadí
date string A povinný pouze za jeden den

Příklad stahování csv pro převody v rámci dne – HTTP request

POST /v1.0/csvDownload HTTP/1.1

Host: payments.comgate.cz

Content-Type: application/x-www-form-urlencoded; charset=utf-8

merchant=135258&secret=wi9VplRz0UNqoxFqSM4udyxyA1ia5z32&date:2019-07-25

Příklad stahování csv pro převody v rámci dne – HTTP response

HTTP/1.1 200 OK

Content-Type: application/zip
Content-Disposition: attachment; filename="vypis-csv-2019-07-25.zip"
Content-Length: delka souboru

CSV soubor nebo ZIP soubor obsahující CSV k převodům za den v parametru ke stazeni jako response

aboDownload = stažení ABO pro převody v rámci dne

Přímé stažení CSV souborů pro konkrétní den metodou aboDowload. Lze stáhnout buď 1 ABO, nebo více ABO v ZIP

Lze využít např. pro volání pomocí wget.
URL metody: https://payments.comgate.cz/v1.0/aboDownload

Parametry volání
parametr typ povinný popis
merchant string A identifikátor e-shopu v systému ComGate
secret string A heslo pro komunikaci na pozadí
date string A povinný pouze za jeden den
type string N parametr "type" může nabývat hodnot "v1" a "v2". Pod "v1" získáíte ABO verzi s poplatky uvedenými zvlášť ke každé platbě, pod "v2" pak ABO s poplatek souhrným v jednom řádku. Pokud nebude parametr vyplněn, automaticky obdržíte typ "v1". Rozdíl mezi jednolivými typy najdete na https://www.comgate.cz/cz/soubory-s-vypisy-transakci.

Příklad stahování ABO pro převody v rámci dne – HTTP request

POST /v1.0/aboDownload HTTP/1.1

Host: payments.comgate.cz

Content-Type: application/x-www-form-urlencoded; charset=utf-8

 

merchant=135258&secret=wi9VplRz0UNqoxFqSM4udyxyA1ia5z32&date:2019-07-25&type=v1

Příklad stahování ABO pro převody v rámci dne – HTTP response

HTTP/1.1 200 OK

Content-Type: application/zip
Content-Disposition: attachment; filename="vypis-csv-2019-07-25.zip"
Content-Length: delka souboru
ABO soubor nebo ZIP soubor obsahující ABO k převodům za den v parametru ke stazeni jako response