Downloading transaction data | imoje API eng documentation

Downloading transaction data Run in API Explorer

GET /{merchantId}/transaction/{transactionId}

This request allows you to retrieve all necessary transaction data.

Data from the payer's bank

This request also allows you to obtain original data from the payer's bank for fast online transfers (pbl) and wire transfers (wt). In the sandbox environment, it is not possible to retrieve data from the payer's bank for technical reasons.

If the data from the payer's bank is not available immediately after the transaction, the API should retry downloading this data at intervals of several hours (in extreme situations, the data may be available even after 24 working hours).

Path parameters

merchantId string Required

Merchant identifier
transactionId string(uuid) Required

Transaction identifier as 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

Request executed correctly
Hide response attributes Show response attributes object
- transaction object Required
  
  Transaction data
  
  Hide transaction attributes Show transaction attributes object
  
  id string(uuid) Required
  
  Transaction identifier as 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
  
  Transaction type
  
  Values are sale or refund.
  
  status string Required
  
  Status
  
  Values are new, pending, settled, authorized, rejected, cancelled, or error.
  
  source string Required
  
  Transaction source
  
  Values are web or api.
  
  created integer | null Required
  
  Creation date as timestamp
  
  modified integer | null Required
  
  Modification date as timestamp
  
  notificationUrl string(uri) Required
  
  Dynamic notification address, possibility to set a specific address for a single transaction. Addresses containing localhost and ports will be rejected.
  
  Maximum length is 300.
  
  serviceId string(uuid) Required
  
  Shop identifier as 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
  
  The transaction amount in the smallest currency unit, e.g. pennies.
  
  currency string Required
  
  Transaction currency in the ISO 4217 standard
  
  Maximum length is 3. Values are PLN, EUR, USD, GBP, CHF, SEK, HUF, CZK, BGN, or RON.
  
  title string Required
  
  Transaction title
  
  Maximum length is 255. Format should match the following pattern: ^[A-Za-z0-9#&_\-\,\.\\\\/ \u00C0-\u02C0"']+$.
  
  orderId string Required
  
  Order ID
  
  Maximum length is 100. Format should match the following pattern: ^[A-Za-z0-9#_\-\.\\\\/ \u00C0-\u02C0]+$.
  
  paymentMethod string Required
  
  Payment method description
  
  Values are blik, pbl, ing, card, wallet, imoje_paylater, wt, or imoje_installments.
  
  paymentMethodCode string Required
  
  Payment method code
  
  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)
  
  Transaction identifier as 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
  
  Transaction type
  
  Value is refund.
  
  status string
  
  Status
  
  Values are new, pending, settled, authorized, rejected, cancelled, or error.
  
  source string
  
  Transaction source
  
  Values are web or api.
  
  created integer | null
  
  Creation date as timestamp
  
  modified integer | null
  
  Modification date as timestamp
  
  serviceId string(uuid)
  
  Shop identifier as 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
  
  The transaction amount in the smallest currency unit, e.g. pennies.
  
  currency string
  
  Transaction currency in the ISO 4217 standard
  
  Maximum length is 3. Values are PLN, EUR, USD, GBP, CHF, SEK, HUF, CZK, BGN, or RON.
  
  title string
  
  Transaction title
  
  Maximum length is 255. Format should match the following pattern: ^[A-Za-z0-9#&_\-\,\.\\\\/ \u00C0-\u02C0"']+$.
  
  orderId string
  
  Order ID
  
  Maximum length is 100. Format should match the following pattern: ^[A-Za-z0-9#_\-\.\\\\/ \u00C0-\u02C0]+$.
  
  paymentMethod string
  
  Payment method description
  
  Values are blik, pbl, ing, card, wallet, imoje_paylater, wt, or imoje_installments.
  
  paymentMethodCode string
  
  Payment method code
  
  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)
  
  Payment link identifier as 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
  
  BLIK transaction identifier
  
  statusCode string
  
  Transaction status code
  
  statusCodeDescription string
  
  Transaction status code description
  
  fee object
  
  The value of the fee charged. This option is not enabled by default. If you would like to enable this solution in your shop, please contact us at kontakt.tech@imoje.pl.
  
  Hide fee attributes Show fee attributes object
  
  merchant integer
  
  Fee value
  
  surcharge integer
  
  Surcharge value
  
  payerData object
  
  Original data from the payer's bank. Returned only for completed transactions via fast online transfer (PBL) or wire transfer.
  
  Hide payerData attributes Show payerData attributes object
  
  name string
  
  Payer's name and address
  
  account string
  
  Payer's account number
  
  payerCardData object
  
  Payment card details used in the transaction
  
  Hide payerCardData attributes Show payerCardData attributes object
  
  brand string
  
  Payment card organisation
  
  bin string
  
  Payment card BIN number
  
  last4 string
  
  The last 4 digits of your payment card number
  
  type string
  
  Payment card type
  
  Values are DEBIT or CREDIT.
  
  countryCodeAlpha2 string
  
  The Alpha2 country code where the payment card was issued.
  
  countryCodeAlpha3 string
  
  The Alpha3 country code where the payment card was issued.
  
  countryName string
  
  The name of the country where the payment card was issued.
  
  firstTransactionId string
  
  External identifier of the recording transaction. Required when debiting the card for OneClick and recurring payment without a profile.
  
  paidAmount integer
  
  Value of funds paid in the case of a wire transfer
- action object
  
  Description of the action to be taken as part of a given transaction.
  
  Hide action attributes Show action attributes object
  
  type string Required
  
  The type of action to be taken as part of a given transaction.
  
  Values are redirect or transfer.
  
  url string
  
  Payment redirect address
  
  method string
  
  Payment redirect method
  
  Values are GET or POST.
  
  contentType string
  
  Redirect content type
  
  contentBodyRaw string
  
  Redirect content
  
  ban string
  
  Account number for traditional transfers for the transfer type.
  
  title string
  
  Title for a traditional transfer for the transfer type.

GET /{merchantId}/transaction/{transactionId}

curl \
 --request GET 'https://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"
}