FlipPay allows for authorised users to receive notifications via webhook, triggered by payment request status changes or individual transactions created on the payment request.
Notification preferences are typically set either when configuring a payment request (via the web interface), or when creating the payment request via API. They can be updated via API at any time.
Payment request status notifications
"info-required"
Payment request is created and waiting for the calling system to upload files into a required product field.
The payment request is not accessible to the Merchant or Customer in this status, nor are communications sent to the Customer.
Once files are uploaded, the status automatically moves to “pending”, the payment request becomes accessible, and if communications were requested to be sent, they will be.
{
"paymentRequestId": "PR-0448-6399",
"status": "info-required"
}
"pending"
Payment request is created and waiting for the Customer to access it
{
"paymentRequestId": "PR-0448-6399",
"status": "pending"
}
"cancelled"
Payment request has been cancelled
{
"paymentRequestId": "PR-0448-6399",
"status": "cancelled"
}
"expired"
Payment request has expired before a Customer successfully completed a payment or “pay-later” application
{
"paymentRequestId": "PR-0448-6399",
"status": "expired"
}
"resent"
Payment request has been resent after expiring
{
"paymentRequestId": "PR-0448-6399",
"status": "resent"
}
"active"
Payment request is now active as a “pay later” option (or a recurring “pay-now” schedule). This status notification confirms the payment option (“productType”) selected by the customer (when a payment request may have pay-now and pay-later offered).
{
"paymentRequestId": "PR-0448-6399",
"prStatus": "active"
"productType": "pay-later"
}
The “pay-now” example will only appear this way for a recurring schedule - for a one-off payment, there is no “active” status notification and the payment request will move to “completed” on a successful payment.
{
"paymentRequestId": "PR-0448-6399",
"prStatus": "active"
"productType": "pay-now"
}
"extended"
Payment request is active as a “pay later” option, Customer has successfully extended the duration of their agreement. Only applicable to some products, and some products may generate multiple status notifications of this type (one for each successful extension).
{
"paymentRequestId": "PR-0448-6399",
"prStatus": "extended"
}
"complete"
Payment request completed. This status notification confirms the payment option (“productType”) selected by the customer (when a payment request may have pay-now and pay-later offered).
For a pay-later option, this status indicates the final payment has been made, there is no outstanding balance on the payment request and the Customer’s agreement is now complete.
{
"paymentRequestId": "PR-0448-6399",
"prStatus": "complete"
"productType": "pay-later"
}
For a pay-now option, this status indicates the Customer has made a successful payment and completed the payment request in full.
{
"paymentRequestId": "PR-0448-6399",
"prStatus": "complete"
"productType": "pay-now"
}
Transaction status notifications
Transaction notifications are generated for "pay-now" related transactions but not "pay-later", as Merchants are not party to the "pay-later" agreement a Customer enters into with FlipPay.
"success" (pay-now one off)
Customer has successfully paid the entire requested amount.
{
"txStatus": "success",
"txId": "TX-123456789",
"prId": "PR-1234-5678",
"prStatus": "complete"
}
"fail" (pay-now one off)
Customer has attempted to pay the requested amount, transaction has failed (e.g. card declined, invalid number, etc)
{
"txStatus": "fail",
"txId": "TX-123456789",
"prId": "PR-1234-5678",
"prStatus": "pending"
}
"success" (pay-now recurring)
A scheduled payment under a recurring schedule has been successfully debited from the Customer’s nominated payment method
{
"txStatus": "success",
"txId": "TX-123456789",
"prId": "PR-1234-5678",
"prStatus": "active"
}
"fail" (pay-now recurring)
A scheduled payment under a recurring schedule has failed (e.g. card declined, invalid number, etc)
{
"txStatus": "fail",
"txId": "TX-123456789",
"prId": "PR-1234-5678",
"prStatus": "active"
}
"refund" (pay-now one-off or recurring)
A refund request was successful.
{
"txStatus": "refund",
"txId": "TX-123456789",
"amountRefunded": "100.00",
"prId": "PR-1234-5678",
"prStatus": "complete"
}