Mint Outgoing Webhook Guide

summary of changes for alternative payment methods

card brand updated to include: POLI
Webhook type updated to include: Card_present

Setup

An outgoing webhook URL can be set up by Mint admins for a merchant account in the admin setup.

The domain must also be allowed out of the firewall.

Format

The webhook is sent as a POST request to the specified URL.

It uses JSON format.

Parameters

Parameter	Description	Example	response values
`transaction_reference`	Mint transaction reference number	`123456789123456789`
`customer_reference`	Customer reference provided on the HPP	`Ref987654`
`invoice_number`	Invoice number provided on the HPP	`Inv123456`
`transaction_time_utc`	UTC time of the transaction	`2023-08-30 04:36:08 AM`
`status`	Status of the transaction	`APPROVED`	`PRE_AUTHORISED` `APPROVED` `PENDING` `DECLINED`
`amount`	Total amount of the transaction including surcharge	`101.00`
`currency`	Currency of the transaction	`AUD`
`masked_card_number`	Masked card number	`411111******1111`
`card_brand`	Typically the brand of the card used could also reflect the APM used.	`visa`	`mastercard` `visa` `amex` `POLi`
`card_holder_name`	The name associated to the payment method	John Smith
`card_expiry`	Card expiry date	`05/2026`
`email_address`	Email address entered in the HPP	`[email protected]`
`mid`	Mint company ID	`12345678`
`trading_name`	Merchant's trading name	`ABC Travel Co`
`sale_amount`	Amount of the original sale (excludes the surcharge if applied)	`100.00`
`surcharge`	Surcharge applied to the transaction	`1.00`
`webhook_type`	Source of the transaction	`VT` (Virtual Terminal)	`VT` `HPP` `CARD_PRESENT` `API`
`payment_type`	The payment type used during the transaction	`POLi`	`POLi` `CreditCard` `BankAccount`

Below is an example of the JSON payload sent in the webhook:

{
  "transaction_reference": "123456789123456789",
  "customer_reference": "Ref987654",
  "invoice_number": "Inv123456",
  "transaction_time_utc": "2023-08-30 04:36:08 AM",
  "status": "APPROVED",
  "amount": "101.00",
  "currency": "AUD",
  "masked_card_number": "411111******1111",
  "card_brand": "visa",
  "card_expiry": "05/2026",
  "email_address": "[email protected]",
  "mid": "12345678",
  "trading_name": "ABC Travel Co",
  "sale_amount": "100.00",
  "surcharge": "1.00",
  "webhook_type": "VT"
}