Utworzenie transakcji | imoje API documentation

Utworzenie transakcji Run in API Explorer

POST /{merchantId}/transaction

Zapytanie umożliwia utworzenie transakcji dla wybranego kanału w ramach danej metody płatności z bezpośrednim przekierowaniem lub w przypadku niektórych metod (karty płatnicze, BLIK z przekazanym kodem) - z natychmiastową realizacją po autoryzacji płatności przez płatnika.

Tabelę metod i przypisanych do nich kanałów realizacji płatności znajdziesz tutaj tutaj.

Każda nieopłacona transakcja wygaśnie automatycznie po upływie 15 miesięcy od daty jej utworzenia. Jeśli chcesz aby wygasała szybciej, skorzystaj z parametru validTo.

Zgodnie z wymaganiami PCI DSS (ustanowionymi przez organizacje płatnicze) zabronione jest przetwarzanie, przekazywanie czy przechowywanie numerów i innych danych dotyczących kart płatniczych, gdy nie posiadasz odpowiedniego certyfikatu.
Domyślnie transakcje kartowe po API są zablokowane. Jeśli posiadasz właściwy certyfikat PCI DSS i chcesz udostępnić formatkę płatności kartami na stronie Twojego sklepu oraz odblokować możliwość tworzenia transakcji kartowej po API - prosimy o przesłanie certyfikatu wraz z dokumentem PCI AoC oraz PCI SAQ na adres kontakt.tech@imoje.pl.
Jeśli nie masz certyfikatu, ale chcesz udostępniać płatności kartami, skorzystaj z endpointu /payment lub naszego widżetu.

Path parameters

merchantId string Required

Identyfikator klienta

application/json

Body Required

type string Required

Typ transakcji

Value is sale.
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.
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.
successReturnUrl string(uri) Required

Adres powrotu z zewnętrznej strony obsługującej płatność w przypadku dokonania płatności z powodzeniem. Adres musi być zgodny ze standardem URL RFC 3986.

Maximum length is 300.
failureReturnUrl string(uri) Required

Adres powrotu z zewnętrznej strony obsługującej płatność w przypadku wystąpienia błędu płatności. Adres musi być zgodny ze standardem URL RFC 3986.

Maximum length is 300.
notificationUrl string(uri)

Dynamiczny adres notyfikacji, możliwość ustawienia konkretnego adresu dla pojedynczej transakcji. Adresy zawierające localhost oraz porty zostaną odrzucone.

Maximum length is 300.
title string

Tytuł transakcji

