Strona korzysta z plików cookies w celu realizacji usług. Jeżeli nie zmienisz ustawień, będą one zapisywane w pamięci Twojego urządzenia.
Allegro WebAPI
doGetMyPayoutsDetails
Za pomocą tej metody pobierzesz szczegółowy raport wypłat środków z konta Allegro Finanse w Allegro.
Do wywołania metody koniecznie podaj identyfikator transakcji Allegro Finanse w polu payoutId. Numer ten możesz uzyskać po wcześniejszym wywołaniu metody doGetMyPayouts.
Szczegółowy raport w odpowiedzi metody doGetMyPayoutsDetails zawiera: listę płatności (payments), listę zwrotów od użytkowników (refundFrom), listę zwrotów do użytkowników (refundTo).
Za pomocą tej metody pobierzesz szczegółowy raport wypłat środków z konta Allegro Finanse w Allegro.
Do wywołania metody koniecznie podaj identyfikator transakcji Allegro Finanse w polu payoutId. Numer ten możesz uzyskać po wcześniejszym wywołaniu metody doGetMyPayouts.
Szczegółowy raport w odpowiedzi metody doGetMyPayoutsDetails zawiera: listę płatności (payments), listę zwrotów od użytkowników (refundFrom), listę zwrotów do użytkowników (refundTo).
- sessionId | string | wymagany
Identyfikator sesji użytkownika, uzyskany za pomocą metody doLogin(Enc). - payoutId | int | wymagany
Identyfikator raportu składającego się na realizowaną wypłatę uzyskany za pomocą metody doGetMyPayouts, w polu payTransId. - limit | int | niewymagany
Rozmiar porcji danych (min. 1, maks. 1000; podanie wartości spoza zakresu powoduje ustawienie rozmiaru na wartość domyślną: 100). - offset | int | niewymagany
Sterowanie (poprzez inkrementację przekazywanej wartości) pobieraniem kolejnych danych (numery kolejnych wyników indeksowane są od 0, każda kolejna wartość w polu offset będzie oznaczać zwrócenie wyników od danego itema w kolejności).
Orientacyjna struktura wywołania metody
$doGetMyPayoutsDetails_request = array(
'sessionId' => '22eb99326c6be29aa16d07d622bcfbcbee94ad54846f2f4e03_1',
'payoutId' => 105573764
'limit' => 3,
'offset' => 100
);
- sessionId | string | wymagany
Identyfikator sesji użytkownika, uzyskany za pomocą metody doLogin(Enc). - payoutId | int | wymagany
Identyfikator raportu składającego się na realizowaną wypłatę uzyskany za pomocą metody doGetMyPayouts, w polu payTransId. - limit | int | niewymagany
Rozmiar porcji danych (min. 1, maks. 1000; podanie wartości spoza zakresu powoduje ustawienie rozmiaru na wartość domyślną: 100). - offset | int | niewymagany
Sterowanie (poprzez inkrementację przekazywanej wartości) pobieraniem kolejnych danych (numery kolejnych wyników indeksowane są od 0, każda kolejna wartość w polu offset będzie oznaczać zwrócenie wyników od danego itema w kolejności).
Orientacyjna struktura wywołania metody
$doGetMyPayoutsDetails_request = array(
'sessionId' => '22eb99326c6be29aa16d07d622bcfbcbee94ad54846f2f4e03_1',
'payoutId' => 105573764
'limit' => 3,
'offset' => 100
);
-
paymentsCount | int
Liczba płatności wchodzących w skład danej wypłaty. -
payments | PayoutPaymentsStruct
Tablica struktur zawierających informacje o płatnościach.- transactionId | long
Identyfikator formularza płatności - userName | string
Imię i nazwisko kupującego użytkownika - userId | long
Identyfikator kupującego - amount | float
Wartość towaru kupionego przez danego użytkownika - transportAmount | float
Cena wybranej opcji transportu - totalAmount | long
Suma ceny towaru i kosztu przesyłki - paidDate | string
Data dokonania płatności
- transactionId | long
-
refundsFromCount | int
Liczba zwrotów od innych użytkowników w ramach wypłaty Allegro Finanse. -
refundsFrom | PayoutRefundFromStruct
Tablica struktur zawierających informacje o zwrotach od innych użytkowników.- transactionId | long
Identyfikator formularza płatności - refundId | long
Identyfikator zwrotu wpłaty - refundReason | string
Powód zwrotu płatności - itemId | long
Numer oferty, której dotyczy zwrot - toUserId | long
Identyfikator Użytkownika, od którego został wysłany zwrot - amount | float
Kwota zwrotu - paidDate | string
Data dokonania zwrotu
- transactionId | long
-
refundsToCount | int
Liczba zwrotów do innych użytkowników w ramach wypłaty Allegro Finanse. -
refundsTo | PayoutRefundToStruct
Tablica struktur zawierających informacje o zwrotach do innych użytkowników.- transactionId | long
Identyfikator formularza płatności - refundId | long
Identyfikator zwrotu wpłaty - refundReason | string
Powód zwrotu płatności - itemId | long
Numer oferty, której dotyczy zwrot - toUserId | long
Identyfikator Użytkownika, do którego został wysłany zwrot - amount | float
Kwota zwrotu - paidDate | string
Data dokonania zwrotu
- transactionId | long
Orientacyjna struktura odpowiedzi serwera
dogetmypayoutsdetails_response = array(
'paymentsCount' => 1,
'payments' = array (
'transactionId' => 682090909,
'userName' => 'Jan Nowak',
'userId' => 880909,
'amount' => 400.88,
'transportAmount' => 0,
'totalAmount'=> 400.88,
'paidDate' => '2017-02-28 13:35:08'),
'refundsFromCount' => 1,
'refundsFrom' = array (
'transactionId' => 641557012,
'refundId' => 6687644,
'refundReason' => 'Odstąpienie od umowy',
'itemId' => 476876,
'toUserId' => 43287,
'amount'=> 40.01,
'paidDate' => '2017-03-01 12:35:08'),
'refundsToCount' => 0
);
-
paymentsCount | int
Liczba płatności wchodzących w skład danej wypłaty. -
payments | PayoutPaymentsStruct
Tablica struktur zawierających informacje o płatnościach.- transactionId | long
Identyfikator formularza płatności - userName | string
Imię i nazwisko kupującego użytkownika - userId | long
Identyfikator kupującego - amount | float
Wartość towaru kupionego przez danego użytkownika - transportAmount | float
Cena wybranej opcji transportu - totalAmount | long
Suma ceny towaru i kosztu przesyłki - paidDate | string
Data dokonania płatności
- transactionId | long
-
refundsFromCount | int
Liczba zwrotów od innych użytkowników w ramach wypłaty Allegro Finanse. -
refundsFrom | PayoutRefundFromStruct
Tablica struktur zawierających informacje o zwrotach od innych użytkowników.- transactionId | long
Identyfikator formularza płatności - refundId | long
Identyfikator zwrotu wpłaty - refundReason | string
Powód zwrotu płatności - itemId | long
Numer oferty, której dotyczy zwrot - toUserId | long
Identyfikator Użytkownika, od którego został wysłany zwrot - amount | float
Kwota zwrotu - paidDate | string
Data dokonania zwrotu
- transactionId | long
-
refundsToCount | int
Liczba zwrotów do innych użytkowników w ramach wypłaty Allegro Finanse. -
refundsTo | PayoutRefundToStruct
Tablica struktur zawierających informacje o zwrotach do innych użytkowników.- transactionId | long
Identyfikator formularza płatności - refundId | long
Identyfikator zwrotu wpłaty - refundReason | string
Powód zwrotu płatności - itemId | long
Numer oferty, której dotyczy zwrot - toUserId | long
Identyfikator Użytkownika, do którego został wysłany zwrot - amount | float
Kwota zwrotu - paidDate | string
Data dokonania zwrotu
- transactionId | long
Orientacyjna struktura odpowiedzi serwera
dogetmypayoutsdetails_response = array(
'paymentsCount' => 1,
'payments' = array (
'transactionId' => 682090909,
'userName' => 'Jan Nowak',
'userId' => 880909,
'amount' => 400.88,
'transportAmount' => 0,
'totalAmount'=> 400.88,
'paidDate' => '2017-02-28 13:35:08'),
'refundsFromCount' => 1,
'refundsFrom' = array (
'transactionId' => 641557012,
'refundId' => 6687644,
'refundReason' => 'Odstąpienie od umowy',
'itemId' => 476876,
'toUserId' => 43287,
'amount'=> 40.01,
'paidDate' => '2017-03-01 12:35:08'),
'refundsToCount' => 0
);
- ERR_INCORRECT_RESULT_SIZE
Niepoprawna wartość rozmiaru porcji danych (spoza zakresu 1-1000). - ERR_INCORRECT_RESULT_OFFSET
Niepoprawna wartość offsetu (mniejsza od 0). - 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_INTERNAL_SYSTEM_ERROR
Wewnętrzny błąd serwera.
- ERR_INCORRECT_RESULT_SIZE
Niepoprawna wartość rozmiaru porcji danych (spoza zakresu 1-1000). - ERR_INCORRECT_RESULT_OFFSET
Niepoprawna wartość offsetu (mniejsza od 0). - 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_INTERNAL_SYSTEM_ERROR
Wewnętrzny błąd serwera.
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.
Korzystanie z serwisu oznacza akceptację regulaminu