Do not miss any imoje API eng changes, ever again

Subscribe to the imoje API eng changelog to be up to date on recent changes.

RSS

Changelog

Last update:
Compare
1.5.1
13 structure changes including:
13 Modifications
Modified 13 Breaking
GET /{merchantId}/payment/{paymentId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • id, url, serviceId, orderId, title, simp, currency, isActive, validTo, created, modified, isGenerated, isUsed, usedAt, isConfirmVisited, confirmVisitedAt, returnUrl, failureReturnUrl, successReturnUrl, notificationUrl, customer properties Modified
        • Properties are no longer required
      • amount property Modified
        • Property is no longer required
        • Type went from integer to string
          Breaking
      • transactions property Modified
        • Property is no longer required
        • id, type, status, source, created, modified, notificationUrl, serviceId, amount, currency, title, orderId, paymentMethod, paymentMethodCode, payment properties Modified
          • Properties are no longer required
        • * property Added
      • * property Added
GET /{merchantId}/profile/cid/{cid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • paymentProfiles property Modified
        • * property Added
      • * property Added
GET /{merchantId}/profile/id/{paymentProfileId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • paymentProfile property Modified
        • * property Added
      • * property Added
GET /{merchantId}/service/{serviceId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • service property Modified
        • paymentMethods property Modified
        • * property Added
      • * property Added
GET /{merchantId}/services
  • Response
  • 200 response Modified
    • application/json content type Modified
      • service property Modified
        • paymentMethods property Modified
        • * property Added
      • * property Added
GET /{merchantId}/transaction/{transactionId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • transaction property Modified
        • id, type, status, source, created, modified, notificationUrl, serviceId, amount, currency, title, orderId, paymentMethod, paymentMethodCode, payment properties Modified
          • Properties are no longer required
        • refunds, fee, payerData, payerCardData properties Modified
        • * property Added
      • action property Modified
        • * property Added
      • * property Added
POST /{merchantId}/payment
  • Response
  • 200 response Modified
    • application/json content type Modified
      • payment property Modified
        • * property Added
      • * property Added
  • 422 response Modified
    • application/json content type Modified
      • apiErrorResponse property Modified
        • instance, errors properties Modified
        • * property Added
      • * property Added
POST /{merchantId}/payment/cancel
  • Response
  • 200 response Modified
    • application/json content type Modified
      • id, url, serviceId, orderId, title, simp, amount, currency, isActive, validTo, created, modified, isGenerated, isUsed, usedAt, isConfirmVisited, confirmVisitedAt, returnUrl, failureReturnUrl, successReturnUrl, notificationUrl properties Modified
        • Properties are no longer required
      • customer property Modified
        • Property is no longer required
        • firstName, lastName, email properties Modified
          • Properties are no longer required
        • * property Added
      • transactions property Modified
        • Property is no longer required
        • id, type, status, source, created, modified, notificationUrl, serviceId, amount, currency, title, orderId, paymentMethod, paymentMethodCode, payment properties Modified
          • Properties are no longer required
        • * property Added
      • * property Added
  • 400 response Modified
    • application/json content type Modified
      • apiErrorResponse property Modified
        • * property Added
      • * property Added
POST /{merchantId}/service/{serviceId}/get-payment-methods
  • Response
  • 200 response Modified
    • application/json content type Modified
      • channels property Modified
        • image property Modified
        • * property Added
      • * property Added
POST /{merchantId}/transaction
  • Response
  • 200 response Modified
    • application/json content type Modified
      • transaction property Modified
        • payment, action properties Modified
        • * property Added
      • * property Added
  • 422 response Modified
    • application/json content type Modified
      • apiErrorResponse property Modified
        • instance, errors properties Modified
        • * property Added
      • * property Added
  • 406 response Modified
    • application/json content type Modified
      • apiErrorResponse property Modified
        • instance, errors properties Modified
        • * property Added
      • * property Added
  • 500 response Modified
    • application/json content type Modified
      • apiErrorResponse property Modified
        • instance, errors properties Modified
        • * property Added
      • * property Added
POST /{merchantId}/transaction/profile
  • Response
  • 200 response Modified
    • application/json content type Modified
      • transaction property Modified
        • payment, paymentProfile properties Modified
        • * property Added
      • * property Added
  • 400 response Modified
    • application/json content type Modified
      • apiErrorResponse property Modified
        • instance, errors properties Modified
        • * property Added
      • * property Added
POST /{merchantId}/transaction/{transactionId}/can-refund
  • Response
  • 200 response Modified
    • application/json content type Modified
      • partialRefund property Modified
        • * property Added
      • * property Added
POST /{merchantId}/transaction/{transactionId}/refund
  • Response
  • 200 response Modified
    • application/json content type Modified
      • transaction property Modified
        • * property Added
      • * property Added
  • 422 response Modified
    • application/json content type Modified
      • apiErrorResponse property Modified
        • instance, errors properties Modified
        • * property Added
      • * property Added
1.4.0
15 structure changes including:
15 Modifications
Modified 15 Breaking
GET /{merchantId}/payment/{paymentId}
  • Response
  • 200 response Added
GET /{merchantId}/profile/cid/{cid}
  • Response
  • 200 response Added
GET /{merchantId}/profile/id/{paymentProfileId}
  • Response
  • 200 response Added
GET /{merchantId}/service/{serviceId}
  • Response
  • 200 response Added
GET /{merchantId}/services
  • Response
  • 200 response Added
GET /{merchantId}/settings/ips
  • Response
  • 200 response Added
GET /{merchantId}/transaction/{transactionId}
  • Response
  • 200 response Added
POST /{merchantId}/payment
  • Body
  • application/json content type Modified
    • invoice property Modified
      • positions property Modified
        • taxAmount property Modified
          • Type went from string to integer
            Breaking
    • isKsef property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • payment property Modified
        • customer property Modified
        • created, modified properties Modified
          • Type went from integer to integer | null
  • 422 response Modified
    • application/json content type Modified
      • apiErrorResponse property Modified
        • instance property Modified
POST /{merchantId}/payment/cancel
  • Response
  • 200, 400 responses Added
POST /{merchantId}/service/{serviceId}/get-payment-methods
  • Response
  • 200 response Added
POST /{merchantId}/transaction
  • Body
  • application/json content type Modified
    • invoice property Modified
      • positions property Modified
        • taxAmount property Modified
          • Type went from string to integer
            Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • transaction property Modified
        • action property Modified
  • 422 response Modified
    • application/json content type Modified
      • apiErrorResponse property Modified
        • instance property Modified
        • errors property Added
      • errors property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
  • 406, 500 responses Added
POST /{merchantId}/transaction/profile
  • Body
  • application/json content type Modified
    • invoice property Modified
      • positions property Modified
        • taxAmount property Modified
          • Type went from string to integer
            Breaking
  • Response
  • 200, 400 responses Added
POST /{merchantId}/transaction/{transactionId}/can-refund
  • Response
  • 200 response Added
POST /{merchantId}/transaction/{transactionId}/refund
  • Response
  • 200, 422 responses Added
PUT /{merchantId}/settings/ips
  • Response
  • 200 response Added
1.3.4
1 structure change including:
1 Modification
Modified 1
POST /{merchantId}/transaction/profile
  • Body
  • application/json content type Modified
    • data, invoice properties Added
1.3.2
1 structure change including:
1 Modification
Modified 1
POST /{merchantId}/service/{serviceId}/get-payment-methods
  • Path
  • serviceId path parameter Added
1.3.0
3 structure changes including:
2 Additions
1 Modification
Modified 1 Breaking
POST /{merchantId}/service/{serviceId}/get-payment-methods
  • Path
  • serviceId path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
Added 2
POST /{merchantId}/transaction/{transactionId}/capture
POST /{merchantId}/transaction/{transactionId}/void
1.2.2
1 structure change including:
1 Modification
Modified 1
POST /{merchantId}/service/{serviceId}/get-payment-methods
  • Path
  • serviceId path parameter Added
1.2.1
1 structure change including:
1 Modification
Modified 1 Breaking
POST /{merchantId}/payment
  • Body
  • application/json content type Modified
    • orderId property Modified
      • Name went from orderID to orderId
        Breaking
1.1.0
1 structure change including:
1 Modification
Modified 1
POST /{merchantId}/transaction
  • Body
  • application/json content type Modified
    • wallet property Added
1 structure change including:
1 Modification
Modified 1 Breaking
POST /{merchantId}/service/{serviceId}/get-payment-methods
  • Body
  • application/json content type Modified
    • type, serviceId, orderId, paymentMethod, paymentMethodCode, successReturnUrl, failureReturnUrl, notificationUrl, title, additionalDescription, validTo, blikCode, clientIp, customer, billing, shipping, card, additionalData, visibleMethod, data, invoice, profileType, installment properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • device, locale properties Added
1.0.1
2 structure changes including:
2 Modifications
Modified 2 Breaking
POST /{merchantId}/service/{serviceId}/get-payment-methods
  • Body
  • application/json content type Modified
    • blikCode property Modified
      • Type went from integer to string
        Breaking
POST /{merchantId}/transaction
  • Body
  • application/json content type Modified
    • blikCode property Modified
      • Type went from integer to string
        Breaking