New Payment/Refund

This webhook is triggered whenever any transactions are created or refunded on your account.

A JSON, XML, or x-www-form-urlencoded object containing the following export fields can be found in directly in the raw body of the POST request to your server:

payment

Field

Type

Description

transaction_id

string

A unique code used to refer to this transaction

date

timestamp

When this transaction was created

status

string

Identifies whether the transaction was a payment (PAID) or a refund (REFUND)

amount

decimal

The transaction’s monetary amount

gateway_id

string

Identifies which payment gateway made the transaction

payment_mask

integer

The last four digits of the card, or (POS) for a POS transaction

payment_type

string

The type of card used, or the type of POS transaction

payment_customer

string

The payer’s name

booking_id

string

The code of the booking which received this transaction (See booking)

Sample Payment Notification

JSON

 1{
 2    "version": "3.11.0.0",
 3    "host": "your-company.checkfront.com",
 4    "type": "transaction",
 5    "action": "insert",
 6    "transaction": {
 7        "transaction_id": "TEST1482283550",
 8        "date": 1582283550,
 9        "status": "PAID",
10        "amount": "27.00",
11        "gateway_id": "TestPayment",
12        "payment_mask": "1111",
13        "payment_type": "Visa",
14        "payment_customer": "Testy McTestface",
15        "booking_id": "LULZ-080916"
16    }
17}

XML

 1<?xml version="1.0" encoding="utf-8"?>
 2<checkfront-notify version="3.11.0.0" host="your-website.checkfront.com">
 3    <type>transaction</type>
 4    <action>insert</action>
 5    <transaction>
 6        <transaction_id>TEST1482284175</transaction_id>
 7        <date>1482284175</date>
 8        <status>PAID</status>
 9        <amount>27.00</amount>
10        <gateway_id>TestPayment</gateway_id>
11        <payment_mask>1111</payment_mask>
12        <payment_type>Visa</payment_type>
13        <payment_customer>Testy McTestface</payment_customer>
14        <booking_id>LULZ-080916</booking_id>
15    </transaction>
16</checkfront-notify>