Documentation

1.7.1 2022-12-01

Changed

• Unify references to our sandbox environment (No more staging but only sandbox)

1.7.0 2022-08-24

Changed

• Clarified description and use case of hi.direkteinreichung

• Typo & format fixes

1.6.0 2022-05-10

Changed

• added /payments/:id/cancel endpoint

• added /payments/:id/capture endpoint

• added new, optional, body parameters for POST /payments request.

  • cardCaptureMode which can take the value of "AUTO" (default if not specified) or "MANUAL"

• removed the x-api-key header requirement from the POST /payments request. It is now possible to pass either a header or a pre-defined merchantId in the body of the request.

1.5.0 2021-12-10

Changed

• added PENDING as a new Order Payment status

• removed CLAIMED Order Payment status

1.4.0 2021-11-10

Changed

• removed amountDetails property from Order Payment entity

1.3.0 2021-09-30

Changed

• added a section about the no code integration with hi.linkzahlung

• added explanation of hi.direkteinreichung

1.2.1 - 2021-07-07

Changed

• updated the error message for when a Payment Id is not found

1.2.0 - 2021-06-24

Changed

• added error responses with their respective return codes and messages

• changed the amount body parameter for creating a Payment

• added cancelRedirect parameter inside merchantUrls

• updated code snippets accordingly

• added Postman collection

1.1.0 - 2021-05-31

Changed

• added snippets to api documentation

• changed preview environment URL to: https://pay.staging.hi.health/ and api URL to: https://pay.api.staging.hi.health