Sign in

v1

latestOpenAPI 3.0.12026-08-06103.2 KB

Webhook for invoice communications

Payload for invoice webhooks

post/webhook-invoice(to be defined)

Request body

idnumber

Unique identifier of the webhook event.

shop_transaction_idstring

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.

ratepay_payment_referencestring

Reference to be indicated in the bank transfer (generated by Ratepay).

ratepay_transaction_idstring

Ratepay transaction ID.

invoice_idstring

The billing ID of the order.

eml_urlstring

The URL to fetch the email document.

pdf_urlstring

The URL to fetch the PDF document.

Example request

{
  "id": 92,
  "shop_transaction_id": "shop-transaction-id-1234",
  "ratepay_payment_reference": "GD1234567890",
  "ratepay_transaction_id": "32-201411251340634",
  "invoice_id": "DG0627731Z7-001",
  "eml_url": "https://api.ratepay.com/api/order/123/correspondences/invoices/456/eml",
  "pdf_url": "https://api.ratepay.com/api/order/123/correspondences/invoices/456/pdf"
}

Response

Success