Settled Event

The SETTLED event is triggered the following day, this happens once payment has been made by Bumper to Dealer. Additonal information about transaction costs are provided.

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": "SETTLED",
    "payment_type": "paynow",
    "payment_status": "complete",
    "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"
    },
    "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>",
      }
}

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	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.
payment_details	Object	This object contains additional data regarding payment and is only provided for SETTLED status.

Payment Details Parameters

Param	Type	Description
amount	String	The payment amount
commission_amount	String	The commission amount
net_amount	String	The net amount
card_type	String	Card Type: VISA, Mastercard, AMEX
last_four_digits	String	Last four digits of card used for payment: 1234
settled_date	String	The date Bumper settled payment