Skip to main content
POST
/
v1
/
webhooks
Create webhook endpoint
curl --request POST \
  --url https://sandbox.payfi.global/v1/webhooks \
  --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 '
{
  "name": "Acme endpoint",
  "url": "https://acme.example/payfi/webhooks",
  "eventTypes": [
    "operation.created",
    "operation.requirements.ready",
    "operation.analysis.completed",
    "operation.action_required"
  ]
}
'
{
  "webhookId": "whe_example",
  "name": "Acme endpoint",
  "url": "https://acme.example/payfi/webhooks",
  "status": "ACTIVE",
  "eventTypes": [
    "operation.created",
    "operation.requirements.ready",
    "operation.analysis.completed",
    "operation.action_required"
  ],
  "secretPreview": "whsec_te...abcd",
  "secret": "whsec_test_returned_once",
  "createdAt": "2026-05-20T12:00:00.000Z",
  "updatedAt": "2026-05-20T12:00:00.000Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.payfi.global/llms.txt

Use this file to discover all available pages before exploring further.

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 endpoint payload.

​
name
string
required
Example:

"Acme endpoint"

​
url
string
required
Example:

"https://acme.example/payfi/webhooks"

​
eventTypes
string[]
Example:
[
  "operation.created",
  "operation.requirements.ready",
  "operation.analysis.completed"
]

Response

Webhook endpoint created. The secret is returned only in this response.

​
webhookId
string
Example:

"whe_example"

​
name
string
Example:

"Acme endpoint"

​
url
string
Example:

"https://acme.example/payfi/webhooks"

​
status
string
Example:

"ACTIVE"

​
eventTypes
string[]
Example:
["operation.analysis.completed"]
​
secretPreview
string
Example:

"whsec_te...abcd"

​
secret
string
Example:

"whsec_test_returned_once"

​
createdAt
string
Example:

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

​
updatedAt
string
Example:

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