Skip to main content
POST
/
public
/
webhooks
/
notify
Notify transaction update
curl --request POST \
  --url https://api.pcxpay.com/v1/public/webhooks/notify \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "org_id": "<string>",
  "transaction_data": {
    "transaction_id": "txn_abc123",
    "status": "completed",
    "amount": 500,
    "currency": "USD",
    "updated_at": "2024-01-15T10:30:00Z"
  }
}
'
{
  "status": "success",
  "message": "Operation completed successfully",
  "data": {}
}

Authorizations

​
X-API-Key
string
header
required

API key issued by PCX. Pass the full key string in the X-API-Key request header. The key encodes your organisation and user identity and is verified on every request.

Body

application/json
​
org_id
string
required

Organisation whose registered webhooks should receive the notification

​
transaction_data
object
required

Arbitrary transaction payload to forward to the registered webhook endpoint(s). Typically includes transaction_id, status, amount, currency, and relevant timestamps.

Example:
{
  "transaction_id": "txn_abc123",
  "status": "completed",
  "amount": 500,
  "currency": "USD",
  "updated_at": "2024-01-15T10:30:00Z"
}

Response

Notifications dispatched

​
status
enum<string>
Available options:
success,
error
Example:

"success"

​
message
string
Example:

"Operation completed successfully"

​
data
object