Vertex Webhooks

It is possible to subscribe to Vertex webhooks. This is a streamlined integration method for all future payment methods supported by the service.

Webhook endpoints can be managed directly in the Merchant Portal.

Event Type	Description	Data Included
`transaction.created`	A new transaction was created	`transaction`
`transaction.confirmed`	A transaction was confirmed	`transaction`
`transaction.updated`	A transaction was updated	`transaction`
`refund.created`	A refund was created	`transaction` `refund`
`invoice.created`	An invoice was created	`transaction`
`creditnote.created`	A credit note was created	`transaction`
`report.complete`	The Detailed Settlement report was created.	`transaction`

Field	Description
`app_mode`	"TEST" or "LIVE"
`created`	Event timestamp in RFC-3339 format e.g. "2016-07-25T21:59:33Z"
`event_id`	A unique event identifier e.g. "ed_14s...PA"
`event_type`	The event type. For example `transaction.created`.
`transaction`	Transaction data related to the event. This is modelled on the responses from the API. See the Reference Guide Overview for more details.
`refund`	Refund data related to the event. Present for the `refund.created` event type. Example: `json { "refund_reason": "Returned", "test_mode": true, "refund_timestamp": "2016-07-25T21:59:33Z", "tax_amount": 0.17, "tax_rate": 20, "line_key": "kc6-K3eITuG1RJa4", "refund_note_number": 1, "refund_note_subnumber": 1, "total_amount": 1.0, "currency_code": "EUR" }`

Regular one-time sales

Singular sales will simply trigger the transaction.confirmed event upon payment.

In case of a sale facilitated through the service, two notifications will be sent: one for the actual sale, and one for the back-to-back transaction between the merchant and Taxamo.

Subscriptions

For subscriptions there is one additional transaction with a 0 amount. This transaction holds all of the customer information and evidence. This is called a placeholder transaction.

If the sale is facilitated through the service, this placeholder transaction will be stored in the service, but a webhook notification will be delivered. No back-to-back transaction is issued for the additional transaction.

Subscription transactions will work the same way as regular sales. They trigger the transaction.confirmed event and they should be fetched through the API endpoint to resolve any additional information required.

Refunds

Refunds for both direct sales or a back-to-back transactions will trigger the refund.created event.

Invoices

Each non-zero sale amount between the customer and Taxamo, or the merchant, will trigger an invoice to be generated.

Taxamo can also deliver an invoice image through email to the customer.

The invoice URL is set at the transaction.invoice_image_url field in transaction data.

Credit notes

Every refund on a charge in Stripe or PayPal will trigger a credit note generation. The credit note is available under the following url syntax:

https://services.taxamo.com/api/v2/transactions/{transaction_key}/invoice/refunds/{refund_note_number}/preview

The refund_note_number value is a sequential number for each refund in a transaction, starting with 1.

It is also possible to fetch refund note links using the GET https://services.taxamo.com/api/v2/transactions/:key/full endpoint, which will work for all kinds of transactions: regular, back-to-back, and delegated.

Detailed Settlement report

The Detailed Settlement Report can be run manually or it is also run automatically at regularly scheduled times.

For automated reports, the service creates an event in the report.complete webhook to notify you when it is complete.