# Webhook Notification Model: 1.3.0

## Webhook Notification Model: Zapper 1.3.0

| Field                         | DataType                                                                                                                     | Description                                                                                             |
| ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
| invoiceReference              | string                                                                                                                       | Zapper's invoice reference                                                                              |
| invoiceExternalReference      | string                                                                                                                       | Merchant's invoice reference                                                                            |
| currencySymbol                | string                                                                                                                       | The currency symbol                                                                                     |
| currencyISOCode               | string                                                                                                                       | The currency ISO code of the invoice                                                                    |
| invoicedAmount                | number                                                                                                                       | The invoiced amount in cents                                                                            |
| paymentReference              | string                                                                                                                       | Zapper's payment reference (Zapper ID)                                                                  |
| paymentUTCDate                | string                                                                                                                       | The date of the payment                                                                                 |
| status                        | [PaymentStatus](https://zapper.gitbook.io/integrations/payment-notifications/webhook-notification-model-1.2.0#paymentstatus) | The outcome of the payment                                                                              |
| tipAmount                     | number                                                                                                                       | The tip amount paid by the customer in cents                                                            |
| tenderedAmount                | number                                                                                                                       | The total tender amount paid by customer (including tips and vouchers)                                  |
| vouchers                      | Array<[Voucher](https://zapper.gitbook.io/integrations/payment-notifications/webhook-notification-model-1.2.0#voucher)>      | A list of voucher amounts and who is liable respectively                                                |
| customer                      | [Customer](https://zapper.gitbook.io/integrations/payment-notifications/webhook-notification-model-1.2.0#customer)           | The Customer's first and last name                                                                      |
| siteId                        | number                                                                                                                       | The Zapper Merchant Site ID                                                                             |
| siteReference                 | string                                                                                                                       | The identifier of the point of sale till. This is required for routing of Zapper payments and invoices. |
| transactionProcessorReference | string                                                                                                                       | The transaction id sent to the payment processor                                                        |
| transactionProcessorId        | string                                                                                                                       | The transaction id given by the payment processor                                                       |

**Example of a Zapper Payment Notification webhook body:**

```javascript
{
    "status": 1,
    "vouchers": [
        {
            "amount": 100,
            "merchantLiable": true
        }
    ],
    "currencySymbol": "R",
    "currencyISOCode": "ZAR",
    "customer": {
        "firstName": "Adam",
        "lastName": "E"
    },
    "invoicedAmount": 1000,
    "paymentReference": "8828NV78V30X5N0VY3",
    "paymentUTCDate": "2019-09-26T13:44:19.8925818Z",
    "invoiceReference": "invoiceReference1234",
    "invoiceExternalReference": "merchantOrderId1234",
    "tenderedAmount": 1100,
    "tipAmount": 100,
    "siteId": 1234,
    "siteReference": "siteReffy2",
    "transactionProcessorReference": "ghr-red-vbf-1231",
    "transactionProcessorId": "5938593"
}
```

### PaymentStatus

| Value | Description |
| ----- | ----------- |
| 1     | Success     |
| 2     | Failed      |

### Customer

| Field     | Datatype | Required | Description                   |
| --------- | -------- | -------- | ----------------------------- |
| firstName | string   | Yes      | The name of the customer      |
| lastName  | string   | Yes      | The last name of the customer |

### Voucher

| Field          | Datatype | Required | Description                           |
| -------------- | -------- | -------- | ------------------------------------- |
| merchantLiable | bool     | Yes      | Is the merchant liable for the tender |
| amount         | number   | Yes      | The redeemed amount in cents          |