Managing notifications

The Connectivity Notifications Service (CNS) enables you to receive different types of notifications.

This topic explains the following notification types:

• Common notification metadata
• Updates to payout details
• Updates to payout method details
• Updates to virtual credit card details
• Updates to bank transfer details
• Updates to the VCC balance
• Updates to VCC fees

Required connection types

You need to be connected with the corresponding connection type related to the notifications you are interested in. The following are the list of supported notification types and the corresponding connection types that you need to be connected with:

Common notification metadata

Irrespective of the notification types, the following elements are common to all the notifications:

Updates to payout details | PAYOUT_UPDATE

CNS pushes these notifications when there are updates to payout details, such as changes in:

• Total payout
• Commission and charges

The notification message includes property and reservation identifiers. To get all the updates, query the Get payout details endpoint with these identifiers.

Notification message body

The following table describes the elements you can see in the notification payload:

Example payload

The following is a notification payload example:

{
    "metadata": {
        "uuid": "FC70575E-ED0E-11EE-B5FA-B675273ACEB0",
        "type": "PAYOUT_UPDATE",
        "payloadVersion": "1.0"
    },
    "payload": {
        "timestamp": "2023-12-10T10:01:322Z",
        "propertyId": 10345,
        "reservationId": 432647264
    }
}

Updates to payout method details | PAYOUT_METHOD_UPDATE

CNS pushes these notifications when there is an update to the payout method. For example, when the property has successfully changed the payout method from virtual credit card to Bank transfer or vice versa.

The notification message includes property and reservation identifiers. To get all the updates, query the Get payout details endpoint with these identifiers.

Notification message body

The following table describes the elements you can see in the notification payload:

Example payload

The following is a notification payload example:

{
    "metadata": {
        "uuid": "FC70575E-ED0E-11EE-B5FA-B675273ACEB0",
        "type": "PAYOUT_METHOD_UPDATE",
        "payloadVersion": "1.0"
    },
    "payload": {
        "timestamp": "2023-12-10T10:01:322Z",
        "propertyId": 10345,
        "reservationId": 432647264
    }
}

Updates to virtual credit card details | VIRTUAL_CREDIT_CARD_UPDATE

CNS pushes these notifications when there is an update to the virtual credit card details. For example, Notification service can push a notification to your endpoint when there is an update to the current balance or card status.

The notification message includes property, reservation and VCC identifiers. To get all the updates, query the Get VCC payout details endpoint with these identifiers.

Notification message body

The following table describes the elements you can see in the notification payload:

Example payload

The following is a notification payload example:

{
    "metadata": {
        "uuid": "FC70575E-ED0E-11EE-B5FA-B675273ACEB0",
        "type": "VIRTUAL_CREDIT_CARD_UPDATE",
        "payloadVersion": "1.0"
    },
    "payload": {
        "timestamp": "2023-12-10T10:01:322Z",
        "propertyId": 10345,
        "reservationId": 432647264,
        "vccId": "FC70575E-ED0E-11EE-B5FA-B675273SHDDBC"
    }
}

Updates to bank transfer details | BANK_TRANSFER_UPDATE

CNS pushes these notifications when there is an update to the bank transfer payout details. For example, Notification service can push a notification to your endpoint when there is an update to the bank transfer payout status change.

The notification message includes property and reservation identifiers. To get all the updates, query the Get bank transfer payout details endpoint with these identifiers.

Notification message body

The following table describes the elements you can see in the notification payload:

Example payload

The following is a notification payload example:

{
    "metadata": {
        "uuid": "FC70575E-ED0E-11EE-B5FA-B675273ACEB0",
        "type": "BANK_TRANSFER_UPDATE",
        "payloadVersion": "1.0"
    },
    "payload": {
        "timestamp": "2023-12-10T10:01:322Z",
        "propertyId": 10345,
        "reservationId": 432647264
    }
}

Updates to VCC balance | VCC_BALANCE

CNS pushes these notifications when there is an update to the VCC balance.

Notification message body

The following table describes the elements you can see in the notification payload:

Example payload

The following is a notification payload example:

{
    "metadata": {
        "uuid": "FC70575E-ED0E-11EE-B5FA-B675273ACEB0",
        "type": "VCC_BALANCE",
        "payloadVersion": "1.0"
    },
    "payload": {
        "updateTimestamp": "2023-12-10T10:01:322Z",
        "currency": "USD",
        "propertyId": 10345,
        "reservationId": 432647264,
        "vccBalanceAmount": "123.40"
    }
}

Updates to VCC fees | VCC_FEES_PAYOUT

CNS pushes these notifications when there is an update to the VCC fees payout for successfully collected no-show/cancellation fees.

Notification message body

The following table describes the elements you can see in the notification payload:

Example payload

The following is a notification payload example:

{
    "metadata": {
        "uuid": "FC70575E-ED0E-11EE-B5FA-B675273ACEB0",
        "type": "VCC_FEES_PAYOUT",
        "payloadVersion": "1.0"
    },
    "payload": {
        "updateTimestamp": "2023-12-10T10:01:322Z",
        "currency": "USD",
        "propertyId": 10345,
        "reservationId": 432647264,
        "vccBalanceAmount": "123.40"
    }
}