Event Triggered
- A user acts on a pending payment request (e.g., approves it).
- The system completes processing of a payment.
Possible Status Values
| Status | Description |
|---|---|
Processing | The payment request is being processed as normal. |
Queued | A fallback state for when transactions aren’t being processed in real time. The request will be paid as soon as the system can process it. |
InReview | The request is under review, typically for additional checks or compliance. |
Scheduled | SynchPay processes future-dated payment requests once per day at 11AM PT. This status means that it will be processed during the batch of the date indicated on the payment request. |
CardPaymentPending | The payer has initiated a card payment but has not yet completed the checkout form. See card payments for details. |
Paid | The payment has been approved and successfully processed. |
Canceled | The request was canceled before completion. |
Denied | The request was rejected by the system or user. |
Failed | The payment processing failed due to technical or banking issues. |
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",
"AccountNumberMasked": "*1111" //String, be aware of the asterisk.
}
}
Payload Fields
| Field | Type | Description |
|---|---|---|
Live | bool | It’s true when coming from production environment |
Event | string | The event name: always PAYMENT_STATUS_CHANGED |
Data.PaymentId | string | Unique identifier of the payment request. |
Data.RegistrationId | string | ID of the user associated with the request. |
Data.Amount | string | Amount of the payment in cents as integer (e.g., 5000 = $50.00). |
Data.Currency | string | ISO currency code (e.g., "USD"). |
Data.Status | string | Current status of the payment (see Possible Status Values above). |
Data.Timestamp | string | ISO timestamp indicating when the event occurred. |
Data.AccountNumberMasked | string | The last four digits of the bank account used in the payment request with an asterisk pre-pended. |