Pobranie danych transakcji | imoje API documentation

Pobranie danych transakcji Run in API Explorer

GET /{merchantId}/transaction/{transactionId}

Zapytanie umożliwia pobranie wszystkich niezbędnych danych transakcji.

Dane z banku płatnika

Za pomocą tego zapytania uzyskasz również oryginalne dane z banku płatnika dla szybkich przelewów online (pbl) oraz przelewu tradycyjnego (wt). W środowisku sandbox nie jest możliwe pobranie danych z banku płatnika z przyczyn technicznych.

Jeżeli danych z banku płatnika nie ma natychmiast po transakcji, API powinno ponawiać próby pobrania tych danych w kilkugodzinnych interwałach (w skrajnych sytuacjach dane mogą być dostępne nawet po 24h roboczych).

Path parameters

merchantId string Required

Identyfikator klienta
transactionId string(uuid) Required

Identyfikator transakcji jako UUID v4

Maximum length is 36. Format should match the following pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$.

Responses

200 application/json

Zapytanie wykonane poprawnie
Hide response attributes Show response attributes object
- transaction object Required
  
  Dane transakcji
  
  Hide transaction attributes Show transaction attributes object
  
  id string(uuid) Required
  
  Identyfikator transakcji jako UUID v4
  
  Maximum length is 36. Format should match the following pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$.
  
  type string Required
  
  Typ transakcji
  
  Values are sale or refund.
  
  status string Required
  
  Status
  
  Values are new, pending, settled, authorized, rejected, cancelled, or error.
  
  source string Required
  
  Żródło transakcji
  
  Values are web or api.
  
  created integer | null Required
  
  Data utworzenia jako timestamp
  
  modified integer | null Required
  
  Data modyfikacji jako timestamp
  
  notificationUrl string(uri) Required
  
  Dynamiczny adres notyfikacji, możliwość ustawienia konkretnego adresu dla pojedynczej transakcji. Adresy zawierające localhost oraz porty zostaną odrzucone.
  
  Maximum length is 300.
  
  serviceId string(uuid) Required
  
  Identyfikator sklepu jako UUID v4
  
  Maximum length is 36. Format should match the following pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$.
  
  amount integer Required
  
  Kwota transakcji w najmniejszej jednostce waluty np. grosze.
  
  currency string Required
  
  Waluta transakcji w standardzie ISO 4217
  
  Maximum length is 3. Values are PLN, EUR, USD, GBP, CHF, SEK, HUF, CZK, BGN, or RON.
  
  title string Required
  
  Tytuł transakcji
  
  Maximum length is 255. Format should match the following pattern: ^[A-Za-z0-9#&_\-\,\.\\\\/ \u00C0-\u02C0"']+$.
  
  orderId string Required
  
  Numer zamówienia
  
  Maximum length is 100. Format should match the following pattern: ^[A-Za-z0-9#_\-\.\\\\/ \u00C0-\u02C0]+$.
  
  paymentMethod string Required
  
  Oznaczenie metody płatności
  
  Values are blik, pbl, ing, card, wallet, imoje_paylater, wt, or imoje_installments.
  
  paymentMethodCode string Required
  
  Oznaczenie kanału płatności
  
  Values are blik, imoje_twisto, paypo, blik_paylater, pragma_go, gpay, applepay, visa_mobile, paypal, ecom3ds, oneclick, recurring, ing, mtransfer, bzwbk, pekao24, inteligo, ipko, getin, noble, creditagricole, alior, millennium, citi, bos, bnpparibas, pocztowy, plusbank, bs, bspb, nest, pbs, cs, mp, kb, rf, pg, pf, cb, uc, posta, sporo, tatra, viamo, vub, wt, wt_split, inbank, or inbank_0.
  
  refunds array[object]
  
  Hide refunds attribute Show refunds attribute object
  
  transaction object
  
  Hide transaction attributes Show transaction attributes object
  
  id string(uuid)
  
  Identyfikator transakcji jako UUID v4
  
  Maximum length is 36. Format should match the following pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$.
  
  type string
  
  Typ transakcji
  
  Value is refund.
  
  status string
  
  Status
  
  Values are new, pending, settled, authorized, rejected, cancelled, or error.
  
  source string
  
  Żródło transakcji
  
  Values are web or api.
  
  created integer | null
  
  Data utworzenia jako timestamp
  
  modified integer | null
  
  Data modyfikacji jako timestamp
  
  serviceId string(uuid)
  
  Identyfikator sklepu jako UUID v4
  
  Maximum length is 36. Format should match the following pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$.
  
  amount integer
  
  Kwota transakcji w najmniejszej jednostce waluty np. grosze.
  
  currency string
  
  Waluta transakcji w standardzie ISO 4217
  
  Maximum length is 3. Values are PLN, EUR, USD, GBP, CHF, SEK, HUF, CZK, BGN, or RON.
  
  title string
  
  Tytuł transakcji
  
  Maximum length is 255. Format should match the following pattern: ^[A-Za-z0-9#&_\-\,\.\\\\/ \u00C0-\u02C0"']+$.
  
  orderId string
  
  Numer zamówienia
  
  Maximum length is 100. Format should match the following pattern: ^[A-Za-z0-9#_\-\.\\\\/ \u00C0-\u02C0]+$.
  
  paymentMethod string
  
  Oznaczenie metody płatności
  
  Values are blik, pbl, ing, card, wallet, imoje_paylater, wt, or imoje_installments.
  
  paymentMethodCode string
  
  Oznaczenie kanału płatności
  
  Values are blik, imoje_twisto, paypo, blik_paylater, pragma_go, gpay, applepay, visa_mobile, paypal, ecom3ds, oneclick, recurring, ing, mtransfer, bzwbk, pekao24, inteligo, ipko, getin, noble, creditagricole, alior, millennium, citi, bos, bnpparibas, pocztowy, plusbank, bs, bspb, nest, pbs, cs, mp, kb, rf, pg, pf, cb, uc, posta, sporo, tatra, viamo, vub, wt, wt_split, inbank, or inbank_0.
  
  payment object Required
  
  Hide payment attributes Show payment attributes object
  
  id string(uuid)
  
  Identyfikator linku płatności jako UUID v4
  
  Maximum length is 36. Format should match the following pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$.
  
  status string
  
  Status
  
  Values are new, pending, settled, authorized, rejected, cancelled, or error.
  
  blikTransactionId string
  
  Identyfikator transakcji BLIK
  
  statusCode string
  
  Kod statusu transakcji
  
  statusCodeDescription string
  
  Opis kodu statusu transakcji
  
  fee object
  
  Wartość naliczonej prowizji. Opcja nie jest domyślnie włączona. Jeśli chcesz włączyć to rozwiązanie u siebie w sklepie, to skontaktuj się z nami pod adresem kontakt.tech@imoje.pl.
  
  Hide fee attributes Show fee attributes object
  
  merchant integer
  
  Wartość prowizji
  
  surcharge integer
  
  Wartość opłaty serwisowej
  
  payerData object
  
  Oryginalne dane z banku płatnika. Zwracane tylko dla zrealizowanych transakcji poprzez szybki przelew online lub przelew tradycyjny.
  
  Hide payerData attributes Show payerData attributes object
  
  name string
  
  Nazwa i adres płatnika
  
  account string
  
  Numer rachunku płatnika
  
  payerCardData object
  
  Dane karty płatniczej użytej w transakcji
  
  Hide payerCardData attributes Show payerCardData attributes object
  
  brand string
  
  Organizacja karty płatniczej
  
  bin string
  
  Numer BIN karty płatniczej.
  
  last4 string
  
  Ostatnie 4 znaki numeru karty płatniczej.
  
  type string
  
  Typ karty płatniczej.
  
  Values are DEBIT or CREDIT.
  
  countryCodeAlpha2 string
  
  Kod kraju Alpha2, w którym została wydana karta płatnicza.
  
  countryCodeAlpha3 string
  
  Kod kraju Alpha3, w którym została wydana karta płatnicza.
  
  countryName string
  
  Nazwa kraju, w którym została wydana karta płatnicza.
  
  firstTransactionId string
  
  Zewnętrzny identyfikator transakcji rejestrującej. Wymagany przy obciążaniu karty w płatnościach OneClick i rekurencyjnej bez profilu.
  
  paidAmount integer
  
  Wartość wpłaconych środków w przypadku przelewu tradycyjnego
- action object
  
  Opis akcji, jaką należy podjąć w ramach danej transakcji.
  
  Hide action attributes Show action attributes object
  
  type string Required
  
  Rodzaj akcji, jaką należy podjąć w ramach danej transakcji.
  
  Values are redirect or transfer.
  
  url string
  
  Adres przekierowania do płatności.
  
  method string
  
  Metoda przekierowania do płatności.
  
  Values are GET or POST.
  
  contentType string
  
  Typ zawartości przekierowania.
  
  contentBodyRaw string
  
  Zawartość przekierowania.
  
  ban string
  
  Numer rachunku do przelewu tradycyjnego dla typu transfer.
  
  title string
  
  Tytuł do przelewu tradycyjnego dla typu transfer.

GET /{merchantId}/transaction/{transactionId}

curl \
 --request GET 'https://sandbox.api.imoje.pl/v1/merchant/{merchantId}/transaction/{transactionId}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "id": "140bb320-4699-4089-986b-93701cee055a",
  "type": "sale",
  "title": "yourTitle",
  "amount": 10000,
  "source": "api",
  "status": "settled",
  "created": 1735686000,
  "orderId": "yourOrderId",
  "payment": {
    "id": "140bb320-4699-4089-986b-93701cee055a",
    "status": "settled"
  },
  "currency": "PLN",
  "modified": 1735686000,
  "serviceId": "01627e4e-79d0-459a-a40b-3f64f2887499",
  "paymentMethod": "blik",
  "notificationUrl": "https://yourshopdomain.com/notification",
  "blikTransactionId": "11111111111",
  "paymentMethodCode": "blik"
}