Webhook POST

Upon successful order completion, a HTTPS POST will be made to the Webhook URL you provide in the /v1/create-instore API.

{
  "merchantReference": "A10003001", // The merchant reference you provided to /v1/create-instore
  "orderToken": "00000000-0000-0000-0000-000000000000", // The same order token in the /v1/create-instore response
  "downPayment": 100.50 // The downpayment amount charged to the customer 
}

Your server should respond with a HTTP 200 response on successful processing of the order confirmation postback. If Caddipay receives any other status code or a timeout, the post will be automatically retried after 5 minutes. If this is unsuccessful, the attempt will be retried again with an exponential backoff.

In rare scenarios, networking issues can occur where your processing was successful but Caddipay was unable to receive the HTTP 200 response. As such, we recommend you take an idempotent processing approach to the postback including checking if the merchantReference and orderToken were already processed, if so responding with HTTP 200 and avoiding further processing.