Event Triggered

  • A user acts on a pending payment request (e.g., approves it).
  • The system completes processing of a payment.

Possible Status Values

StatusDescription
PendingThe payment request has been created and is waiting for user action.
InReviewThe request is under review, typically for additional checks or compliance.
PaidThe payment has been approved and successfully processed.
CanceledThe request was canceled before completion.
DeniedThe request was rejected by the system.

Webhook Payload

{
  "Live": false,
  "Event": "PAYMENT_STATUS_CHANGED",
  "Data": {
    "PaymentId": "ce0e3549-a83e-4cf6-bb5c-1d50a21d8af7",
    "RegistrationId": "6e8d9257-bd5f-45cf-8f29-6d0ae8a6d991",
    "Amount": 5000,
    "Currency": "USD",
    "Status": "Processing",
    "Timestamp": "2024-08-09T12:34:56Z"
  }
}

Payload Fields

FieldTypeDescription
LiveboolIt’s true when coming from production environment
EventstringThe event name: always PAYMENT_STATUS_CHANGED
Data.PaymentIdstringUnique identifier of the payment request.
Data.RegistrationIdstringID of the user associated with the request.
Data.AmountstringAmount of the payment in cents as integer (e.g., 5000 = $50.00).
Data.CurrencystringISO currency code (e.g., "USD").
Data.StatusstringStatus of the payment ("Pending" or "Paid").
Data.TimestampstringISO timestamp indicating when the event occurred.