Allegro WebAPI

Interfejs programistyczny platformy Allegro

doGetMyPayments

Tematyka: Allegro Finanse
Ostatnia zmiana: 16.05.2016 r.
Dostępność:

Metoda pozwala na pobranie listy wpłat (dokonanych za pośrednictwem Allegro Finanse) za transakcje zrealizowane przez zalogowanego użytkownika, dokonane w okresie do 90 dni wstecz. Domyślnie (w przypadku niezdefiniowania zakresu czasu), pobierana jest lista wpłat z przeciągu ostatniego tygodnia (domyślnie 25 ostatnio dokonanych wpłat), posortowana malejąco po czasie ich realizacji.

Dostępne filtry:

  • sellerId - Użytkownik, któremu dokonywane były wpłaty
  • itemId - Oferta, której wpłaty dotyczą
  • paymentTimeFrom/paymentTimeTo - Zakres czasu, w którym wpłaty zostały dokonane.
Poszczególne filtry można ze sobą łączyć. W przypadku przekazania identyfikatora użytkownika, który nie istnieje, zwracana jest pusta struktura.

Pole strictedSearch, które pozwala zdefiniować sposób filtrowania danych po czasie. Gdy w podanym polu przekażemy 0 lub pole nie zostanie przekazane w ogóle (parametr opcjonalny z domyślną wartością 0) filtrowanie będzie działało nastepująco:

Gdy podana zostanie konkretna wartość w paymentTimeFrom, a dla paymentTimeTo przekazane zostanie 0:

  • paymentTimeFrom zostanie ustawiony na przekazaną datę, ale cofniętą do godziny 00:00, czyli przekazując timestamp=1462486320 (05.05.2016 22:12:00) system ją ustawi na wartość 1462406400 (05.05.2016 00:00:00).
  • paymentTimeTo zostanie ustawiony na mniejszą wartość z:
    • daty przekazanej w paymentTimeFrom + 7 dni (1463011200 - 12.05.2016 00:00:00)
    • dnia następnego od dnia przekazanego w paymentTimeFrom (1462492800 - 06.05.2016 00:00:00) czyli wartość paymentTimeTo wyniesie: 1462492800.

W przypadku odwrotnym (gdy w paymentTimeFrom przekazane zostanie 0, a dla paymentTimeTo podstawiona zostanie konkretna wartość):

  • paymentTimeTo zostanie ustawiony na przekazaną datę + 1 dzień, ale cofniętą do godziny 00:00, czyli przekazując timestamp=1462536000 (06.05.2016 12:00:00) system ją ustawi na wartość: 1462579200 (07.05.2016 00:00:00)
  • paymentTimeFrom zostanie ustawiony na większą wartość z:
    • zera (0),
    • wartość paymentTimeTo - 7 dni (1461974400 - 30.04.2016 00:00:00), czyli paymentTimeFrom wyniesie: 1461974400.

Przy podaniu konkretnych wartości zakresu czasu zarówno dla daty początkowej, np.: 1462486320 (05.05.2016 22:12:00), jak i dla daty końcowej, np.: 1462536000 (06.05.2016 22:12:00), zwrócona zostanie lista wpłat zrealizowanych w podanym zakresie:

  • paymentTimeFrom zostanie ustawiony na 1462406400 (05.05.2016 00:00:00),
  • paymentTimeTo zostanie ustawiony 1462579200 (07.05.2016 00:00:00).

Jeżeli przekazywany paymentTimeFrom będzię mniejszy od wartości teraz - 3 miesiące (czyli np.: 3 m-ce i 2 dni) to parametr zostanie ustawiony na wartość teraz - 3 miesiące. Jeżeli przekazywany paymentTimeTo będzie większy od wartości teraz + jeden dzień (czyli np.: 1 dzień i 8 godzin) to parametr zostanie ustawiony na wartość teraz + 1 dzień.

Natomiast gdy w polu strictedSearch przekażemy 1, filtrowanie będzie działało następująco:

  • Gdy w paymentTimeFrom podstawiona zostanie konkretna wartość, a w paymentTimeTo przekazane zostanie 0, zwrócona zostanie lista wpłat od daty podanej do daty podanej + 7 dni.
  • W przypadku odwrotnym, gdy w paymentTimeFrom przekazane zostanie 0, a w paymentTimeTo podstawiona zostanie konkretna wartość, zwrócona zostanie lista wpł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 wpłat zrealizowanych w podanym zakresie.


  1. session-id | string | wymagany
    Identyfikator sesji użytkownika, uzyskany za pomocą metody doLogin(Enc).
  2. seller-id | int | niewymagany
    Identyfikator sprzedającego, któremu dokonywane wpłaty mają zostać pobrane.
  3. item-id | long | niewymagany
    Identyfikator oferty, której dotyczy dana wpłata (także, gdy dana oferta jest częścią wpłaty łącznej).
  4. payment-time-from | long | niewymagany
    Data początkowa zakresu czasu (w formacie Unix time), od którego ma zostać pobrana lista wpłat.
  5. payment-time-to | long | niewymagany
    Data końcowa zakresu czasu (w formacie Unix time), do którego ma zostać pobrana lista wpłat.
  6. page-size | int | niewymagany
    Rozmiar porcji danych (min. 1, maks. 24; podanie wartości spoza zakresu powoduje ustawienie rozmiaru porcji na wartość domyślną: 25)
  7. page-number | int | niewymagany
    Sterowanie (poprzez inkrementację przekazywanej wartości) pobieraniem kolejnych porcji danych (numery porcji indeksowane są od 0).
  8. stricted-search | int | niewymagany
    Wyszukiwanie z dokładnością do przekazanych sekund w paymentTimeFrom i paymentTimeTo (0 - nie, 1 - tak).



