Webhook

We have webhook support for some events. Please visit For Developers > Webhook in Dashboard.

You can configure your webhook endpoints where you will get notifications from our server. The events we have supported are

• Offer transaction status update
  • Called when a Service Provider updates a transaction status (for example, from pending to completed)
• Dispute completion
  • Called when a dispute request is updated
• Payment completion (BNPL)
  • Called when BNPL request status is updated
• Disbursement status update (BNPL)
  • Called when BNPL related disbursement info is updated

The payload is like following

• Offer transaction status update
  • Transaction ID
  • Credify ID
  • Transaction status
  • Offer code
• Dispute completion
  • Transaction ID
  • Credify ID
  • Transaction status
  • Offer code
• Order status update (BNPL)
  • Order ID
  • Order status
• Disbursement status update (BNPL)
  • Order ID
  • Requirement Type (INVOICE - DOWN_PAYMENT - FIRST_PAYMENT - DELIVERY)
  • From Provider (Boolean - will be true if the proof of disbursement's document is from the FI)
  • Is Fulfilled (Boolean - will be true if all the disbursement requriement is fulfiled. This time, market can send the disburse request)

Authorization

The request has Credify's signature, so you can validate the request is coming from Credify. The signature's algorithm is in X-Signature-Algorithm. The signing message is following

{http_verb}\n{webhook_url}\n{event_id}\n{timestamp}\n{base64_url(sha256(json(body)))}

event_id is in the webhook HTTP request header X-Event-Id. timestamp is in the webhook HTTP request header X-Event-Timestamp.

body is like

{"type":"BNPL_ORDER_STATUS_UPDATED","order_id":"b73fd497-cc03-41c4-bad2-b6e042b29204","order_status":"PAID"}

Here is an example.

POST\n
https://webhook-debugger.credify.one/api/webhook\n
51750a4a-0a6b-4c2a-9c6f-827277c35e66\n
2022-05-24T09:37:05Z\n
usGf1kiPjZ0-HegDJ9BmvgFDxmmWdZbRQUDsLPQ2jwk

Formed HTTP request:

POST https://webhook-debugger.credify.one/api/webhook
Content-Type: application/json
Accept: application/json
Signature: oJ6yDFkgsQk8wMqLQm2vtBVKxJ69fH2oU5SYIrCaTy5RjHdpIFBT_UV8I8PbJj_Gv7ll2bc2FFGepURUC23SBg
X-Event-Id: 51750a4a-0a6b-4c2a-9c6f-827277c35e66
X-Event-Timestamp: 2022-05-24T09:37:05Z
X-Signature-Algorithm: EdDSA
{"type":"BNPL_ORDER_STATUS_UPDATED","order_id":"b73fd497-cc03-41c4-bad2-b6e042b29204","order_status":"PAID"}