Webhook for invoice communications

Payload for invoice webhooks

Request
header Parameters
x-signature
required
string

the hashed (SHA-512) payload

Example: 1be8ca419d1969085fba97228a5eeb55683cc5442cb475ffd9d8a40419ead40d3d82bea3209b6f4fdcce51c9ce6eb43a025faaf05b09bb90e4cb3c143143adec
Authorization
required
string

For each request, a valid access token must be provided in the Authorization header. See Authentication API for obtaining a valid token.

Request Body schema: application/json
required
id
number

Unique identifier of the webhook event.

shop_transaction_id
string [ 1 .. 50 ] characters

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_reference
string [ 10 .. 127 ] characters

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

ratepay_transaction_id
string

Ratepay transaction ID.

invoice_id
string

The billing ID of the order.

eml_url
string

The URL to fetch the email document.

pdf_url
string

The URL to fetch the PDF document.

Responses
200

Success

post/webhook-invoice(to be defined)
Request samples
application/json
{}