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

XML

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