Server integration

For a successful checkout via hi.direkteinreichung, the payment first needs to be prepared by your backend, then confirmed by the user, and finally, the invoice for this order will needs to be uploaded to hi.direkteinreichung. This allows us to process the user's reimbursement claim with their insurance.

Prepare payment

When a user is ready to pay, a payment has to be initiated via the hi.direkteinreichung API
  1. 1.
    End user clicks the "Get with Hi" Button on the Checkout Page.
  2. 2.
    The button sends a request to your server.
  3. 3.
    Your server creates the payment via the API, and receives a token in return.
  4. 4.
    Your button redirects the user to the Checkout Flow via the token.
Checkout Flow URL
Sandbox: https://pay.sandbox.hi.health/?token=<TOKEN>
Production: https://pay.hi.health/?token=<TOKEN>

Confirm Payment

Once the user reaches the Checkout, they have to login with their hi.health Account or register before they can review and confirm the order.
  1. 1.
    End user logs in with their hi.health account and reviews the payment.
  2. 2.
    End user confirms the payment in the Checkout Flow.
  3. 3.
    hi.direkteinreichung Backend will call your server to confirm the payment.
  4. 4.
    The browser will redirect to your confirmation page.

Upload Invoice

To process the users order for reimbursement we need to invoice for his order.
  1. 1.
    The invoice is generated by your backend.
  2. 2.
    The invoice is uploaded to hi.health via the UploadInvoice endpoint.*
  3. 3.
    The invoice is processed by hi.health and sent to the users insurance for reimbursement.
*There is a payload limit of 10 MB.