Allegro WebAPI

Interfejs programistyczny platformy Allegro

doGetMyIncomingPayments

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

Metoda pozwala na pobranie listy wpłat od kupujących (dokonanych za pośrednictwem PayU, zakończonych) za transakcje w ramach ofert 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:

  • buyerId - Użytkownik dokonujący wpłaty
  • itemId - Oferta, której wpłaty dotyczą
  • transRecvDateFrom/transRecvDateTo - 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 w transRecvDateFrom podstawiona zostanie konkretna wartość, a w transRecvDateTo przekazane zostanie 0:

  • transRecvDateFrom 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).
  • transRecvDateTo zostanie ustawiony na mniejszą wartość z:
    • daty przekazanej w transRecvDateFrom + 7 dni (1463011200 - 12.05.2016 00:00:00)
    • dnia następnego od dnia przekazanego w transRecvDateFrom (1462492800 - 06.05.2016 00:00:00) czyli w typ przypadku wartość transRecvDateTo wyniesie: 1462492800.

W przypadku odwrotnym (gdy w transRecvDateFrom przekazane zostanie 0, a w transRecvDateTo podstawiona zostanie konkretna wartość):

  • transRecvDateTo 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)
  • transRecvDateFrom zostanie ustawiony na większą wartość z:
    • zera (0)
    • wartość transRecvDateTo - 7 dni (1461974400 - 30.04.2016 00:00:00) czyli w tym przypadku wartość transRecvDateFrom 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:

  • transRecvDateFrom zostanie ustawiony na 1462406400 (05.05.2016 00:00:00)
  • transRecvDateTo zostanie ustawiony 1462579200 (07.05.2016 00:00:00).

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

  • W przypadku gdy za datę początkową zakresu czasu (transRecvDateFrom) podstawiona zostanie konkretna wartość, a dla daty końcowej zakresu czasu (transRecvDateTo) przekazane zostanie 0, zwrócona zostanie lista wpł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 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-handle | string | wymagany
    Identyfikator sesji użytkownika, uzyskany za pomocą metody doLogin(Enc).
  2. buyer-id | int | niewymagany
    Identyfikator kupującego, którego 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. trans-recv-date-from | long | niewymagany
    Data początkowa zakresu czasu (w formacie Unix time), od którego ma zostać pobrana lista wpłat.
  5. trans-recv-date-to | long | niewymagany
    Data końcowa zakresu czasu (w formacie Unix time), do którego ma zostać pobrana lista wpłat.
  6. trans-page-limit | int | niewymagany
    Rozmiar porcji danych (zakres 1-25, domyślnie: 25).
  7. trans-offset | 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 transRecvDateFrom i transRecvDateTo (0 - nie, 1 - tak).



Orientacyjna struktura wywołania metody

