New improved version of Webhook V2 is available
This old version has deprecated performance.
Webhook architecture
Upon transaction generation, Merchant provides hookUrl
.
Payze calls back hookUrl
with HTTP POST
method when any change occurs to the transaction.
Security measures
TODO: Add auth token and security recommendations
Expect the following Request body
upon Hook activation
Request body
upon Hook activation{
"cardMask": "528058xxxxxx1419", // Customer card number
"amount": 0.1, // Paid amount
"splits": [ // Split scheme
{
"amount": 1,
"iban": "GE05TB7460045061100006",
"status": "Created",
"cashOutOrder": {}
}
],
"log": [ // Transaction status logs by date
{
"date": "Jan 23, 2021, 1:22:35 PM",
"statusBefore": "Nothing",
"status": "Created",
"changeType": "BackgroundJob"
},
{
"date": "Jan 23, 2021, 1:22:38 PM",
"statusBefore": "Created",
"status": "Blocked",
"changeType": "BackgroundJob"
}
],
"canBeCommitted": true, // Is it possible to commit transaction, usually true for preauthorised transactions
"resultCode": "1", // Not used by merchants
"transactionId": "3BC34E79D7BA4B4AA3B6C011C8362926", // Merchant and Payze transaction identifier
"finalAmount": 0.1, // Amount after partial refund
"currency": "GEL", // Transaction Currency
"commission": 2.2, // Transaction cost
"refundable": true, // Can be transaction refunded
"refunded": 0, // Refunded amount
"hasSplit": true, // Identified if split is used
"status": "Blocked", // Transaction Status
"createDate": "Jan 23, 2021, 1:22:38 PM" // Transaction creation date
}
Transaction Statuses
Refer to Transaction Statuses section, to understand more about how transaction statuses are used.