API Reference

Webhooks

payment.created

Fired once for each payment that is created. Payload is the same as /payments/:id with all fields expanded.

{
    "id": "75475f61-6a18-465c-9eb9-bb1675a8a06f",
    "amount": 2278.43,
    "currency": "gbp",
    "description": "Airbnb Payout",
    "date": "2021-05-03T14:01:12.000Z",
    "uniqueRef": "0G40wVVm9uzwuwRdn5",
    "metadata": { },
    "status": "pending",
    "type": "payout",
    "lines": [
        {
            "categoryId": null,
            "category": null,
            "amount": 2700,
            "uniqueRef": "0G40wVVm9uzwuwRdn5-3518324508-ACCOMMODATION",
            "type": "accommodation",
            "description": "Reservation",
            "metadata": null,
            "reservation": {
                "checkIn": "2021-05-02T00:00:00+00:00",
                "checkOut": "2021-05-08T00:00:00+00:00",
                "nights": 6,
                "guestName": "Emma Stone",
                "bookerName": null,
                "guests": 7,
                "uniqueRef": "3518324508",
                "metadata": null,
                "confirmationCode": "HMDABRMKQM",
                "listingConnection": {
                    "name": "15569 Apartment",
                    "uniqueRef": "37904274",
                    "id": "49ee68f7-a980-420e-9eff-41968555c921"
                },
                "id": "6a589982-1e2b-4bec-949e-672398f0505b"
            },
            "invoiceLines": [],
            "listing": {
                "name": "Charming Townhouse",
                "code": "15569",
                "beds": null,
                "bedrooms": null,
                "address": null,
                "id": "7034557a-de00-45f0-a403-caf167bf713b"
            },
            "id": "1380da37-3032-443e-aecf-0881a63b72fa"
        }
    ],
    "connection": {
        "name": "Airbnb 1",
        "type": "service",
        "appId": "airbnb",
        "status": "enabled",
        "id": "e731f56f-4bcc-4171-b2c9-b7ec684d1036"
    }
}

reservation.created

Fired for each reservation that is created. Payload is the same as /reservations/:id with all fields expanded.

{
    "id": "59c0d0c1-6bef-451a-91ea-66782ad52810",
    "checkIn": "2021-06-26T00:00:00+00:00",
    "checkOut": "2021-06-27T00:00:00+00:00",
    "nights": 1,
    "guestName": "Emma Stone",
    "bookerName": null,
    "guests": 6,
    "uniqueRef": "3451289101",
    "confirmationCode": "HMH4SPRYKF",
    "currency": "gbp",
    "status": "booked",
    "listingConnectionId": "eac8baf3-0d01-47e7-b16b-99f8925f88a2",
    "listingId": null,
    "connection": {
        "name": "Airbnb 1",
        "type": "service",
        "appId": "airbnb",
        "status": "enabled",
        "id": "eac8baf3-0d01-47e7-b16b-99f8925f88a2"
    },
    "__dangerousAmounts": {
        "amount": 0,
        "amountAccommodation": 676,
        "amountAdjustments": 0,
        "amountService": 0,
        "amountCancellation": -901,
        "amountOta": 0,
        "amountCleaning": 225,
        "amountCityTax": 0
    },
}