Allegro WebAPI

Interfejs programistyczny platformy Allegro

doGetMyPayouts

Tematyka: Allegro Finanse
Ostatnia zmiana: 25.01.2011 r.
Dostępność:
Metoda pozwala na pobranie listy wypłat środków (wpłaconych przez kupujących za pośrednictwem Allegro Finanse) za transakcje w ramach ofert zalogowanego użytkownika. Domyślnie (w przypadku nie zdefiniowana zakresu czasu) pobierana jest lista wypłat z przeciągu ostatniego tygodnia (domyślnie 50 ostatnio dokonanych wypłat), posortowana malejąco po czasie ich realizacji. Listę można filtrować po zakresie czasu, w którym wypłaty zostały dokonane. W przypadku gdy za datę początkową zakresu czasu (trans-create-date-from) podstawiona zostanie konkretna wartość, a dla daty końcowej zakresu czasu (trans-create-date-to) przekazane zostanie 0, zwrócona zostanie lista wypłat od daty podanej do daty podanej + 7 dni. W przypadku odwrotnym (gdy dla daty początkowej zakresu czasu przekazane zostanie 0, a dla daty końcowej zakresu czasu podstawiona zostanie konkretna wartość), zwrócona zostanie lista wypłat od daty podanej - 7 dni do daty podanej. Przy podaniu konkretnych wartości zakresu czasu zarówno dla daty początkowej, jak i dla daty końcowej, zwrócona zostanie lista wypłat zrealizowanych w podanym zakresie (ustalony zakres nie może jednak przekraczać 30 dni).

  1. session-handle | string | wymagany
    Identyfikator sesji użytkownika, uzyskany za pomocą metody doLogin(Enc).
  2. trans-create-date-from | long | niewymagany
    Data początkowa zakresu czasu (w formacie Unix time), od którego ma zostać pobrana lista wypłat.
  3. trans-create-date-to | long | niewymagany
    Data końcowa zakresu czasu (w formacie Unix time), do którego ma zostać pobrana lista wypłat.
  4. trans-page-limit | int | niewymagany
    Rozmiar porcji danych (min. 1, maks. 49; podanie wartości spoza zakresu powoduje ustawienie rozmiaru porcji na wartość domyślną: 50).
  5. trans-offset | int | niewymagany
    Sterowanie (poprzez inkrementację przekazywanej wartości) pobieraniem kolejnych porcji danych (numery porcji indeksowane są od 0).



Orientacyjna struktura wywołania metody

$dogetmypayouts_request = array(
   'session-handle' => '22eb99326c6be29aa16d07d622bcfbcbee94ad54846f2f4e03_1',
   'trans-create-date-from' => 0,
   'trans-create-date-to' => 1268352000,
   'trans-page-limit' => 2,
   'trans-offset' => 0
);

  1. pay-trans-payout | UserPayoutStruct[]
    Tablica struktur zawierających informacje o wypłatach zalogowanego użytkownika.
    1. pay-trans-id | long
      Identyfikator transakcji Allegro Finanse.
    2. pay-trans-status | string
      Status transakcji Allegro Finanse (listę wszystkich możliwych statusów dla wypłat podejrzeć można tutaj).
    3. pay-trans-amount | float
      Wysokość kwoty wypłaty użytkownika.
    4. pay-trans-create-date | long
      Data utworzenie transakcji Allegro Finanse (w formacie Unix time).
    5. pay-trans-recv-date | long
      Data zakończenia transakcji Allegro Finanse (w formacie Unix time).
    6. pay-trans-cancel-date | long
      Data anulowania transakcji Allegro Finanse (w formacie Unix time, -1 gdy transakcja nie została anulowana).
    7. pay-trans-report | string
      Odnośnik do raportu z listą wpłat od kupujących skladających się na realizowaną wypłatę.



Orientacyjna struktura odpowiedzi serwera

$dogetmypayouts_response = array(
   'pay-trans-payout' => array(
      array(
         'pay-trans-id' => 626518,
         'pay-trans-status' => 'Zakończona',
         'pay-trans-amount' => 63.00,
         'pay-trans-create-date' => 1268390142,
         'pay-trans-recv-date' => 1264636263,
         'pay-trans-cancel-date' => -1,
         'pay-trans-report' => 'www.allegro.pl/myaccount/NewpaymentsPayoutReport.php/payoutId,626518'),
      array(
         'pay-trans-id' => 626241,
         'pay-trans-status' => 'Zakończona',
         'pay-trans-amount' => 25.00,
         'pay-trans-create-date' => 1268305398,
         'pay-trans-recv-date' => 1268390080,
         'pay-trans-cancel-date' => -1,
         'pay-trans-report' => 'www.allegro.pl/myaccount/NewpaymentsPayoutReport.php/payoutId,626241'))
);

  • ERR_INPUT_DATE_RANGE
    Niepoprawne określenie zakresu dat (zakres pomiędzy datą początkową, a końcową przekracza 30 dni, ustalona data końcowa jest równa lub wcześniejsza niż data początkowa lub podano wartości mniejsze od 0).
  • 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_WEBAPI_KEY_INACTIVE
    Klucz WebAPI na którym została wygenerowana sesja został zdezaktywowany (jego właściciel nie zaakceptował warunków Regulaminu WebAPI).

Allegro nie bierze odpowiedzialności za skutki wykorzystania zamieszczonych przykładów kodu, nie daje także gwarancji ich poprawnego działania. Widoczny kod ma charakter wyłącznie poglądowy i może zawierać błędy.