$dogetmyincomingpayments_request = array(
   'session-handle' => '22eb99326c6be29aa16d07d622bcfbcbee94ad54846f2f4e03_1',
   'buyer-id' => 0,
   'item-id' => 0,
   'trans-recv-date-from' => 1269129600,
   'trans-recv-date-to' => 0,
   'trans-page-limit' => 0,
   'trans-offset' => 0
   'stricted-search' => 0
);

  1. pay-trans-income | UserIncomingPaymentStruct[]
    Tablica struktur zawierających informacje o wpłatach użytkowników.
    1. pay-trans-id | long
      Identyfikator transakcji.
    2. pay-trans-it-id | long
      Identyfikator oferty (lub 0 dla wpłat łacznych, dla których informacje o poszczególnych ofertach znajdują się w strukturze pay-trans-details).
    3. pay-trans-buyer-id | int
      Identyfikator kupującego.
    4. 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 PayU), Płacę przy odbiorze).
    5. pay-trans-status | string
      Status transakcji PayU (listę wszystkich możliwych statusów dla wpłat podejrzeć można tutaj).
    6. pay-trans-amount | float
      Wysokość kwoty wpłaty użytkownika.
    7. pay-trans-create-date | long
      Data utworzenie transakcji PayU (w formacie Unix time).
    8. pay-trans-recv-date | long
      Data zakończenia transakcji PayU (w formacie Unix time).
    9. pay-trans-price | float
      Wartość przedmiotów zakupionych przez użytkownika w ramach danej oferty (lub ofert - dla wpłat łącznych) i opłaconych w ramach danej transakcji PayU (lub 0 w przypadku dopłaty).
    10. pay-trans-count | int
      Liczba przedmiotów zakupionych przez użytkownika w ramach danej oferty i opłaconych w ramach danej transakcji PayU (lub 0 w momencie wpłaty łącznej lub w przypadku dopłaty).
    11. pay-trans-postage-amount | float
      Łączne koszta wybranego przez użytkownika sposobu dostawy, opłacone w ramach transakcji PayU (lub 0 w przypadku dopłaty).
    12. pay-trans-details | PaymentDetailsStruct[]
      Tablica struktur zawierających informacje dot. ofert składających się na wpłatę łączną.
      1. pay-trans-details-it-id | long
        Identyfikator oferty.
      2. pay-trans-details-price | float
        Wartość przedmiotu zakupionego przez użytkownika w ramach danej oferty i opłaconego w ramach danej transakcji PayU.
      3. pay-trans-details-count | int
        Liczba przedmiotów zakupionych przez użytkownika w ramach danej oferty i opłaconych w ramach danej transakcji PayU.
    13. pay-trans-incomplete | int
      Informacja o kompletności wpłaty (1 - wpłata niekompletna, 0 - wpłata kompletna).
    14. pay-trans-main-id | int
      Identyfikator transakcji głównej (dla dopłat); 0 jeśli sprawdzana transakcja nie jest dopłatą).



Orientacyjna struktura odpowiedzi serwera

$dogetmyincomingpayments_response = array(
   'pay-trans-income' => array(
      array(
         'pay-trans-id' => 3381748,
         ' pay-trans-it-id' => 0,
         ' pay-trans-buyer-id' => 2580451,
         ' pay-trans-type' => 'Karta płatnicza',
         ' pay-trans-status' => 'Zakończona',
         ' pay-trans-amount' => 6.00,
         ' pay-trans-create-date' => 1269616926,
         ' pay-trans-recv-date' => 1269618127,
         ' pay-trans-price' => 6.00,
         ' pay-trans-count' => 0,
         ' pay-trans-postage-amount' => 0.00,
         ' pay-trans-details => array(
            array(
               ' pay-trans-details-it-id' => 972090662,
               ' pay-trans-details-price' => 1.00,
               ' pay-trans-details-count' => 1),
            array(
               ' pay-trans-details-it-id' => 916649765,
               ' pay-trans-details-price' => 5.00,
               ' pay-trans-details-count' => 1),
         ' pay-trans-incomplete' => 0,
         ' pay-trans-main-id' => 0 ),
      array(
         ' pay-trans-id' => 2970725,
         ' pay-trans-it-id' => 946792459,
         ' pay-trans-buyer-id' => 1510558,
         ' pay-trans-type' => 'iPKO BP',
         ' pay-trans-status' => 'Zakończona',
         ' pay-trans-amount' => 64.50,
         ' pay-trans-create-date' => 1269266038,
         ' pay-trans-recv-date' => 1269266231,
         ' pay-trans-price' => 50.00,
         ' pay-trans-count' => 1,
         ' pay-trans-postage-amount' => 14.50,
         ' pay-trans-details' => array(),
         ' pay-trans-incomplete' => 0,
         ' pay-trans-main-id' => 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_BUYER_ID
    Niepoprawny (< 0) identyfikator kupującego.
  • 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_NEW_PAYMENT_INTERNAL_ERROR
    Wewnętrzny błąd systemu związany z pobieraniem transakcji PayU.
  • 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).
  • ERR_YOU_NOT_SOLD_THIS_ITEM
    Zalogowany użytkownik nie był sprzedającym w podanej ofercie.

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.