Metoda payment.info
Pobiera informacje o metodzie płatności
array call(string $session_id, "payment.info", array($id, $translations = false, $currencies = false))
Ta metoda wywoływana jest za pośrednictwem metody call
Parametry wejściowe
- id
- translations (boolean) - - czy zwrócić dodatkowo informacje o tłumaczeniach
- currencies (boolean) - - czy zwrócić dodatkowo informacje o dowiązanych walutach
Wartość zwracana
- (array) - tablica asocjacyjna z informacjami o metodzie płatności.
Zwracana tablica ma strukturę:- ['payment_id'] (int) - identyfikator metody płatności
- ['install'] (int[0/1]) - czy metoda płatności jest dostarczona wraz z dystrybucją oprogramowania (1) czy nie (0)
- ['order'] (int) - priorytet brany pod uwagę przy szacowaniu kolejności wyświetlania metod płatności
- ['name'] (string) - nazwa silnika płatności, który obsługuje tą metodę płatności
- ['translations'] (array) - tablica asocjacyjna z istniejącymi tłumaczeniami obiektu, zwracana tylko wtedy, kiedy parametr $translations jest ustawiony na true. Kluczami tablicy są nazwy lokalizacji, a wartościami tablice asocjacyjne informacji o tłumaczeniach:
- ['pl_PL'] (array) - przykładowa tablica z informacjami o tłumaczeniu w lokalizacji pl_PL
- ['translation_id'] (int) - identyfikator tłumaczenia
- ['payment_id'] (int) - identyfikator metody płatności
- ['title'] (string) - nazwa metody płatności
- ['description'] (string) - opis metody płatności
- ['notify'] (string) - treść komunikatu po dokonaniu płatności
- ['notify_mail'] (string) - treść komunikatu wysyłanego w mailu po dokonaniu płatności
- ['active'] (int[0/1]) - czy metoda płatności jest aktywna (1) lub nie (0)
- ['lang_id'] (int) - identyfikator lokalizacji
- ['currencies'] (array) - tablica, której wartościami są identyfikatory dowiązanych do płatności walut, zwraca tylko wtedy, kiedy parametr $currencies jest ustawiony na true
Rzucane wyjątki SoapFault
- W przypadku próby pobrania informacji o nieistniejącej metodzie płatności, rzucany jest wyjątek z komunikatem payment identified as id: {$id} does not exist
Istnieje możliwość wystąpienia wyjątku SoapFault w przypadku nieprawidłowego działania modułu aplikacji. (np poprzez modyfikację kodu aplikacji lub poprzez nieoczekiwany błąd po stronie serwera)
Przykład wywołania w PHP
<?php /** * Logowanie do API * * @param resource $c cURL resource handle * @param string $login Login użytkownika * @param string $password Hasło użytkownika * @return string Indentyfikatorr sesji użytkownika */ function login($c, $login, $password) { $params = Array( "method" => "login", "params" => Array($login, $password) ); curl_setopt($c, CURLOPT_POSTFIELDS, "json=" . json_encode($params)); $result = (Array) json_decode(curl_exec($c)); if (isset($result['error'])) { return null; } else { return $result[0]; } } $c = curl_init(); curl_setopt($c, CURLOPT_URL, 'http://shop.example.com/webapi/json/'); curl_setopt($c, CURLOPT_POST, true); curl_setopt($c, CURLOPT_RETURNTRANSFER, 1); // zalogowanie użytkownika i pobranie identyfikatora sesji $session = login($c, "api", "test"); if ($session != null) { $params = Array( "method" => "call", "params" => Array($session, "payment.info", Array(1, true, true) // id płatności, translacje, waluty ) ); // zakodowanie parametrów dla metody POST $postParams = "json=" . json_encode($params); curl_setopt($c, CURLOPT_POSTFIELDS, $postParams); // dekodowanie rezultatu w formacie JSON do tablicy result $data = curl_exec($c); $result = (Array)json_decode($data); // sprawdzenie, czy wystąpił błąd if (isset($result['error'])) { echo "Wystąpił błąd: " . $result['error'] . ", kod: " . $result['code']; } else { echo "Id płatności: " . $result['payment_id'] . "<br>"; $translations = (Array)$result['translations']; $translPL = (Array)$translations['pl_PL']; echo "Nazwa w języku polskim: " . $translPL['title'] . "<br>"; // itp. echo "Waluty:<br>"; $payments = (Array)$result['currencies']; foreach ($payments as $currencyId) { echo "Id waluty: " . $currencyId . "<br>"; } } } else { echo "Wystąpił błąd logowania"; } curl_close($c); ?>