Allegro WebAPI

Interfejs programistyczny platformy Allegro

doGetMyPaymentsInfo

Tematyka: Allegro Finanse
Ostatnia zmiana: 01.09.2011 r.
Dostępność:
Metoda pozwala na pobieranie kompletu informacji dot. ustawień Allegro Finanse z konta zalogowanego użytkownika.

  1. session-id | string | wymagany
    Identyfikator sesji użytkownika, uzyskany za pomocą metody doLogin(Enc).



Orientacyjna struktura wywołania metody

$dogetmypaymentsinfo_request = array(
   'session-id' => '22eb99326c6be29aa16d07d622bcfbcbee94ad54846f2f4e03_1'
);

  1. payments-info | PaymentsInfoStruct
    Struktura z ustawieniami Allegro Finanse zalogowanego użytkownika.
    1. payments-balance | float
      Saldo konta.
    2. payments-bank-account | string
      Rachunek bankowy, na który przelewane są środki z konta Allegro Finanse.
    3. payments-user-data | PaymentsUserDataStruct
      Dane osobowe właściciela konta.
      1. user-full-name | string
        Imię i nazwisko użytkownika.
      2. user-address | string
        Adres użytkownika.
      3. user-postcode | string
        Kod pocztowy użytkownika.
      4. user-city | string
        Miejscowość użytkownika.
      5. user-country | int
        Identyfikator kraju użytkownika.
      6. user-phone | string
        Numer telefonu użytkownika.
    4. payments-payout | PaymentsPayoutStruct
      Struktura z informacjami o wypłatach.
      1. payout-type | int
        Wybrana opcja wypłat (1 - automatyczne, 2 - na żądanie).
      2. payout-auto-settings | PayoutAutoSettingsStruct
        Struktura z dodatkowymi informacjami dla wypłat automatycznych.
        1. payout-auto-amount | float
          Minimalna kwota dla wypłat automatycznych.
        2. payout-auto-frequency | PayoutAutoFrequencyStruct
          Struktura z informacjami o częstotliwości wypłat automatycznych.
          1. frequency-type | int
            Częstotliwość wypłat automatycznych (1 - w każdy dzień roboczy, 2 - raz w tygodniu, 3 - raz w miesiącu, 4 – niestandardowa (dla wypłat realizowanych przekazem pocztowym lub na konta zagraniczne: 14 dnia miesiąca, o ile wartość zgromadzonych środków przekroczy 100 zł lub ostatniego dnia miesiąca, niezależnie od kwoty, całość zgromadzonych środków)).
          2. frequency-week-value | int
            Ustalony dzień tygodnia dla wypłat, w przypadku gdy frequency-type = 2 (1 - pon, 2 - wt, ..., 7 - nd). Dla pozostałych frequency-type w polu zwracane jest 0.
          3. frequency-month-value | int
            Ustalony dzień miesiąca dla wypłat, w przypadku gdy frequency-type = 3 (-1 - ostatni dzień miesiąca, 1-31 - poszczególne dni miesiąca). Dla pozostałych frequency-type w polu zwracane jest 0.
    5. payments-notifications | int
      Informacja o włączonych powiadomieniach dot. Allegro Finanse (maska: 1 - e-mail o wpłacie od kupującego, 2 - e-mail o wypłacie, 4 - miesięczne zestawienie płatności).



Orientacyjna struktura wywołania metody

$dogetmypaymentsinfo_response = array(
   'payments-info' => array(
      'payments-balance' => 9.99,
      'payments-bank-account' => 'PL 08 1140 2004 0000 3452 6875 5449',
      'payments-user-data' => array(
         'user-full-name' => 'Jan Kowalski',
         'user-address' => 'os. Przyjaźni 53/8',
         'user-postcode' => '61-629',
         'user-city' => 'Poznań'
         'user-country' => 1,
         'user-phone' => '+48600100200'),
      'payments-payout' => array(
         'payout-type' => 1,
         'payout-auto-settings' => array(
            'payout-auto-amount' => 100.00,
            'payout-auto-frequency' => array(
               'frequency-type' => 2,
               'frequency-week-value' => 5,
               'frequency-month-value' => 0))),
      'payments-notifications' => 3)
);

  • ERR_NEW_PAYMENT_INTERNAL_ERROR
    Wewnętrzny błąd systemu związany z pobieraniem transakcji Allegro Finanse.
  • ERR_NEW_PAYMENTS_NOT_CONFIGURED
    Brak aktywnego konta w ramach 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).