GP webpay: Správa objednávek, Web Services červenec 2013
OBSAH: ÚVOD... 3 ON-LINE ADMINISTRACE PROSTŘEDNICTVÍM WEB SERVICES... 3 DRUHY PODPOROVANÝCH POŽADAVKŮ... 4 Approve Reversal... 6 Deposit... 9 Deposit Reversal... 13 Credit... 16 Credit Reversal... 20 Order Close... 23 Delete... 26 Query Order State... 29 Batch Close... 33 PŘÍLOHA 1 PODEPISOVÁNÍ ZPRÁV... 38 Podepisování požadavku... 38 Podepisování odpovědi... 39 Výpočet elektronického podpisu... 39 Ověření elektronického podpisu... 39 Grafické znázornění generování a ověření... 40 Použité klíče... 41 Formáty předávaných klíčů... 41 Logování... 42 Reference... 42 PŘÍLOHA 2 SEZNAM NÁVRATOVÝCH KÓDŮ... 44 PŘÍLOHA 3 STAV OBJEDNÁVKY... 47 Global Payments Europe, s.r.o. Global Payments Europe, s.r.o., V Olšinách 80/626, 100 00 Praha 10 - Strašnice 2
Úvod Dokument informuje o možnosti integrace on-line komunikace elektronického obchodu obchodníka a systému GP webpay prostřednictvím Web Services. Dokument dále obsahuje podrobný popis on-line rozhraní Web Services. Aplikace GP webpay (dále jen GP webpay) je internetová platební brána, která umožňuje elektronickým obchodům (dále jen e-shop) přijímat platby, uskutečněné platebními kartami asociací VISA, MasterCard a Diners Club, v prostředí sítě Internet. GP webpay plně podporuje standard 3-D Secure a poskytuje možnost integrovat funkčnost standardního webového rozhraní formou Web Services Komunikace s GP webpay je zajištěna: on-line formou zaslání administrativního požadavku do GP webpay. Následuje zpracování přijatého požadavku a zaslání výsledku zpracování požadavku. Detailní popis je součástí tohoto dokumentu; on-line formou zaslání požadavku na vytvoření objednávky do GP webpay. Následuje zpracování přijatého požadavku a zaslání výsledku zpracování požadavku. Detailní popis je součástí dokumentu GP webpay Seznámení se systémem, vytváření objednávek; prostřednictvím standardně dodávaného webového rozhraní aplikace. Detailní popis administrace GP webpay je součástí dokumentu GP webpay - Administrace. ON-LINE ADMINISTRACE PROSTŘEDNICTVÍM WEB SERVICES Standardní administrace GP webpay je přístupná prostřednictvím standardně dodávaného grafického webového rozhraní na adrese, která bude uvedena ve smlouvě. Kromě tohoto rozhraní je k dispozici možnost zasílat požadavky podle standardu Web Services definovaného organizací W3C (více na adrese www.w3.org). Vzhledem k tomu, že aplikace GP webpay administrativní požadavky podporuje, je možné integrovat kompletní funkčnost standardně poskytovaného webového administrativního rozhraní do systémů obchodníka. Zasílaný požadavek (HTTPS request) pro administraci musí splňovat následující podmínky: Web Services standard definovaný organizací W3C; komunikace s GP webpay probíhá dle definice W3C Web Services. Popis standardu Web Services, včetně komunikace prostřednictvím Web Services, není součástí dokumentu více informací na adrese www.w3.org. Příklady uvedené v tomto dokumentu jsou pouze demonstrativní, nelze pouze vyměnit hodnoty a zasílat takto požadavky na server. Vzhledem k použité technologii (WS) výsledný požadavek připraví WS framework na pozadí a odešle jej ke zpracování. Stejně jak přijme odpověď a předá ji aplikaci na straně klienta. Neexistuje záruka, že odpovědi budou mít stejnou strukturu jako v uvedených příkladech. 3
Druhy podporovaných požadavků GP webpay definuje následující množinu požadavků, jejichž zpracování je přímo závislé na předchozím stavu objednávky/dávky. Dle výsledku zpracování požadavku se změní stav objednávky/dávky. Detailní popis stavů objednávek/dávek je součástí dokumentu GP webpay Seznámení se systémem, vytváření objednávek. PODPOROVANÉ OPERACE S OBJEDNÁVKAMI Požadavek Význam Popis Předchozí možné stavy approvereversal Zneplatnění autorizace objednávky Požadavek na zneplatnění autorizace objednávky. Platí pouze pro úspěšně autorizované objednávky. Autorizována APPROVED Výsledné možné stavy Reverzována REVERSED deposit Úhrada objednávky Požadavek na úhradu (zaúčtování) objednávky. Označí objednávku pro následné zpracování, po kterém bude zaslán požadavek na zaúčtování finanční transakce zúčtovací bance. Vlastní zaúčtování je v kompetenci zúčtující banky. Platí pouze pro úspěšně autorizované objednávky. Autorizována APPROVED Uhrazena DEPOSITED depositreversal Zneplatnění úhrady objednávky Požadavek na zneplatnění úhrady objednávky. Platí pouze pro uhrazené objednávky, které ještě nebyly zpracovány nedojde k převodu finančních prostředků od držitele karty k obchodníkovi Uhrazena DEPOSITED Autorizována APPROVED credit Návrat objednávky Požadavek na návrat úhrady objednávek, které již byly zpracovány. Zpracována PROCESSED Kreditována CREDITED Označí objednávku pro následné zpracování, po kterém budou finanční prostředky převedeny od obchodníka zpět k držiteli karty. Kreditována CREDITED 4
Požadavek Význam Popis Předchozí možné stavy creditreversal Zneplatnění návratu objednávky Požadavek na zrušení, zneplatnění úhrady objednávky. Platí pouze pro zneplatněné objednávky, které ještě nebyly zpracovány nedojde k zpětnému převodu finančních prostředků od obchodníka k držiteli karty. Kreditována CREDITED Dávka s kreditem musí být otevřená Výsledné možné stavy Uhrazena DEPOSITED (v případě, že další platné kredity neexistují) Kreditována CREDITED orderclose Uzavření objednávky Požadavek na uzavření objednávky. Uhrazena DEPOSITED Uzavřena CLOSED Zpracována PROCESSED Kreditována CREDITED delete Odstranění objednávky Požadavek na odstranění objednávky. Zamítnuta DECLINED Vymazána DELETED Reverzována REVERSED Uzavřena CLOSED queryorderstate Stav objednávky Požadavek na zjištění aktuálního stavu objednávky na dotaz se vrátí aktuální stav dané objednávky. libovolný PODPOROVANÉ OPERACE S DÁVKAMI Požadavek Význam Popis Předchozí možné stavy batchclose Uzavření dávky objednávek Požadavek na uzavření dávky obsahující objednávky, označené pro další zpracování. Není nezbytně nutné zasílat tento požadavek. Uzavírání dávek probíhá automaticky před každým zpracování dávek. Výsledné možné stavy 5
Approve Reversal POPIS ZPRACOVÁNÍ POŽADAVKU Akce Approve Reversal Req Auth Reversal Req Auth Reversal Res Approve Reversal Res Popis GP webpay obdrží požadavek na zneplatnění autorizace dané objednávky. GP webpay vytvoří požadavek na zneplatnění autorizace finanční transakce, který předá do autorizačního centra. Požadavek je předán prostřednictvím finančních sítí vydavateli karty, který zneplatní autorizaci dané finanční transakce. GP webpay obdrží odpověď na autorizační požadavek. GP webpay zašle výsledek autorizace objednávky. PRŮBĚH ZPRACOVÁNÍ POŽADAVKU Nutné podmínky: Objednávka byla úspěšně autorizována je ve stavu: APPROVED Zpracování: GP webpay zkontroluje platnost zadaných údajů: vyhledá požadovaného obchodníka; vyhledá požadovanou objednávku; zkontroluje platnost zadané operace zda stav objednávky povoluje požadovanou operaci; zkontroluje podpis požadavku; zkontroluje platnost obsahu (délka, typ, hodnota) všech prvků. Výsledek: GP webpay vytvoří požadavek na zneplatnění autorizace a ten předá ke zpracování do autorizačního centra. Podle výsledku zneplatnění autorizace může být objednávka ve stavu: APPROVE_REVERSED autorizace objednávky byla úspěšně zneplatněna; APPROVED objednávka zůstává úspěšně autorizována autorizaci nebylo možné zneplatnit. 6
Chybové stavy: požadavek nelze zpracovat obchodník nenalezen; požadavek nelze zpracovat objednávka nenalezena; požadavek nelze zpracovat neplatná operace; požadavek nelze zpracovat chybný podpis dat; požadavek nelze zpracovat prvek XXX neobsahuje požadovaný typ; požadavek nelze zpracovat prvek XXX neobsahuje požadovanou délku; požadavek nelze zpracovat prvek XXX neobsahuje požadovanou hodnotu; neúspěšné zneplatnění autorizace objednávky z důvodu XXX; požadavek nelze zpracovat technické problémy. FORMÁT POŽADAVKU: Request approvereversal Vstupní parametr Typ Délka Povinný Poznámka merchantnumber znakový 10 ano Přidělené číslo obchodníka. ordernumber znakový 15 ano Číslo objednávky, pro kterou je požadováno zneplatnění autorizace. digest znakový ano Kontrolní podpis všech výše uvedených polí, zřetězených se sdílenou tajnou informací za využití hash funkce SHA1. Popis algoritmu výpočtu pole DIGEST viz Příloha 1 Podepisování zpráv FORMÁT ZASLANÉ ODPOVĚDI: Response OrderResponse Atribut Typ Délka Povinný Poznámka ordernumber znakový 15 ano Obsah pole z požadavku. primaryreturncode numerický ano Obsahuje primární kód, viz Příloha 2 Seznam návratových kódů secondaryreturncode numerický ano Obsahuje sekundární kód, viz Příloha 2 Seznam návratových kódů digest znakový ano Popis algoritmu výpočtu pole DIGEST viz Příloha 1 Podepisování zpráv 7
Příklad zaslaného požadavku a obdržené odpovědi: Požadavek: request: POST /webservices/services/pgw HTTP/1.0 Content-Type: text/xml; charset=utf-8 Accept: application/soap+xml, application/dime, multipart/related, text/* User-Agent: Axis/1.2.1 Host: pat Cache-Control: no-cache Pragma: no-cache SOAPAction: "" Content-Length: 923 <?xml version="1.0" encoding="utf-8"?> <soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/xmlschema" xmlns:xsi="http://www.w3.org/2001/xmlschema-instance"> <soapenv:body> <ns1:approvereversal xmlns:ns1="http://webservices.pgw.muzo.com"> <merchantnumber xsi:type="xsd:string">9999999021</merchantnumber> <ordernumber xsi:type="xsd:string">130501607469</ordernumber> <digest xsi:type="xsd:string">erx+jxh7oywzba3l+xka6ylqhhxrnovsqnuqewr+qjrv9fm45dz8b938zkfmyskme /4KuIoxyTf7Yli70113iOjnrgitS8rmTEKX3Aj59Y5v28ZzpfStRnyZ5Mznv0bR4HgieVx8aHwC+Jn1R2XuS4Gd QbyyYcBhbrlu10vSDAwurH58gpuaUbkpY7mp7ahBf2HASJxnJ4S2/2aRH3VKE4lSDAp31ClK1DNX9SPBYm+CdAt NckCQfkoF/EYJBShR+Gt5KwR8EQGV2EkYP/ZZ3KQYenP2peWsG8gUky+Y8gZ5vDdhu6/2H6a/gQkTpV7KfWRjm8 +IOucgjETeZ1w8Zg==</digest> </ns1:approvereversal> </soapenv:body> </soapenv:envelope> Odpověď: HTTP/1.1 200 OK Date: Tue, 10 May 2011 08:37:32 GMT Server: Apache/2.2.10 (Win32) mod_ssl/2.2.10 OpenSSL/0.9.8i mod_auth_sspi/1.0.4 Connection: close Content-Type: text/xml; charset=utf-8 Content-Language: cs-cz <?xml version="1.0" encoding="utf-8"?> <soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/xmlschema" xmlns:xsi="http://www.w3.org/2001/xmlschema-instance"> <soapenv:body> <ns1:approvereversalresponse xmlns:ns1="http://webservices.pgw.muzo.com"> <approvereversalreturn href="#id0"/> </ns1:approvereversalresponse> <multiref id="id0" soapenc:root="0" xsi:type="ns2:orderresponse" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="http://request.pgw.muzo.com"> <digest xsi:type="soapenc:string">xm15nykdw5rpjfbantcp/5kfk3d7pfcrq+plgkq53ja2zuha88og+jqbunihq XdprkhYMb+pa1kY27u/OxPEgIP5zfkPmZyTWvXP4aSX0wwVCdqk/RZkO8jK0obFvFS2/HoB5CgWpdV8gktyVLcW Irm8Ja+4EBHfZdN1Olxe7nQvCvvqYRUnxkhsg8tFy0xNGTqOTPGYfCKW1W6aUsGnrxPruplQrpsoJJ411qLzOet AaMDpDt24l+W0eqvs5gp7m9j5zdnPjn7yo/Kaf9KrRBPrp09yic9VXHR00lZmo+UeufsD0l2Atf1BwZ49x5W9d5 WIJZdsOT/xxliE5NB2vA==</digest> <ok href="#id1"/> <ordernumber xsi:type="soapenc:string">130501607469</ordernumber> <primaryreturncode href="#id2"/> 8
<secondaryreturncode href="#id3"/> <requestid href="#id4"/> </multiref> <multiref id="id3" soapenc:root="0" xsi:type="xsd:int" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">0</multiref> <multiref id="id2" soapenc:root="0" xsi:type="xsd:int" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">0</multiref> <multiref id="id4" soapenc:root="0" xsi:type="xsd:long" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">1158006558211766605</multiref > <multiref id="id1" soapenc:root="0" xsi:type="xsd:boolean" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">true</multiref> </soapenv:body> </soapenv:envelope> Deposit POPIS ZPRACOVÁNÍ POŽADAVKU Akce Deposit Req Deposit Res Processing Capture Req Capture Res Capture Amount + Captured Amount Popis GP webpay obdrží požadavek na úhradu dané objednávky. GP webpay označí danou objednávku pro zpracování a zašle výsledek zaúčtování objednávky. GP webpay zpracuje všechny objednávky určené ke zpracování. GP webpay vytvoří požadavek na zaúčtování objednávky. Požadavek je předán prostřednictvím mezibankovních sítí vydavateli karty, který provede zaúčtování. Bance daného obchodníka je potvrzeno zaúčtování objednávky. Na účet obchodníka je připsána zaúčtovaná částka. Z účtu držitele karty je odepsána zaúčtovaná částka. 9
PRŮBĚH ZPRACOVÁNÍ POŽADAVKU Nutné podmínky: Objednávka byla úspěšně autorizována je ve stavu: APPROVED Zpracování: GP webpay zkontroluje platnost zadaných údajů: vyhledá požadovaného obchodníka; vyhledá požadovanou objednávku; zkontroluje platnost zadané operace zda stav objednávky povoluje požadovanou operaci; zkontroluje požadovanou částku zda je rovna (nebo menší) než původně autorizovaná částka; zkontroluje podpis požadavku; zkontroluje platnost obsahu (délka, typ, hodnota) všech prvků. Výsledek: GP webpay vytvoří požadavek na zaúčtování objednávky. Stav objednávky se změní na: DEPOSITED BATCH OPEN Chybové stavy: požadavek nelze zpracovat obchodník nenalezen; požadavek nelze zpracovat objednávka nenalezena; požadavek nelze zpracovat neplatná operace; požadavek nelze zpracovat chybný podpis dat; požadavek nelze zpracovat prvek XXX neobsahuje požadovaný typ; požadavek nelze zpracovat prvek XXX neobsahuje požadovanou délku; požadavek nelze zpracovat prvek XXX neobsahuje požadovanou hodnotu; neúspěšné zaúčtování objednávky z důvodu XXX; požadavek nelze zpracovat technické problémy. Formát požadavku Request deposit Vstupní parametr Typ Délka Povinný Poznámka merchantnumber znakový 10 ano Přidělené číslo obchodníka. ordernumber znakový 15 ano Číslo objednávky, pro kterou je požadováno zaúčtování. amount numerický 15 ano Částka v nejmenších jednotkách dané měny. digest znakový ano Kontrolní podpis všech výše uvedených polí, zřetězených se sdílenou tajnou informací za využití hash funkce SHA1. Popis algoritmu výpočtu pole DIGEST viz Příloha 1 Podepisování zpráv 10
Formát zaslané odpovědi Response OrderResponse Atribut Typ Délka Povinný Poznámka ordernumber znakový 15 ano Obsahuje ordernumber z požadavku. primaryreturncode numerický ano Obsahuje primární kód, viz Příloha 2 Seznam návratových kódů secondaryreturncode numerický ano Obsahuje sekundární kód, viz Příloha 2 Seznam návratových kódů digest znakový ano Popis algoritmu výpočtu pole DIGEST viz Příloha 1 Podepisování zpráv 11
Příklad zaslaného požadavku a obdržené odpovědi Požadavek: POST /webservices/services/pgw HTTP/1.0 Content-Type: text/xml; charset=utf-8 Accept: application/soap+xml, application/dime, multipart/related, text/* User-Agent: Axis/1.2.1 Host: pat Cache-Control: no-cache Pragma: no-cache SOAPAction: "" Content-Length: 947 <?xml version="1.0" encoding="utf-8"?> <soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/xmlschema" xmlns:xsi="http://www.w3.org/2001/xmlschema-instance"> <soapenv:body> <ns1:deposit xmlns:ns1="http://webservices.pgw.muzo.com"> <merchantnumber xsi:type="xsd:string">9999999021</merchantnumber> <ordernumber xsi:type="xsd:string">130501656703</ordernumber> <amount xsi:type="xsd:long">100</amount> <digest xsi:type="xsd:string">armus+rjlluuivgznvo3qqpl9iyepczdjvkdele/kfibeor2dp8bfoz5f8ar3n8tg Z7X4oNua1iiIjQ3oJJuwKXhgn64ivd4RMzWsDaXmvI/Iq+tCkG1+GKWGpvCxz5ZO+DnNwSM89erYOIihawkr78O Iv8rCm8IihIv2CKz0fdavO6sjs2jfyBf0++Nek+DUzfWyDGUyZ5JNsKT25iCdMve5SKgq6HQuReTcmzpOqz6w2/ ny6q/+oulcxqtvsnydk9wao5meioy1gkvyha2mz83otoykjln0bfgusm7kkgifcdq5p+lqvda0uomvqv/ac602b P10jvyv0aWly3yOA==</digest> </ns1:deposit> </soapenv:body> </soapenv:envelope> Odpověď: HTTP/1.1 200 OK Date: Tue, 10 May 2011 08:41:29 GMT Server: Apache/2.2.10 (Win32) mod_ssl/2.2.10 OpenSSL/0.9.8i mod_auth_sspi/1.0.4 Connection: close Content-Type: text/xml; charset=utf-8 Content-Language: cs-cz <?xml version="1.0" encoding="utf-8"?> <soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/xmlschema" xmlns:xsi="http://www.w3.org/2001/xmlschema-instance"> <soapenv:body> <ns1:depositresponse xmlns:ns1="http://webservices.pgw.muzo.com"> <depositreturn href="#id0"/> </ns1:depositresponse> <multiref id="id0" soapenc:root="0" xsi:type="ns2:orderresponse" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="http://request.pgw.muzo.com"> <digest xsi:type="soapenc:string">tezqcyri1yigu0cqaebyr7h9hxtcqkk+3f6tlw58bagewjmyjgyhtca/u27fx 4AHDc0W0fZxA9C8D8byMtm1Hd4WyJcpq4Sivcrtb9gwLJT6Js74IAWRIwsVctC6XbZP4g29A5JfwSa+WspOEnuF uojfv9qiemg6qkwxgm/id2rgqas5srhtvrtkntbepasxftp87kaqjex7iqlbw7d9s+vmkgsdhjfyporz4wfcwjn NHRAb4Nw4rEPmfDkYIJaOWNjQvL3f23B6Jazusdum1UTicYVavRs1qumX4CGBVAzhYN/WibY5K9ThT/cHC+GvkH 3A+Z54x4IiawHs0zogtQ==</digest> <ok href="#id1"/> <ordernumber xsi:type="soapenc:string">130501656703</ordernumber> <primaryreturncode href="#id2"/> <secondaryreturncode href="#id3"/> <requestid href="#id4"/> </multiref> 12
<multiref id="id4" soapenc:root="0" xsi:type="xsd:long" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">1158006682765818425</multiref > <multiref id="id1" soapenc:root="0" xsi:type="xsd:boolean" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">true</multiref> <multiref id="id3" soapenc:root="0" xsi:type="xsd:int" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">0</multiref> <multiref id="id2" soapenc:root="0" xsi:type="xsd:int" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">0</multiref> </soapenv:body> </soapenv:envelope> Deposit Reversal POPIS ZPRACOVÁNÍ POŽADAVKU Akce Deposit Reversal Req Deposit Reversal Res Popis GP webpay obdrží požadavek na zneplatnění úhrady dané objednávky. GP webpay zneplatní úhradu dané objednávky a zašle výsledek zneplatnění úhrady objednávky. PRŮBĚH ZPRACOVÁNÍ POŽADAVKU Nutné podmínky: Objednávka byla předána k zaúčtování, ale zaúčtování ještě neproběhlo, objednávka je ve stavu DEPOSITED BATCH OPEN Zpracování: GP webpay zkontroluje platnost zadaných údajů: vyhledá požadovaného obchodníka; vyhledá požadovanou objednávku; zkontroluje platnost zadané operace zda stav objednávky povoluje požadovanou operaci; zkontroluje požadovanou částku zda je rovna (nebo menší) než původně autorizovaná částka; zkontroluje podpis požadavku; zkontroluje platnost obsahu (délka, typ, hodnota) všech prvků. 13
Výsledek: GP webpay vytvoří požadavek na zaúčtování objednávky. Stav objednávky se změní na: DEPOSITED BATCH OPEN Chybové stavy: požadavek nelze zpracovat obchodník nenalezen; požadavek nelze zpracovat objednávka nenalezena; požadavek nelze zpracovat neplatná operace; požadavek nelze zpracovat chybný podpis dat; požadavek nelze zpracovat prvek XXX neobsahuje požadovaný typ; požadavek nelze zpracovat prvek XXX neobsahuje požadovanou délku; požadavek nelze zpracovat prvek XXX neobsahuje požadovanou hodnotu; neúspěšné zneplatnění zaúčtování objednávky z důvodu XXX; požadavek nelze zpracovat technické problémy. Formát požadavku Request depositreversal Vstupní parametr Typ Délka Povinný Poznámka merchantnumber znakový 10 ano Přidělené číslo obchodníka. ordernumber znakový 15 ano Číslo objednávky, pro kterou je požadováno zneplatnění zaúčtování. digest znakový ano Kontrolní podpis všech výše uvedených polí, zřetězených se sdílenou tajnou informací za využití hash funkce SHA1. Popis algoritmu výpočtu pole DIGEST viz Příloha 1 Podepisování zpráv Formát zaslané odpovědi Response OrderResponse Atribut Typ Délka Povinný Poznámka ordernumber znakový 15 ano Obsahuje ordernumber z požadavku. primaryreturncode numerický ano Obsahuje primární kód, viz Příloha 2 Seznam návratových kódů secondaryreturncode numerický ano Obsahuje sekundární kód, viz Příloha 2 Seznam návratových kódů digest znakový ano Popis algoritmu výpočtu pole DIGEST viz Příloha 1 Podepisování zpráv 14
Příklad zaslaného požadavku a obdržené odpovědi Požadavek: POST /webservices/services/pgw HTTP/1.0 Content-Type: text/xml; charset=utf-8 Accept: application/soap+xml, application/dime, multipart/related, text/* User-Agent: Axis/1.2.1 Host: pat Cache-Control: no-cache Pragma: no-cache SOAPAction: "" Content-Length: 923 <?xml version="1.0" encoding="utf-8"?> <soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/xmlschema" xmlns:xsi="http://www.w3.org/2001/xmlschema-instance"> <soapenv:body> <ns1:depositreversal xmlns:ns1="http://webservices.pgw.muzo.com"> <merchantnumber xsi:type="xsd:string">9999999021</merchantnumber> <ordernumber xsi:type="xsd:string">130501656703</ordernumber> <digest xsi:type="xsd:string">cmcniyifpkgeio1jsyqx9waf6jjf5f65sjpq85rzcuyvs7l2le6rx2ptvkgcqcmri K6L78H+MxVV5Ujz3ZZAgWPCUd04xbVvyOQ1PLmlXqNb9d0PeaiPtmRteCCLNxt+utrGAEcGyLlajCCF4JVN9Woq vqrpgpx/kfxbzpt7dnbezqk8tll4c/qkwrubghjmyh7+hs8iubo8rflj+fk4pt0rodez84+8txr4wywy/6gliid qwjiy1h/5bjifubjd/lvzhad7syjghtwham1izxaptc0k7zit2qapg0vpcvkd0flydqabo18mtuwppkktl7lgco uppr9wkvnxxqxjrg==</digest> </ns1:depositreversal> </soapenv:body> </soapenv:envelope> Odpověď: HTTP/1.1 200 OK Date: Tue, 10 May 2011 08:43:20 GMT Server: Apache/2.2.10 (Win32) mod_ssl/2.2.10 OpenSSL/0.9.8i mod_auth_sspi/1.0.4 Connection: close Content-Type: text/xml; charset=utf-8 Content-Language: cs-cz <?xml version="1.0" encoding="utf-8"?> <soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/xmlschema" xmlns:xsi="http://www.w3.org/2001/xmlschema-instance"> <soapenv:body> <ns1:depositreversalresponse xmlns:ns1="http://webservices.pgw.muzo.com"> <depositreversalreturn href="#id0"/> </ns1:depositreversalresponse> <multiref id="id0" soapenc:root="0" xsi:type="ns2:orderresponse" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="http://request.pgw.muzo.com"> <digest xsi:type="soapenc:string">tezqcyri1yigu0cqaebyr7h9hxtcqkk+3f6tlw58bagewjmyjgyhtca/u27fx 4AHDc0W0fZxA9C8D8byMtm1Hd4WyJcpq4Sivcrtb9gwLJT6Js74IAWRIwsVctC6XbZP4g29A5JfwSa+WspOEnuF uojfv9qiemg6qkwxgm/id2rgqas5srhtvrtkntbepasxftp87kaqjex7iqlbw7d9s+vmkgsdhjfyporz4wfcwjn NHRAb4Nw4rEPmfDkYIJaOWNjQvL3f23B6Jazusdum1UTicYVavRs1qumX4CGBVAzhYN/WibY5K9ThT/cHC+GvkH 3A+Z54x4IiawHs0zogtQ==</digest> <ok href="#id1"/> <ordernumber xsi:type="soapenc:string">130501656703</ordernumber> <primaryreturncode href="#id2"/> <secondaryreturncode href="#id3"/> <requestid href="#id4"/> </multiref> <multiref id="id4" soapenc:root="0" 15
xsi:type="xsd:long" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">1158006803024902824</multiref > <multiref id="id1" soapenc:root="0" xsi:type="xsd:boolean" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">true</multiref> <multiref id="id3" soapenc:root="0" xsi:type="xsd:int" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">0</multiref> <multiref id="id2" soapenc:root="0" xsi:type="xsd:int" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">0</multiref> </soapenv:body> </soapenv:envelope> Credit POPIS ZPRACOVÁNÍ POŽADAVKU Akce Credit Req Credit Res Processing Capture Req Capture Res Capture Amount Captured Amount + Popis GP webpay obdrží požadavek na návrat již uhrazené objednávky. GP webpay označí danou objednávku pro zpracování a zašle výsledek návratu uhrazené objednávky. GP webpay zpracuje všechny objednávky určené ke zpracování. GP webpay vytvoří požadavek na návrat již zaúčtované objednávky. Požadavek je předán prostřednictvím mezibankovních sítí vydavateli karty, který provede návrat zaúčtování. Bance daného obchodníka je potvrzen návrat zaúčtování objednávky. Z účtu obchodníka je odepsána zaúčtovaná částka. Na účet držitele karty je připsána zaúčtovaná částka. PRŮBĚH ZPRACOVÁNÍ POŽADAVKU Nutné podmínky: Objednávka již byla zaúčtována je ve stavu: 16
DEPOSITED BATCH CLOSED CREDITED BATCH OPEN CREDITED BATCH CLOSED Zpracování: GP webpay zkontroluje platnost zadaných údajů: vyhledá požadovaného obchodníka; vyhledá požadovanou objednávku; zkontroluje platnost operace zda stav objednávky povoluje požadovanou operaci; zkontroluje požadovanou částku zda je rovna (nebo menší) než zaúčtovaná částka; zkontroluje podpis požadavku; zkontroluje platnost obsahu (délka, typ, hodnota) všech prvků. Výsledek: GP webpay vytvoří požadavek na návrat zaúčtování objednávky. Stav objednávky se změní na: CREDITED BATCH OPEN Chybové stavy: požadavek nelze zpracovat obchodník nenalezen; požadavek nelze zpracovat objednávka nenalezena; požadavek nelze zpracovat neplatná částka; požadavek nelze zpracovat neplatná operace; požadavek nelze zpracovat chybný podpis dat; požadavek nelze zpracovat prvek XXX neobsahuje požadovaný typ; požadavek nelze zpracovat prvek XXX neobsahuje požadovanou délku; požadavek nelze zpracovat prvek XXX neobsahuje požadovanou hodnotu; neúspěšný návrat objednávky z důvodu XXX; požadavek nelze zpracovat technické problémy. Formát požadavku Request credit Vstupní parametr Typ Délka Povinný Poznámka merchantnumber znakový 10 ano Přidělené číslo obchodníka. ordernumber znakový 15 ano Číslo objednávky, pro kterou je požadován návrat finančních prostředků. amount numerický 15 ano Částka v nejmenších jednotkách dané měny. digest znakový ano Kontrolní podpis všech výše uvedených polí, zřetězených se sdílenou tajnou informací za využití hash funkce SHA1. Popis algoritmu výpočtu pole DIGEST viz Příloha 1 Podepisování zpráv Formát odpovědi Response OrderResponse Atribut Typ Délka Povinný Poznámka 17
ordernumber znakový 15 ano Obsahuje ordernumber z požadavku. primaryreturncode numerický ano Obsahuje primární kód, viz Příloha 2 Seznam návratových kódů secondaryreturncode numerický ano Obsahuje sekundární kód, viz Příloha 2 Seznam návratových kódů digest znakový ano Popis algoritmu výpočtu pole DIGEST viz Příloha 1 Podepisování zpráv 18
Příklad zaslaného požadavku a obdržené odpovědi Požadavek: POST /webservices/services/pgw HTTP/1.0 Content-Type: text/xml; charset=utf-8 Accept: application/soap+xml, application/dime, multipart/related, text/* User-Agent: Axis/1.2.1 Host: pat Cache-Control: no-cache Pragma: no-cache SOAPAction: "" Content-Length: 944 <?xml version="1.0" encoding="utf-8"?> <soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/xmlschema" xmlns:xsi="http://www.w3.org/2001/xmlschema-instance"> <soapenv:body> <ns1:credit xmlns:ns1="http://webservices.pgw.muzo.com"> <merchantnumber xsi:type="xsd:string">9999999021</merchantnumber> <ordernumber xsi:type="xsd:string">130501656703</ordernumber> <amount xsi:type="xsd:long">50</amount> <digest xsi:type="xsd:string">bwoh7/0agm0xwnqztkcp2jjqsxahoxyxrsmfkxda1oztqhj8enmhz30f2+dq0t7zk mfpurl5n8wms4tjbvjrzrr89j+bkh8llon+jrozdspmseo076w8zrx8spb8v8bzcuqw4gzjwwbjinlzi3kdsgn+ yruamr0ckf+n9e1wekrjqeua6mtylnzdpa/tyoriicrcik5bl8rwm7wn8rgmogmodvs1tkpphfn5b8fz8s2cbck obkyu9gn+ai56oecyspxkli9a4tbhrbjumsycyksmgb39ubhkdwayxf2lr7zpthtevnsqy8e+6dty+ugxyhc0vb RDoXKofzUyxsDh8Q==</digest> </ns1:credit> </soapenv:body> </soapenv:envelope> Odpověď: HTTP/1.1 200 OK Date: Tue, 10 May 2011 08:48:32 GMT Server: Apache/2.2.10 (Win32) mod_ssl/2.2.10 OpenSSL/0.9.8i mod_auth_sspi/1.0.4 Connection: close Content-Type: text/xml; charset=utf-8 Content-Language: cs-cz <?xml version="1.0" encoding="utf-8"?> <soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/xmlschema" xmlns:xsi="http://www.w3.org/2001/xmlschema-instance"> <soapenv:body> <ns1:creditresponse xmlns:ns1="http://webservices.pgw.muzo.com"> <creditreturn href="#id0"/> </ns1:creditresponse> <multiref id="id0" soapenc:root="0" xsi:type="ns2:orderresponse" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="http://request.pgw.muzo.com"> <digest xsi:type="soapenc:string">tezqcyri1yigu0cqaebyr7h9hxtcqkk+3f6tlw58bagewjmyjgyhtca/u27fx 4AHDc0W0fZxA9C8D8byMtm1Hd4WyJcpq4Sivcrtb9gwLJT6Js74IAWRIwsVctC6XbZP4g29A5JfwSa+WspOEnuF uojfv9qiemg6qkwxgm/id2rgqas5srhtvrtkntbepasxftp87kaqjex7iqlbw7d9s+vmkgsdhjfyporz4wfcwjn NHRAb4Nw4rEPmfDkYIJaOWNjQvL3f23B6Jazusdum1UTicYVavRs1qumX4CGBVAzhYN/WibY5K9ThT/cHC+GvkH 3A+Z54x4IiawHs0zogtQ==</digest> <ok href="#id1"/> <ordernumber xsi:type="soapenc:string">130501656703</ordernumber> <primaryreturncode href="#id2"/> <secondaryreturncode href="#id3"/> <requestid href="#id4"/> 19
</multiref> <multiref id="id3" soapenc:root="0" xsi:type="xsd:int" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">0</multiref> <multiref id="id2" soapenc:root="0" xsi:type="xsd:int" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">0</multiref> <multiref id="id4" soapenc:root="0" xsi:type="xsd:long" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">1158007138032352225</multiref > <multiref id="id1" soapenc:root="0" xsi:type="xsd:boolean" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">true</multiref> </soapenv:body> </soapenv:envelope> Credit Reversal POPIS ZPRACOVÁNÍ POŽADAVKU Akce Credit Reversal Req Credit Reversal Res Popis GP webpay obdrží požadavek na zneplatnění návratu již zaúčtované objednávky. GP webpay zneplatní zaúčtování dané objednávky a zašle výsledek zneplatnění návratu již zaúčtované objednávky. PRŮBĚH ZPRACOVÁNÍ POŽADAVKU Nutné podmínky: Návrat objednávky byl předán k zaúčtování, ale zaúčtování ještě neproběhlo; objednávka je ve stavu: CREDITED BATCH OPEN Zpracování: GP webpay zkontroluje platnost zadaných údajů: vyhledá požadovaného obchodníka; vyhledá požadovanou objednávku; zkontroluje platnost zadané operace zda stav objednávky povoluje požadovanou operaci; zkontroluje podpis požadavku; zkontroluje platnost obsahu (délka, typ, hodnota) všech prvků. Výsledek: GP webpay vytvoří požadavek na zaúčtování objednávky. Stav objednávky se změní na: 20
DEPOSITED BATCH CLOSED CREDITED BATCH CLOSED Chybové stavy požadavek nelze zpracovat obchodník nenalezen; požadavek nelze zpracovat objednávka nenalezena; požadavek nelze zpracovat chybný podpis dat; požadavek nelze zpracovat prvek XXX neobsahuje požadovaný typ; požadavek nelze zpracovat prvek XXX neobsahuje požadovanou délku; požadavek nelze zpracovat prvek XXX neobsahuje požadovanou hodnotu; neúspěšné zneplatnění návratu objednávky z důvodu XXX; požadavek nelze zpracovat technické problémy. Formát požadavku Request creditreversal Vstupní parametr Typ Délka Povinný Poznámka merchantnumber znakový 10 ano Přidělené číslo obchodníka. ordernumber znakový 15 ano Číslo objednávky, pro kterou je požadováno zneplatnění návratu finančních prostředků. creditnumber numerický ano Unikátní identifikátor zneplatnění návratu v rámci dané objednávky. Z důvodu možnosti provedení několika návratů v rámci jedné objednávky je nezbytně nutné identifikovat, pro který návrat je zneplatnění požadováno. digest znakový ano Kontrolní podpis všech výše uvedených polí, zřetězených se sdílenou tajnou informací za využití hash funkce SHA1. Popis algoritmu výpočtu pole DIGEST viz Příloha 1 Podepisování zpráv Formát odpovědi Response OrderResponse Atribut Typ Délka Povinný Poznámka ordernumber znakový 15 ano Obsahuje ordernumber z požadavku. primaryreturncode numerický ano Obsahuje primární kód, viz Příloha 2 Seznam návratových kódů secondaryreturncode numerický ano Obsahuje sekundární kód, viz Příloha 2 Seznam návratových kódů digest znakový ano Popis algoritmu výpočtu pole DIGEST viz Příloha 1 Podepisování zpráv 21
Příklad zaslaného požadavku a obdržené odpovědi Požadavek: POST /webservices/services/pgw HTTP/1.0 Content-Type: text/xml; charset=utf-8 Accept: application/soap+xml, application/dime, multipart/related, text/* User-Agent: Axis/1.2.1 Host: pat Cache-Control: no-cache Pragma: no-cache SOAPAction: "" Content-Length: 970 <?xml version="1.0" encoding="utf-8"?> <soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/xmlschema" xmlns:xsi="http://www.w3.org/2001/xmlschema-instance"> <soapenv:body> <ns1:creditreversal xmlns:ns1="http://webservices.pgw.muzo.com"> <merchantnumber xsi:type="xsd:string">9999999021</merchantnumber> <ordernumber xsi:type="xsd:string">130501656703</ordernumber> <creditnumber xsi:type="xsd:int">1</creditnumber> <digest xsi:type="xsd:string">ls/vzd+jcpi00wfj3d8bet3/i1opjsgkvaif9m6t5doxp5uzwxhjogwblys6qw5d+ ktedgoefmqbkvwzn3wrmpr2vol4mt/ro5aq1fxw/uowjatm7tdjjsrbyhcbcypfiinoglddhxj24q2mcll81bnc 7UmUQy1OFEdXPRhgYWyF1Plunq+vowbtHhdBdy+RW7L4EvbGdyZRrzrdEzOTVhsPepCb5hDhyhLlhBdOX4XO5oe UPctbg/Omz+qLG1RWRze6PFKoaAz/oKlxjO9kp6pYiS50ByKj8OHstxqkVsnmdI4q1oanvZasxEORHQ31mjIzGS XPe0/0nGUZJvZ1iA==</digest> </ns1:creditreversal> </soapenv:body> </soapenv:envelope> Odpověď: HTTP/1.1 200 OK Date: Tue, 10 May 2011 08:49:57 GMT Server: Apache/2.2.10 (Win32) mod_ssl/2.2.10 OpenSSL/0.9.8i mod_auth_sspi/1.0.4 Connection: close Content-Type: text/xml; charset=utf-8 Content-Language: cs-cz <?xml version="1.0" encoding="utf-8"?> <soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/xmlschema" xmlns:xsi="http://www.w3.org/2001/xmlschema-instance"> <soapenv:body> <ns1:creditreversalresponse xmlns:ns1="http://webservices.pgw.muzo.com"> <creditreversalreturn href="#id0"/> </ns1:creditreversalresponse> <multiref id="id0" soapenc:root="0" xsi:type="ns2:orderresponse" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="http://request.pgw.muzo.com"> <digest xsi:type="soapenc:string">tezqcyri1yigu0cqaebyr7h9hxtcqkk+3f6tlw58bagewjmyjgyhtca/u27fx 4AHDc0W0fZxA9C8D8byMtm1Hd4WyJcpq4Sivcrtb9gwLJT6Js74IAWRIwsVctC6XbZP4g29A5JfwSa+WspOEnuF uojfv9qiemg6qkwxgm/id2rgqas5srhtvrtkntbepasxftp87kaqjex7iqlbw7d9s+vmkgsdhjfyporz4wfcwjn NHRAb4Nw4rEPmfDkYIJaOWNjQvL3f23B6Jazusdum1UTicYVavRs1qumX4CGBVAzhYN/WibY5K9ThT/cHC+GvkH 3A+Z54x4IiawHs0zogtQ==</digest> <ok href="#id1"/> <ordernumber xsi:type="soapenc:string">130501656703</ordernumber> <primaryreturncode href="#id2"/> <secondaryreturncode href="#id3"/> <requestid href="#id4"/> 22
</multiref> <multiref id="id4" soapenc:root="0" xsi:type="xsd:long" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">1158007262586403893</multiref > <multiref id="id1" soapenc:root="0" xsi:type="xsd:boolean" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">true</multiref> <multiref id="id3" soapenc:root="0" xsi:type="xsd:int" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">0</multiref> <multiref id="id2" soapenc:root="0" xsi:type="xsd:int" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">0</multiref> </soapenv:body> </soapenv:envelope> Order Close POPIS ZPRACOVÁNÍ POŽADAVKU Akce Close Order Req Close Order Res Popis GP webpay obdrží požadavek uzavření objednávky. GP webpay uzavře danou objednávku a zašle výsledek uzavření objednávky. PRŮBĚH ZPRACOVÁNÍ POŽADAVKU Nutné podmínky: Objednávka je ve stavu: DEPOSITED BATCH OPEN DEPOSITED BATCH CLOSED CREDITED BATCH OPEN CREDITED BATCH CLOSED Zpracování: GP webpay kontroluje platnost zadaných údajů: vyhledá požadovaného obchodníka; vyhledá požadovanou objednávku; zkontroluje platnost zadané operace zda stav objednávky povoluje požadovanou operaci; zkontroluje podpis požadavku; zkontroluje platnost obsahu (délka, typ, hodnota) všech prvků. Výsledek: 23
GP webpay uzavře objednávku. Pro uzavřenou objednávkou není možné zpracovat požadavek na zaúčtování. Stav objednávky se změní na: ORDER CLOSED Chybové stavy: požadavek nelze zpracovat obchodník nenalezen; požadavek nelze zpracovat objednávka nenalezena; požadavek nelze zpracovat chybný podpis dat; požadavek nelze zpracovat prvek XXX neobsahuje požadovaný typ; požadavek nelze zpracovat prvek XXX neobsahuje požadovanou délku; požadavek nelze zpracovat prvek XXX neobsahuje požadovanou hodnotu; neúspěšné uzavření objednávky z důvodu XXX; požadavek nelze zpracovat technické problémy. Formát požadavku Request orderclose Vstupní parametr Typ Délka Povinný Poznámka merchantnumber znakový 10 ano Přidělené číslo obchodníka. ordernumber znakový 15 ano Číslo objednávky, pro kterou je požadováno uzavření. digest znakový ano Kontrolní podpis všech výše uvedených polí, zřetězených se sdílenou tajnou informací za využití hash funkce SHA1. Popis algoritmu výpočtu pole DIGEST viz Příloha 1 Podepisování zpráv Formát zaslané odpovědi Response OrderResponse Atribut Typ Délka Povinný Poznámka ordernumber znakový 15 ano Obsahuje ordernumber z požadavku primaryreturncode numerický ano Obsahuje primární kód, viz Příloha 2 Seznam návratových kódů secondaryreturncode numerický ano Obsahuje sekundární kód, viz Příloha 2 Seznam návratových kódů digest znakový ano Popis algoritmu výpočtu pole DIGEST viz Příloha 1 Podepisování zpráv 24
Příklad zaslaného požadavku a obdržené odpovědi Požadavek: POST /webservices/services/pgw HTTP/1.0 Content-Type: text/xml; charset=utf-8 Accept: application/soap+xml, application/dime, multipart/related, text/* User-Agent: Axis/1.2.1 Host: pat Cache-Control: no-cache Pragma: no-cache SOAPAction: "" Content-Length: 913 <?xml version="1.0" encoding="utf-8"?> <soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/xmlschema" xmlns:xsi="http://www.w3.org/2001/xmlschema-instance"> <soapenv:body> <ns1:orderclose xmlns:ns1="http://webservices.pgw.muzo.com"> <merchantnumber xsi:type="xsd:string">9999999021</merchantnumber> <ordernumber xsi:type="xsd:string">130501656703</ordernumber> <digest xsi:type="xsd:string">cmcniyifpkgeio1jsyqx9waf6jjf5f65sjpq85rzcuyvs7l2le6rx2ptvkgcqcmri K6L78H+MxVV5Ujz3ZZAgWPCUd04xbVvyOQ1PLmlXqNb9d0PeaiPtmRteCCLNxt+utrGAEcGyLlajCCF4JVN9Woq vqrpgpx/kfxbzpt7dnbezqk8tll4c/qkwrubghjmyh7+hs8iubo8rflj+fk4pt0rodez84+8txr4wywy/6gliid qwjiy1h/5bjifubjd/lvzhad7syjghtwham1izxaptc0k7zit2qapg0vpcvkd0flydqabo18mtuwppkktl7lgco uppr9wkvnxxqxjrg==</digest> </ns1:orderclose> </soapenv:body> </soapenv:envelope> Odpověď: HTTP/1.1 200 OK Date: Tue, 10 May 2011 08:51:17 GMT Server: Apache/2.2.10 (Win32) mod_ssl/2.2.10 OpenSSL/0.9.8i mod_auth_sspi/1.0.4 Connection: close Content-Type: text/xml; charset=utf-8 Content-Language: cs-cz <?xml version="1.0" encoding="utf-8"?> <soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/xmlschema" xmlns:xsi="http://www.w3.org/2001/xmlschema-instance"> <soapenv:body> <ns1:ordercloseresponse xmlns:ns1="http://webservices.pgw.muzo.com"> <orderclosereturn href="#id0"/> </ns1:ordercloseresponse> <multiref id="id0" soapenc:root="0" xsi:type="ns2:orderresponse" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="http://request.pgw.muzo.com"> <digest xsi:type="soapenc:string">tezqcyri1yigu0cqaebyr7h9hxtcqkk+3f6tlw58bagewjmyjgyhtca/u27fx 4AHDc0W0fZxA9C8D8byMtm1Hd4WyJcpq4Sivcrtb9gwLJT6Js74IAWRIwsVctC6XbZP4g29A5JfwSa+WspOEnuF uojfv9qiemg6qkwxgm/id2rgqas5srhtvrtkntbepasxftp87kaqjex7iqlbw7d9s+vmkgsdhjfyporz4wfcwjn NHRAb4Nw4rEPmfDkYIJaOWNjQvL3f23B6Jazusdum1UTicYVavRs1qumX4CGBVAzhYN/WibY5K9ThT/cHC+GvkH 3A+Z54x4IiawHs0zogtQ==</digest> <ok href="#id1"/> <ordernumber xsi:type="soapenc:string">130501656703</ordernumber> <primaryreturncode href="#id2"/> <secondaryreturncode href="#id3"/> <requestid href="#id4"/> </multiref> <multiref id="id2" soapenc:root="0" 25
xsi:type="xsd:int" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">0</multiref> <multiref id="id1" soapenc:root="0" xsi:type="xsd:boolean" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">true</multiref> <multiref id="id4" soapenc:root="0" xsi:type="xsd:long" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">1158007541759278213</multiref > <multiref id="id3" soapenc:root="0" xsi:type="xsd:int" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">0</multiref> </soapenv:body> </soapenv:envelope> Delete POPIS ZPRACOVÁNÍ POŽADAVKU Akce Delete Order Req Delete Order Res Popis GP webpay obdrží požadavek na odstranění objednávky. GP webpay odstraní danou objednávku a zašle výsledek odstranění objednávky. PRŮBĚH ZPRACOVÁNÍ POŽADAVKU Nutné podmínky: Objednávka je ve stavu: REQUESTED PENDING DECLINED UNAPPROVED APPROVE_REVERSED ORDER_CLOSE Zpracování: GP webpay zkontroluje platnost zadaných údajů: vyhledá požadovaného obchodníka; vyhledá požadovanou objednávku; zkontroluje platnost zadané operace zda stav objednávky povoluje požadovanou operaci; zkontroluje podpis požadavku; zkontroluje platnost obsahu (délka, typ, hodnota) všech prvků. 26
Výsledek: GP webpay odstraní objednávku. Stav objednávky se změní na: DELETED Chybové stavy: požadavek nelze zpracovat obchodník nenalezen; požadavek nelze zpracovat objednávka nenalezena; požadavek nelze zpracovat chybný podpis dat; požadavek nelze zpracovat prvek XXX neobsahuje požadovaný typ; požadavek nelze zpracovat prvek XXX neobsahuje požadovanou délku; požadavek nelze zpracovat prvek XXX neobsahuje požadovanou hodnotu; neúspěšné odstranění objednávky z důvodu XXX; požadavek nelze zpracovat technické problémy. Formát požadavku Request delete Vstupní parametr Typ Délka Povinný Poznámka merchantnumber znakový 10 ano Přidělené číslo obchodníka. ordernumber znakový 15 ano Číslo objednávky, pro kterou je požadováno odstranění. digest znakový ano Kontrolní podpis všech výše uvedených polí, zřetězených se sdílenou tajnou informací za využití hash funkce SHA1. Popis algoritmu výpočtu pole DIGEST viz Příloha 1 Podepisování zpráv Formát zaslané odpovědi Response OrderResponse Atribut Typ Délka Povinný Poznámka ordernumber znakový 15 ano Obsahuje ordernumber z požadavku primaryreturncode numerický ano Obsahuje primární kód, viz Příloha 2 Seznam návratových kódů secondaryreturncode numerický ano Obsahuje sekundární kód, viz Příloha 2 Seznam návratových kódů digest znakový ano Popis algoritmu výpočtu pole DIGEST viz Příloha 1 Podepisování zpráv 27
Příklad zaslaného požadavku a obdržené odpovědi Požadavek: POST /webservices/services/pgw HTTP/1.0 Content-Type: text/xml; charset=utf-8 Accept: application/soap+xml, application/dime, multipart/related, text/* User-Agent: Axis/1.2.1 Host: pat Cache-Control: no-cache Pragma: no-cache SOAPAction: "" Content-Length: 905 <?xml version="1.0" encoding="utf-8"?> <soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/xmlschema" xmlns:xsi="http://www.w3.org/2001/xmlschema-instance"> <soapenv:body> <ns1:delete xmlns:ns1="http://webservices.pgw.muzo.com"> <merchantnumber xsi:type="xsd:string">9999999021</merchantnumber> <ordernumber xsi:type="xsd:string">130501656703</ordernumber> <digest xsi:type="xsd:string">cmcniyifpkgeio1jsyqx9waf6jjf5f65sjpq85rzcuyvs7l2le6rx2ptvkgcqcmri K6L78H+MxVV5Ujz3ZZAgWPCUd04xbVvyOQ1PLmlXqNb9d0PeaiPtmRteCCLNxt+utrGAEcGyLlajCCF4JVN9Woq vqrpgpx/kfxbzpt7dnbezqk8tll4c/qkwrubghjmyh7+hs8iubo8rflj+fk4pt0rodez84+8txr4wywy/6gliid qwjiy1h/5bjifubjd/lvzhad7syjghtwham1izxaptc0k7zit2qapg0vpcvkd0flydqabo18mtuwppkktl7lgco uppr9wkvnxxqxjrg==</digest> </ns1:delete> </soapenv:body> </soapenv:envelope> Odpověď: HTTP/1.1 200 OK Date: Tue, 10 May 2011 08:52:32 GMT Server: Apache/2.2.10 (Win32) mod_ssl/2.2.10 OpenSSL/0.9.8i mod_auth_sspi/1.0.4 Connection: close Content-Type: text/xml; charset=utf-8 Content-Language: cs-cz <?xml version="1.0" encoding="utf-8"?> <soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/xmlschema" xmlns:xsi="http://www.w3.org/2001/xmlschema-instance"> <soapenv:body> <ns1:deleteresponse xmlns:ns1="http://webservices.pgw.muzo.com"> <deletereturn href="#id0"/> </ns1:deleteresponse> <multiref id="id0" soapenc:root="0" xsi:type="ns2:orderresponse" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="http://request.pgw.muzo.com"> <digest xsi:type="soapenc:string">tezqcyri1yigu0cqaebyr7h9hxtcqkk+3f6tlw58bagewjmyjgyhtca/u27fx 4AHDc0W0fZxA9C8D8byMtm1Hd4WyJcpq4Sivcrtb9gwLJT6Js74IAWRIwsVctC6XbZP4g29A5JfwSa+WspOEnuF uojfv9qiemg6qkwxgm/id2rgqas5srhtvrtkntbepasxftp87kaqjex7iqlbw7d9s+vmkgsdhjfyporz4wfcwjn NHRAb4Nw4rEPmfDkYIJaOWNjQvL3f23B6Jazusdum1UTicYVavRs1qumX4CGBVAzhYN/WibY5K9ThT/cHC+GvkH 3A+Z54x4IiawHs0zogtQ==</digest> <ok href="#id1"/> <ordernumber xsi:type="soapenc:string">130501656703</ordernumber> <primaryreturncode href="#id2"/> <secondaryreturncode href="#id3"/> <requestid href="#id4"/> </multiref> <multiref id="id4" soapenc:root="0" 28
xsi:type="xsd:long" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">1158007670608297168</multiref > <multiref id="id1" soapenc:root="0" xsi:type="xsd:boolean" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">true</multiref> <multiref id="id3" soapenc:root="0" xsi:type="xsd:int" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">0</multiref> <multiref id="id2" soapenc:root="0" xsi:type="xsd:int" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">0</multiref> </soapenv:body> </soapenv:envelope> Query Order State POPIS ZPRACOVÁNÍ POŽADAVKU Akce Query Order State Req Query Order State Res Popis GP webpay obdrží požadavek na zjištění aktuálního stavu objednávky. GP webpay zašle výsledek obsahující aktuální stav objednávky. PRŮBĚH ZPRACOVÁNÍ POŽADAVKU Nutné podmínky: Objednávka je v libovolném stavu. Zpracování: GP webpay zkontroluje platnost zadaných údajů: vyhledá požadovaného obchodníka; vyhledá požadovanou objednávku; zkontroluje platnost zadané operace; zkontroluje podpis požadavku; zkontroluje platnost obsahu (délka, typ, hodnota) všech prvků. Výsledek: GP webpay předá detailní informace o objednávce. 29
Chybové stavy: požadavek nelze zpracovat obchodník nenalezen; požadavek nelze zpracovat objednávka nenalezena; požadavek nelze zpracovat neplatná operace; požadavek nelze zpracovat chybný podpis dat; požadavek nelze zpracovat prvek XXX neobsahuje požadovaný typ; požadavek nelze zpracovat prvek XXX neobsahuje požadovanou délku; požadavek nelze zpracovat prvek XXX neobsahuje požadovanou hodnotu; požadavek nelze zpracovat technické problémy. 30
Formát požadavku Request queryorderstate Vstupní parametr Typ Délka Povinný Poznámka merchantnumber znakový 10 ano Přidělené číslo obchodníka. ordernumber znakový 15 ano Číslo objednávky, pro kterou je požadováno zjištění aktuálního stavu. digest znakový ano Kontrolní podpis všech výše uvedených polí, zřetězených se sdílenou tajnou informací, za využití hash funkce SHA1. Popis algoritmu výpočtu pole DIGEST viz Příloha 1 Podepisování zpráv Formát zaslané odpovědi Response OrderStateResponse Atribut Typ Délka Povinný Poznámka ordernumber znakový 15 ano Obsahuje ordernumber z požadavku. state numerický ano Obsahuje aktuální stav objednávky, viz Příloha 2 Seznam návratových kódů primaryreturncode numerický ano Obsahuje primární kód, viz Příloha 2 Seznam návratových kódů secondaryreturncode numerický ano Obsahuje sekundární kód, viz Příloha 2 Seznam návratových kódů digest znakový ano Popis algoritmu výpočtu pole DIGEST viz Příloha 1 Podepisování zpráv 31
Příklad zaslaného požadavku a obdržené odpovědi Požadavek: POST /webservices/services/pgw HTTP/1.0 Content-Type: text/xml; charset=utf-8 Accept: application/soap+xml, application/dime, multipart/related, text/* User-Agent: Axis/1.2.1 Host: pat Cache-Control: no-cache Pragma: no-cache SOAPAction: "" Content-Length: 923 <?xml version="1.0" encoding="utf-8"?> <soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/xmlschema" xmlns:xsi="http://www.w3.org/2001/xmlschema-instance"> <soapenv:body> <ns1:queryorderstate xmlns:ns1="http://webservices.pgw.muzo.com"> <merchantnumber xsi:type="xsd:string">9999999021</merchantnumber> <ordernumber xsi:type="xsd:string">130501656703</ordernumber> <digest xsi:type="xsd:string">cmcniyifpkgeio1jsyqx9waf6jjf5f65sjpq85rzcuyvs7l2le6rx2ptvkgcqcmri K6L78H+MxVV5Ujz3ZZAgWPCUd04xbVvyOQ1PLmlXqNb9d0PeaiPtmRteCCLNxt+utrGAEcGyLlajCCF4JVN9Woq vqrpgpx/kfxbzpt7dnbezqk8tll4c/qkwrubghjmyh7+hs8iubo8rflj+fk4pt0rodez84+8txr4wywy/6gliid qwjiy1h/5bjifubjd/lvzhad7syjghtwham1izxaptc0k7zit2qapg0vpcvkd0flydqabo18mtuwppkktl7lgco uppr9wkvnxxqxjrg==</digest> </ns1:queryorderstate> </soapenv:body> </soapenv:envelope> Odpověď: HTTP/1.1 200 OK Date: Tue, 10 May 2011 08:53:39 GMT Server: Apache/2.2.10 (Win32) mod_ssl/2.2.10 OpenSSL/0.9.8i mod_auth_sspi/1.0.4 Connection: close Content-Type: text/xml; charset=utf-8 Content-Language: cs-cz <?xml version="1.0" encoding="utf-8"?> <soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/xmlschema" xmlns:xsi="http://www.w3.org/2001/xmlschema-instance"> <soapenv:body> <ns1:queryorderstateresponse xmlns:ns1="http://webservices.pgw.muzo.com"> <queryorderstatereturn href="#id0"/> </ns1:queryorderstateresponse> <multiref id="id0" soapenc:root="0" xsi:type="ns2:orderstateresponse" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="http://request.pgw.muzo.com"> <digest xsi:type="soapenc:string">ms0nefcngligrvk1qezguwdo21nnqgtrhqz6ejlj+ajvocu77gffjp+qiw8m4 ween5dmzctnhrrmy5o81kihj7y2sqxottrhow8gv0wfzy6aq9omf/v6p30dwpvu0ftlbruf0zex6p/s3tdqfgjo H4C+/y8GL6hlGahBhCsKLZlqptAU+KLHMk+juPi6Fim7myVF14j06gjkvqP6N9giQRBJqcXI98faIbFz4cQPg2M zmf3aumg3m4qbu+ludobdixod9zkyrw3fu65yb4xfuib/fyhdcvptpoeryimgw0vpwjt+brhx98jb3xx/wew7di LIXby3Rc8uKQ3ZD2EeTw==</digest> <ok href="#id1"/> <ordernumber xsi:type="soapenc:string">130501656703</ordernumber> <primaryreturncode href="#id2"/> <secondaryreturncode href="#id3"/> <state href="#id4"/> 32
<requestid href="#id5"/> </multiref> <multiref id="id1" soapenc:root="0" xsi:type="xsd:boolean" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">true</multiref> <multiref id="id3" soapenc:root="0" xsi:type="xsd:int" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">0</multiref> <multiref id="id5" soapenc:root="0" xsi:type="xsd:long" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">1158007799457316115</multiref > <multiref id="id2" soapenc:root="0" xsi:type="xsd:int" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">0</multiref> <multiref id="id4" soapenc:root="0" xsi:type="xsd:int" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">10</multiref> </soapenv:body> </soapenv:envelope> Batch Close POPIS ZPRACOVÁNÍ POŽADAVKU Akce Batch Close Req Batch Close Res Popis GP webpay obdrží požadavek na uzavření dávky objednávek určených ke zpracování. GP webpay uzavře dávku objednávek a zašle výsledek uzavření dávky PRŮBĚH ZPRACOVÁNÍ POŽADAVKU Nutné podmínky: Dávka je ve stavu: OPEN Zpracování: GP webpay zkontroluje platnost zadaných údajů: vyhledá požadovaného obchodníka; zkontroluje platnost zadané operace zda stav dávky povoluje požadovanou operaci; zkontroluje podpis požadavku; zkontroluje platnost obsahu (délka, typ, hodnota) všech prvků. Výsledek: 33