Dokumentacja

Konta bankowe

Zarządzanie kontami bankowymi należącymi do użytkownika

Definicja

Obiekt BankAccount zawiera następujące klucze:

Parametr Typ danych Wymagany Opis
id integer Tylko do odczytu ID konta bankowego
bank_name string Tak Nazwa banku
account_number string Tak Numer konta
swift string Nie Numer swift
default boolean Nie Konto domyślne: true lub false. Domyślnie: false

Listowanie kont bankowych

GET /v3/bank_accounts.json

Akcja listowania zwraca odpowiedź zawierającą tablicę obiektów pod kluczem entities oraz informacje pomocnicze dotyczące stronicowania. Domyślne sortowanie dla zwracanej tablicy odbywa się rosnąco przy użyciu pola bank_name.

Dodatkowo, na zbiorze danych można wykonywać następujące operacje:

Przykład akcji listowania:

Przykład curl

curl -H "X-inFakt-ApiKey: 49206c6f766520496e66616b74203a3e" \
  https://api.infakt.pl/v3/bank_accounts.json

Przykładowa odpowiedź

{
  "metainfo": {
    "count": 2,
    "total_count": 2,
    "next": "https://api.infakt.pl/api/v3/bank_accounts.json?offset=10",
    "previous": "https://api.infakt.pl/api/v3/bank_accounts.json?offset=0"
  },
  "entities": [{
    "id": 17,
    "bank_name": "Bank 0",
    "account_number": "70102010130000010200026526"
    ...
  }, {
    "id": 16,
    "bank_name": "Bank 1",
    ...
  }]
}

Możliwe kody odpowiedzi:

Kod odpowiedzi Opis
200 Zapytanie zostało wykonane poprawnie
401 Brak autoryzacji lub uprawnień do danego zasobu

Tworzenie

POST /v3/bank_accounts.json

Tworzenie

curl -H "X-inFakt-ApiKey: 49206c6f766520496e66616b74203a3e" \
  -H "Content-Type: application/json" \
  -X POST
  -d '{"bank_account":{"bank_name":"Example bank"}}' \
  https://api.infakt.pl/v3/bank_accounts.json

Możliwe kody odpowiedzi:

Kod odpowiedzi Opis
201 Zasób został poprawnie utworzony
422 Zwracany wraz z informacją o błędach w przypadku problemów z zasobem.

Aktualizacja konta bankowego

PUT /v3/bank_accounts.json

Aktualizacja

curl -H "X-inFakt-ApiKey: 49206c6f766520496e66616b74203a3e" \
  -H "Content-Type: application/json" \
  -X PUT \
  -d '{"bank_account":{"bank_name":"Example bank"}}' \
  https://api.infakt.pl/v3/bank_accounts/1.json

Możliwe kody odpowiedzi:

Kod odpowiedzi Opis
200 Zapytanie zostało wykonane poprawnie
422 Zwracany wraz z informacją o błędach w przypadku problemów z zasobem.

Usuwanie konta bankowego

DELETE /v3/bank_accounts.json

Usuwanie

curl -H "X-inFakt-ApiKey: 49206c6f766520496e66616b74203a3e" \
    -X DELETE \
    https://api.infakt.pl/v3/bank_accounts/1.json

Możliwe kody odpowiedzi:

Kod odpowiedzi Opis
204 Zwracany po poprawnym usunięciu zasobu.
401 Brak autoryzacji lub uprawnień do danego zasobu
comments powered by Disqus