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

1 day ago

prod
1.5.1
Compare
1.5.1

API structure has changed

Next change
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