Maximum length is 255. Format should match the following pattern: ^[A-Za-z0-9#&_\-\,\.\\\\/ \u00C0-\u02C0"']+$.
additionalDescription string

Szczegóły zamówionych produktów lub usług

Maximum length is 255. Format should match the following pattern: ^[A-Za-z0-9#&_\s\-\,\.\/ \u00C0-\u02C0"']+$.
validTo integer | null

Data ważności transakcji jako timestamp w sekundach. Brak realizacji płatności do tego czasu spowoduje jej anulowanie. Jeżeli nie jest przekazane to transakcja ważna jest do czasu ustawionego w parametrze Aktywność płatności w Panelu Administracyjnym imoje (ustawienia sklepu) lub po upływie 15 miesięcy. Przekazanie parametru validTo= NULL powoduje brak wygaśnięcia transakcji z pominięciem ustawień w parametrze Aktywność płatności na Panelu Administracyjnym imoje (ustawienia sklepu). Minimalny czas ważności linku to 60 sekund.
blikCode string

Kod BLIK pobrany od płatnika

Maximum length is 6.
clientIp string(ipv4, ipv6)

Rzeczywisty adres IP płatnika podany w protokole IPv4 lub IPv6. Wymagany przy podaniu blikCode.
customer object Required

Dane płatnika
Hide customer attributes Show customer attributes object
- firstName string Required
  
  Imię płatnika
  
  Maximum length is 100. Format should match the following pattern: ^[A-Za-z0-9#&_\-\,\.\\\\/ \u00C0-\u02C0\u0400-\u04FF"']+$.
- lastName string Required
  
  Nazwisko płatnika
  
  Maximum length is 100. Format should match the following pattern: ^[A-Za-z0-9#&_\-\,\.\\\\/ \u00C0-\u02C0\u0400-\u04FF"']+$.
- email string(email) Required
  
  Adres e-mail płatnika w formacie zgodnym ze standardem RFC 5322 oraz RFC 6531
  
  Maximum length is 200.
- phone string
  
  Numer telefonu płatnika
  
  Maximum length is 20. Format should match the following pattern: ^[0-9\+\- ]+$.
- cid string
  
  Identyfikator płatnika. (Wymagane podczas płatności oneclick, recurring).
  
  Maximum length is 36. Format should match the following pattern: ^[A-Za-z0-9\x2D]+$.
- company string
  
  Nazwa firmy płatnika
  
  Maximum length is 200. Format should match the following pattern: ^[A-Za-z0-9#&_\-\,\.\/ \u00C0-\u02C0"']+$.
- locale string
  
  Maximum length is 2. Values are pl, en, cs, de, es, fr, it, lt, ru, sk, sl, uk, nl, hu, ro, bg, or sv.
billing object

Adres rozliczeniowy płatnika
Hide billing attributes Show billing attributes object
- firstName string Required
  
  Imię płatnika
  
  Maximum length is 100. Format should match the following pattern: ^[A-Za-z0-9#&_\-\,\.\\\\/ \u00C0-\u02C0\u0400-\u04FF"']+$.
- lastName string Required
  
  Nazwisko klienta
  
  Maximum length is 100. Format should match the following pattern: ^[A-Za-z0-9#&_\-\,\.\\\\/ \u00C0-\u02C0\u0400-\u04FF"']+$.
- company string
  
  Nazwa firmy płatnika
  
  Maximum length is 200. Format should match the following pattern: ^[A-Za-z0-9#&_\-\,\.\/ \u00C0-\u02C0"']+$.
- street string
  
  Ulica
  
  Maximum length is 200. Format should match the following pattern: ^[A-Za-z0-9 ]+$.
- city string
  
  Miasto
  
  Maximum length is 100. Format should match the following pattern: ^[A-Za-z0-9 ]+$.
- region string
  
  Region
  
  Maximum length is 100. Format should match the following pattern: ^[A-Za-z0-9 ]+$.
- postalCode string
  
  Kod pocztowy
  
  Maximum length is 30.
- countryCodeAlpha2 string
  
  Kod kraju Alpha2
  
  Maximum length is 2.
- taxId string
  
  Numer identyfikacji podatkowej
  
  Maximum length is 12.
shipping object

Adres dostawy
Hide shipping attributes Show shipping attributes object
- firstName string Required
  
  Imię
  
  Maximum length is 100. Format should match the following pattern: ^[A-Za-z0-9#&_\-\,\.\\\\/ \u00C0-\u02C0\u0400-\u04FF"']+$.
- lastName string Required
  
  Nazwisko
  
  Maximum length is 100. Format should match the following pattern: ^[A-Za-z0-9#&_\-\,\.\\\\/ \u00C0-\u02C0\u0400-\u04FF"']+$.
- company string
  
  Nazwa firmy
  
  Maximum length is 200. Format should match the following pattern: ^[A-Za-z0-9#_\-\,\.\/ \u00C0-\u02C0"']+$.
- street string
  
  Ulica
  
  Maximum length is 200. Format should match the following pattern: ^[A-Za-z0-9 ]+$.
- city string
  
  Miasto
  
  Maximum length is 100. Format should match the following pattern: ^[A-Za-z0-9 ]+$.
- region string
  
  Region
  
  Maximum length is 100. Format should match the following pattern: ^[A-Za-z0-9 ]+$.
- postalCode string
  
  Kod pocztowy
  
  Maximum length is 30.
- countryCodeAlpha2 string
  
  Kod kraju Alpha2
  
  Maximum length is 2.
card object

Dane do płatności kartą
Hide card attributes Show card attributes object
- firstName string Required
  
  Imię posiadacza karty
  
  Maximum length is 100. Format should match the following pattern: ^[A-Za-z0-9#&_\-\.\\\\/ \u00C0-\u02C0\u0400-\u04FF"']+$.
- lastName string Required
  
  Nazwisko posiadacza karty
  
  Maximum length is 100. Format should match the following pattern: ^[A-Za-z0-9#&_\-\,\.\\\\/ \u00C0-\u02C0\u0400-\u04FF"']+$.
- number string Required
  
  Numer karty
  
  Maximum length is 16.
- month string Required
  
  Ważność karty - miesiąc
  
  Maximum length is 2.
- year string Required
  
  Ważność karty - rok
  
  Maximum length is 2.
- cvv string Required
  
  Kod cvv karty
  
  Maximum length is 4.
- firstTransactionId string
  
  Zewnętrzny identyfikator transakcji rejestrującej. Wymagany przy obciążaniu karty w płatnościach OneClick i rekurencyjnej bez profilu.
additionalData object

Informacje o przeglądarce płatnika.
Wymagane podczas wykonywania płatności kartą z autoryzacją 3ds oraz Google Pay i Apple Pay 0 level.
Hide additionalData attributes Show additionalData attributes object
- browser object Required
  
  Informacje na temat przeglądarki płatnika
- browser.ip string(ipv4, ipv6) Required
  
  Adres IP. Dopuszczalne: ipv4, ipv6.
- browser.language string Required
  
  Język przeglądarki określony w formacie UNICODE np. pl-PL
- browser.jsEnabled boolean Required
  
  Określa, czy w przeglądarce włączona jest obsługa JavaScript
- browser.timezoneOffset integer Required
  
  Informacja o strefie czasowej. Dla strefy Europe/Warsaw (+0200) timezoneOffset ma mieć wartość 120, a dla strefy Austalia/Melbourne (+1000) ma mieć wartość 600.
- browser.userAgent string Required
  
  Informacja o używanej aplikacji klienckiej
- browser.accept string Required
  
  Akceptowane wartości przez aplikację
- browser.javaEnabled boolean Required
  
  Określa, czy w przeglądarce włączona jest obsługa Java
- browser.screenColorDepth integer Required
  
  Głębia wyświetlanych kolorów
- browser.screenHeight integer Required
  
  Wysokość okna przeglądarki
- browser.screenWidth integer Required
  
  Szerokość okna przeglądarki
visibleMethod array[string]

Metody płatności widoczne na bramce płatności po zmianie metody/kanału przez płatnika. Jeśli tego pola nie ma lub jest puste to są wyświetlane wszystkie włączone w sklepie metody płatności. Istnieje wiele konfiguracji wyświetlania metod płatności. Należy je zawsze rozdzielać przecinkiem.

Values are pbl, card, wallet, blik, imoje_paylater, wt, lease, or imoje_installments.
data object
Hide data attribute Show data attribute object
- multipayout array[object] Required
  
  Informacje na temat numerów rachunków, na jakie mają zostać wypłacone środki z transakcji.
  Wymagana aktywna funkcja multiwypłat.
  
  W przypadku korzystania z płatności Split Payment, maksymalna dopuszczalna kwota, jaką można przekazać w ramach multiwypłat jest równa kwocie netto zamówienia.
  Hide multipayout attributes Show multipayout attributes object
  
  ban string Required
  
  Numer konta bankowego
  
  Minimum length is 26, maximum length is 26. Format should match the following pattern: ^[0-9]{26}$.
  
  amount integer Required
  
  Kwota transakcji w najmniejszej jednostce waluty np. grosze.
  
  label string Required
  
  Nazwa odbiorcy
  
  Maximum length is 70. Format should match the following pattern: ^[A-Za-z0-9\-\,\. \u00C0-\u02C0"']+$.
  
  title string
  
  Tytuł przelewu.
  Jego obecność powoduje wyodrębnienie danej transakcji na koncie odbiorcy. Podanie parametru dla jednego elementu warunkuje konieczność dostarczenia go dla pozostałych.
  
  Maximum length is 105. Format should match the following pattern: ^[A-Za-z0-9#&_\-\,\.\\\\/ \u00C0-\u02C0"']+$.
invoice object

Dane do faktury wymagane przy aktywnej usłudze ING Księgowość oraz przy płatności Split payment.

Obiekt nie może być użyty, jeśli w sklepie włączona jest opłata serwisowa.
Hide invoice attributes Show invoice attributes object
- buyer object Required
  
  Dane kupującego
  Hide buyer attributes Show buyer attributes object
  
  type string Required
  
  Typ kupującego. Przyjmuje wartość PERSON odbioraca indywidualny lub COMPANY firma
  
  Values are PERSON or COMPANY.
  
  email string(email) Required
  
  Adres e-mail w formacie zgodnym ze standardem RFC 5322 oraz RFC 6531
  
  Maximum length is 200.
  
  fullName string Required
  
  Imię i nazwisko nabywcy/nazwa firmy
  
  Maximum length is 200. Format should match the following pattern: ^[A-Za-z0-9#&_\-\,\.\\\\/ \u00C0-\u02C0\u0400-\u04FF"']+$.
  
  street string Required
  
  Ulica
  
  Maximum length is 200. Format should match the following pattern: ^[0-9a-zA-Z\s\-#.'"&,_/\u00C0-\u02C0]*$`.
  
  city string Required
  
  Miasto
  
  Maximum length is 100. Format should match the following pattern: ^[0-9a-zA-Z\s\-#.'"&,_/\u00C0-\u02C0]*$`.
  
  postalCode string Required
  
  Kod pocztowy
  
  Maximum length is 30.
  
  countryCodeAlpha2 string Required
  
  Kod kraju Alpha2
  
  Maximum length is 2.
  
  idCountryCodeAlpha2 string
  
  Identyfikator kodu kraju Alpha2. Wymagane dla wartości VAT_ID parametru idType.
  
  Maximum length is 2.
  
  idType string
  
  Typ numeru identyfikacyjnego. Wymagane dla wartości COMPANY parametru type. Przyjmuje wartość ID dla PESEL lub VAT_ID dla NIP.
  
  Values are ID or VAT_ID.
  
  idNumber string
  
  NIP lub numer PESEL. Wymagane w przypadku wartości COMPANY dla parametru type.
  
  Maximum length is 30.
- positions array[object] Required
  
  Lista produktów
  Hide positions attributes Show positions attributes object
  
  name string Required
  
  Nazwa produktu
  
  code string Required
  
  Kod produktu
  
  quantity number Required
  
  Ilość. Minimalna wartość to 0.
  
  unit string Required
  
  Jednostka
  
  grossAmount integer Required
  
  Wartość jednostkowa brutto
  
  taxStake string Required
  
  Stawka podatku
  
  Values are TAX_23, TAX_22, TAX_8, TAX_7, TAX_5, TAX_3, TAX_0, TAX_EXEMPT, TAX_NOT_LIABLE, TAX_REVERSE_CHARGE, or TAX_EXCLUDING.
  
  discountAmount integer
  
  Wartość upustu
  
  taxAmount integer
  
  Wartość podatku w groszach. Wymagany tylko dla płatności Split Payment.
- issueInvoice boolean
  
  Automatyczna wysyłka faktury
- basisForVatExemption object
  
  Podstawa zwolnienia z podatku
  Hide basisForVatExemption attributes Show basisForVatExemption attributes object
  
  type string Required
  
  Values are DENTAL_TECHNICAN_SERVICES, DOCTOR_DENTIST_SERVICES, PHYSIOTHERAPY_SERVICES, NURSING_SERVICES, PSYCHOLOGICAL_SERVICES, MEDICAL_TRANSPORT_SERVICES, CARE_SERVICES, TUTORING, TEACHING_FOREIGN_LANGUAGES, ARTISTS, RENTING_PROPERTY, INSURANCE_SERVICES, CREDITS_AND_LOANS_SERVICES, GUARANTIEES, SPECIAL_CONDITIONS_FOR_EXEMPTION, UE_TRANSACTIONS, SUBJECTIVE_EXEMPTIONS, OTHER, or OTHER_OBJECTIVE_EXEMPTIONS.
  
  text string
  
  Opis. Parametr niezbędny w przypadku podania w parametrze type wartości OTHER.
- invoiceId string
  
  Numer faktury. Wymagany tylko dla płatności Split Payment.
profileType string

Rodzaj transakcji kartowej OneClick i recurring. Wymagany przy płatnościach OneClick i rekurencyjna bez profilu kartowego. FIRST w przypadku transakcji rejestrującej, STANDARD w przypadku obciążenia karty.

Values are FIRST or STANDARD.
installment object

Dodatkowe dane dotyczące imoje raty
Hide installment attribute Show installment attribute object
- period integer Required
  
  Ilość rat. Od 3 do 36 dla wartości inbank, od 3 do 10 dla wartości inbank_0.
wallet object

Dane płatności dla portfela elektronicznego.
Wymagane przy płatności Google Pay i Apple Pay 0 level.
Hide wallet attributes Show wallet attributes object
- signature string
  
  Sygnatura otrzymana w obiekcie token.
  Wymagane przy płatności Google Pay 0 level.
- protocolVersion string
  
  Wersja protokołu otrzymana w obiekcie token.
  Wymagane przy płatności Google Pay 0 level.
- signedMessage string
  
  Podpis wiadomości otrzymany w obiekcie token.
  Wymagane przy płatności Google Pay 0 level.
- paymentData object
  
  Obiekt z danymi płatności tokenu Apple Pay.
  Wymagane przy płatności Apple Pay 0 level.
  Hide paymentData attributes Show paymentData attributes object
  
  version string Required
  
  data string Required
  
  signature string Required
  
  header object Required
  
  Hide header attributes Show header attributes object
  
  ephemeralPublicKey string Required
  
  publicKeyHash string Required
  
  transactionId string Required

Responses

200 application/json

Zapytanie wykonane poprawnie
Hide response attribute Show response 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
  
  Values are sale or 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
  
  notificationUrl string(uri)
  
  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)
  
  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
  
  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.
  
  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.
422 application/json

Payload nie zawiera wymaganaych parametrów, zawiera niedopuszczalne parametry, lub przesłane w nich wartości nie spełniają wymogów.
Hide response attribute Show response attribute object
- apiErrorResponse object
  
  Szczegóły błędu
  
  Hide apiErrorResponse attributes Show apiErrorResponse attributes object
  
  code string
  
  Kod błędu
  
  message string
  
  Komunikat błędu
  
  instance object
  
  Body przesłanego zapytania HTTP do imoje.
  
  errors array[object]
  
  Lista błędów
  
  Hide errors attributes Show errors attributes object
  
  property string
  
  Miejsce wystąpienia błędu
  
  message string
  
  Powód wystąpienia błędu
406 application/json

Payload jest poprawny, ale zawiera wartości, które nie mogą zostać obecnie zaakceptowane. Błąd ten będzie zwrócony, gdy zostanie wykorzystana metoda lub kanał płatności, który jest nieaktywny w sklepie, lub tymczasowo ograniczona jest jego dostępność globalnie.
Hide response attribute Show response attribute object
- apiErrorResponse object
  
  Szczegóły błędu
  
  Hide apiErrorResponse attributes Show apiErrorResponse attributes object
  
  code string
  
  Kod błędu
  
  message string
  
  Komunikat błędu
  
  instance object
  
  Body przesłanego zapytania HTTP do imoje.
  
  errors array[object]
  
  Lista błędów
  
  Hide errors attributes Show errors attributes object
  
  property string
  
  Miejsce wystąpienia błędu
  
  message string
  
  Powód wystąpienia błędu
500 application/json

Payload jest poprawny, ale transakcja nie może zostać przeprocesowana z powodu błędu w konfiguracji lub u dostawcy metody płatności.
Hide response attribute Show response attribute object
- apiErrorResponse object
  
  Szczegóły błędu
  
  Hide apiErrorResponse attributes Show apiErrorResponse attributes object
  
  code string
  
  Kod błędu
  
  message string
  
  Komunikat błędu
  
  instance object
  
  Body przesłanego zapytania HTTP do imoje.
  
  errors array[object]
  
  Lista błędów
  
  Hide errors attributes Show errors attributes object
  
  property string
  
  Miejsce wystąpienia błędu
  
  message string
  
  Powód wystąpienia błędu

POST /{merchantId}/transaction

curl \
 --request POST 'https://api.imoje.pl/v1/merchant/{merchantId}/transaction' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"type":"sale","title":"yourTitle","amount":100,"orderId":"yourOrderId","currency":"PLN","customer":{"email":"john.doe@example.com","lastName":"Doe","firstName":"John"},"serviceId":"ab16c18c-e83b-424f-80c9-f839ed23181f","paymentMethod":"blik","notificationUrl":"https://yourshopdomain.com/notification","failureReturnUrl":"https://yourshopdomain.com/failure","successReturnUrl":"https://yourshopdomain.com/success","paymentMethodCode":"blik"}'

Request example

{
  "type": "sale",
  "title": "yourTitle",
  "amount": 100,
  "orderId": "yourOrderId",
  "currency": "PLN",
  "customer": {
    "email": "john.doe@example.com",
    "lastName": "Doe",
    "firstName": "John"
  },
  "serviceId": "ab16c18c-e83b-424f-80c9-f839ed23181f",
  "paymentMethod": "blik",
  "notificationUrl": "https://yourshopdomain.com/notification",
  "failureReturnUrl": "https://yourshopdomain.com/failure",
  "successReturnUrl": "https://yourshopdomain.com/success",
  "paymentMethodCode": "blik"
}

Response examples (200)

{
  "transaction": {
    "id": "bf10e554-3da8-4f9e-82e8-937c3286b1da",
    "type": "sale",
    "title": "yourTitle",
    "action": {
      "url": "https://paywall.imoje.pl/redirect/bf10e554-3da8-4f9e-82e8-937c3286b1da/d8799fd8-f1a5-4288-9988-515a5d7db2d4",
      "type": "redirect",
      "method": "GET",
      "contentType": "",
      "contentBodyRaw": ""
    },
    "amount": 10000,
    "source": "api",
    "status": "pending",
    "created": 1735686000,
    "orderId": "yourOrderId",
    "payment": {
      "id": "bf10e554-3da8-4f9e-82e8-937c3286b1da",
      "status": "pending"
    },
    "currency": "PLN",
    "modified": 1735686000,
    "serviceId": "ab16c18c-e83b-424f-80c9-f839ed23181f",
    "paymentMethod": "blik",
    "notificationUrl": "https://yourshopdomain.com/notification",
    "paymentMethodCode": "blik"
  }
}

Response examples (422)

{
  "apiErrorResponse": {
    "code": "TRX-ERROR-120001",
    "errors": [
      {
        "message": "requires property \"customer\"",
        "property": "instance"
      }
    ],
    "message": "Unprocessable Entity.",
    "instance": {
      "type": "sale",
      "title": "yourTitle",
      "amount": 10000,
      "orderId": "yourOrderId",
      "currency": "PLN",
      "serviceId": "ab16c18c-e83b-424f-80c9-f839ed23181f",
      "paymentMethod": "blik",
      "notificationUrl": "https://yourshopdomain.com/notification",
      "failureReturnUrl": "https://yourshopdomain.com/failure",
      "successReturnUrl": "https://yourshopdomain.com/success",
      "paymentMethodCode": "blik"
    }
  }
}

Response examples (406)

{
  "apiErrorResponse": {
    "code": "TRX-ERROR-120003",
    "errors": [],
    "message": "Cannot process transaction. Not supported payment method.",
    "instance": {
      "type": "sale",
      "title": "yourTitle",
      "amount": 10000,
      "orderId": "yourOrderId",
      "currency": "PLN",
      "customer": {
        "email": "john.doe@example.com",
        "lastName": "Doe",
        "firstName": "John"
      },
      "serviceId": "ab16c18c-e83b-424f-80c9-f839ed23181f",
      "paymentMethod": "blik",
      "notificationUrl": "https://yourshopdomain.com/notification",
      "failureReturnUrl": "https://yourshopdomain.com/failure",
      "successReturnUrl": "https://yourshopdomain.com/success",
      "paymentMethodCode": "blik"
    }
  }
}

Response examples (500)

{
  "apiErrorResponse": {
    "code": "ACQ-ERROR-130004",
    "errors": [],
    "message": "Cannot process transaction. Payment method provider error.",
    "instance": {
      "type": "sale",
      "title": "yourTitle",
      "amount": 10000,
      "orderId": "yourOrderId",
      "currency": "PLN",
      "customer": {
        "email": "john.doe@example.com",
        "lastName": "Doe",
        "firstName": "John"
      },
      "serviceId": "ab16c18c-e83b-424f-80c9-f839ed23181f",
      "paymentMethod": "blik",
      "notificationUrl": "https://yourshopdomain.com/notification",
      "failureReturnUrl": "https://yourshopdomain.com/failure",
      "successReturnUrl": "https://yourshopdomain.com/success",
      "paymentMethodCode": "blik"
    }
  }
}