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

Param
Type
Description

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 Body (SETTLED)

Send Transactional Data

Upon request we can include additional transactional data with the SIGNED endpoint. We can inlcude the following additonal data.

Param
Type
Description

processed_date

String

This is the date the transaction was processed

type

String

This is the type of payment. Examples: Open Banking - ECOM Pay by card - PayPad Pay by card - ECOM PayLater

scheme

String

This is the payment. Examples: Visa Mastercard OB

authorisation_code

String

This is the authorisation code associated to the payment. This can be used as reference for the transaction.

sender_iban

String

Masked IBAN is provided for Open Banking Payments

sender_name

String

Account Holder Name is provided for Open Banking Payments

card_number

String

This is the masked card number of the card that took payment. The card details can be sent as first 6 and last 4 or just the last 4. This depends on transaction type.

terminal_id

String

If the transaction was taken on terminal, here we'll provide the terminal ID.

reference

String

This is the reference entered on the terminal before taking payment.

method

String

This is the method of payment. Example: Online Payment Wire

Last updated