# Webhook for invoice communications

Payload for invoice webhooks

Endpoint: POST /webhook-invoice(to be defined)
Version: version

## Header parameters:

  - `x-signature` (string, required)
    the hashed (SHA-512) payload
    Example: "1be8ca419d1969085fba97228a5eeb55683cc5442cb475ffd9d8a40419ead40d3d82bea3209b6f4fdcce51c9ce6eb43a025faaf05b09bb90e4cb3c143143adec"

  - `Authorization` (string, required)
    For each request, a valid access token must be provided in the Authorization header. See                       Authentication API for obtaining a valid token.

## Request fields (application/json):

  - `id` (number)
    Unique identifier of the webhook event.
    Example: 92

  - `shop_transaction_id` (string)
    The order ID generated by the shop. This ID must be known to the buyer and is used for buyer communication, e.g. emails and buyer support.
    Example: "shop-transaction-id-1234"

  - `ratepay_payment_reference` (string)
    Reference to be indicated in the bank transfer (generated by Ratepay).
    Example: "GD1234567890"

  - `ratepay_transaction_id` (string)
    Ratepay transaction ID.
    Example: "32-201411251340634"

  - `invoice_id` (string)
    The billing ID of the order.
    Example: "DG0627731Z7-001"

  - `eml_url` (string)
    The URL to fetch the email document.
    Example: "https://api.ratepay.com/api/order/123/correspondences/invoices/456/eml"

  - `pdf_url` (string)
    The URL to fetch the PDF document.
    Example: "https://api.ratepay.com/api/order/123/correspondences/invoices/456/pdf"


## Response 200 fields