Webhooks
Webhooks allow your application to listen to the following events from Bumper:
Applied
The customer has applied for PayLater
Signed
The customer has added card details and been accepted
Updated
The application has been updated
Cancelled
The application has been cancelled
Dealer Paid
Payment has been settled, Bumper has paid funds into dealer account
Event Header
X-Signature: "5a295e8c9e0cae3448a65aaa3bdaa1dba9e4360860ec65e759048aa626e7ec07"Event Header Parameters
X-Signature
String
A signature is created by using a sorted string of all parameters in the event body with the format “{PARAMETER}={value}&” . Parameter key should be upper-cased and value is provided as is.
The sorted string is then hashed (HMAC-SHA256) to form the signature.
Event Body
{
"event_timestamp": "2023-04-11 10:15:18",
"event_id": "0b772bf7d779410d897b0e8299e125a4",
"event_value": "APPLIED",
"payment_type": "paylater",
"payment_status": "inprogress",
"payment_token": "c05f3da225a8459eaea",
"payment_reference": "4567",
"payment_id": "PL-123456",
"amount": "2000.00",
"min_amount_allowed": "60.00",
"max_amount_allowed": "3000.00",
"additional_data": {
"key1": "value1",
"key2": "value2",
"key3": "value3"
}
}Event Body Parameters
Param
Type
Description
event_timestamp
String
timestamp: yyyy-mm-dd hh:mm:ss
event_id
String
This is the event ID
event_value
String
APPLIED
SIGNED
UPDATED
CANCELLED
SETTLED
payment_type
String
paynow
paylater
payment_status
String
Payment Type: paynow
pending – Waiting on customer action
completed – Payment made
failed – Payment Failed
cancelled – Payment cancelled
error – Unknown reason, error returned
Payment Type: paylater
pending - Application not started
inprogress - Application in progress, customer has applied
completed - Payment complete
failed - Customer failed application
cancelled - Application has been cancelled
error - Error has occurred
payment_token
String
Application / Payment token returned in response
payment_reference
String
This is order_reference sent with request
amount
String
This is the amount sent with request for customer to pay
min_amount_allowed
String
The min amount allowed by customer
max_amount_allowed
String
The max amount allowed by customer
additional_data
Object
Optional object that can contain keys and values set by supplier. These are sent to Bumper in creation API endpoint.
If additional_data is not provided during application/payment creation key will not be returned in payload.
object
Object
This object contains additional data regarding payment and is only provided for SETTLED status. Example payload shown below.
Event Body (APPLIED, SIGNED, UPDATED, CANCELLED)
{
"event_timestamp": "2023-04-11 10:15:18",
"event_id": "0b772bf7d779410d897b0e8299e125a4",
"event_value": "APPLIED",
"payment_type": "<payment_type>",
"payment_status": "<payment_status>",
"payment_token": "c05f3da225a8459eaea",
"payment_reference": "4567",
"payment_id": "PL-123456",
"amount": "2000.00",
"min_amount_allowed": "60.00",
"max_amount_allowed": "3000.00",
"additional_data": {
"key1": "value1",
"key2": "value2",
"key3": "value3"
}
}Event Body (SETTLED)
{
"event_timestamp": "<timestamp>",
"event_id": "<unique_event_id>",
"event_value": "DEALERPAID",
"payment_type": "<payment_type>",
"payment_status": "<payment_status>",
"payment_token": "<unique_payment_token>",
"payment_reference": "<reference_number>",
"payment_id": "PL-123456",
"additional_data": {
"key1": "value1",
"key2": "value2",
"key3": "value3"
},
"payment_details": {
"amount": "<payment_amount>",
"commission_amount": "<commission_amount>",
"net_amount": "<net_amount>",
"card_type": "<card_type>",
"last_four_digits": "<last_four_digits>",
"settled_date": "<settled_date>",
}
}min_amount_allowed, max_amount_allowed should be ignored if payment_type is paynow.
HTTP/1.1 200 OKLast updated