Allegro WebAPI

Interfejs programistyczny platformy Allegro

doGetMyPaymentsRefunds

Tematyka: Allegro Finanse
Ostatnia zmiana: 10.11.2011 r.
Dostępność:
Metoda pozwala na pobranie listy zwrotów (wycofanych wpłat dokonanych za pośrednictwem Allegro Finanse) za transakcje zrealizowane przez zalogowanego użytkownika. Okres czasu, dla jakiego metoda zwraca dane to ok. 90 dni. W przypadku przekazania identyfikatora użytkownika, który nie istnieje - zwracana jest pusta struktura.

  1. session-handle | string | wymagany
    Identyfikator sesji użytkownika, uzyskany za pomocą metody doLogin(Enc).
  2. seller-id | int | niewymagany
    Identyfikator sprzedającego, któremu dokonana została wpłata której dotyczy zwrot.
  3. item-id | long | niewymagany
    Identyfikator oferty, której dotyczy zwrot.
  4. limit | int | niewymagany
    Rozmiar porcji danych (min. 1, maks. 25; przesłanie wartości 0 lub wyższej niż maksymalna spowoduje ustawienie rozmiaru porcji na wartość domyślną: 25).
  5. offset | int | niewymagany
    Sterowanie (poprzez inkrementację przekazywanej wartości) pobieraniem kolejnych porcji danych (numery porcji indeksowane są od 0).



Orientacyjna struktura wywołania metody

$dogetmypaymentsrefunds_request = array(
   'session-handle' => '22eb99326c6be29aa16d07d622bcfbcbee94ad54846f2f4e03_1',
   'seller-id' => 0,
   'item-id' => 0,
   'limit' => 0,
   'offset' => 0
);

  1. pay-trans-payment-refunds | UserPaymentRefundsStruct[]
    Tablica struktur zawierających informacje o zwrotach zalogowanego użytkownika.
    1. pay-refund-trans-id | long
      Identyfikator transakcji Allegro Finanse.
    2. pay-refund-it-id | long
      Identyfikator oferty (lub 0 dla zwrotu kwoty dodatkowej).
    3. pay-refund-seller-id | int
      Identyfikator sprzedającego.
    4. pay-refund-value | float
      Wartość kwoty zwrotu.
    5. pay-refund-reason | string
      Treść powodu zwrotu.
    6. pay-refund-date | long
      Data zwrotu (w formacie Unix time).



Orientacyjna struktura odpowiedzi serwera

$dogetmypaymentsrefunds_response = array(
   'pay-trans-payment-refunds' => array(
      array(
         'pay-refund-trans-id' => 1964852,
         'pay-refund-it-id' => 891436088,
         'pay-refund-seller-id' => 2907979,
         'pay-refund-value' => 54.00,
         'pay-refund-reason' => 'Towar niedostępny',
         'pay-refund-date' => 1264636263))
);


  • 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).

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.