Orientacyjna struktura wywołania metody

$dogetmypayments_request = array(
   'session-id' => '22eb99326c6be29aa16d07d622bcfbcbee94ad54846f2f4e03_1',
   'seller-id' => 0,
   'item-id' => 0,
   'payment-time-from' => 1264636200,
   'payment-time-to' => 1264636500,
   'page-size' => 0,
   'page-number' => 0,
   'stricted-search' => 0
);

  1. pay-trans-payment | UserPaymentStruct[]
    Tablica struktur zawierających informacje o wpłatach zalogowanego użytkownika.
    1. pay-trans-id | long
      Identyfikator transakcji Allegro Finanse.
    2. pay-trans-sellers | PaymentSellersStruct[]
      Tablica struktur zawierających informację o przedmiotach składających się na transakcję, zakupionych od określonych sprzedających.
      1. pay-trans-seller-id | int
        Identyfikator sprzedającego.
      2. pay-trans-seller-name | string
        Nazwa sprzedającego.
      3. pay-trans-items | PaymentItemsStruct[]
        Tablica struktur zawierających informacje o przedmiotach zakupionych u danego sprzedającego.
        1. pay-trans-it-id | long
          Identyfikator oferty.
        2. pay-trans-it-name | string
          Nazwa oferty.
        3. pay-trans-it-count | int
          Liczba przedmiotów zakupionych w ramach oferty.
        4. pay-trans-it-price | float
          Wartość przedmiotu zakupionego w ramach oferty.
      4. pay-trans-seller-postage-amount | float
        Łączny koszt sposobów dostawy wybranych dla ofert danego sprzedającego. 
    3. pay-trans-type | string
      Metoda płatności (mBank, Multibank, BZ WBK, Pekao SA, BPH, Inteligo, Nordea, iPKO BP, ING, Raiffeisen Bank, Millennium, Kredyt Bank, Polbank, Citi Handlowy, Deutsche Bank, Getin Bank, Invest-Bank, Meritum Bank, Eurobank, Alior Bank, BGŻ, Karta płatnicza, Przelew bankowy, Zwykły przelew (poza systemem Allegro Finanse), Płacę przy odbiorze).
    4. pay-trans-status | string
      Status transakcji Allegro Finanse (listę wszystkich możliwych statusów dla wpłat podejrzeć można tutaj).
    5. pay-trans-amount | float
      Wysokość kwoty wpłaty użytkownika.
    6. pay-trans-create-date | long
      Data utworzenie transakcji Allegro Finanse(w formacie Unix time).
    7. pay-trans-price | float
      Wartość przedmiotów zakupionych przez użytkownika w ramach transakcji i opłaconych przez Allegro Finanse(lub 0 w przypadku dopłaty).
    8. pay-trans-postage-amount | float
      Łączne koszta wybranego przez użytkownika sposobu dostawy, opłacone w ramach transakcji Allegro Finanse(lub 0 w przypadku dopłaty).
    9. pay-trans-incomplete | int
      Informacja o kompletności wpłaty (1 - wpłata niekompletna, 0 - wpłata kompletna).



Orientacyjna struktura odpowiedzi serwera

$dogetmypayments_response = array(
   'pay-trans-payment' => array(
      array(
         'pay-trans-id' => 1964852,
         'pay-trans-sellers' => array(
            array(
               'pay-trans-seller-id' => 2907979,
               'pay-trans-seller-name' => 'kubek-sklep',
               'pay-trans-items' => array(
                  array(
                     'pay-trans-it-id' => 891436088,
                     'pay-trans-it-name' => 'Czarny kubek 50ml',
                     'pay-trans-it-count' => 1,
                     'pay-trans-it-price' => 40.00),
                  array(
                     'pay-trans-it-id' => 891437091,
                     'pay-trans-it-name' => 'Łyżeczka do kubka - czarna',
                     'pay-trans-it-count' => 1,
                     'pay-trans-it-price' => 12.00)),
               'pay-trans-seller-postage-amount' => 2.00)),

         'pay-trans-type' => 'BZ WBK',
         'pay-trans-status' => 'Zakończona',
         'pay-trans-amount' => 54.00,
         'pay-trans-create-date' => 1264636263,
         'pay-trans-price' => 52.00,
         'pay-trans-postage-amount' => 2.00,
         'pay-trans-incomplete' => 0))
);


  • ERR_INPUT_DATE_RANGE
    Niepoprawne określenie zakresu dat (zakres pomiędzy datą początkową, a końcową przekracza 90 dni, ustalona data końcowa jest równa lub wcześniejsza niż data początkowa lub podano wartości mniejsze od 0).
  • ERR_INCORRECT_ITEM_ID
    Niepoprawny (< 0) identyfikator oferty lub oferta o podanym identyfikatorze nie istnieje.
  • ERR_INCORRECT_PAGE_NUMBER
    Niepoprawny (< 0) numer porcji danych.
  • ERR_INCORRECT_PAGE_SIZE
    Niepoprawny (< 0) rozmiar porcji danych.
  • ERR_INCORRECT_SELLER_ID
    Niepoprawny (< 0) identyfikator sprzedającego.
  • 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).