Skip to main content
POST
/
v1
/
webhooks
/
test
curl --request POST \
  --url https://sandbox.payfi.global/v1/webhooks/test \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <api-key>' \
  --header 'X-PayFi-Api-Key: <api-key>' \
  --header 'X-PayFi-Nonce: <api-key>' \
  --header 'X-PayFi-Signature: <api-key>' \
  --data '
{
  "webhookId": "whe_example"
}
'
{
  "webhookDeliveryId": "whd_example",
  "status": "DELIVERED",
  "responseStatus": 204,
  "attemptedAt": "2026-05-20T12:00:00.000Z",
  "samplePayload": {
    "eventId": "evt_example",
    "eventType": "operation.analysis.completed",
    "event": "operation.analysis.completed",
    "operationId": "op_example",
    "externalOperationId": "acme-op-123",
    "partnerOperationId": "acme-op-123",
    "status": "READY_FOR_MANUAL_REVIEW",
    "decisionPackId": "dp_example",
    "decisionSummary": {
      "score": 8.2,
      "riskLevel": "LOW",
      "recommendedStatus": "READY_FOR_MANUAL_REVIEW",
      "blockingReasons": [],
      "actionItemsCount": 0
    },
    "score0To100": 82,
    "score1To10": 9,
    "riskLevel": "medium",
    "missingDocumentTypes": [],
    "actionRequired": false,
    "manualApprovalRequired": true,
    "analysisRunId": "job_example",
    "manualReviewDecision": null,
    "processedAt": "2026-05-20T12:00:00.000Z",
    "occurredAt": "2026-05-20T12:00:00.000Z"
  }
}

Authorizations

​
X-PayFi-Api-Key
string
header
required
​
X-PayFi-Nonce
string
header
required
​
X-PayFi-Signature
string
header
required
​
Idempotency-Key
string
header
required

Body

application/json

Webhook test options.

​
webhookId
string
required
Example:

"whe_example"

​
event
enum<string>
Available options:
operation.created,
operation.requirements.ready,
operation.documents.partial,
operation.analysis.completed,
operation.action_required,
operation.manual_review.completed,
operation.callback.failed
Example:

"operation.analysis.completed"

Response

Test delivery attempted.

​
webhookDeliveryId
string
Example:

"whd_example"

​
status
string
Example:

"DELIVERED"

​
responseStatus
number
Example:

204

​
attemptedAt
string
Example:

"2026-05-20T12:00:00.000Z"

​
samplePayload
object