Allegro WebAPI

Interfejs programistyczny platformy Allegro

doRequestSurcharge

Tematyka: Allegro Finanse
Ostatnia zmiana: 25.01.2011 r.
Dostępność:
Metoda pozwala na wnioskowanie o dopłatę do transakcji, za którą płatność jest niekompletna. Dla każdej transakcji można wysłać tylko jeden wniosek o dopłatę.

  1. session-handle | string | wymagany
    Identyfikator sesji użytkownika, uzyskany za pomocą metody doLogin(Enc).
  2. surcharge-trans-id | long | wymagany
    Identyfikator transakcji, do pobrania za pomocą doGetTransactionsIDs.
  3. surcharge-value | float | wymagany
    Kwota dopłaty.
  4. surcharge-message | string | niewymagany
    Wiadomość dla kontrahenta.



Orientacyjna struktura wywołania metody

$dorequestsurcharge_request = array(
   'session-handle' => '22eb99326c6be29aa16d07d622bcfbcbee94ad54846f2f4e03_1',
   'surcharge-trans-id' => 42254380,
   'surcharge-value' => 30.00,
   'surcharge-message' => 'Proszę o dopłatę brakującej kwoty.'
);

  1. request-value int
    Wynik operacji (1 - żądanie zostało wysłane, 0 - żądanie nie zostało wysłane).



Orientacyjna struktura odpowiedzi serwera

$dorequestsurcharge_response = array(
   'request-value' => 1
);


  • ERR_INCORRECT_TRANSACTION_ID
    Nieprawidłowy identyfikator transakcji.
  • ERR_INCORRECT_SURCHARGE_VALUE
    Brak lub niepoprawna wartość kwoty dopłaty.
  • ERR_NEW_PAYMENT_INTERNAL_ERROR
    Wewnętrzny błąd systemu związany z pobieraniem transakcji Allegro Finanse.
  • ERR_NO_SESSION / ERR_SESSION_EXPIRED
    Niepoprawny identyfikator sesji lub sesja wygasła.
  • ERR_PZA_ISNT_CONFIGURED
    Użytkownik nie ma w pełni skonfigurowanego Allegro Finanse.
  • ERR_SURCHARGE_REQUEST_ALREADY_MADE
    Wniosek o dopłatę do tej transakcji został złożony wcześniej.
  • ERR_USER_CANNOT_MAKE_SURCHARGE_REQUEST
    Użytkownik nie był sprzedającym w podanej ofercie.
  • ERR_WEBAPI_KEY_INACTIVE
    Klucz WebAPI na którym została wygenerowana sesja został zdezaktywowany (jego właściciel nie zaakceptował warunków Regulaminu WebAPI).